eslint-config-nodejs-pmb 0.2.4 → 0.2.8

package/.github/workflows/ci.yaml

@@ -0,0 +1,30 @@
+%YAML 1.1
+# ^-- ATTN: [2019-12-31] If you use a later version, Github will fail
+#     with a bogus error message "You have an error in your yaml syntax".
+# -*- coding: UTF-8, tab-width: 4 -*-
+---
+
+on:
+    push:
+        branches:
+            -   '*'
+
+jobs:
+    job_npm_test:
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                node-version:
+                    -   "16.x"
+
+        steps:
+            -   uses: actions/checkout@v2
+            -   name: Use Node.js ${{ matrix.node-version }}
+                uses: actions/setup-node@v1
+                with:
+                    node-version: ${{ matrix.node-version }}
+            -   run: npm install .
+            -   run: npm test
+
+
+...

package/depsHelper.js

@@ -0,0 +1,9 @@
+/* -*- tab-width: 2 -*- */
+'use strict';
+
+module.exports = (function depsHelper(require) {
+  return [
+    require('@babel/eslint-parser'),
+    require('eslint-config-airbnb-base'),
+  ];
+}(String));

package/devDepPatterns.js

@@ -1,22 +1,21 @@
 /* -*- tab-width: 2 -*- */
 'use strict';
 
-const instaffo = require('@instaffogmbh/eslint-config-nodejs/rules.js');
+const devDirs = [
+  'build',
+  'test',
+  'tests',
+];
 
-const jsFexts = (function refine() {
-  let xt = new Set(instaffo.settings['import/extensions']);
-  xt.delete('.json');
-  xt = Array.from(xt);
-  return xt;
-}());
 
