aberlaas 2.0.0 → 2.2.0

package/package.json

@@ -1,59 +1,65 @@
 {
   "name": "aberlaas",
+  "type": "module",
   "description": "Scaffold your JavaScript projects with tests, lint and release scripts",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "repository": "pixelastic/aberlaas",
   "homepage": "https://projects.pixelastic.com/aberlaas/",
   "author": "Tim Carry (@pixelastic)",
   "license": "MIT",
-  "main": "main.js",
+  "exports": {
+    ".": "./main.js",
+    "./configs/lintstaged.cjs": "./configs/lintstaged.cjs",
+    "./configs/prettier.cjs": "./configs/prettier.cjs",
+    "./configs/styleling.cjs": "./configs/styleling.cjs"
+  },
   "files": [
     "bin/",
     "lib/",
+    "scripts/",
     "*.js",
-    "commands/*.js",
     "commands/ci/*.js",
     "commands/compress/*.js",
+    "commands/init/*.js",
     "commands/lint/*.js",
+    "commands/lint/helpers/*.js",
+    "commands/precommit/*.js",
     "commands/readme/*.js",
+    "commands/release/*.js",
     "commands/setup/*.js",
     "commands/setup/autoRelease/*.js",
     "commands/setup/helpers/*.js",
+    "commands/test/*.js",
     "configs/",
     "templates/"
   ],
-  "bin": {
-    "aberlaas": "bin/aberlaas",
-    "aberlass": "bin/aberlaas",
-    "aberlas": "bin/aberlaas"
-  },
+  "bin": "bin/aberlaas.js",
   "dependencies": {
     "@octokit/rest": "18.12.0",
     "ci-info": "3.9.0",
     "dedent": "1.5.1",
-    "eslint": "7.32.0",
-    "eslint-config-prettier": "8.10.0",
-    "eslint-plugin-jest": "24.7.0",
+    "eslint": "8.54.0",
+    "eslint-config-prettier": "9.0.0",
+    "eslint-plugin-import": "2.29.0",
     "eslint-plugin-jsdoc": "46.9.0",
-    "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-prettier": "3.4.1",
+    "eslint-plugin-n": "16.3.1",
+    "eslint-plugin-prettier": "5.0.1",
+    "eslint-plugin-vitest": "0.3.10",
+    "eslint-plugin-vitest-globals": "1.4.0",
     "find-up": "5.0.0",
-    "firost": "2.17.0",
+    "firost": "3.1.0",
     "front-matter": "4.0.2",
+    "gilmore": "0.1.0",
     "golgoth": "2.1.0",
-    "husky": "4.3.8",
-    "jest": "27.5.1",
-    "jest-environment-node": "27.5.1",
-    "jest-expect-message": "1.1.3",
-    "jest-extended": "0.11.5",
+    "jest-extended": "4.0.2",
     "lint-staged": "11.2.6",
     "minimist": "1.2.8",
     "np": "7.7.0",
     "parse-github-repo-url": "1.4.1",
-    "prettier": "2.8.8",
+    "prettier": "3.1.0",
     "std-mocks": "1.0.1",
-    "strip-ansi": "6.0.1",
     "stylelint": "13.13.1",
+    "vitest": "1.0.4",
     "yaml-lint": "1.7.0"
   },
   "engines": {
@@ -67,7 +73,8 @@
     "release": "../scripts/release",
     "serve": "../scripts/docs/serve",
     "test": "../scripts/lib/test",
-    "test:watch": "../scripts/lib/test-watch"
+    "test:watch": "../scripts/lib/test-watch",
+    "postinstall": "./scripts/postinstall"
   },
-  "gitHead": "f600de65f2f1f916d5ad2e5b8d63438770586efa"
+  "gitHead": "bbf9f5024d007deca00abf451ddf879c876d80aa"
 }

package/scripts/postinstall

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+# This script *should be* automatically run when aberlaas in installed
+# It will configure the local git repository to use ./scripts/hooks (if it
+# exists) for git hooks
+#
+# Note that npm/yarn/etc might have caching mechanisms that will prevent this
+# script from running in some circumstances. It's not (and will never be)
+# a bulletproof approach, but should cover the most basic needs.
+#
+# In case hooks no longer trigger, you will need to manually run:
+# $ git config core.hooksPath scripts/hooks
+
+if [ ! -d "./scripts/hooks" ]; then
+	git config core.hooksPath scripts/hooks
+fi

package/templates/_circleci/config.yml

@@ -3,7 +3,7 @@ version: 2.1
 aliases:
   - &defaults
     docker:
