aberlaas-lint 2.20.2 → 2.22.0

package/configs/eslint/docs.js

@@ -0,0 +1,6 @@
+export default [
+  {
+    name: 'aberlaas/docs',
+    ignores: ['**/docs/**/*.js'],
+  },
+];

package/configs/eslint/index.js

@@ -0,0 +1,15 @@
+import configDocs from './docs.js';
+import configJs from './js.js';
+import configJson from './json.js';
+import configReact from './react.js';
+import configScripts from './scripts.js';
+import configVitest from './vitest.js';
+
+export default [
+  ...configJs,
+  ...configVitest,
+  ...configReact,
+  ...configJson,
+  ...configScripts,
+  ...configDocs,
+];

package/configs/{eslint.js → eslint/js.js}

@@ -1,13 +1,9 @@
 import js from '@eslint/js';
-// @vitest/plugins requires @typescript-eslint/utils and typescripts as deps
-// See: https://github.com/vitest-dev/eslint-plugin-vitest/issues/543
-import pluginVitest from '@vitest/eslint-plugin';
 import { nodeVersion } from 'aberlaas-versions';
 import pluginImport from 'eslint-plugin-import';
 import pluginJsdoc from 'eslint-plugin-jsdoc';
 import pluginN from 'eslint-plugin-n';
 import pluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
-import pluginReact from 'eslint-plugin-react';
 import globals from 'globals';
 
 export default [
@@ -207,80 +203,4 @@ export default [
       },
     },
   },
-  {
-    name: 'aberlaas/vitest',
-    files: ['**/__tests__/**/*.{js,ts}'],
-    languageOptions: {
-      globals: {
-        afterAll: true,
-        afterEach: true,
-        beforeAll: true,
-        beforeEach: true,
-        describe: true,
-        expect: true,
-        it: true,
-        test: true,
-        vitest: true,
-        vi: true,
-        captureOutput: false,
-        dedent: false,
-        fdescribe: false,
-        fit: false,
-        testName: false,
-        xdescribe: false,
-        xit: false,
-      },
-    },
-    plugins: {
-      vitest: pluginVitest,
-    },
-    rules: {
-      ...pluginVitest.configs.recommended.rules,
-      'no-restricted-globals': [
-        'error',
-        { name: 'fit', message: 'No focused test' },
-        { name: 'fdescribe', message: 'No focused tests' },
-        { name: 'xit', message: 'No skipped test' },
-        { name: 'xdescribe', message: 'No skipped tests' },
-      ],
-      // In tests, we like to have the variable 'current' hold the object
-      // under test. The import/no-named-as-default-member would have warned
-      // us about using current.foo rather than foo directly, so we disable
-      // it.
-      'import/no-named-as-default-member': ['off'],
-      'vitest/consistent-test-it': ['warn', { fn: 'it' }],
-      // Disabling vitest/no-identical-title
-      // It can make eslint crash when used with fit/xit/fdescribe/xdescribe
-      // See: https://github.com/veritem/eslint-plugin-vitest/issues/310
-      'vitest/no-identical-title': ['off'],
-      'vitest/prefer-to-contain': ['error'],
-    },
-  },
-  {
-    name: 'aberlaas/react',
-    files: ['**/*.{jsx,tsx}'],
-    plugins: {
-      react: pluginReact,
-    },
-    languageOptions: {
-      parserOptions: {
-        ecmaFeatures: {
-          jsx: true,
-        },
-      },
-    },
-    rules: {
-      'react/jsx-uses-react': ['error'],
-      'react/jsx-uses-vars': ['error'],
-      'import/extensions': ['error', 'always', { ignorePackages: true }],
-    },
-  },
-  {
-    name: 'aberlaas/scripts',
-    files: ['**/scripts/**/*.{js,ts}'],
-    rules: { 'no-process-exit': ['off'] },
-  },
-  {
-    ignores: ['**/docs/**/*.js'],
-  },
 ];

package/configs/eslint/json.js

