newspack-scripts 3.0.0 → 3.1.0-alpha.4

package/README.md

@@ -35,6 +35,39 @@ Will run [`semantic-release`](semantic-release.gitbook.io/) based on a very opin
 
 ---
 
+## Semantic Release
+
+This package contains a configuration of [`semantic-release`](semantic-release.gitbook.io/), which can be used for automated software releases, published on Github. It's configured to work with the following repository branch setup:
+
+1. `master` – ongoing development
+1. `alpha` – release candidate
+1. `release` – the production-ready, released code
+
+The following assumes that CI will run:
+
+1. `npm run release` for `release`, `alpha`, and `hotfix/*` branches
+1. `post-release.sh` script on `release` branch, after the above command completes
+
+### Regular release flow
+
+1. Commit ongoing changes to `master` branch, using [structured commit messages](https://www.conventionalcommits.org/en/v1.0.0/)
+1. Merge `master` into `alpha` to create a release candidate (e.g. `1.2.0-alpha.1`)
+1. Merge `alpha` into `release` to create a release (e.g. `1.2.0`)
+1. `alpha` branch will be reset on top of `release`
+1. `master` branch will be updated with the changes from the `release` branch
+
+### Hotfix release flow
+
+1. Create a new `hotfix/*` branch off the `release` branch
+1. Push the branch to Github, so the CI can process it – _don't create a PR just yet!*_
+1. A new "hotfix" pre-release (e.g. `1.2.0-hotfix.1`) will be published
+1. Merge the hotfix branch into `release` to create a release
+1. `alpha` & `master` branches will be updated with the changes from the `release` branch
+
+\* `semantic-release` [will not release if the CI job was triggered by a PR](https://github.com/semantic-release/semantic-release/blob/971a5e0d16f1a32e117e9ce382a1618c8256d0d9/index.js#L48-L51)
+
+---
+
 ## Available configs
 
 This package exposes a couple of configuration files.

package/bin/newspack-scripts.js

@@ -5,9 +5,15 @@ const spawn = require("cross-spawn");
 const [scriptName, ...nodeArgs] = process.argv.slice(2);
 
 if (
-  ["test", "build", "watch", "commit", "commitlint", "release"].includes(
-    scriptName
-  )
+  [
+    "test",
+    "build",
+    "watch",
+    "commit",
+    "commitlint",
+    "release",
+    "typescript-check",
+  ].includes(scriptName)
 ) {
   const result = spawn.sync(
     process.execPath,

package/config/eslintrc.js

@@ -15,11 +15,22 @@ module.exports = {
     "plugin:react/recommended",
     "plugin:import/errors",
     "plugin:import/warnings",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
   ],
   env: {
     browser: true,
     jest: true,
   },
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  settings: {
+    "import/resolver": {
+      node: {
+        extensions: [".js", ".jsx", ".ts", ".tsx"],
+      },
+    },
+  },
   ignorePatterns: ["dist/", "node_modules/"],
   parser: "@babel/eslint-parser",
   rules: {
@@ -43,5 +54,8 @@ module.exports = {
     "jsdoc/require-param": "off",
     // Deprecated rules
     "jsx-a11y/no-onchange": "off",
+    // For TypeScript type declarations.
+    camelcase: "off",
+    "@typescript-eslint/no-empty-function": "off",
   },
 };

package/config/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "noEmit":true,
+    "rootDir": "scripts",
+    "composite": true,
+    "noEmitHelpers": true,
+    "skipLibCheck": true,
+    "lib": [
+      "ESNext",
+      "DOM",
+      "DOM.Iterable"
+    ],
+    "module": "ESNext",
+    "esModuleInterop": true,
+    "jsx": "react-jsx",
+    "strict": true,
+    "isolatedModules": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "forceConsistentCasingInFileNames": true,
+    "allowJs": true,
+    "checkJs": false
+  },
+  "include": [
+    "scripts"
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newspack-scripts",
-  "version": "3.0.0",
+  "version": "3.1.0-alpha.4",
   "description": "",
   "bin": {
     "newspack-scripts": "./bin/newspack-scripts.js"
@@ -17,6 +17,7 @@
     "@semantic-release/git": "^10.0.1",
     "@testing-library/jest-dom": "^5.15.1",
     "@testing-library/react": "^12.1.2",
+    "@types/wordpress__data": "^4.6.10",
     "@wordpress/a11y": "^3.2.4",
     "@wordpress/api-fetch": "^5.2.6",
     "@wordpress/base-styles": "^4.0.4",
@@ -30,7 +31,7 @@
     "@wordpress/edit-post": "^5.0.17",
     "@wordpress/element": "^4.0.4",
     "@wordpress/escape-html": "^2.2.3",
-    "@wordpress/eslint-plugin": "^9.3.0",
+    "@wordpress/eslint-plugin": "^10.0.0",
     "@wordpress/hooks": "^3.2.2",
     "@wordpress/html-entities": "^3.2.3",
     "@wordpress/i18n": "^4.2.4",
@@ -44,11 +45,11 @@
     "commitizen": "^4.2.4",
     "cross-spawn": "^7.0.3",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^7.32.0",
+    "eslint": "^8.8.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-jest": "^25.3.0",
-    "eslint-plugin-react": "^7.27.1",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-jest": "^26.0.0",
+    "eslint-plugin-react": "^7.28.0",
     "jest": "^27.4.3",
     "jest-environment-jsdom": "^27.4.3",
     "postcss": "^8.4.4",
@@ -59,6 +60,7 @@
     "stylelint": "^14.1.0",
     "stylelint-config-prettier": "^9.0.3",
     "stylelint-prettier": "^2.0.0",
+    "typescript": "^4.5.5",
     "webpack": "^5.65.0"
   },
   "scripts": {

package/scripts/typescript-check.js

@@ -0,0 +1,13 @@
+"use strict";
+
+const spawn = require("cross-spawn");
+const path = require("path");
+const modules = require("./utils/modules");
+
+const result = spawn.sync(`${process.cwd()}/node_modules/.bin/tsc`, [], {
+  stdio: "inherit",
+});
+
+console.log(result);
+
+process.exit(result.status);