-const jsGlob = ('.{' + jsFexts.map(s => s.replace(/^\./, '')).join(',') + '}');
-
-
-function gen() {
+function gen(how) {
+  const { jsFextsNoDot } = how;
+  const jsGlob = ('.{' + Array.from(jsFextsNoDot).join(',') + '}');
+  const cwd = process.cwd();
+  const nmSub = cwd.replace(/^\S+\/node_modules(?=\/)/, '…') + '/';
+  if (devDirs.find(d => nmSub.includes('/' + d + '/'))) { return ['**']; }
   return [
-    'test/**',
-    'build/**',
+    ...devDirs.map(d => d + '/**'),
     '**{/,-,.}test{,s,/**}' + jsGlob,
     '**.spec' + jsGlob,
     '**/{,.}eslintrc.js{,on}',

package/package.json

@@ -1,5 +1,5 @@
 { "name": "eslint-config-nodejs-pmb",
-  "version": "0.2.4",
+  "version": "0.2.8",
   "description": "My favorite eslint rules",
   "keywords": [],
 
@@ -16,16 +16,26 @@
 
   "private": false, "license": "ISC",
   "main": "rules.js",
-  "scripts": { "test": "nodejs test/all.js" },
+  "scripts": { "test": "eslint --ext=js,mjs . && echo '+OK eslint succeeded.'" },
   "directories": { "test": "test" },
+  "eslintConfig": { "extends": "." },
 
+  "engines": { "npm": ">=7.0.0", "node": ">=16.0.0" },
   "dependencies": {
-    "@instaffogmbh/eslint-config-nodejs": "^1.2.8",
-    "eslint": "^7.32.0"
+    "@babel/eslint-parser": "^7.17.0",
+    "eslint-config-airbnb-base": "^15.0.0"
   },
   "devDependencies": {
+    "absdir": "^1.0.6",
+    "eslint-plugin-json-light": "^1.0.3",
+    "eslint-plugin-node": "^11.1.0",
+    "p-fatal": "^0.1.3",
+    "safe-sortedjson": "^1.0.6",
+    "usnam-pmb": "^0.2.5"
+  },
+  "peerDependencies": {
+    "eslint": "^8.10.0"
   },
-
 
   "npm vs. BOM = Unexpected token": "-*- coding: UTF-8 -*-"
 }

package/rules.js

@@ -1,41 +1,70 @@
 /* -*- tab-width: 2 -*- */
 'use strict';
 
-const instaffo = require('@instaffogmbh/eslint-config-nodejs/rules');
-const devDepPatterns = require('./devDepPatterns.js');
+const configDeps = [
+  ...require('./depsHelper.js'),
+  ...require('./test/expectedPeerDependencies.js'),
+];
+const devDepPatternsGen = require('./devDepPatterns.js');
 
+function uniq(a) { return Array.from(new Set(a)).sort(); }
+
+const jsFextsNoDot = ['js', 'mjs'];
+const devDepPatternsList = devDepPatternsGen.generate({ jsFextsNoDot });
 const extraneousDepsOpts = {
-  devDependencies: devDepPatterns.generate(),
+  devDependencies: devDepPatternsList,
+};
+
+const importFextsNoDot = uniq([...jsFextsNoDot, 'json']);
+const importFextsWithDots = importFextsNoDot.map(x => '.' + x);
+const importSettings = {
+  'import/extensions': importFextsWithDots,
+  'import/resolver': {
+    node: { extensions: importFextsWithDots },
+  },
 };
 
 
+function mustStartWith(p) { return function d(s) { return s.startsWith(p); }; }
+
+const lineLengthRules = {
+  code: 80,
+  ignoreRegExpLiterals: true,
+  ignoreTrailingComments: true,
+  ignoreUrls: true,
+};
+
 const rules = {
-  ...instaffo.rules,
 
   // rules docs: https://github.com/eslint/eslint.github.io/tree/master/docs/rules
 
+  'arrow-parens': ['error', 'as-needed', { requireForBlockBody: true }],
   'consistent-return': 'off',
+  'default-case': 'off',
   'func-names': ['error', 'as-needed'],
+  'function-call-argument-newline': 'off',
   'function-paren-newline': 'off',
+  'global-require': 'off', // deprecated, see 'node/global-require' instead.
+  'import/no-extraneous-dependencies': ['error', extraneousDepsOpts],
+  'key-spacing': 'off', // b/c it doesn't support all the combinations I want
   'lines-around-directive': 'off',
+  'max-len': ['error', lineLengthRules],
   'no-console': 'off',
+  'no-control-regex': 'off',
+  'node/global-require': 'off', // I'd rather exempt just top-level arrays
+  'no-div-regex': 'error',
   'no-extra-semi': 'off',
   'no-multiple-empty-lines': 'off',
   'no-multi-spaces': ['off', { ignoreEOLComments: true }],
+  'no-useless-escape': 'off',   // allow \. in RegExp char group
   'object-curly-newline': 'off',
+  'padded-blocks': 'off',
   'prefer-arrow-callback': 'off',
   'prefer-template': 'off',
+  'quote-props': 'off',
   'semi': ['error', 'always'],
+  'strict': ['error', 'safe'],
   'unicode-bom': 'off',
-  'no-control-regex': 'off',
-  'no-useless-escape': 'off',   // allow \. in RegExp char group
-  'no-div-regex': 'error',
-  'quote-props': 'off',
-  'default-case': 'off',
-  'key-spacing': 'off', // b/c it doesn't support all the combinations I want
-  'arrow-parens': ['error', 'as-needed', { requireForBlockBody: true }],
-  'import/no-extraneous-dependencies': ['error', extraneousDepsOpts],
-  'padded-blocks': 'off',
 
   // Ugly but unfortunately node v12+ native ESM forces us to:
   'import/extensions': ['error', 'ignorePackages'],
@@ -44,9 +73,53 @@ const rules = {
 };
 
 
+const overrides = [
+  { files: ['**.js'], parserOptions: { sourceType: 'script' } },
+  { files: ['**.mjs'],
+    rules: {
+      'node/no-unsupported-features/es-syntax': 'off', // assume esmod-pmb
+    },
+  },
+  { files: devDepPatternsList,
+    rules: {
+      'node/no-unpublished-import': 'off',
+    },
+  },
+];
+
+
 const config = {
-  ...instaffo,
+
+  env: {
+    es6: true,
+    node: true,
+  },
+
+  extends: [
+    ...[
+      ...configDeps.filter(mustStartWith('eslint-config-')),
+    ].map(require.resolve),
+    'plugin:node/recommended',
+  ],
+
+  overrides,
+
+  parser: require.resolve('@babel/eslint-parser'),
+  parserOptions: {
+    allowImportExportEverywhere: true,
+    requireConfigFile: false,
+  },
+
+  plugins: [
+    ...configDeps.filter(mustStartWith('eslint-plugin-')),
+  ],
+
   rules,
+
+  settings: {
+    ...importSettings,
+  },
+
 };
 
 module.exports = config;

package/test/dump_as_json.mjs

@@ -0,0 +1,16 @@
+// -*- coding: utf-8, tab-width: 2 -*-
+
+import 'p-fatal';
+import 'usnam-pmb';
+
+import absdir from 'absdir';
+import jsonify from 'safe-sortedjson';
+
+import rules from '../rules.js';
+
+const nmPath = absdir(import.meta, '../..')('.') + '/';
+
+let json = jsonify(rules);
+json = json.split(nmPath).join('nm://');
+
+console.log(json);

package/test/expectedPeerDependencies.js

@@ -0,0 +1,9 @@
+/* -*- tab-width: 2 -*- */
+'use strict';
+
+module.exports = (function depsHelper(require) {
+  return [
+    require('eslint-plugin-json-light'),
+    require('eslint-plugin-node'),
+  ];
+}(String));