-      - image: cimg/node:14.17.0
+      - image: cimg/node:18.18.0
   - &restore_cache
     restore_cache:
       key: yarn-cache-{{ checksum "yarn.lock" }}

package/templates/_eslintignore.conf

@@ -1,4 +1,4 @@
-# Hidden files (.prettierrc.js, .huskyrc.js, etc) are ignored by default by ESLint
+# Hidden files (.prettierrc.js, etc) are ignored by default by ESLint
 # The following line will unignore them
 !.*
 

package/templates/_eslintrc.cjs

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['./node_modules/aberlaas/configs/eslint.cjs'],
+};

package/templates/_lintstagedrc.cjs

@@ -0,0 +1,4 @@
+const config = require('aberlaas/configs/lintstaged.cjs');
+module.exports = {
+  ...config,
+};

package/templates/_prettierrc.cjs

@@ -0,0 +1,4 @@
+const config = require('aberlaas/configs/prettier.cjs');
+module.exports = {
+  ...config,
+};

package/templates/_stylelintrc.cjs

@@ -0,0 +1,4 @@
+const config = require('aberlaas/configs/stylelint.cjs');
+module.exports = {
+  ...config,
+};

package/templates/_yarnrc.yml

@@ -0,0 +1,9 @@
+compressionLevel: 0
+
+defaultSemverRangePrefix: ''
+
+enableGlobalCache: true
+
+nmMode: hardlinks-local
+
+nodeLinker: node-modules

package/templates/lib/__tests__/main.js

