Skip to content

Commit

Permalink
Merge pull request #656 from Goju-Ryu/vscode-extension-quality-of-lif…
Browse files Browse the repository at this point in the history
…e-changes

Vscode extension packaging
  • Loading branch information
sharkdp authored Nov 21, 2024
2 parents 2d6e1e2 + 72e46e8 commit 86c80e5
Show file tree
Hide file tree
Showing 6 changed files with 56 additions and 52 deletions.
59 changes: 11 additions & 48 deletions vscode-extension/README.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,28 @@
# numbat README
# Numbat README

This is the README for your extension "numbat". After writing up a brief description, we recommend including the following sections.
The Numbat extension provides language support for the [Numbat](https://github.com/sharkdp/numbat) programming language.

## Features

Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.

For example if there is an image subfolder under your extension project workspace:

\!\[feature X\]\(images/feature-x.png\)

> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
- Syntax highlighting
- Code block folding
- comment toggling
- autosurrounding brackets

## Requirements

If you have any requirements or dependencies, add a section describing those and how to install and configure them.
_TO BE DONE_

## Extension Settings

Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.

For example:

This extension contributes the following settings:

* `myExtension.enable`: enable/disable this extension
* `myExtension.thing`: set to `blah` to do something
_None_

## Known Issues

Calling out known issues can help limit users opening duplicate issues against your extension.
_None so far_

## Release Notes

Users appreciate release notes as you update your extension.

### 1.0.0

Initial release of ...

### 1.0.1

Fixed issue #.

### 1.1.0

Added features X, Y, and Z.

-----------------------------------------------------------------------------------------------------------

## Working with Markdown

**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets

### For more information

* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
### 0.1.0

**Enjoy!**
Initial release of the Numbat extension!
Binary file added vscode-extension/assets/numbat-256x256.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 added vscode-extension/assets/numbat-64x64.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions vscode-extension/language-configuration.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,12 @@
["(", ")"],
["<", ">"],
["[", "]"],
["\"", "\""],
],
// symbols that can be used to surround a selection
"surroundingPairs": [
["(", ")"],
["\"", "\""],
],
"folding": {
"offSide": true // This is not strictly true, but we encourage a coding style where blocks are somewhat based on indentation
Expand Down
32 changes: 29 additions & 3 deletions vscode-extension/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,50 @@
"name": "numbat",
"displayName": "Numbat",
"description": "Syntax highlighting for the Numbat programming language",
"version": "0.0.1",
"version": "0.1.0",
"license": "(MIT OR Apache-2.0)",
"icon": "./assets/numbat-256x256.png",
"engines": {
"vscode": "^1.71.0"
},
"categories": [
"Programming Languages"
],
"keywords": [
"language",
"physics",
"units",
"calculation"
],
"contributes": {
"languages": [{
"id": "numbat",
"aliases": ["Numbat", "numbat"],
"extensions": [".nbt"],
"configuration": "./language-configuration.json"
"configuration": "./language-configuration.json",
"icon": {
"light": "./assets/numbat-64x64.png",
"dark": "./assets/numbat-64x64.png"
}
}],
"grammars": [{
"language": "numbat",
"scopeName": "source.numbat",
"path": "./syntaxes/numbat.tmLanguage.json"
}]
}
},
"scripts": {
"vscode:package": "vsce package"
},
"devDependencies": {
"@vscode/vsce": "3.2.1"
},
"vsce": {
"skipLicense": true
},
"repository": {
"type": "git",
"url": "https://github.com/sharkdp/numbat.git"
},
"homepage": "https://github.com/sharkdp/numbat/blob/master/vscode-extension/README.md"
}
15 changes: 14 additions & 1 deletion vscode-extension/syntaxes/numbat.tmLanguage.json
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,20 @@
},
"strings": {
"name": "string.quoted.double",
"match": "((?<=})|\")((?!(?<!\\\\)[{\"])([^\"]|\\\"))*((?={)|\")"
"begin": "\"",
"end": "\"",
"patterns": [
{
"name": "constant.character.escape",
"begin": "{",
"end": "}",
"patterns": [
{
"include": "$base"
}
]
}
]
}
},
"scopeName": "source.numbat"
Expand Down

0 comments on commit 86c80e5

Please sign in to comment.