eslint-config-uphold 5.0.0 → 6.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +19 -7
  2. package/package.json +13 -10
package/README.md CHANGED
@@ -10,7 +10,7 @@ that allow the [Prettier](https://prettier.io) pretty-printer to reformat the co
10
10
  ## Installation
11
11
 
12
12
  ```sh
13
- $ npm install eslint eslint-config-uphold prettier --save-dev
13
+ npm install eslint eslint-config-uphold prettier --save-dev
14
14
  ```
15
15
 
16
16
  ## Usage
@@ -34,19 +34,31 @@ Add a `lint` command to the `scripts` section of your `package.json`, like so:
34
34
  and run the linter with:
35
35
 
36
36
  ```sh
37
- $ npm run lint
37
+ npm run lint
38
38
  ```
39
39
 
40
40
  To automatically fix all lint issues, use the `--fix` option:
41
41
 
42
42
  ```sh
43
- $ npm run lint --fix
43
+ npm run lint --fix
44
44
  ```
45
45
 
46
- ## Upgrading eslint
46
+ ## Upgrading ESLint
47
47
 
48
- See the [eslint repo](https://github.com/eslint/eslint#semantic-versioning-policy) for eslint's guidelines on semantic versioning.
48
+ See the [ESLint repo](https://github.com/eslint/eslint#semantic-versioning-policy) for ESLint's guidelines on semantic versioning.
49
49
 
50
- A [tilde range](https://docs.npmjs.com/cli/v6/using-npm/semver#tilde-ranges-123-12-1) is set for the eslint dependency to pick up any patch changes by default.
50
+ A [tilde range](https://docs.npmjs.com/cli/v6/using-npm/semver#tilde-ranges-123-12-1) is set for the ESLint dependency to pick up any patch changes by default.
51
51
 
52
- For any minor/major upgrades to `eslint` it is recommended to update both eslint and `eslint-config-uphold` and keep them in parallel. This is down to the fact that no guarantee is made that minor upgrades do not cause conflicts or issues with existing or new rules. The downside here is a package update is required for any security or other bug fixes. The benefit however is the included rules are always guaranteed to be stable.
52
+ For any minor/major upgrades to ESLint it is recommended to update both `eslint` and `eslint-config-uphold` and keep them in parallel.
53
+ This is down to the fact that no guarantee is made that minor upgrades do not cause conflicts or issues with existing or new rules.
54
+ The downside here is a package update is required for any security or other bug fixes.
55
+ The benefit however is the included rules are always guaranteed to be stable.
56
+
57
+ ## Release process
58
+
59
+ The release of a version is automated via the [release](https://github.com/uphold/eslint-config-uphold/.github/workflows/release.yml) GitHub workflow.
60
+ Run it by clicking the "Run workflow" button.
61
+
62
+ ## License
63
+
64
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "eslint-config-uphold",
3
- "version": "5.0.0",
3
+ "version": "6.0.0",
4
4
  "description": "Uphold-flavored ESLint config",
5
5
  "keywords": [
6
6
  "config",
@@ -22,31 +22,34 @@
22
22
  "files": [
23
23
  "src"
24
24
  ],
25
+ "publishConfig": {
26
+ "access": "public"
27
+ },
25
28
  "scripts": {
26
- "changelog": "echo \"$(github-changelog-generator --owner uphold --repo eslint-config-uphold --future-release=$npm_package_version)\n$(tail -n +2 CHANGELOG.md)\" > CHANGELOG.md",
27
29
  "lint": "eslint src test/index.js",
28
- "test": "mocha $npm_package_options_mocha",
29
- "version": "npm run changelog --future-release=$npm_package_version && git add -A CHANGELOG.md"
30
+ "release": "release-it",
31
+ "test": "mocha $npm_package_options_mocha"
30
32
  },
31
33
  "dependencies": {
32
- "@babel/core": "^7.21.4",
33
- "@babel/eslint-parser": "^7.21.3",
34
+ "@babel/core": "^7.23.6",
35
+ "@babel/eslint-parser": "^7.23.3",
34
36
  "eslint-config-prettier": "^8.8.0",
35
37
  "eslint-plugin-mocha": "^10.1.0",
36
38
  "eslint-plugin-prettier": "^4.2.1",
37
39
  "eslint-plugin-promise": "^6.1.1",
38
40
  "eslint-plugin-rulesdir": "^0.2.2",
41
+ "eslint-plugin-sort-destructure-keys": "^1.5.0",
39
42
  "eslint-plugin-sort-imports-requires": "^1.0.2",
40
43
  "eslint-plugin-sort-keys-fix": "^1.1.2",
41
44
  "eslint-plugin-sql-template": "^2.0.0"
42
45
  },
43
46
  "devDependencies": {
44
- "@uphold/github-changelog-generator": "^3.3.1",
45
- "eslint": "^8.38.0",
46
- "eslint-plugin-sort-destructure-keys": "^1.5.0",
47
+ "@uphold/github-changelog-generator": "^3.4.0",
48
+ "eslint": "^8.56.0",
47
49
  "mocha": "^10.2.0",
48
50
  "pre-commit": "^1.2.2",
49
51
  "prettier": "^2.8.7",
52
+ "release-it": "^17.1.1",
50
53
  "should": "^13.2.3"
51
54
  },
52
55
  "peerDependencies": {
@@ -57,7 +60,7 @@
57
60
  "lint"
58
61
  ],
59
62
  "engines": {
60
- "node": ">=14"
63
+ "node": ">=18"
61
64
  },
62
65
  "options": {
63
66
  "mocha": "-t 10000 --require should test"