@allthings/eslint-config 3.0.0 → 3.1.0

package/README.md

@@ -48,14 +48,6 @@ export default [
 ]
 ```
 
-## Deployment
-
-Publishing to npm
-
-```shell
-yarn deploy
-```
-
 ## Development
 
 Run `yarn link` in the project folder
@@ -66,3 +58,44 @@ After you finish run in your project `yarn unlink @allthings/eslint-config` and
 to restore the initial state of dependencies
 
 Or you could release a dev npm version with `yarn deploy:dev`. Remember to update the version in package.json
+
+### Production release
+
+!! DO NOT `npm version` !!
+
+The project uses [semantic-release](https://github.com/semantic-release/semantic-release) which automates the whole package release workflow including:
+
+- determining the next version number
+- generating the release notes and publishing the package
+
+This repository is also configured to `squash-merge` ([see here](https://github.blog/2016-04-01-squash-your-commits/)).  
+When you squash merge, GitHub takes the title of the PR for the squash-merge's commit subject.
+
+By choosing a proper PR title e.g. `feat: my new feature` your merged PR will trigger a new release.  
+See semantic-releases [docs](https://github.com/semantic-release/semantic-release#how-does-it-work) for available prefixes.
+
+### Development release
+
+1. **Create or check out the target branch** from the commit you want to release.
+
+2. **Push the branch** to trigger the CI pipeline:
+
+   ```sh
+   git push --force origin HEAD:beta   # or alpha / next
+   ```
+
+   The pipeline will automatically run `semantic-release`, which detects the branch name, bumps the version with the appropriate pre-release tag, and publishes it to npm under the matching dist-tag. Check [Actions page](https://github.com/allthings/eslint-config/actions) for the release logs.
+
+3. **Install the pre-release** in another project:
+
+   ```sh
+   yarn add -E @allthings/eslint-config@beta   # or @alpha / @next
+   ```
+
+   or use exact release (check [versions on npm](https://www.npmjs.com/package/@allthings/eslint-config?activeTab=versions)):
+
+   ```sh
+   yarn add -E @allthings/eslint-config@x.x.x-beta.x
+   ```
+
+4. **Promote to stable** – once the pre-release is validated, create a PR from your target branch and proceed with [Production release](#production-release) section.

package/index.js

@@ -41,7 +41,7 @@ export default [
     },
     plugins: {
       '@stylistic': stylisticPlugin,
-      'jest': jestPlugin,
+      jest: jestPlugin,
       'prefer-arrow': preferArrowPlugin,
       'simple-import-sort': simpleImportSortPlugin,
       'typescript-sort-keys': typescriptSortKeysPlugin,
@@ -268,6 +268,7 @@ export default [
       'react/jsx-uses-react': 'error',
       'react/jsx-uses-vars': 'error',
       'react/no-unknown-property': ['error', { ignore: ['css'] }],
+      'react/prop-types': 'off',
       'react/react-in-jsx-scope': 'off',
       'simple-import-sort/exports': 'error',
       'simple-import-sort/imports': 'error',

package/node.js

@@ -30,7 +30,7 @@ export default [
     },
     plugins: {
       '@stylistic': stylisticPlugin,
-      'jest': jestPlugin,
+      jest: jestPlugin,
       'prefer-arrow': preferArrowPlugin,
       'simple-import-sort': simpleImportSortPlugin,
       'typescript-sort-keys': typescriptSortKeysPlugin,

package/package.json

@@ -1,9 +1,16 @@
 {
   "name": "@allthings/eslint-config",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "type": "module",
   "description": "ESlint shareable config for Allthings style",
   "main": "index.js",
+  "release": {
+    "repositoryUrl": "https://github.com/allthings/eslint-config-allthings.git"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:allthings/eslint-config-allthings.git"
+  },
   "exports": {
     ".": "./index.js",
     "./node": "./node.js"
@@ -15,15 +22,12 @@
   "packageManager": "yarn@1.22.22",
   "scripts": {
     "lint": "prettier --check .",
+    "semantic-release": "semantic-release",
     "test": "eslint test/",
-    "predeploy": "yarn test",
-    "deploy": "yarn publish --new-version $npm_package_version --tag latest --access public",
-    "deploy:dev": "yarn publish --new-version $npm_package_version --tag dev --access public",
-    "postdeploy": "git push --tags origin HEAD",
     "deps": "yarn upgrade-interactive --latest"
   },
   "dependencies": {
-    "@stylistic/eslint-plugin": "3.1.0",
+    "@stylistic/eslint-plugin": "^3.1.0",
     "@typescript-eslint/eslint-plugin": "^8.48.0",
     "@typescript-eslint/parser": "^8.48.0",
     "eslint-config-prettier": "^10.1.8",
@@ -43,14 +47,15 @@
     "globals": "^13.0.0"
   },
   "peerDependencies": {
-    "eslint": "^9.0.0",
-    "prettier": ">=3.5.0",
-    "typescript": ">=4.7.4"
+    "eslint": ">=9.33.0",
+    "prettier": ">=3.8.0",
+    "typescript": ">=5.9.0"
   },
   "devDependencies": {
-    "eslint": "^9.0.0",
-    "prettier": "^3.5.3",
-    "typescript": "^5.8.3"
+    "eslint": "9.39.4",
+    "prettier": "3.8.1",
+    "semantic-release": "25.0.3",
+    "typescript": "5.9.3"
   },
   "keywords": [
     "eslint",
@@ -64,7 +69,6 @@
     "trailingComma": "all",
     "useTabs": false
   },
-  "repository": "git@github.com:allthings/eslint-config-allthings.git",
   "author": "Dmitry Markov <forall@stylive.com>",
   "license": "MIT"
 }