Skip to content

Commit 11fa022

Browse files
committed
Prepare for release
- Update README.md - Update CHANGELOG.md - Add DEVELOPMENT.md - Add .gitattributes - Update icons - Update publisher information
1 parent ba5a04a commit 11fa022

File tree

11 files changed

+81
-79
lines changed

11 files changed

+81
-79
lines changed

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.cash linguist-language=Solidity

.vscodeignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
.vscode/**
22
.vscode-test/**
3+
.yarn/** */
34
out/test/**
45
test/**
56
src/**
67
**/*.map
78
*.vsix
89
.gitignore
910
tsconfig.json
10-
vsc-extension-quickstart.md
11-
*.svg
11+
*.svg

CHANGELOG.md

Lines changed: 34 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,48 @@
22

33
All notable changes to the "vscode-cashscript" extension will be documented in this file.
44

5-
## 0.1.0
5+
## v0.4.0
66

7-
Initial release of vscode-cashscript. Features:
7+
- Add support for CashScript v0.10.0
8+
- Add `console.log` statements
9+
- Add optional failure message to `require` statements
10+
- Add support for underscores in numbers and scientific notation
811

9-
- Syntax Highlighting
10-
- Auto-Completion
11-
- Snippets
12-
- Linting
13-
- Contract Compilation (press F5 or click "Compile Contract")
14-
Would like to implement tests and other sustainability features before bumping version
12+
## v0.3.0
1513

16-
## 0.1.1
14+
- Add support for CashScript v0.8.0
15+
- Add token properties to inputs and outputs
16+
- Remove 'OutputX' in favour of 'LockingBytecodeX'
17+
- Remove 'Compilation' functionality due to ESM incompatibilties
18+
- Small fixes and refactors
19+
- Update examples
1720

18-
- Fixed language grammar to have comprehensive highlighting
19-
- Added janky HoverProvider for variable types
20-
- Added split/reverse to hover provider
21+
## 0.2.0
22+
23+
- Add support for CashScript v0.7.0
24+
- Updated to new Native Introspection functionality
25+
- Added tuple destructuring
26+
- Added new `constant` keyword
27+
- Added `*` operator
2128

2229
## 0.1.2
2330

2431
- Added tx to completion provider and syntax highlighting
2532
- added byte alias for bytes1
2633

27-
## 0.2.0
34+
## 0.1.1
2835

29-
- Compatible with `cashscript@0.7.0`
30-
- Updated to new Native Introspection functionality
31-
- Added tuple destructuring
32-
- Added new `constant` keyword
33-
- Added `*` operator
36+
- Fixed language grammar to have comprehensive highlighting
37+
- Added janky HoverProvider for variable types
38+
- Added split/reverse to hover provider
39+
40+
## 0.1.0
41+
42+
Initial release of vscode-cashscript. Features:
43+
44+
- Syntax Highlighting
45+
- Auto-Completion
46+
- Snippets
47+
- Linting
48+
- Contract Compilation (press F5 or click "Compile Contract")
49+
Would like to implement tests and other sustainability features before bumping version
Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,53 @@
1-
# Welcome to your VS Code Extension
1+
## Development Instructions
22

3-
## What's in the folder
3+
Clone the project
4+
5+
```
6+
git clone https://github.com/CashScript/vscode-cashscript
7+
```
8+
9+
Install Dependencies
10+
11+
```
12+
cd vscode-cashscript && yarn
13+
```
14+
15+
Open the project in vscode.
16+
17+
```
18+
code .
19+
```
20+
21+
Press F5 anywhere to start the test window, open the examples folder to test out any `.cash` file. All relevent files are located within the `/src` directory.
22+
23+
---
24+
25+
## Welcome to your VS Code Extension
26+
27+
### What's in the folder
428

529
- This folder contains all of the files necessary for your extension.
630
- `package.json` - this is the manifest file in which you declare your language support and define the location of the grammar file that has been copied into your extension.
731
- `syntaxes/cashscript.tmLanguage.json` - this is the Text mate grammar file that is used for tokenization.
832
- `language-configuration.json` - this is the language configuration, defining the tokens that are used for comments and brackets.
933

10-
## Get up and running straight away
34+
### Get up and running straight away
1135

1236
- Make sure the language configuration settings in `language-configuration.json` are accurate.
1337
- Press `F5` to open a new window with your extension loaded.
1438
- Create a new file with a file name suffix matching your language.
1539
- Verify that syntax highlighting works and that the language configuration settings are working.
1640

