Skip to content

Commit 7d552b5

Browse files
committed
renamed building.md -> CONTRIBUTING.md
1 parent ddc619b commit 7d552b5

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
# Building
1+
# Contributing
2+
3+
Thank you for considering contributing!
24

35
## Regex Engine
46

57
VSCode uses a regular expressions engine that is based on Ruby for syntax highlighting.
68
[This Rubular site is good site](https://rubular.com/) to test and try out these regular expressions because it uses Ruby which supports `oniguruma` flavor of regular expressions.
79

8-
## Build Process
10+
## Original Build Process
911

1012
We pretty much followed [these instructions](https://code.visualstudio.com/api/get-started/your-first-extension) for building this extension.
1113
And [this link](https://code.visualstudio.com/api/working-with-extensions/publishing-extension) for packaging the extension.
@@ -35,6 +37,8 @@ If you have all these tools already installed, you should be able to clone this
3537
8. Go to the output tab
3638
9. In the combo box on the right, choose `Nushell Language Server`. You should now see debug messaging as the client and server communicate
3739

40+
Instead of using VS Code, you can run `npm run compile` manually.
41+
3842
## Regex Engine
3943

4044
TIL - VSCode uses regexes for language syntax highlighting in \*.tmLanguage.json files. Those regexes and json are based on Textmate, which uses (and here is the secret-sauce) `oniguruma` flavor of syntax. See the cheat-sheet for the [syntax here](https://github.com/kkos/oniguruma/blob/master/doc/RE). Also there's a rust-crate called `onig` or `rust-onig` if we wanted to write something to help create compatible regular expressions.

0 commit comments

Comments
 (0)