Release v1.0.16 (#28)

* remove deprecated formatting rules
  * See https://eslint.org/blog/2023/10/deprecating-formatting-rules/
* remove .npmignore, populate [files] in package.json
* ci: update to use shared workflows

.github/workflows/ci.yml

@@ -6,23 +6,13 @@ env:
   CI: true
 
 jobs:
-  test:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ ubuntu-latest, windows-latest ]
-        node-version: [ 14, 16, 18 ]
-      fail-fast: false
-    steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-node@v3
-      name: Node.js ${{ matrix.node-version }} on ${{ matrix.os }}
-      with:
-        node-version: ${{ matrix.node-version }}
 
-    - run: npm install
+  lint:
+    uses: haraka/.github/.github/workflows/lint.yml@master
+
+  test:
+    needs: [ lint ]
+    uses: haraka/.github/.github/workflows/ubuntu.yml@master
 
-    - name: Test
-      run: |
-        npm run test
-        node index.js
+  windows:
+    uses: haraka/.github/.github/workflows/windows.yml@master

.gitignore

@@ -37,3 +37,9 @@ jspm_packages
 .node_repl_history
 
 package-lock.json
+bower_components
+# Optional npm cache directory
+.npmrc
+.idea
+.DS_Store
+haraka-update.sh

Changes.md → CHANGELOG.md

@@ -1,71 +1,71 @@
+# Changelog
 
-#### N.N.N - YYYY-MM-DD
+The format is based on [Keep a Changelog](https://keepachangelog.com/).
 
+### Unreleased
 
-#### 1.0.15 - 2022-05-28
+#### [1.0.16] - 2024-04-05
+
+- chore: remove eslint deprecated formatting rules
+  - see https://eslint.org/blog/2023/10/deprecating-formatting-rules/
+- chore: remove .npmignore, populate [files] in package.json
+- chore: add CodeQL workflow for GitHub code scanning (#27)
+- ci: update to use shared workflows
+- doc(README): fix badge URL, update usage
+
+#### [1.0.15] - 2022-05-28
 
 - style: replace integers with off|warn|error
 - chore(ci): update configs
 - chore(pkg): add .release submodule
 
-
 #### 1.0.14 - 2021-02-03
 
 - CI travis -> Github Actions
 - dep eslint >= 7 (was 6)
 - ecmaVersion 2017 -> 2018
 
-
 #### 1.0.13 - 2019-11-22
 
-- eslint prefers 'warn' to 'warning' <sigh>
-
+- eslint prefers 'warn' to 'warning'
 
 #### 1.0.12 - 2019-11-22
 
 - add prefer-template rule
 - add eslint parserOptions: ecmaVersion: 2017
 - convert .eslintrc.json to .eslintrc.yaml
 
-
-#### 1.0.11 - 2019-07-09
+#### [1.0.11] - 2019-07-09
 
 - add brace-style rule
 
-
 #### 1.0.10 - 2019-06-22
 
 - remove node 6 testing
 
-
 #### 1.0.9 - 2017-09-16
 
 - remove no-useless-escape rule
 
-
 #### 1.0.8 - 2017-09-13
 
 - import rules from haraka/Haraka
 
-
 #### 1.0.7 - 2017-06-16
 
 - Fixes the format of an eslint plugin. The "rules" section is for custom
   rules (i.e. the code for defining the rules), not for enforced rules.
 
-
 #### 1.0.6 - 2017-06-15
 
 - eslint 4 enables no-useless-escape. Reduces error to warning until that rule
   is less brain damaged.
 
-
 #### 1.0.5 - 2017-02-01
 
 - fixed missing comma at end of no-empty rule
 - added "no-undef": 1  (warnings only)
 
-
 #### 1.0.3 - 2017-01-27
 
 - Updated rules from Haraka main repo
@@ -74,3 +74,8 @@
 - added install and usage sections to README
 - added env:es6=true
 - added space-before-function-paren rule
+
+
+[1.0.11]: https://github.com/haraka/haraka-eslint/releases/tag/1.0.11
+[1.0.15]: https://github.com/haraka/haraka-eslint/releases/tag/1.0.15
+[1.0.16]: https://github.com/haraka/haraka-eslint/releases/tag/v1.0.16

index.js

@@ -5,28 +5,19 @@
 // 2 = error
 
 const recommendedRules = {
-    "comma-dangle": ["error", "only-multiline"],
     "dot-notation": "error",
-    "indent": ["error", 4, {"SwitchCase": 1}],
     "one-var": ["error", "never"],
-    "no-trailing-spaces": ["error", { "skipBlankLines": false }],
-    "keyword-spacing": ["error", {
-        "before": true,
-        "after": true
-    }],
     "no-empty": ["error", { "allowEmptyCatch": true }],
     "no-shadow": "error",
     "no-undef": "warn",
     "no-unused-vars": [ "warn", { "args": "none" }],
-    "space-before-function-paren": ["error", { "anonymous": "always", "named": "always" }],
     "no-console": "off",
     "no-path-concat": "error",
     "no-cond-assign": ["error", "except-parens"],
     "no-constant-condition": ["error", { "checkLoops": false }],
     "prefer-const": ["error", {"ignoreReadBeforeAssign": true}],
     "no-var": "error",
     "object-shorthand": ["warn", "always"],
-    "brace-style": ["error", "stroustrup", { "allowSingleLine": true }],
     "prefer-template": "warn"
 };
 

package.json

@@ -1,10 +1,14 @@
 {
   "name": "eslint-plugin-haraka",
-  "version": "1.0.15",
+  "version": "1.0.16",
   "description": "eslint rules for Haraka projects",
   "main": "index.js",
+  "files": [
+    "CHANGELOG.md", "rules"
+  ],
   "scripts": {
-    "test": "npx eslint *.js"
+    "lint": "npx eslint@^8 *.js",
+    "test": "node index.js"
   },
   "repository": {
     "type": "git",
@@ -22,7 +26,5 @@
     "url": "https://github.com/haraka/haraka-eslint/issues"
   },
   "homepage": "https://github.com/haraka/haraka-eslint#readme",
-  "devDependencies": {
-    "eslint": ">=8"
-  }
+  "devDependencies": { }
 }