17-
## Make changes
41+
### Make changes
1842

1943
- You can relaunch the extension from the debug toolbar after making changes to the files listed above.
2044
- You can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes.
2145

22-
## Add more language features
46+
### Add more language features
2347

2448
- To add features such as intellisense, hovers and validators check out the VS Code extenders documentation at https://code.visualstudio.com/docs
2549

26-
## Install your extension
50+
### Install your extension
2751

2852
- To start using your extension with Visual Studio Code copy it into the `<user home>/.vscode/extensions` folder and restart Code.
2953
- To share your extension with the world, read on https://code.visualstudio.com/docs about publishing an extension.

README.md

Lines changed: 10 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# vscode-cashscript
22

3-
![Visual Studio Marketplace Version (including pre-releases)](https://img.shields.io/visual-studio-marketplace/v/nathanielCherian.cashscript)
4-
![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/nathanielcherian.cashscript)
5-
![Visual Studio Marketplace Rating (Stars)](https://img.shields.io/visual-studio-marketplace/stars/nathanielCherian.cashscript)
3+
![Visual Studio Marketplace Version (including pre-releases)](https://img.shields.io/visual-studio-marketplace/v/CashScript.cashscript)
4+
![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/CashScript.cashscript)
5+
![Visual Studio Marketplace Rating (Stars)](https://img.shields.io/visual-studio-marketplace/stars/CashScript.cashscript)
66

7-
Vscode-cashscript provides tools that make it easier for developers to write smart contracts with [cashscript](https://cashscript.org/).
7+
The `cashscript` extension for VS Code that provides auto-completion, linting, and more when writing smart contracts with [CashScript](https://cashscript.org/).
88

9-
![example of vscode-cashscript](https://raw.githubusercontent.com/nathanielCherian/vscode-cashscript/main/media/p2pkh.gif)
9+
<!-- TODO: Improvde video -->
1010

11-
A special thank you to [vscode-solidity](https://github.com/juanfranblanco/vscode-solidity) which inspired much of the code structure!
11+
![example of vscode-cashscript](https://raw.githubusercontent.com/CashScript/vscode-cashscript/main/media/p2pkh.gif)
1212

1313
## Features
1414

@@ -17,46 +17,10 @@ A special thank you to [vscode-solidity](https://github.com/juanfranblanco/vscod
1717
- Snippets
1818
- Linting
1919

20-
## Development Instructions
20+
## CashScript
2121

22-
Press **F5** or click the "**Compile Contract**" button in the top right. A json file containing the contract artifiact will be created in the same directory with the same name.
22+
CashScript is a high-level language that allows you to write Bitcoin Cash smart contracts in a straightforward and familiar way. Its syntax is inspired by Ethereum's Solidity language, but its functionality is different since the underlying systems have very different fundamentals. See the [language documentation](https://cashscript.org/docs/language/) for a full reference of the language.
2323

24-
Clone the project
24+
## Acknowledgements
2525

26-
```
27-
git clone https://github.com/nathanielCherian/vscode-cashscript
28-
```
29-
30-
Install Dependencies
31-
32-
```
33-
cd vscode-cashscript && npm i
34-
```
35-
36-
Open the project in vscode.
37-
38-
```
39-
code .
40-
```
41-
42-
Press F5 anywhere to start the test window, open the examples folder to test out any '.cash' file. All relevent files are located within the /src directory.
43-
44-
## Extension Settings
45-
46-
None available yet.
47-
48-
## Known Issues
49-
50-
None available yet.
51-
52-
## Release Notes
53-
54-
Check the [changelog](/CHANGELOG.md) for past releases. Latest stable version:
55-
56-
## 0.2.0
57-
58-
- Compatible with `cashscript@0.7.0`
59-
- Updated to new Native Introspection functionality
60-
- Added tuple destructuring
61-
- Added new `constant` keyword
62-
- Added `'*'` operator
26+
The original version of this extension was created by [Nathaniel Cherian](https://github.com/nathanielCherian) and was inspired by [vscode-solidity](https://github.com/juanfranblanco/vscode-solidity).

media/icon-full.png

40.4 KB
Loading

media/icon.png

93 Bytes
Loading

media/logo-dark.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

media/logo.png

-31.4 KB
Binary file not shown.

media/logo.svg

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)