@@ -0,0 +1,129 @@
+import pluginJson from '@eslint/json';
+import packageJson from 'eslint-plugin-package-json';
+import jsoncParser from 'jsonc-eslint-parser';
+
+export default [
+  {
+    name: 'aberlaas/json',
+    files: ['**/*.json'],
+    ignores: ['**/package.json'],
+    plugins: {
+      json: pluginJson,
+    },
+    language: 'json/json',
+    rules: {
+      'json/no-duplicate-keys': ['error'],
+      'json/no-empty-keys': ['error'],
+      'json/no-unnormalized-keys': ['error'],
+      'json/no-unsafe-values': ['error'],
+      'json/top-level-interop': ['error'],
+      'json/sort-keys': ['off'],
+    },
+  },
+  {
+    name: 'aberlaas/packageJson',
+    files: ['**/package.json'],
+    plugins: {
+      'package-json': packageJson,
+    },
+    languageOptions: {
+      parser: jsoncParser,
+    },
+    rules: {
+      'package-json/bin-name-casing': ['error'],
+      'package-json/exports-subpaths-style': ['error'],
+      'package-json/no-empty-fields': ['error'],
+      'package-json/no-redundant-files': ['error'],
+      'package-json/no-redundant-publishConfig': ['error'],
+      'package-json/order-properties': [
+        'error',
+        {
+          // See: https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/blob/main/docs/rules/order-properties.md
+          order: [
+            // Name
+            'name',
+            'version',
+            // Dev info
+            'private',
+            'type',
+            'workspaces',
+            // Metadata
+            'description',
+            'author',
+            'homepage',
+            'keywords',
+            'repository',
+            // Compatibility
+            'sideEffects',
+            'license',
+            'engines',
+            'packageManager',
+            // Exports
+            'files',
+            'exports',
+            'main',
+            'bin',
+            // Dependencies
+            'devDependencies',
+            'dependencies',
+            'peerDependencies',
+            // Scripts
+            'scripts',
+          ],
+        },
+      ],
+      'package-json/repository-shorthand': ['error'],
+      'package-json/require-description': ['error'],
+      'package-json/require-license': ['error'],
+      'package-json/require-name': ['error'],
+      'package-json/require-type': ['error'],
+      'package-json/require-version': ['error'],
+      'package-json/scripts-name-casing': ['error'],
+      'package-json/sort-collections': ['error'],
+      'package-json/specify-peers-locally': ['error'],
+      'package-json/unique-dependencies': ['error'],
+      'package-json/valid-author': ['error'],
+      'package-json/valid-bin': ['error'],
+      'package-json/valid-bundleDependencies': ['error'],
+      'package-json/valid-config': ['error'],
+      'package-json/valid-contributors': ['error'],
+      'package-json/valid-cpu': ['error'],
+      'package-json/valid-dependencies': ['error'],
+      'package-json/valid-description': ['error'],
+      'package-json/valid-devDependencies': ['error'],
+      'package-json/valid-directories': ['error'],
+      'package-json/valid-engines': ['error'],
+      'package-json/valid-exports': ['error'],
+      'package-json/valid-files': ['error'],
+      'package-json/valid-homepage': ['error'],
+      'package-json/valid-keywords': ['error'],
+      'package-json/valid-license': ['error'],
+      'package-json/valid-main': ['error'],
+      'package-json/valid-man': ['error'],
+      'package-json/valid-module': ['error'],
+      'package-json/valid-name': ['error'],
+      'package-json/valid-optionalDependencies': ['error'],
+      'package-json/valid-os': ['error'],
+      'package-json/valid-peerDependencies': ['error'],
+      'package-json/valid-private': ['error'],
+    },
+  },
+  {
+    name: 'aberlaas/packageJsonPublishable',
+    files: ['**/lib/package.json', '**/modules/*/package.json'],
+    ignores: ['**/docs/package.json'],
+    plugins: {
+      'package-json': packageJson,
+    },
+    languageOptions: {
+      parser: jsoncParser,
+    },
+    rules: {
+      'package-json/require-attribution': ['error'],
+      'package-json/require-exports': ['error'],
+      'package-json/require-files': ['error'],
+      'package-json/require-repository': ['error'],
+      'package-json/require-sideEffects': ['error'],
+    },
+  },
+];

package/configs/eslint/react.js

@@ -0,0 +1,23 @@
+import pluginReact from 'eslint-plugin-react';
+
+export default [
+  {
+    name: 'aberlaas/react',
+    files: ['**/*.{jsx,tsx}'],
+    plugins: {
+      react: pluginReact,
+    },
+    languageOptions: {
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+    },
+    rules: {
+      'react/jsx-uses-react': ['error'],
+      'react/jsx-uses-vars': ['error'],
+      'import/extensions': ['error', 'always', { ignorePackages: true }],
+    },
+  },
+];

package/configs/eslint/scripts.js

@@ -0,0 +1,7 @@
+export default [
+  {
+    name: 'aberlaas/scripts',
+    files: ['**/scripts/**/*.{js,ts}'],
+    rules: { 'no-process-exit': ['off'] },
+  },
+];

package/configs/eslint/vitest.js

