aberlaas 2.0.0 → 2.1.0

package/configs/jest/{index.js → index.cjs}

@@ -1,7 +1,7 @@
 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');
+const jestExtendedPath = path.resolve(__dirname, './jest-extended.cjs');
+const setupFileAfterEnv = path.resolve(__dirname, './setupFileAfterEnv.cjs');
+const testEnvironment = path.resolve(__dirname, './testEnvironment.cjs');
 module.exports = {
   // Custom environment that automatically set testName and allow for --failFast
   testEnvironment,
@@ -34,13 +34,16 @@ module.exports = {
     '<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',
-  },
+  // 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',
+  // },
+
+  // Make sure we don't transform source code and use the default ESM code
+  transform: {},
 
   bail: true,
 

package/configs/jest/{testEnvironment.js → testEnvironment.cjs}

@@ -1,6 +1,6 @@
 const NodeEnvironment = require('jest-environment-node');
 const shouldFailFast = process.env.ABERLAAS_TEST_FAIL_FAST;
-const sharedState = require('./sharedState.js');
+const sharedState = require('./sharedState.cjs');
 
 class AberlaasEnvironment extends NodeEnvironment {
   async handleTestEvent(event, _state) {

package/configs/jest.cjs

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

package/configs/{lintstaged.js → lintstaged.cjs}

@@ -20,6 +20,6 @@ if (pkg.scripts && pkg.scripts.lint) {
 }
 // Testing changed js files
 if (pkg.scripts && pkg.scripts.test) {
-  result['./lib/**/*.js'] = ['yarn run test --failFast --findRelatedTests'];
+  result['./lib/**/*.js'] = ['yarn run test --failFast --related'];
 }
 module.exports = result;

package/configs/node.cjs

@@ -0,0 +1,5 @@
+// Note: This file must still be in .cjs as it is require()d by eslintrc.cjs,
+// which we also have to keep in cjs format
+module.exports = {
+  nodeVersion: '18.18.0', // Also see templates/_circleci/config.yml
+};

package/configs/vite/test/setupFiles/captureOutput.js

@@ -0,0 +1,4 @@
+// We make captureOutput publicly available inside of tests
+import captureOutput from 'firost/captureOutput.js';
+
+globalThis.captureOutput = captureOutput;

package/configs/vite/test/setupFiles/dedent.js

@@ -0,0 +1,4 @@
+// We make dedent publicly available inside of tests
+import dedent from 'dedent';
+
+globalThis.dedent = dedent;

package/configs/vite/test/setupFiles/fit-xit-fdescribe-xdescribe.js

@@ -0,0 +1,13 @@
+/**
+ * Add faster to type aliases:
+ * - fit, ftest, fdescribe: To focus specific tests
+ * - xit, xtest, xdescribe: To skip specific tests
+ **/
+
+globalThis.fit = globalThis.it.only;
+globalThis.ftest = globalThis.test.only;
+globalThis.fdescribe = globalThis.describe.only;
+
+globalThis.xit = globalThis.it.skip;
+globalThis.xtest = globalThis.test.skip;
+globalThis.xdescribe = globalThis.describe.skip;

package/configs/vite/test/setupFiles/jest-extended.js

@@ -0,0 +1,10 @@
+// We use extended matchers from jest-extended in vitest
+// It includes matcher like .toStartWith, .toBeEmpty, etc
+// See: https://github.com/jest-community/jest-extended
+//
+// The expect.extend() from Vitest is compatible with the one from Jest, so
+// setup is straightforward
+import { expect } from 'vitest';
+import * as matchers from 'jest-extended';
+
+expect.extend(matchers);

package/configs/vite/test/setupFiles/testName.js

@@ -0,0 +1,9 @@
+/* global beforeEach, expect */
+/**
+ * Make the variable `testName` contain the name of the current test in each
+ * test
+ **/
+beforeEach(() => {
+  const fullName = expect.getState().currentTestName;
+  globalThis.testName = fullName.split(' > ').pop();
+});

package/configs/vite.js

@@ -0,0 +1,25 @@
+import { configDefaults, defineConfig } from 'vitest/config';
+const configDir = new URL('./vite/', import.meta.url).pathname;
+
+export default defineConfig({
+  test: {
+    // Make describe, it, beforeEach and other globally available
+    globals: true,
+    // Tests should be in a __tests__ folder next to their code
+    include: ['**/__tests__/**/*.js?(x)'],
+    // We ignore temporary folders from the tests
+    exclude: [...configDefaults.exclude, '**/tmp/**'],
+    watchExclude: [...configDefaults.watchExclude, '**/tmp/**'],
+    // Restore mocks after each tests
+    restoreMocks: true,
+
+    // Run before each test file
+    setupFiles: [
+      `${configDir}/test/setupFiles/dedent.js`,
+      `${configDir}/test/setupFiles/captureOutput.js`,
+      `${configDir}/test/setupFiles/fit-xit-fdescribe-xdescribe.js`,
+      `${configDir}/test/setupFiles/jest-extended.js`,
+      `${configDir}/test/setupFiles/testName.js`,
+    ],
+  },
+});

package/helper.js

@@ -1,10 +1,12 @@
-const path = require('path');
-const _ = require('golgoth/_');
-const run = require('firost/run');
-const glob = require('firost/glob');
-const stripAnsi = require('strip-ansi');
-const findUp = require('find-up');
-module.exports = {
+import path from 'path';
+import _ from 'golgoth/lodash.js';
+import run from 'firost/run.js';
+import glob from 'firost/glob.js';
+import exists from 'firost/exists.js';
+import findUp from 'find-up';
+import * as url from 'url';
+
+export default {
   /**
    * Return absolute path to the host dir
    * @returns {string} Absolute path to host dir
@@ -25,7 +27,7 @@ module.exports = {
    * @returns {string} Absolute path to aberlaas dir
    **/
   aberlaasRoot() {
-    return path.resolve(__dirname);
+    return url.fileURLToPath(new URL('.', import.meta.url));
   },
   /**
    * Return an absolute path to a file in the aberlaas directory
@@ -115,35 +117,39 @@ module.exports = {
 
   /**
    * Returns path to a specific binary.
-   * Will use the local yarn version of the host if available, or the one
-   * defined in aberlaas otherwise
+   *
+   * Knowing the path to a specific binary is not trivial:
+   * - Aberlaas dependencies should be in node_modules/aberlaas/.bin
+   * - Host dependencies should be in node_modules/.bin
+   *
+   * There are some special cases:
+   * - If both aberlaas and host use the same dependency version, it will be
+   *   hoisted to the host
+   * - If they use different versions, priority should be given to the one in
+   *   aberlaas
+   * - Mono-repo setup and yarn link will move dependencies out of
+   *   node_modules/.bin
+   *
+   * For those reasons, we defer to running yarn bin to get the exact path to
+   * the binary, and check in order of importance in aberlaas first, and then in
+   * the host
+   *
    * @param {string} bin Binary name
    * @returns {string} Path to the binary
    **/
   async which(bin) {
-    // Try to find the executable in the host
-    const { stdout: hostPath } = await this.__run(`yarn bin ${bin}`, {
-      stdout: false,
-      stderr: false,
-    });
-    if (hostPath) {
-      return stripAnsi(hostPath);
-    }
+    const binaryPathSuffix = `./node_modules/.bin/${bin}`;
+    const pathsToTest = [
+      this.aberlaasPath(binaryPathSuffix),
+      this.hostPath(binaryPathSuffix),
+    ];
 
-    // Try in Aberlaas
-    const { stdout: aberlaasPath } = await this.__run(
-      `cd ${this.aberlaasRoot()} && yarn bin ${bin}`,
-      {
-        shell: true,
-        stdout: false,
-        stderr: false,
+    for (const binaryPath of pathsToTest) {
+      if (await exists(binaryPath)) {
+        return binaryPath;
       }
-    );
-    if (aberlaasPath) {
-      return stripAnsi(aberlaasPath);
     }
-
-    return null;
+    return false;
   },
   /**
    * Run a specific script through yarn run
@@ -151,14 +157,6 @@ module.exports = {
    * @returns {object} Result of the run, including .sterr and .stdout
    **/
   async yarnRun(scriptName) {
-    const currentDir = process.cwd();
-    process.chdir(this.hostRoot());
-
-    try {
-      return await run(`yarn run ${scriptName}`);
-    } finally {
-      process.chdir(currentDir);
-    }
+    return await run(`yarn run ${scriptName}`, { cwd: this.hostRoot() });
   },
-  __run: run,
 };

package/main.js

@@ -1,27 +1,34 @@
-const minimist = require('minimist');
-const consoleError = require('firost/consoleError');
-const exit = require('firost/exit');
-const _ = require('golgoth/lodash');
+import minimist from 'minimist';
+import consoleError from 'firost/consoleError.js';
+import exit from 'firost/exit.js';
+import _ from 'golgoth/lodash.js';
+import commandCi from './commands/ci/index.js';
+import commandCompress from './commands/compress/index.js';
+import commandInit from './commands/init/index.js';
+import commandPrecommit from './commands/precommit/index.js';
+import commandRelease from './commands/release/index.js';
+import commandTest from './commands/test/index.js';
+import commandLint from './commands/lint/index.js';
+import commandReadme from './commands/readme/index.js';
+import commandSetup from './commands/setup/index.js';
 
-module.exports = {
+export default {
   /**
    * List of allowed commands to run
    * @returns {Array} List of allowed commands to run
    **/
-  safelist() {
-    return [
-      'build',
-      'ci',
-      'compress',
-      'init',
-      'lint',
-      'migrate',
-      'precommit',
-      'readme',
-      'release',
-      'setup',
-      'test',
-    ];
+  allCommands() {
+    return {
+      ci: commandCi,
+      compress: commandCompress,
+      init: commandInit,
+      lint: commandLint,
+      precommit: commandPrecommit,
+      readme: commandReadme,
+      release: commandRelease,
+      setup: commandSetup,
+      test: commandTest,
+    };
   },
   /**
    * Run the command specified on the command-line, along with specific
@@ -34,7 +41,8 @@ module.exports = {
     });
 
     const commandName = args._[0];
-    if (!_.includes(this.safelist(), commandName)) {
+    const command = this.allCommands()[commandName];
+    if (!command) {
       this.__consoleError(`Unknown command ${commandName}`);
       this.__exit(1);
       return;
@@ -44,7 +52,6 @@ module.exports = {
     args._ = _.drop(args._, 1);
 
     try {
-      const command = this.__require(`./commands/${commandName}`);
       await command.run(args);
     } catch (err) {
       this.__consoleError(err.message);
@@ -53,5 +60,4 @@ module.exports = {
   },
   __consoleError: consoleError,
   __exit: exit,
-  __require: require,
 };

package/package.json

@@ -1,59 +1,66 @@
 {
   "name": "aberlaas",
+  "type": "module",
   "description": "Scaffold your JavaScript projects with tests, lint and release scripts",
-  "version": "2.0.0",
+  "version": "2.1.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"
+    "aberlaas": "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-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 +74,12 @@
     "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"
+  },
+  "devDependencies": {
+    "eslint-plugin-import": "2.29.0",
+    "eslint-plugin-vitest": "0.3.10"
   },
-  "gitHead": "f600de65f2f1f916d5ad2e5b8d63438770586efa"
+  "gitHead": "5d021891b8ba9c030747a3bc7bf20d86c85422db"
 }

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/jest.config.cjs

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

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/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.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');