|
1 | | -# vscode-nushell-lang README |
| 1 | +# vscode-nushell-lang VSCode extension |
2 | 2 |
|
3 | | -This extension provides editing and syntax highlighting support |
4 | | -for [Nushell](http://nushell.sh), a data driven document language. |
| 3 | +This [extension for VSCode](https://code.visualstudio.com/docs/introvideos/extend) provides editing and syntax highlighting support for [Nushell](http://nushell.sh), a data-driven document language. |
5 | 4 |
|
6 | 5 | ## Features |
7 | 6 |
|
8 | | -* Syntax highlighting grammar |
| 7 | +* Syntax highlighting grammar for Nushell scripts (`.nu` files) |
9 | 8 | * Nushell theme that tries to match Nushell's coloring |
10 | 9 |
|
11 | 10 | ## Screenshot (v0.0.4) |
| 11 | + |
12 | 12 | With Nushell Color Theme |
13 | | - |
| 13 | + |
14 | 14 | With VSDark+ Color Theme |
15 | | - |
| 15 | + |
16 | 16 |
|
17 | 17 | ## Known Issues |
18 | 18 |
|
19 | | -See [our Github repository](https://github.com/nushell/vscode-nushell-lang/issues) |
20 | | -for active issues. |
| 19 | +See [our Github repository](https://github.com/nushell/vscode-nushell-lang/issues) for active issues. |
21 | 20 |
|
22 | 21 | ## Regex Engine |
23 | 22 |
|
24 | | -VSCode uses a regular expressions that is based on Ruby for syntax highlighting. [This is a good site](https://rubular.com/) to test and try out these regular expressions. |
| 23 | +VSCode uses a regular expressions engine that is based on Ruby for syntax highlighting. |
| 24 | +[This is a good site](https://rubular.com/) to test and try out these regular expressions. |
25 | 25 |
|
26 | 26 | ## Build Process |
27 | 27 |
|
28 | | -We pretty much followed [these instructions](https://code.visualstudio.com/api/get-started/your-first-extension) for building this extension. And [this link](https://code.visualstudio.com/api/working-with-extensions/publishing-extension) for packaging the extension. |
| 28 | +We pretty much followed [these instructions](https://code.visualstudio.com/api/get-started/your-first-extension) for building this extension. |
| 29 | +And [this link](https://code.visualstudio.com/api/working-with-extensions/publishing-extension) for packaging the extension. |
| 30 | + |
| 31 | +To summarize, the steps were: |
29 | 32 |
|
30 | | -To summarize: |
31 | | -1. npm install -g yo generator-code |
32 | | -2. yo code |
33 | | -3. chose `New Language Support` and filled out the rest of the questions |
34 | | -4. npm install -g vsce |
35 | | -5. update the readme and package.json |
36 | | -6. vsce package |
37 | | -7. code --install-extension vscode-nushell-lang-0.0.2.vsix or alternatively you can do ctrl/cmd-shift-p Extensions:Install From VSIX... |
| 33 | +1. `npm install -g yo generator-code` |
| 34 | +2. `yo code` |
| 35 | +3. choose "New Language Support" and fill out the rest of the questions |
| 36 | +4. `npm install -g vsce` |
| 37 | +5. update the `README.md` and `package.json` |
| 38 | +6. `vsce package` |
| 39 | +7. `code --install-extension vscode-nushell-lang-0.0.2.vsix`<br/> |
| 40 | + (Alternatively, you can do <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>-<kbd>Shift</kbd>-<kbd>P</kbd> and type "Extensions:Install From VSIX...") |
38 | 41 |
|
39 | | -If you have all these tools already installed you should be able to clone this repo and just do a `vsce package` to get a vsix file that you can install in vscode. |
| 42 | +If you have all these tools already installed, you should be able to clone this repo and just run `vsce package` to get a `.vsix` file that you can install in vscode. |
40 | 43 |
|
41 | 44 | ## Help |
42 | 45 |
|
43 | | -We are happily accepting pull requests to make this better. :) |
| 46 | +We are happily accepting pull requests to make this better. :) |
0 commit comments