@@ -1,4 +1,4 @@
-const current = require('../main.js');
+import current from '../main.js';
 
 describe('current', () => {
   it('should do something', async () => {
@@ -6,6 +6,6 @@ describe('current', () => {
 
     const actual = current.run(input);
 
-    expect(actual).toEqual(true);
+    expect(actual).toBe(true);
   });
 });

package/templates/lib/main.js

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   run() {
     return true;
   },

package/templates/scripts/{husky-precommit → compress}

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 set -e
 
-aberlaas precommit "$@"
+aberlaas compress "$@"

package/templates/scripts/hooks/pre-commit

@@ -0,0 +1,11 @@
+#!/usr/bin/env sh
+# This script *should be* automatically triggered before each git commit.
+#
+# If it doesn't work, make sure your local git repo is configured to use
+# ./scripts/hooks as the base directory for git hooks.
+#
+# If not, run:
+# $ git config core.hooksPath scripts/hooks
+set -e
+
+aberlaas precommit "$@"

package/templates/vite.config.js

@@ -0,0 +1,4 @@
+import viteConfig from 'aberlaas/configs/vite.js';
+export default {
+  ...viteConfig,
+};

package/commands/test.js

@@ -1,92 +0,0 @@
-/* eslint-disable jest/no-jest-import */
-const helper = require('../helper');
-const _ = require('golgoth/lodash');
-
-module.exports = {
-  /**
-   * Transform all aberlaas test cli options into suitable jest-cli options
-   * @param {object} cliArgs CLI Argument object, as created by minimist
-   * @returns {Array} Array of cli arguments and values
-   **/
-  async jestCliArguments(cliArgs = {}) {
-    const args = {
-      ...cliArgs,
-      cache: false,
-      passWithNoTests: true,
-    };
-    // Default list of files
-    if (_.isEmpty(args._)) {
-      args._ = [helper.hostPath()];
-    }
-    // Config file
-    args.config = await helper.configFile(
-      cliArgs.config,
-      'jest.config.js',
-      'lib/configs/jest.js'
-    );
-    // Set no-watchman when watching
-    if (args.watch) {
-      args.watchman = false;
-    }
-
-    // Handle additional --failFast switch to stop after one test fails
-    if (args.failFast) {
-      delete args.failFast;
-      this.setEnv('ABERLAAS_TEST_FAIL_FAST', true);
-    }
-
-    // Convert to array of cli arguments
-    return _.transform(
-      args,
-      (result, value, key) => {
-        if (key === '_') {
-          return;
-        }
-        if (value === true) {
-          result.push(`--${key}`);
-          return;
-        }
-        if (value === false) {
-          result.push(`--no-${key}`);
-          return;
-        }
-        result.push(`--${key}`);
-        result.push(`${value}`);
-      },
-      [...args._]
-    );
-  },
-  /**
-   * Test all files using Jest
-   * @param {object} cliArgs CLI Argument object, as created by minimist
-   **/
-  async run(cliArgs) {
-    const options = await this.jestCliArguments(cliArgs);
-    await this.__jestRun(options);
-  },
-  /**
-   * Wrapper method around jest.run. Using a wrapper here makes it easier to
-   * mock the call in our tests. Because we are using jest itself to test this
-   * file, mocking jest from inside of it is not practical, so we need to wrap
-   * it.
-   * @param {object} options CLI Options to pass to jest.run
-   **/
-  async __jestRun(options) {
-    // We lazy-load jest here because importing it at the top kinda confuses
-    // Jest when we're running tests and complaining about cyclical
-    // dependencies. So we're loading it only when needed.
-    if (!this.__jest) {
-      this.__jest = require('jest');
-    }
-
-    await this.__jest.run(options);
-  },
-  /**
-   * Set an environment variable to a specific value
-   * @param {string} key Key entry
-   * @param {string} value Value to set
-   **/
-  setEnv(key, value) {
-    process.env[key] = value;
-  },
-};

package/configs/husky.js

@@ -1,5 +0,0 @@
-module.exports = {
-  hooks: {
-    'pre-commit': 'yarn run husky:precommit',
-  },
-};

package/configs/jest/index.js

@@ -1,49 +0,0 @@
-const path = require('path');
-const jestExtendedPath = path.resolve(__dirname, './jest-extended.js');
-const setupFileAfterEnv = path.resolve(__dirname, './setupFileAfterEnv.js');
-const testEnvironment = path.resolve(__dirname, './testEnvironment.js');
-module.exports = {
-  // Custom environment that automatically set testName and allow for --failFast
-  testEnvironment,
-
-  // Use additional Jest plugins
-  setupFilesAfterEnv: [jestExtendedPath, setupFileAfterEnv],
-
-  // We need to set rootDir to the host directory, otherwise Jest will assume
-  // test are to be looked for in the directory that contains the config (ie.
-  // aberlaas).
-  rootDir: process.cwd(),
-
-  // Tests should be in a __tests__ folder
-  testMatch: ['**/__tests__/**/*.js?(x)'],
-
-  // By default watch mode watches for changes in all directories, and whenever
-  // a test file or associated code file changes, it re-runs tests.
-  // This can cause useless re-render of tests when it catches changes in
-  // directories like ./tmp, etc, so we exclude such directories
-  // watchPathIgnorePatterns only accept RegExp and not globs, so we have to
-  // deal with ((.*)/)? to express any depth of folders
-  watchPathIgnorePatterns: [
-    '<rootDir>/((.*)/)?node_modules/',
-    '<rootDir>/((.*)/)?tmp/',
-    '<rootDir>/((.*)/)?templates/',
-  ],
-  testPathIgnorePatterns: [
-    '<rootDir>/((.*)/)?fixtures/',
-    '<rootDir>/((.*)/)?tmp/',
-    '<rootDir>/((.*)/)?templates/',
-  ],
-
-  moduleNameMapper: {
-    // When using lodash-es (which is treeshakeable, thus preferable in front-end
-    // envs), it will fail in tests as it isn't compiled to ES5.
-    // So, we make jest load the full lodash instead. Note that the lib still
-    // needs to be added as a devDependency
-    '^lodash-es$': 'lodash',
-  },
-
-  bail: true,
-
-  resetMocks: true,
-  restoreMocks: true,
-};

package/configs/jest/jest-extended.js

@@ -1,3 +0,0 @@
-// This is a proxy to make sure we load the plugin no matter where it is
-// installed
-module.exports = require('jest-extended');

package/configs/jest/setupFileAfterEnv.js

@@ -1,13 +0,0 @@
-/* eslint-disable jest/no-jasmine-globals,no-global-assign */
-const captureOutput = require('firost/captureOutput');
-const dedent = require('dedent');
-
-/**
- * Add new globals to each test file:
- * - captureOutput accepts a callback that will be executed with all output
- *   silenced and returned instead
- * - dedent (https://github.com/dmnd/dedent) to enter multiline strings without
- *   the indentation
- **/
-global.captureOutput = captureOutput;
-global.dedent = dedent;

package/configs/jest/sharedState.js

@@ -1,14 +0,0 @@
-/**
- * Jest environments are sandboxed by test suite. To be able to fail fast and
- * stop all tests as soon as one of them failed, we are using this file as an
- * external singleton.
- **/
-module.exports = {
-  __skipAllTests: false,
-  skipAllTests() {
-    this.__skipAllTests = true;
-  },
-  shouldSkipAllTests() {
-    return this.__skipAllTests;
-  },
-};

package/configs/jest/testEnvironment.js

@@ -1,46 +0,0 @@
-const NodeEnvironment = require('jest-environment-node');
-const shouldFailFast = process.env.ABERLAAS_TEST_FAIL_FAST;
-const sharedState = require('./sharedState.js');
-
-class AberlaasEnvironment extends NodeEnvironment {
-  async handleTestEvent(event, _state) {
-    this.failFast(event);
-    this.setTestName(event);
-  }
-  /**
-   * If one test fails, we skip all other tests
-   * @param {object} event As fired by handleTestEvent
-   */
-  failFast(event) {
-    // Do nothing if --failFast is not passed
-    if (!shouldFailFast) {
-      return;
-    }
-
-    // Whenever a test is failing, we update the shared state to skip all other
-    // tests
-    const eventName = event.name;
-    const isTestFailing = eventName == 'test_fn_failure';
-    const isTestStarting = eventName === 'test_start';
-
-    if (isTestFailing) {
-      sharedState.skipAllTests();
-    }
-    if (isTestStarting && sharedState.shouldSkipAllTests()) {
-      event.test.mode = 'skip';
-    }
-  }
-  /**
-   * When a test starts, we set the global variable testName to the name of the
-   * test
-   * @param {object} event As fired by handleTestEvent
-   **/
-  setTestName(event) {
-    const eventName = event.name;
-    if (eventName === 'test_start') {
-      this.global.testName = event.test.name;
-    }
-  }
-}
-
-module.exports = AberlaasEnvironment;

package/configs/jest.js

@@ -1 +0,0 @@
-module.exports = require('./jest/index.js');

package/configs/node.js

@@ -1,3 +0,0 @@
-module.exports = {
-  nodeVersion: '14.17.0', // Also see templates/_circleci/config.yml
-};

package/lib/configs/deprecated.js

@@ -1,17 +0,0 @@
-/**
- * In July 2021, I moved the repository to a monorepo holding the docs. The path
- * to the config files changed, no longer referencing the ./lib. This break all
- * usage, so I added this proxy, with a deprecation notice.
- *
- * Require the correct file, but display a warning about what file to change
- * @param {string} hostPath Example: jest.config.js
- * @param {string} aberlaasPath Example configs/jest.js
- * @returns {object} Config file object
- **/
-module.exports = (hostPath, aberlaasPath) => {
-  console.info(
-    `Please update your ${hostPath} to require aberlaas/${aberlaasPath} instead of aberlaas/lib/${aberlaasPath}`
-  );
-
-  return require(`../../${aberlaasPath}`);
-};

package/lib/configs/eslint.js

@@ -1,2 +0,0 @@
-const deprecated = require('./deprecated.js');
-module.exports = deprecated('.eslintrc.js', 'configs/eslint.js');

package/lib/configs/husky.js

@@ -1,2 +0,0 @@
-const deprecated = require('./deprecated.js');
-module.exports = deprecated('.huskyrc.js', 'configs/husky.js');

package/lib/configs/jest.js

@@ -1,2 +0,0 @@
-const deprecated = require('./deprecated.js');
-module.exports = deprecated('jest.config.js', 'configs/jest.js');

package/lib/configs/lintstaged.js

@@ -1,2 +0,0 @@
-const deprecated = require('./deprecated.js');
-module.exports = deprecated('.lintstagedrc.js', 'configs/lintstaged.js');

package/lib/configs/prettier.js

@@ -1,2 +0,0 @@
-const deprecated = require('./deprecated.js');
-module.exports = deprecated('.prettierrc.js', 'configs/prettier.js');

package/lib/configs/stylelint.js

@@ -1,2 +0,0 @@
-const deprecated = require('./deprecated.js');
-module.exports = deprecated('.stylelintrc.js', 'configs/stylelint.js');

package/templates/_eslintrc.js

@@ -1,3 +0,0 @@
-module.exports = {
-  extends: ['./node_modules/aberlaas/configs/eslint.js'],
-};

package/templates/_huskyrc.js

@@ -1,4 +0,0 @@
-const config = require('aberlaas/configs/husky.js');
-module.exports = {
-  ...config,
-};

package/templates/_lintstagedrc.js

@@ -1,4 +0,0 @@
-const config = require('aberlaas/configs/lintstaged.js');
-module.exports = {
-  ...config,
-};

package/templates/_prettierrc.js

@@ -1,4 +0,0 @@
-const config = require('aberlaas/configs/prettier.js');
-module.exports = {
-  ...config,
-};

package/templates/_stylelintrc.js

@@ -1,4 +0,0 @@
-const config = require('aberlaas/configs/stylelint.js');
-module.exports = {
-  ...config,
-};

package/templates/babel.config.js

@@ -1,3 +0,0 @@
-module.exports = {
-  presets: ['aberlaas/configs/babel.js'],
-};

package/templates/jest.config.js

@@ -1,4 +0,0 @@
-const config = require('aberlaas/configs/jest.js');
-module.exports = {
-  ...config,
-};