Skip to content

Commit

Permalink
Prepare for release
Browse files Browse the repository at this point in the history
- Update README.md
- Update CHANGELOG.md
- Add DEVELOPMENT.md
- Add .gitattributes
- Update icons
- Update publisher information
  • Loading branch information
rkalis committed Jan 10, 2025
1 parent ba5a04a commit 11fa022
Show file tree
Hide file tree
Showing 11 changed files with 81 additions and 79 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.cash linguist-language=Solidity
4 changes: 2 additions & 2 deletions .vscodeignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
.vscode/**
.vscode-test/**
.yarn/** */
out/test/**
test/**
src/**
**/*.map
*.vsix
.gitignore
tsconfig.json
vsc-extension-quickstart.md
*.svg
*.svg
52 changes: 34 additions & 18 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,48 @@

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

## 0.1.0
## v0.4.0

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

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

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

- Fixed language grammar to have comprehensive highlighting
- Added janky HoverProvider for variable types
- Added split/reverse to hover provider
## 0.2.0

- Add support for CashScript v0.7.0
- Updated to new Native Introspection functionality
- Added tuple destructuring
- Added new `constant` keyword
- Added `*` operator

## 0.1.2

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

## 0.2.0
## 0.1.1

- Compatible with `[email protected]`
- Updated to new Native Introspection functionality
- Added tuple destructuring
- Added new `constant` keyword
- Added `*` operator
- Fixed language grammar to have comprehensive highlighting
- Added janky HoverProvider for variable types
- Added split/reverse to hover provider

## 0.1.0

Initial release of vscode-cashscript. Features:

- Syntax Highlighting
- Auto-Completion
- Snippets
- Linting
- Contract Compilation (press F5 or click "Compile Contract")
Would like to implement tests and other sustainability features before bumping version
36 changes: 30 additions & 6 deletions vsc-extension-quickstart.md → DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,53 @@
# Welcome to your VS Code Extension
## Development Instructions

## What's in the folder
Clone the project

```
git clone https://github.com/CashScript/vscode-cashscript
```

Install Dependencies

```
cd vscode-cashscript && yarn
```

Open the project in vscode.

```
code .
```

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.

---

## Welcome to your VS Code Extension

### What's in the folder

- This folder contains all of the files necessary for your extension.
- `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.
- `syntaxes/cashscript.tmLanguage.json` - this is the Text mate grammar file that is used for tokenization.
- `language-configuration.json` - this is the language configuration, defining the tokens that are used for comments and brackets.

## Get up and running straight away
### Get up and running straight away

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

## Make changes
### Make changes

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

## Add more language features
### Add more language features

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

## Install your extension
### Install your extension

- To start using your extension with Visual Studio Code copy it into the `<user home>/.vscode/extensions` folder and restart Code.
- To share your extension with the world, read on https://code.visualstudio.com/docs about publishing an extension.
56 changes: 10 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# vscode-cashscript

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

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

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

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

## Features

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

## Development Instructions
## CashScript

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.
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.

Clone the project
## Acknowledgements

```
git clone https://github.com/nathanielCherian/vscode-cashscript
```

Install Dependencies

```
cd vscode-cashscript && npm i
```

Open the project in vscode.

```
code .
```

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.

## Extension Settings

None available yet.

## Known Issues

None available yet.

## Release Notes

Check the [changelog](/CHANGELOG.md) for past releases. Latest stable version:

## 0.2.0

- Compatible with `[email protected]`
- Updated to new Native Introspection functionality
- Added tuple destructuring
- Added new `constant` keyword
- Added `'*'` operator
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).
Binary file added media/icon-full.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified media/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion media/logo-dark.svg

This file was deleted.

Binary file removed media/logo.png
Binary file not shown.
3 changes: 0 additions & 3 deletions media/logo.svg

This file was deleted.

7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
{
"name": "cashscript",
"publisher": "NathanielCherian",
"publisher": "CashScript",
"displayName": "cashscript",
"description": "Cashscript language support for Visual Studio Code",
"version": "0.4.0",
"icon": "media/icon.png",
"repository": {
"type": "git",
"url": "https://github.com/nathanielCherian/vscode-cashscript"
"url": "https://github.com/CashScript/vscode-cashscript"
},
"bugs": {
"url": "https://github.com/nathanielCherian/vscode-cashscript/issues"
"url": "https://github.com/CashScript/vscode-cashscript/issues"
},
"contributors": [
"CashScript",
"Nathaniel Cherian"
],
"keywords": [
Expand Down

0 comments on commit 11fa022

Please sign in to comment.