chore: Fix npm/node to v6 and latest LTS (#441)

Doist · Feb 22, 2021 · 3c008ba · 3c008ba
1 parent 6dc59f9
commit 3c008ba
Show file tree

Hide file tree

Showing 24 changed files with 37 additions and 20 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -18,7 +18,7 @@ Feel free to leave unchecked or remove the lines that are not applicable.
 -   [ ] Updated docs (storybooks, readme)
 -   [ ] Executed `npm run validate` and made sure no errors / warnings were shown
 -   [ ] Described changes in `CHANGELOG.md`
--   [ ] Bumped version in `package.json`
+-   [ ] Bumped version in `package.json` and `package-lock.json` (`npm --no-git-tag-version version <major|minor|patch>`) [ref](https://docs.npmjs.com/cli/v6/commands/npm-version)
 -   [ ] Updated all static build artifacts (`npm run build-all`)
 
 ## Versioning

diff --git a/.github/codeql/codeql-config.yml b/.github/codeql/codeql-config.yml
@@ -0,0 +1,2 @@
+paths:
+  - src
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -30,8 +30,9 @@ jobs:
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v1
+      with:
+        config-file: ./.github/codeql/codeql-config.yml
       # Override language selection by uncommenting this and choosing your languages
-      # with:
       #   languages: go, javascript, csharp, python, cpp, java
 
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).

diff --git a/.github/workflows/coverage-reporting.yml b/.github/workflows/coverage-reporting.yml
@@ -13,7 +13,7 @@ jobs:
             - uses: actions/checkout@v2
             - uses: actions/setup-node@v1
               with:
-                  node-version: 12
+                  node-version: 14
             - name: Install dependencies
               run: npm set progress=false && CYPRESS_INSTALL_BINARY=0 HUSKY_SKIP_INSTALL=1 npm ci --silent
             - name: Run tests and collect coverage

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -12,7 +12,7 @@ jobs:
             - uses: actions/checkout@v1
             - uses: actions/setup-node@v1
               with:
-                  node-version: 12
+                  node-version: 14
             - run: npm ci
             - run: npm run lint
             - run: npm run type-check
@@ -24,7 +24,7 @@ jobs:
             # Publish to GitHub package registry
             - uses: actions/setup-node@v1
               with:
-                  node-version: 12
+                  node-version: 14
                   registry-url: https://npm.pkg.github.com/
                   scope: '@doist'
             - run: npm publish
@@ -34,7 +34,7 @@ jobs:
             # Publish to npm registry
             - uses: actions/setup-node@v1
               with:
-                  node-version: 12
+                  node-version: 14
                   registry-url: https://registry.npmjs.org/
                   scope: '@doist'
             - run: npm publish

diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml
@@ -9,7 +9,7 @@ jobs:
             - uses: actions/checkout@v1
             - uses: actions/setup-node@v1
               with:
-                  node-version: 12
+                  node-version: 14
             - run: npm ci
             - run: npm run lint
             - run: npm run type-check

diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+engine-strict=true
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+v14.15.5
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 Reactist follows [semantic versioning](https://semver.org/) and doesn't introduce breaking changes (API-wise) in minor or patch releases. However, the appearance of a component might change in a minor or patch release so keep an eye on redesigns and make sure your app still looks and feels like you expect it.
 
+## 9.0.0
+
+-   [Build] The project now requires node v14.5.5+ and npm v6.14.11+ to install and run.
+-   We're skipping right over v8.0.0 as its tag has already been created previously
+
 ## 7.2.1
 
 -   [Tweak] Adds `defaultValue` and ensures additional props are carried forward on the `Select` component.

diff --git a/README.md b/README.md
@@ -44,11 +44,17 @@ You can find our changelog [here](./CHANGELOG.md).
 
 # Development
 
-First clone the repository, and run its setup task:
+We leverage `package.json`'s `engines` field to specify the node/npm versions to be used while in development. The easiest way to switch quickly is through [fnm](https://github.com/Schniz/fnm).
+
+It's worth noting that fnm can automatically switch to a project's specified node version when it encounters a `.nvmrc` file. To do so, use the `--use-on-cd` flag when [generating your shell's config script with `fnm env`](https://github.com/Schniz/fnm#fnm-env).
+
+Once fnm is installed, clone the repository. Then, switch to the required node version, and run its setup task:
 
 ```sh
 git clone https://github.com/doist/reactist.git
 cd reactist
+fnm install
+fnm use
 npm run setup
 ```
 

diff --git a/docs/iframe.html b/docs/iframe.html
@@ -71,4 +71,4 @@
   }</script><style>#root[hidden],
       #docs-root[hidden] {
         display: none !important;
-      }</style></head><body><div class="sb-nopreview sb-wrapper"><div class="sb-nopreview_main"><h1 class="sb-nopreview_heading sb-heading">No Preview</h1><p>Sorry, but you either have no stories or none are selected somehow.</p><ul><li>Please check the Storybook config.</li><li>Try reloading the page.</li></ul><p>If the problem persists, check the browser console, or the terminal you've run Storybook from.</p></div></div><div class="sb-errordisplay sb-wrapper"><pre id="error-message" class="sb-heading"></pre><pre class="sb-errordisplay_code"><code id="error-stack"></code></pre></div><div id="root"></div><div id="docs-root"></div><script src="runtime~main.e8da7b7e63150a6ee1ad.bundle.js"></script><script src="vendors~main.e8da7b7e63150a6ee1ad.bundle.js"></script><script src="main.e8da7b7e63150a6ee1ad.bundle.js"></script></body></html>
+      }</style></head><body><div class="sb-nopreview sb-wrapper"><div class="sb-nopreview_main"><h1 class="sb-nopreview_heading sb-heading">No Preview</h1><p>Sorry, but you either have no stories or none are selected somehow.</p><ul><li>Please check the Storybook config.</li><li>Try reloading the page.</li></ul><p>If the problem persists, check the browser console, or the terminal you've run Storybook from.</p></div></div><div class="sb-errordisplay sb-wrapper"><pre id="error-message" class="sb-heading"></pre><pre class="sb-errordisplay_code"><code id="error-stack"></code></pre></div><div id="root"></div><div id="docs-root"></div><script src="runtime~main.929b84d083b192d4babb.bundle.js"></script><script src="vendors~main.929b84d083b192d4babb.bundle.js"></script><script src="main.929b84d083b192d4babb.bundle.js"></script></body></html>
diff --git a/docs/main.e8da7b7e63150a6ee1ad.bundle.js → docs/main.929b84d083b192d4babb.bundle.js b/docs/main.e8da7b7e63150a6ee1ad.bundle.js → docs/main.929b84d083b192d4babb.bundle.js
diff --git a/docs/main.929b84d083b192d4babb.bundle.js.map b/docs/main.929b84d083b192d4babb.bundle.js.map
diff --git a/docs/main.e8da7b7e63150a6ee1ad.bundle.js.map b/docs/main.e8da7b7e63150a6ee1ad.bundle.js.map
diff --git a/...ntime~main.e8da7b7e63150a6ee1ad.bundle.js → ...ntime~main.929b84d083b192d4babb.bundle.js b/...ntime~main.e8da7b7e63150a6ee1ad.bundle.js → ...ntime~main.929b84d083b192d4babb.bundle.js
diff --git a/docs/runtime~main.929b84d083b192d4babb.bundle.js.map b/docs/runtime~main.929b84d083b192d4babb.bundle.js.map
diff --git a/docs/runtime~main.e8da7b7e63150a6ee1ad.bundle.js.map b/docs/runtime~main.e8da7b7e63150a6ee1ad.bundle.js.map
diff --git a/docs/vendors~main.929b84d083b192d4babb.bundle.js b/docs/vendors~main.929b84d083b192d4babb.bundle.js
diff --git a/...8da7b7e63150a6ee1ad.bundle.js.LICENSE.txt → ...29b84d083b192d4babb.bundle.js.LICENSE.txt b/...8da7b7e63150a6ee1ad.bundle.js.LICENSE.txt → ...29b84d083b192d4babb.bundle.js.LICENSE.txt
diff --git a/docs/vendors~main.929b84d083b192d4babb.bundle.js.map b/docs/vendors~main.929b84d083b192d4babb.bundle.js.map
diff --git a/docs/vendors~main.e8da7b7e63150a6ee1ad.bundle.js b/docs/vendors~main.e8da7b7e63150a6ee1ad.bundle.js
diff --git a/docs/vendors~main.e8da7b7e63150a6ee1ad.bundle.js.map b/docs/vendors~main.e8da7b7e63150a6ee1ad.bundle.js.map
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
     "name": "@doist/reactist",
     "description": "Open source React components by Doist",
     "author": "Henning Muszynski <[email protected]> (http://doist.com)",
-    "version": "7.2.1",
+    "version": "9.0.0",
     "license": "MIT",
     "homepage": "https://github.com/Doist/reactist#readme",
     "repository": "git+https://github.com/Doist/reactist.git",
@@ -21,7 +21,8 @@
         "styles"
     ],
     "engines": {
-        "node": ">=10"
+        "node": "^14.5.5",
+        "npm": "^6.14.11"
     },
     "scripts": {
         "setup": "npm install && npm run validate",