Merge pull request #114 from scala/improve-contributing

Improve contributing guide and workflow

Author: nicolasstucki

CONTRIBUTING.md

@@ -9,8 +9,6 @@ for Visual Studio Code.
 Make sure you have the following binaries installed:
 
 - [`yarn`](https://yarnpkg.com/en/): to build the project
-- [`vsce`](https://code.visualstudio.com/api/working-with-extensions/publishing-extension):
-  to package the extension for VS Code.
 - [`code`](https://code.visualstudio.com/docs/setup/mac): to launch VS Code from
   the terminal.
 
@@ -32,9 +30,15 @@ command:
 yarn build
 ```
 
-The output tmLanguage file `syntaxes/Scala.tmLanguage.json` is marked as ignored
-in git and shouldn't be commited into the repository. The output file is
-validated against the json schema before being written.
+The output tmLanguage file `syntaxes/Scala.tmLanguage.json` is tracked by git,
+and is committed on every release (see [#23](https://github.com/scala/vscode-scala-syntax/pull/23)).
+The output file is validated against the json schema before being written.
+
+To run the tests, run the following command:
+
+```bash
+yarn test
+```
 
 ## Installing the extension locally
 
@@ -44,7 +48,7 @@ changes.
 ```bash
 yarn install
 yarn build
-vsce package
+
 # replace `*` below with the version of the generated vsix file
 code --install-extension scala-*.vsix
 ```

bin/ci-release.sh

@@ -6,7 +6,7 @@ NEW_VERSION=${TRAVIS_TAG#"v"}
 
 # Build the extension
 yarn install
-yarn build
+yarn build:syntax
 yarn test
 
 # Update package.json and CHANGELOG.md

package.json

@@ -44,16 +44,20 @@
     "devDependencies": {
         "@types/node": "^14.0.14",
         "ajv": "^6.12.2",
+        "npm-run-all": "^4.1.5",
         "ts-node": "^8.10.2",
-        "tsc": "^1.20150623.0",
         "typescript": "^3.9.5",
         "vsce": "^1.77.0",
         "vscode-tmgrammar-test": "0.0.10"
     },
     "scripts": {
         "vscode:prepublish": "test -f ./syntaxes/Scala.tmLanguage.json",
         "vscode:publish": "vsce publish --yarn",
-        "build": "ts-node src/typescript/GenerateTmLanguageFile.ts > ./syntaxes/Scala.tmLanguage.json",
-        "test": "node scripts/unit.js && node scripts/snap.js"
+        "build": "npm-run-all build:syntax build:extension",
+        "build:syntax": "ts-node src/typescript/GenerateTmLanguageFile.ts > ./syntaxes/Scala.tmLanguage.json",
+        "build:extension": "vsce package",
+        "test": "npm-run-all test:*",
+        "test:unit": "vscode-tmgrammar-test -s source.scala -g syntaxes/Scala.tmLanguage.json -t 'tests/unit/**/*.test.scala'",
+        "test:snap": "vscode-tmgrammar-snap -s source.scala -g syntaxes/Scala.tmLanguage.json -t 'tests/snap/**/*.test.scala'"
     }
 }