Skip to content

Commit

Permalink
Add section on tooling and recommend using ASDF for tool versioning (#…
Browse files Browse the repository at this point in the history
…2547)

* spelling error / file name

* Add section on tooling using ASDF

* Set specific Node version
  • Loading branch information
fatso83 authored Sep 26, 2023
1 parent 062e318 commit e1c3dad
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
1 change: 1 addition & 0 deletions .tool-versions
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
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

0 comments on commit e1c3dad

Please sign in to comment.