Skip to content
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.

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

Bump NodeJS supported versions to ^16.16 || ^18.13 and add engines to package.json #8201

Merged
merged 15 commits into from
Jan 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 0 additions & 6 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -116,12 +116,6 @@ module.exports = {
'import/extensions': 'off',
'import/no-default-export': 'off',
'import/no-anonymous-default-export': 'off',
// We could omit this if we set `engines` fields properly
// As we don't set them then eslint thinks we're using node 8
'node/no-unsupported-features/node-builtins': [
'error',
{version: '>=16.0.0'},
],
Comment on lines -119 to -124
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We set the engines field now so this is no longer needed.

},
},
{
Expand Down
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ Each contributor is required to [sign a CLA](https://cla.shopify.com/). This pro

### Contribution prerequisites

- You have Node installed at v16.13.0+ and Yarn at v1.22.18+
- You have Node installed at v18.13.0+ and Yarn at v1.22.18+

### Best practices

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ jobs:
with:
fetch-depth: 0

- name: Setup Node with v16.13.0
- name: Setup Node with v18.13.0
uses: actions/setup-node@v3
with:
node-version: 16.13.0
node-version: 18.13.0

- name: Check for Changeset
run: npx @changesets/cli status --since="origin/main"
8 changes: 4 additions & 4 deletions .github/workflows/ci-a11y-vrt.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ jobs:
sudo rm -rf "/usr/local/share/boost"
sudo rm -rf "$AGENT_TOOLSDIRECTORY"

- name: Setup Node with v16.13.0
- name: Setup Node with v18.13.0
uses: actions/setup-node@v3
with:
node-version: 16.13.0
node-version: 18.13.0
cache: yarn

- name: Restore cache
Expand Down Expand Up @@ -72,10 +72,10 @@ jobs:
with:
fetch-depth: 0 # Chromatic git history to track changes

- name: Setup Node with v16.13.0
- name: Setup Node with v18.13.0
uses: actions/setup-node@v3
with:
node-version: 16.13.0
node-version: 18.13.0
cache: yarn

- name: Restore cache
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: ['14.18.0', '16.13.0']
node-version: ['16.16.0', '18.13.0']
steps:
- name: Checkout branch
uses: actions/checkout@v3
Expand Down
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v16.13.0
v18.13.0
2 changes: 1 addition & 1 deletion dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: polaris
up:
- node:
yarn: v1.22.18
version: v16.13.0 # to be kept in sync with .nvmrc and .github/workflows/ci.yml
version: v18.13.0 # to be kept in sync with .nvmrc and .github/workflows/ci.yml
- custom:
name: Build monorepo
met?: yarn build --output-logs=none
Expand Down
18 changes: 10 additions & 8 deletions documentation/Nodejs support.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,38 +16,40 @@ The `package.json` engines. This should match the `.github/workflows/ci.yml` and

```json
"engines": {
"node": "^14.18.0 || ^16.13.0"
"node": "^16.16.0 || ^18.13.0"
},
```

The GitHub actions `.github/workflows/ci.yml` file. This should match the `package.json` and list all supported versions.

```yml
node-version: ['14.18.0', '16.13.0']
node-version: ['16.16.0', '18.13.0']
```

The `dev.yml` file which creates a local development environment. This should match the `.nvmrc` file.

```yml
version: v16.13.0
version: v18.13.0
```

The `.nvmrc` file for local development. This should match the `dev.yml` file.

```
v16.13.0
v18.13.0
```

The `shipit.yml` files. This should point towards the GitHub Actions the packages require to pass before publishing.

```yml
ci:
require:
- 'Validate with Node v14.18.0'
- 'Validate with Node v16.13.0'
- 'Validate with Node v16.16.0'
- 'Validate with Node v18.13.0'

merge:
require:
- 'Validate with Node v14.18.0'
- 'Validate with Node v16.13.0'
- 'Validate with Node v16.16.0'
- 'Validate with Node v18.13.0'
```

The `rollup.config.mjs` for some monorepo packages. This should match the minimum supported version.
5 changes: 5 additions & 0 deletions documentation/guides/migrating-from-v10-to-v11.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,16 @@ Polaris v11.0.0 ([full release notes](https://github.com/Shopify/polaris/release

## Table of Contents

- [Node support](#node-support)
- [Components](#components)
- [Removed deprecated Collapsible argument](#removed-deprecated-collapsible-argument)
- [Removed KonamiCode component](#removed-konamicode-component)
- [Tokens](#tokens)

## Node support

NodeJS version 14 is no longer supported. NodeJS 18 is recommended and 16 is the minimum supported version.

## Components

### Removed deprecated Collapsible argument
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "0.0.0",
"private": true,
"engines": {
"node": "^14.18.0 || ^16.13.0"
"node": "^16.16.0 || ^18.13.0"
},
"workspaces": {
"packages": [
Expand Down Expand Up @@ -67,6 +67,7 @@
"@shopify/typescript-configs": "^5.1.0",
"@size-limit/preset-small-lib": "^5.0.3",
"@types/jest": "^27.5.1",
"@types/node": "^18.11.18",
"babel-loader": "^9.1.2",
"downlevel-dts": "^0.6.0",
"eslint": "^8.3.0",
Expand Down
2 changes: 1 addition & 1 deletion polaris-cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
},
"engine-strict": true,
"engines": {
"node": ">=14.13.1"
"node": "^16.16.0 || ^18.13.0"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By setting the engines on the specific node packages, they shall refuse to install if the node version does not match these versions. This is great for blocking installation on older unsupported versions, however the configuration of "^16.16.0 || ^18.13.0" means "Only node 16 or 18" - you're currently also blocking the installation of these packages on the currently supported node 19 (and the lts node 20 when it comes out in April).

For these per-package engine fields I strongly think we should allow current and future versions for the sake of forwards compatibility - ^16.16.0 || >=18.13.0.

},
"os": [
"darwin",
Expand Down
3 changes: 1 addition & 2 deletions polaris-for-vscode/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"shopify"
],
"engines": {
"vscode": "^1.64.0"
"node": "^16.16.0 || ^18.13.0"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems incorrect

},
"categories": [
"Other"
Expand All @@ -43,7 +43,6 @@
},
"devDependencies": {
"@shopify/polaris-tokens": "^6.3.0",
"@types/node": "14.x",
"@types/vscode": "^1.64.0",
"@vscode/test-electron": "^2.1.2",
"globby": "^11.1.0",
Expand Down
3 changes: 3 additions & 0 deletions polaris-icons/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@
]
}
},
"engines": {
"node": "^16.16.0 || ^18.13.0"
},
"scripts": {
"build": "rollup -c",
"dev": "rollup -c -w",
Expand Down
3 changes: 3 additions & 0 deletions polaris-migrator/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
"author": "Shopify <[email protected]>",
"homepage": "https://polaris.shopify.com",
"repository": "https://github.com/Shopify/polaris",
"engines": {
"node": "^16.16.0 || ^18.13.0"
},
"bugs": {
"url": "https://github.com/Shopify/polaris/issues"
},
Expand Down
2 changes: 1 addition & 1 deletion polaris-migrator/rollup.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export default {
include: ['src/**/*'],
babelHelpers: 'bundled',
envName: 'production',
targets: 'node 14.13',
targets: 'node 16.16.0',
}),
json({compact: true}),
],
Expand Down
4 changes: 3 additions & 1 deletion polaris-react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
"bugs": {
"url": "https://github.com/Shopify/polaris/issues"
},
"engines": {
"node": "^16.16.0 || ^18.13.0"
},
"publishConfig": {
"access": "public",
"@shopify:registry": "https://registry.npmjs.org"
Expand Down Expand Up @@ -87,7 +90,6 @@
"@storybook/builder-webpack5": "^6.5.12",
"@storybook/manager-webpack5": "^6.5.12",
"@storybook/react": "^6.5.12",
"@types/node": "^16.11.11",
"@types/react": "^18.0.15",
"@types/react-dom": "^18.0.6",
"ajv-cli": "^5.0.0",
Expand Down
3 changes: 1 addition & 2 deletions polaris-react/playground/DetailsPage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -527,8 +527,7 @@ export function DetailsPage() {
alt={file.name}
source={
validImageTypes.indexOf(file.type) > 0
? // eslint-disable-next-line node/no-unsupported-features/node-builtins
URL.createObjectURL(file)
? URL.createObjectURL(file)
: 'https://cdn.shopify.com/s/files/1/0757/9955/files/New_Post.png?12678548500147524304'
}
/>
Expand Down
2 changes: 1 addition & 1 deletion polaris-react/rollup.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ function generateConfig({output, targets, stylesConfig}) {
/** @type {import('rollup').RollupOptions} */
export default [
generateConfig({
targets: 'extends @shopify/browserslist-config, node 12.20',
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This scared me but nothing seems to be bad since changing the version...

targets: 'extends @shopify/browserslist-config, node 16.16.0',
stylesConfig: {
mode: 'standalone',
output: 'styles.css',
Expand Down
1 change: 0 additions & 1 deletion polaris-react/scripts/build-validate.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
// eslint-disable-next-line node/no-unsupported-features/node-builtins
const assert = require('assert').strict;
const fs = require('fs');

Expand Down
20 changes: 6 additions & 14 deletions polaris-react/src/components/DropZone/DropZone.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ export function Default() {
alt={file.name}
source={
validImageTypes.includes(file.type)
? // eslint-disable-next-line node/no-unsupported-features/node-builtins
window.URL.createObjectURL(file)
? window.URL.createObjectURL(file)
: NoteMinor
}
/>
Expand Down Expand Up @@ -92,7 +91,6 @@ export function WithImageFileUpload() {
<Thumbnail
size="small"
alt={file.name}
// eslint-disable-next-line node/no-unsupported-features/node-builtins
source={window.URL.createObjectURL(file)}
/>
<div>
Expand Down Expand Up @@ -151,8 +149,7 @@ export function WithSingleFileUpload() {
alt={file.name}
source={
validImageTypes.includes(file.type)
? // eslint-disable-next-line node/no-unsupported-features/node-builtins
window.URL.createObjectURL(file)
? window.URL.createObjectURL(file)
: NoteMinor
}
/>
Expand Down Expand Up @@ -193,8 +190,7 @@ export function WithDropOnPage() {
alt={file.name}
source={
validImageTypes.includes(file.type)
? // eslint-disable-next-line node/no-unsupported-features/node-builtins
window.URL.createObjectURL(file)
? window.URL.createObjectURL(file)
: NoteMinor
}
/>
Expand Down Expand Up @@ -253,7 +249,6 @@ export function AcceptsOnlySVGFiles() {
<Thumbnail
size="small"
alt={file.name}
// eslint-disable-next-line node/no-unsupported-features/node-builtins
source={window.URL.createObjectURL(file)}
/>
<div>
Expand Down Expand Up @@ -318,8 +313,7 @@ export function Nested() {
alt={file.name}
source={
validImageTypes.includes(file.type)
? // eslint-disable-next-line node/no-unsupported-features/node-builtins
window.URL.createObjectURL(file)
? window.URL.createObjectURL(file)
: NoteMinor
}
/>
Expand Down Expand Up @@ -390,8 +384,7 @@ export function WithCustomFileUploadText() {
alt={file.name}
source={
validImageTypes.includes(file.type)
? // eslint-disable-next-line node/no-unsupported-features/node-builtins
window.URL.createObjectURL(file)
? window.URL.createObjectURL(file)
: NoteMinor
}
/>
Expand Down Expand Up @@ -439,8 +432,7 @@ export function WithCustomFileDialogTrigger() {
alt={file.name}
source={
validImageTypes.includes(file.type)
? // eslint-disable-next-line node/no-unsupported-features/node-builtins
window.URL.createObjectURL(file)
? window.URL.createObjectURL(file)
: NoteMinor
}
/>
Expand Down
3 changes: 3 additions & 0 deletions polaris-tokens/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
"main": "dist/cjs/build/index.js",
"module": "dist/esm/build/index.mjs",
"types": "dist/types/build/index.d.ts",
"engines": {
"node": "^16.16.0 || ^18.13.0"
},
"exports": {
".": {
"types": "./dist/types/build/index.d.ts",
Expand Down
4 changes: 3 additions & 1 deletion polaris.shopify.com/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
"name": "polaris.shopify.com",
"version": "0.30.1",
"private": true,
"engines": {
"node": "^16.16.0 || ^18.13.0"
},
"scripts": {
"build": "yarn gen-assets && playroom build && next build && cp -r public ./.next/standalone/polaris.shopify.com/ && mkdirp ./.next/standalone/polaris.shopify.com/.next && cp -r .next/static ./.next/standalone/polaris.shopify.com/.next/",
"start": "cd ./.next/standalone/polaris.shopify.com && node ./server.js",
Expand Down Expand Up @@ -47,7 +50,6 @@
"@types/lodash.get": "^4.4.7",
"@types/lodash.throttle": "^4.1.7",
"@types/marked": "^4.0.3",
"@types/node": "17.0.21",
"@types/prismjs": "^1.26.0",
"@types/react": "18.0.15",
"babel-plugin-preval": "^5.1.0",
Expand Down
3 changes: 3 additions & 0 deletions stylelint-polaris/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@
"access": "public",
"@shopify:registry": "https://registry.npmjs.org"
},
"engines": {
"node": "^16.16.0 || ^18.13.0"
},
"files": [
"index.js",
"configs/",
Expand Down
Loading