Improve contributing guide and workflow #114
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Removes the indirection of the JS files, and runs commands straight from package.json instead
tsc has been deprecated in favor of typescript
The vsix extension should only be built after the changelog commit
| @@ -6,7 +6,7 @@ NEW_VERSION=${TRAVIS_TAG#"v"} | |||
|
|
|||
| # Build the extension | |||
| yarn install | |||
| yarn build | |||
| yarn build:syntax | |||
There was a problem hiding this comment.
When is yarn build:extension executed? Is that part of yarn vscode:publish?
There was a problem hiding this comment.
Yes it is. From the vsce docs it seems that yarn vscode:publish (aka vsce publish) does the packaging before publishing, as it is the only command needed to publish.
MaximeKjaer
commented
Jul 5, 2020
| "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", |
There was a problem hiding this comment.
I don't think this prepublish script is actually doing anything useful? I tried messing with the json file but this doesn't result in failures of vscode:prepublish
There was a problem hiding this comment.
@MaximeKjaer , it just checks if the file ./syntaxes/Scala.tmLanguage.json exists.
nicolasstucki
approved these changes
Jul 6, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR:
package.json,This should simplify the workflow little, as there is a Yarn task for every possible action. The basic workflow now only consists of
yarn install,yarn buildandyarn test. But you can still run very more precise tasks throughyarn test:unitoryarn build:extension, for instance.