@@ -0,0 +1,55 @@
+// @vitest/plugins requires @typescript-eslint/utils and typescripts as deps
+// See: https://github.com/vitest-dev/eslint-plugin-vitest/issues/543
+import pluginVitest from '@vitest/eslint-plugin';
+
+export default [
+  {
+    name: 'aberlaas/vitest',
+    files: ['**/__tests__/**/*.{js,ts}'],
+    languageOptions: {
+      globals: {
+        afterAll: true,
+        afterEach: true,
+        beforeAll: true,
+        beforeEach: true,
+        describe: true,
+        expect: true,
+        it: true,
+        test: true,
+        vitest: true,
+        vi: true,
+        captureOutput: false,
+        dedent: false,
+        fdescribe: false,
+        fit: false,
+        testName: false,
+        xdescribe: false,
+        xit: false,
+      },
+    },
+    plugins: {
+      vitest: pluginVitest,
+    },
+    rules: {
+      ...pluginVitest.configs.recommended.rules,
+      'no-restricted-globals': [
+        'error',
+        { name: 'fit', message: 'No focused test' },
+        { name: 'fdescribe', message: 'No focused tests' },
+        { name: 'xit', message: 'No skipped test' },
+        { name: 'xdescribe', message: 'No skipped tests' },
+      ],
+      // In tests, we like to have the variable 'current' hold the object
+      // under test. The import/no-named-as-default-member would have warned
+      // us about using current.foo rather than foo directly, so we disable
+      // it.
+      'import/no-named-as-default-member': ['off'],
+      'vitest/consistent-test-it': ['warn', { fn: 'it' }],
+      // Disabling vitest/no-identical-title
+      // It can make eslint crash when used with fit/xit/fdescribe/xdescribe
+      // See: https://github.com/veritem/eslint-plugin-vitest/issues/310
+      'vitest/no-identical-title': ['off'],
+      'vitest/prefer-to-contain': ['error'],
+    },
+  },
+];

package/lib/helpers/eslintRun.js

@@ -0,0 +1,68 @@
+import { _ } from 'golgoth';
+import { firostError, run } from 'firost';
+import { getConfig } from 'aberlaas-helper';
+import { ESLint } from 'eslint';
+import eslintConfig from '../../configs/eslint/index.js';
+
+/**
+ * Lint all files and display results.
+ * @param {Array} files Files to lint
+ * @param {string} userConfigFile Custom config file to use
+ * @param {object} userOptions Options to pass to ESLint, including fix
+ * @returns {boolean} True on success
+ */
+export async function eslintRun(files, userConfigFile, userOptions = {}) {
+  // Files
+  if (_.isEmpty(files)) {
+    return true;
+  }
+
+  // Config file
+  const config = await getConfig(
+    userConfigFile,
+    'eslint.config.js',
+    eslintConfig,
+  );
+
+  // Options
+  const options = { fix: false, warnIgnored: false, ...userOptions };
+
+  // Run the actual lint
+  const eslint = new ESLint({
+    ...options,
+    overrideConfigFile: true,
+    overrideConfig: config,
+  });
+  const results = await eslint.lintFiles(files);
+
+  // Fix
+  if (options.fix) {
+    await ESLint.outputFixes(results);
+  }
+
+  // All good, we can stop
+  const errorCount = _.chain(results).map('errorCount').sum().value();
+  if (errorCount == 0) {
+    return true;
+  }
+
+  // Format errors
+  const formatter = await eslint.loadFormatter('stylish');
+  const errorText = formatter.format(results);
+  throw firostError('ABERLAAS_LINT_ESLINT', errorText);
+}
+
+/**
+ * Autofix files in place
+ * @param {Array} userPatterns Patterns to narrow the search down
+ * @param {string} userConfigFile Custom config file to use
+ * @returns {boolean} True on success
+ */
+export async function fix(userPatterns, userConfigFile) {
+  return await run(userPatterns, userConfigFile, { fix: true });
+}
+
+export default {
+  run,
+  fix,
+};

package/lib/js.js

@@ -1,8 +1,7 @@
 import { _ } from 'golgoth';
 import { firostError } from 'firost';
-import { findHostPackageFiles, getConfig } from 'aberlaas-helper';
-import { ESLint } from 'eslint';
-import eslintConfig from '../configs/eslint.js';
+import { findHostPackageFiles } from 'aberlaas-helper';
+import { eslintRun } from './helpers/eslintRun.js';
 
 export let __;
 
