From e1c3dad21d3d7c18f23f014bd952b5e4136687cb Mon Sep 17 00:00:00 2001 From: Carl-Erik Kopseng Date: Tue, 26 Sep 2023 16:23:23 +0200 Subject: [PATCH] Add section on tooling and recommend using ASDF for tool versioning (#2547) * spelling error / file name * Add section on tooling using ASDF * Set specific Node version --- .tool-versions | 1 + CONTRIBUTING.md | 18 +++++++++++++++++- 2 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 .tool-versions diff --git a/.tool-versions b/.tool-versions new file mode 100644 index 000000000..4076189a8 --- /dev/null +++ b/.tool-versions @@ -0,0 +1 @@ +nodejs 20.6.1 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 859bcb4f5..9a71d508f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. + +
+ +``` +asdf plugin add ruby +asdf plugin add nodejs +asdf install +``` + +
+ +[asdf]: https://asdf-vm.com + ### Run the tests Following command runs unit tests in PhantomJS, Node and WebWorker @@ -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