aberlaas-precommit 2.18.1 → 2.20.1

package/configs/lintstaged.js

@@ -1,25 +1,28 @@
-const readmeCommands = [
-  'yarn run aberlaas readme',
-  'git add ./README.md ./lib/README.md',
-];
+export const commands = {
+  lintCss: 'yarn run lint:fix --css',
+  lintYml: 'yarn run lint:fix --yml',
+  lintCircleci: 'yarn run lint --circleci',
+  lintJson: 'yarn run lint:fix --json',
+  lintJs: 'yarn run lint:fix --js',
+  testJs: 'yarn run test --failFast --related',
+  compressPng: 'yarn run compress --png',
+  readme: 'yarn run aberlaas readme --add-to-git',
+};
 
 export default {
   // Lint
-  '*.css': ['yarn run lint:fix --css'],
-  '*.{yml,yaml}': ['yarn run lint:fix --yml'],
-  '.circleci/config.yml': ['yarn run lint --circleci'],
-  '*.json': ['yarn run lint:fix --json'],
-  '*.js': ['yarn run lint:fix --js'],
+  '**/*.css': [commands.lintCss],
+  '**/*.{yml,yaml}': [commands.lintYml],
+  '.circleci/config.yml': [commands.lintCircleci],
+  '**/*.json': [commands.lintJson],
+  '**/*.js': [commands.lintJs],
 
   // Test
-  './lib/**/*.js': ['FORCE_COLOR=1 yarn run test --failFast --related'],
+  '**/lib/**/*.js': [commands.testJs],
 
   // Compress
-  '*.png': ['yarn run compress --png'],
+  '**/*.png': [commands.compressPng],
 
   // Documentation
-  // Update the README whenever the documentation, or the README template
-  // changes
-  'docs/src/**/*.md': readmeCommands,
-  '.github/README.template.md': readmeCommands,
+  '**/*.md': [commands.readme],
 };

package/lib/main.js

@@ -1,33 +1,70 @@
+import { consoleInfo, consoleWarn, firostError } from 'firost';
+import { getConfig } from 'aberlaas-helper';
 import lintStaged from 'lint-staged';
-import { firostError } from 'firost';
-import helper from 'aberlaas-helper';
 import lintStagedConfig from '../configs/lintstaged.js';
 
-export default {
-  async run(cliArgs) {
-    // Config
-    const config = await helper.getConfig(
+export let __;
+let additionalOptions = {};
+
+/**
+ * Runs precommit linting using lint-staged with the provided configuration
+ * @param {object} cliArgs - Command line arguments object
+ * @param {string} [cliArgs.config] - Path to custom configuration file
+ * @returns {boolean} True on success
+ */
+export async function run(cliArgs = {}) {
+  const options = await __.getOptions(cliArgs);
+
+  // Grab all errors output by lint-staged, to display later
+  const errors = [];
+  const logger = {
+    log: consoleInfo,
+    warn: consoleWarn,
+    error(error) {
+      errors.push(error);
+    },
+  };
+
+  const canCommit = await __.lintStaged(options, logger);
+
+  // Stop if can commit
+  if (canCommit) {
+    return true;
+  }
+
+  // Throw error if can't commit
+  throw __.firostError('ABERLAAS_PRECOMMIT_LINT_FAILED', errors);
+}
+
+__ = {
+  /**
+   * Retrieves configuration options for lint-staged execution
+   * @param {object} cliArgs - Command line arguments object
+   * @param {string} [cliArgs.config] - Path to custom configuration file
+   * @returns {object} configuration options object with config, additional options, and shell set to true
+   */
+  async getOptions(cliArgs) {
+    // Find the most relevant config
+    const config = await getConfig(
       cliArgs.config,
       'lintstaged.config.js',
       lintStagedConfig,
     );
 
-    try {
-      const result = await lintStaged({
-        config,
-        // Allow use extended shell syntax in config, like pipes, redirects or
-        // env variables
-        shell: true,
-      });
-      // Linting failed
-      if (!result) {
-        throw firostError(
-          'ERROR_PRECOMMIT_LINT_FAILED',
-          'Precommit linting failed',
-        );
-      }
-    } catch (_error) {
-      throw firostError('ERROR_PRECOMMIT', 'Precommit failed');
-    }
+    return {
+      config,
+      ...additionalOptions, // Additional overrides from tests
+    };
+  },
+  lintStaged,
+  firostError,
+  // Internal methods to pass additional options to lint-staged, for tests
+  addOption(key, value) {
+    additionalOptions[key] = value;
+  },
+  clearOptions() {
+    additionalOptions = {};
   },
 };
+
+export default { run };

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "aberlaas-precommit",
   "type": "module",
+  "sideEffects": false,
   "description": "aberlaas precommit helper: Sanitize and cleanup on commit",
-  "version": "2.18.1",
+  "version": "2.20.1",
   "repository": "pixelastic/aberlaas",
   "homepage": "https://projects.pixelastic.com/aberlaas/",
   "author": "Tim Carry (@pixelastic)",
@@ -19,25 +20,27 @@
   "engines": {
     "node": ">=18.18.0"
   },
-  "scripts": {
-    "build": "../../scripts/local/build",
-    "build:prod": "../../scripts/local/build-prod",
-    "cms": "../../scripts/local/cms",
-    "serve": "../../scripts/local/serve",
-    "ci": "../../scripts/local/ci",
-    "release": "../../scripts/local/release",
-    "update-dependencies": "node ../../scripts/meta/update-dependencies.js",
-    "test:meta": "../../scripts/local/test-meta",
-    "test": "../../scripts/local/test",
-    "test:watch": "../../scripts/local/test-watch",
-    "compress": "../../scripts/local/compress",
-    "lint": "../../scripts/local/lint",
-    "lint:fix": "../../scripts/local/lint-fix"
-  },
   "dependencies": {
-    "aberlaas-helper": "^2.18.1",
-    "firost": "5.2.1",
-    "lint-staged": "15.2.10"
+    "aberlaas-helper": "workspace:*",
+    "firost": "5.5.1",
+    "lint-staged": "16.2.7"
+  },
+  "scripts": {
+    "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"
   },
-  "gitHead": "00b60dcf9aebab442a809ccc81942005d87d1b5c"
+  "devDependencies": {
+    "gilmore": "1.2.0",
+    "golgoth": "3.0.0",
+    "micromatch": "4.0.8"
+  }
 }