@@ -14,45 +13,14 @@ export let __;
  * @returns {boolean} True on success
  */
 export async function run(userPatterns, userConfigFile, userOptions = {}) {
-  // Options
-  const options = { fix: false, warnIgnored: false, ...userOptions };
-
-  // Files to lint
   const files = await __.getInputFiles(userPatterns);
-  if (_.isEmpty(files)) {
-    return true;
-  }
-
-  // Config file
-  const config = await getConfig(
-    userConfigFile,
-    'eslint.config.js',
-    eslintConfig,
-  );
 
-  // Run the actual lint
-  const eslint = new ESLint({
-    ...options,
-    overrideConfigFile: true,
-    overrideConfig: config,
-  });
-  const results = await eslint.lintFiles(files);
-
-  // Fix
-  if (options.fix) {
-    await ESLint.outputFixes(results);
-  }
-
-  // All good, we can stop
-  const errorCount = _.chain(results).map('errorCount').sum().value();
-  if (errorCount == 0) {
+  try {
+    await eslintRun(files, userConfigFile, userOptions);
     return true;
+  } catch (err) {
+    throw firostError('ABERLAAS_LINT_JS', err.message);
   }
-
-  // Format errors
-  const formatter = await eslint.loadFormatter('stylish');
-  const errorText = formatter.format(results);
-  throw firostError('ABERLAAS_LINT_JS', errorText);
 }
 
 /**

package/lib/json.js

@@ -1,7 +1,7 @@
-import path from 'node:path';
-import { _, pMap } from 'golgoth';
-import { firostError, read } from 'firost';
-import { findHostPackageFiles, hostGitRoot } from 'aberlaas-helper';
+import { _ } from 'golgoth';
+import { firostError } from 'firost';
+import { findHostPackageFiles } from 'aberlaas-helper';
+import { eslintRun } from './helpers/eslintRun.js';
 import { prettierFix } from './helpers/prettierFix.js';
 
 export let __;
@@ -9,44 +9,42 @@ export let __;
 /**
  * Lint all files and display results.
  * @param {Array} userPatterns Patterns to narrow the search down
+ * @param {string} userConfigFile Custom config file to use
+ * @param {object} userOptions Options to pass to ESLint, including fix
  * @returns {boolean} True on success
  */
-export async function run(userPatterns) {
+export async function run(userPatterns, userConfigFile, userOptions = {}) {
   const files = await __.getInputFiles(userPatterns);
-  if (_.isEmpty(files)) {
-    return true;
-  }
-
-  let hasErrors = false;
-  const errorMessages = [];
-  await pMap(files, async (filepath) => {
-    try {
-      JSON.parse(await read(filepath));
-    } catch (error) {
-      hasErrors = true;
-      const relativePath = path.relative(hostGitRoot(), filepath);
-      errorMessages.push(`Invalid JSON: ${relativePath}`);
-      errorMessages.push(error.message);
-    }
-  });
 
-  if (hasErrors) {
-    throw firostError('ABERLAAS_LINT_JSON', errorMessages.join('\n'));
+  try {
+    await eslintRun(files, userConfigFile, userOptions);
+    return true;
+  } catch (err) {
+    throw firostError('ABERLAAS_LINT_JSON', err.message);
   }
-  return true;
 }
 
 /**
  * Autofix files in place
  * @param {Array} userPatterns Patterns to narrow the search down
+ * @param {string} userConfigFile Custom config file to use
  * @returns {boolean} True on success
  */
-export async function fix(userPatterns) {
+export async function fix(userPatterns, userConfigFile) {
   const files = await __.getInputFiles(userPatterns);
-  if (_.isEmpty(files)) {
-    return true;
+
+  // Note: The @eslint/json plugin doesn't seem to support fixing the JSON and
+  // chokes on malformed JSON (like trailing commas).
+  // Prettier, on the other hand, can fix trailing commas.
+  // So we run both.
+  try {
+    // To fix most issues ESLint can't fix
+    await __.prettierFix(files);
+    // To warn about leftover issues
+    return await run(userPatterns, userConfigFile, { fix: true });
+  } catch (err) {
+    throw firostError('ABERLAAS_LINT_JSON_FIX', err.message);
   }
-  await __.prettierFix(files);
 }
 
 __ = {

package/lib/main.js

@@ -12,24 +12,36 @@ export async function run(cliArgs = {}) {
   const allTypesKeys = _.keys(__.linters);
   const userTypes = _.intersection(_.keys(cliArgs), allTypesKeys);
   const typesToLint = _.isEmpty(userTypes) ? allTypesKeys : userTypes;
+  const shouldFailFast = cliArgs.failFast;
+  const errors = [];
 
-  let hasErrors = false;
-  await pMap(typesToLint, async (type) => {
-    const methodName = cliArgs.fix ? 'fix' : 'run';
-    try {
+  await pMap(
+    typesToLint,
+    async (type) => {
+      const methodName = cliArgs.fix ? 'fix' : 'run';
       const linter = await __.getLinter(type);
-
       const configFile = _.get(cliArgs, `config.${type}`);
       const userPatterns = _.get(cliArgs, '_');
 
-      await linter[methodName](userPatterns, configFile);
-    } catch (error) {
-      __.consoleError(error.message);
-      hasErrors = true;
-    }
-  });
+      try {
+        await linter[methodName](userPatterns, configFile);
+      } catch (error) {
+        errors.push(error);
+
+        if (shouldFailFast) {
+          if (errors.length == 1) {
+            __.consoleError(error.message);
+          }
+          throw firostError('ABERLAAS_LINT_FAIL_FAST', 'Fail to lint files');
+        }
+
+        __.consoleError(error.message);
+      }
+    },
+    { stopOnError: shouldFailFast },
+  );
 
-  if (hasErrors) {
+  if (!_.isEmpty(errors)) {
     throw firostError('ABERLAAS_LINT_FAIL', 'Fail to lint files');
   }
 

package/package.json

@@ -1,47 +1,51 @@
 {
   "name": "aberlaas-lint",
+  "version": "2.22.0",
   "type": "module",
-  "sideEffects": false,
   "description": "aberlaas lint command: Lint files",
-  "version": "2.20.2",
-  "repository": "pixelastic/aberlaas",
+  "author": "Tim Carry <tim@pixelastic.com>",
   "homepage": "https://projects.pixelastic.com/aberlaas/",
-  "author": "Tim Carry (@pixelastic)",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pixelastic/aberlaas"
+  },
+  "sideEffects": false,
   "license": "MIT",
   "files": [
     "lib/*.js",
     "lib/helpers/*.js",
-    "configs/*.js"
+    "configs/*.js",
+    "configs/eslint/*.js"
   ],
   "exports": {
     ".": "./lib/main.js",
-    "./configs/eslint": "./configs/eslint.js",
+    "./configs/eslint": "./configs/eslint/index.js",
     "./configs/prettier": "./configs/prettier.js",
     "./configs/stylelint": "./configs/stylelint.js"
   },
   "main": "./lib/main.js",
-  "engines": {
-    "node": ">=18.18.0"
-  },
   "dependencies": {
     "@eslint/js": "9.39.2",
+    "@eslint/json": "1.0.0",
     "@typescript-eslint/utils": "8.54.0",
     "@vitest/eslint-plugin": "1.6.6",
-    "aberlaas-helper": "workspace:*",
-    "aberlaas-versions": "workspace:*",
+    "aberlaas-helper": "2.22.0",
+    "aberlaas-versions": "2.22.0",
     "ci-info": "4.4.0",
     "eslint": "9.39.2",
     "eslint-config-prettier": "10.1.8",
     "eslint-plugin-import": "2.32.0",
     "eslint-plugin-jsdoc": "62.5.0",
     "eslint-plugin-n": "17.23.2",
+    "eslint-plugin-package-json": "0.88.2",
     "eslint-plugin-prettier": "5.5.5",
     "eslint-plugin-react": "7.37.5",
     "firost": "5.5.1",
-    "globals": "17.2.0",
+    "globals": "17.3.0",
     "golgoth": "3.1.0",
+    "jsonc-eslint-parser": "2.4.2",
     "prettier": "3.8.1",
-    "stylelint": "17.0.0",
+    "stylelint": "17.1.0",
     "typescript": "5.9.3",
     "yaml-lint": "1.7.0"
   },
@@ -49,13 +53,13 @@
     "build": "cd ../docs && yarn run build",
     "build:prod": "cd ../docs && yarn run build:prod",
     "cms": "cd ../docs && yarn run cms",
-    "serve": "cd ../docs && yarn run serve",
-    "release": "cd ../.. && ./scripts/release",
-    "test:meta": "cd ../.. && ./scripts/test-meta",
-    "test": "cd ../.. && ./scripts/test",
-    "test:watch": "cd ../.. && ./scripts/test-watch",
     "compress": "cd ../.. && ./scripts/compress",
     "lint": "cd ../.. && ./scripts/lint",
-    "lint:fix": "cd ../.. && ./scripts/lint-fix"
+    "lint:fix": "cd ../.. && ./scripts/lint-fix",
+    "release": "cd ../.. && ./scripts/release",
+    "serve": "cd ../docs && yarn run serve",
+    "test": "cd ../.. && ./scripts/test",
+    "test:meta": "cd ../.. && ./scripts/test-meta",
+    "test:watch": "cd ../.. && ./scripts/test-watch"
   }
-}
+}