Skip to content

Section on tooling #2547

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fatso83 merged 3 commits into from
Sep 26, 2023
Merged

Section on tooling #2547

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
212ee77
spelling error / file name
fatso83 Sep 18, 2023
09e39ca
Add section on tooling using ASDF
fatso83 Sep 18, 2023
3a8e9cf
Set specific Node version
fatso83 Sep 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .tool-versions
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
nodejs 20.6.1
18 changes: 17 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,22 @@ $ npm run prettier:write

To ensure consistent reporting of lint warnings, you should use the same versions of ESLint and Prettier as defined in `package.json` (which is what the CI servers use).

### Tooling

To transparently handle all issues with different tool versions we recommend using [_ASDF: The Multiple Runtime Manager_][asdf]. You would then need the Ruby and Node plugins.

<details>

```
asdf plugin add ruby
asdf plugin add nodejs
asdf install
```

</details>

[asdf]: https://asdf-vm.com

### Run the tests

Following command runs unit tests in PhantomJS, Node and WebWorker
Expand Down Expand Up @@ -133,4 +149,4 @@ Build requires Node. Under the hood [Browserify](http://browserify.org/) is used

To build run

$ node build.js
$ node build.cjs