aberlaas 2.0.0 → 2.2.0

package/commands/setup/helpers/github.js

@@ -1,8 +1,9 @@
-const run = require('firost/run');
-const { Octokit } = require('@octokit/rest');
-const parseGithubUrl = require('parse-github-repo-url');
-const _ = require('golgoth/lodash');
-module.exports = {
+import run from 'firost/run.js';
+import { Octokit } from '@octokit/rest';
+import parseGithubUrl from 'parse-github-repo-url';
+import _ from 'golgoth/lodash.js';
+
+export default {
   /**
    * Returns the GitHub token saved in ENV
    * @returns {string} The GitHub token

package/commands/setup/helpers/npm.js

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   /**
    * Returns the npm token saved in ENV
    * @returns {string} The npm token

package/commands/setup/helpers/ssh.js

@@ -1,13 +1,14 @@
-const helper = require('../../../helper.js');
-const githubHelper = require('./github.js');
-const _ = require('golgoth/lodash');
-const which = require('firost/which');
-const exists = require('firost/exists');
-const read = require('firost/read');
-const run = require('firost/run');
-const mkdirp = require('firost/mkdirp');
-const path = require('path');
-module.exports = {
+import helper from '../../../helper.js';
+import githubHelper from './github.js';
+import _ from 'golgoth/lodash.js';
+import which from 'firost/which.js';
+import exists from 'firost/exists.js';
+import read from 'firost/read.js';
+import run from 'firost/run.js';
+import mkdirp from 'firost/mkdirp.js';
+import path from 'path';
+
+export default {
   /**
    * Check if ssh-keygen is available
    * @returns {boolean} True if available, false otherwise

package/commands/setup/index.js

@@ -1,10 +1,10 @@
-const github = require('./github.js');
-const circleci = require('./circleci.js');
-const renovate = require('./renovate.js');
-const autoRelease = require('./autoRelease');
-const _ = require('golgoth/lodash');
+import github from './github.js';
+import circleci from './circleci.js';
+import renovate from './renovate.js';
+import autoRelease from './autoRelease/index.js';
+import _ from 'golgoth/lodash.js';
 
-module.exports = {
+export default {
   /**
    * Enable external services.
    * Will enable CircleCI, GitHub and Renovate by default.

package/commands/setup/renovate.js

@@ -1,7 +1,8 @@
-const githubHelper = require('./helpers/github.js');
-const consoleSuccess = require('firost/consoleSuccess');
-const consoleError = require('firost/consoleError');
-module.exports = {
+import githubHelper from './helpers/github.js';
+import consoleSuccess from 'firost/consoleSuccess.js';
+import consoleError from 'firost/consoleError.js';
+
+export default {
   renovateId: 2471197,
   /**
    * Returns the GitHub repository Id
@@ -28,7 +29,7 @@ module.exports = {
     // Fail early if no token available
     if (!githubHelper.hasToken()) {
       this.__consoleError(
-        `[renovate]: No GITHUB_TOKEN found, please visit ${manualUrl} to enable manually.`
+        `[renovate]: No GITHUB_TOKEN found, please visit ${manualUrl} to enable manually.`,
       );
       return false;
     }
@@ -41,7 +42,7 @@ module.exports = {
       });
     } catch (err) {
       this.__consoleError(
-        `Renovate is not installed with this GitHub account, please visit ${manualUrl} to install it first.`
+        `Renovate is not installed with this GitHub account, please visit ${manualUrl} to install it first.`,
       );
       return false;
     }

package/commands/test/index.js

@@ -0,0 +1,83 @@
+import helper from '../../helper.js';
+import run from 'firost/run.js';
+import _ from 'golgoth/lodash.js';
+
+export default {
+  /**
+   * Test all files using Vitest
+   * Usage:
+   * $ aberlaas test                                # Test all files
+   * $ aberlaas test ./path/to/__tests__/file.js    # Test specific files
+   * $ aberlaas test ./path/to/file.js              # Test specific files
+   * $ aberlaas test --related                      # Test all related files
+   * $ aberlaas test --failFast                     # Stop early as soon as one test fails
+   * $ aberlaas test --flags                        # Flags passed to vitest
+   * @param {object} cliArgs CLI Argument object, as created by minimist
+   * @returns {boolean} true on success
+   **/
+  async run(cliArgs) {
+    const options = await this.vitestCliOptions(cliArgs);
+
+    await run(`yarn run vitest ${options.join(' ')}`, { stdin: true });
+    return true;
+  },
+
+  /**
+   * Transform all aberlaas test cli options into suitable vitest CLI options
+   * @param {object} cliArgs CLI Argument object, as created by minimist
+   * @returns {Array} Array of cli arguments and values
+   **/
+  async vitestCliOptions(cliArgs = {}) {
+    // Options that have special meaning in aberlaas and shouldn't be passed
+    // as-is to vitest
+    const aberlaasOptions = ['_', 'watch', 'config', 'failFast', 'related'];
+
+    // Input files
+    const inputFiles = _.isEmpty(cliArgs._) ? [helper.hostPath()] : cliArgs._;
+    const vitestOptions = [...inputFiles];
+
+    // Run "vitest related" when --related is passed
+    if (cliArgs.related) {
+      vitestOptions.unshift('related');
+    }
+
+    // Stop early as soon as one test fails
+    if (cliArgs.failFast) {
+      vitestOptions.push('--bail=1');
+    }
+
+    // Disable watch by default
+    vitestOptions.push(cliArgs.watch ? '--watch=true' : '--watch=false');
+
+    // Allow a success, even if no files are passed
+    vitestOptions.push('--passWithNoTests');
+
+    // Hide skipped tests, allowing less noisy debug with fit/fdescribe
+    vitestOptions.push('--hideSkippedTests');
+
+    // Config file
+    const configFile = await helper.configFile(
+      cliArgs.config,
+      'vite.config.js',
+      'lib/configs/vite.js',
+    );
+    vitestOptions.push(`--config=${configFile}`);
+
+    // Pass any unknown options to vitest
+    _.each(cliArgs, (argValue, argKey) => {
+      // Skip keys that we already handled
+      if (_.includes(aberlaasOptions, argKey)) {
+        return;
+      }
+
+      if (argValue === true) {
+        vitestOptions.push(`--${argKey}`);
+        return;
+      }
+
+      vitestOptions.push(`--${argKey}=${argValue}`);
+    });
+
+    return vitestOptions;
+  },
+};

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

@@ -1,27 +1,38 @@
-const nodeConfig = require('./node');
+const nodeConfig = require('./node.cjs');
 module.exports = {
   env: {
     browser: true,
-    es6: true,
+    es2023: true,
     node: true,
-    jest: true,
   },
   parserOptions: {
-    ecmaVersion: 2018,
+    sourceType: 'module',
+    ecmaVersion: 'latest',
   },
   extends: [
     'eslint:recommended',
-    'plugin:node/recommended',
-    'plugin:jest/recommended',
+    'plugin:n/recommended',
+    'plugin:import/recommended',
     'plugin:prettier/recommended',
   ],
-  globals: {
-    // Additional Jest globals added by Aberlaas
-    testName: false,
-    captureOutput: false,
-    dedent: false,
+  settings: {
+    // eslint-plugin-import doesn't currently support the "exports" syntax in
+    // package.json. This allow mapping between custom entrypoints and
+    // files on disk.
+    // For example, it doesn't understand "import * from 'vitest/config';" as
+    // "vitest/config/" isn't really an existing filepath, but a mapping defined
+    // in vitest package.json
+    //
+    // Until this is fixed (see
+    // https://github.com/import-js/eslint-plugin-import/issues/2430)
+    // we manually define the most common extensions
+    'import/resolver': {
+      node: {
+        extensions: ['.js', '.cjs', '.mjs', '.d.ts'],
+      },
+    },
   },
-  plugins: ['jest', 'jsdoc', 'prettier'],
+  plugins: ['jsdoc', 'prettier'],
   rules: {
     'dot-notation': ['error'],
     'max-len': [
@@ -63,33 +74,20 @@ module.exports = {
     'quote-props': ['error', 'as-needed'],
     quotes: ['error', 'single', { avoidEscape: true }],
     // Node
-    'node/no-unsupported-features/es-syntax': [
-      'error',
-      {
-        version: `>=${nodeConfig.nodeVersion}`,
-      },
-    ],
-    'node/no-unsupported-features/node-builtins': [
+    'n/no-unsupported-features/es-syntax': [
       'error',
       {
         version: `>=${nodeConfig.nodeVersion}`,
       },
     ],
-    // Jest
-    'jest/expect-expect': ['error'],
-    'jest/no-test-prefixes': 0,
-    'jest/prefer-called-with': 0,
-    'jest/prefer-spy-on': ['error'],
-    'jest/prefer-todo': 0,
-    'jest/prefer-to-contain': ['error'],
-    'jest/prefer-to-have-length': ['error'],
-    'jest/valid-title': ['error'],
+    // Import
+    'import/no-cycle': ['error'],
     // JSDoc
     'jsdoc/check-param-names': ['warn'],
     'jsdoc/check-types': ['warn'],
     'jsdoc/no-undefined-types': ['warn'],
     'jsdoc/check-alignment': ['warn'],
-    'jsdoc/check-examples': ['warn'],
+    'jsdoc/check-examples': ['off'],
     'jsdoc/check-syntax': ['warn'],
     'jsdoc/check-tag-names': ['warn'],
     'jsdoc/require-jsdoc': ['warn'],
@@ -106,6 +104,56 @@ module.exports = {
     'prettier/prettier': 'error',
   },
   overrides: [
+    // Vitest
+    {
+      files: ['**/__tests__/**/*.js'],
+      env: {
+        'vitest-globals/env': true,
+      },
+      globals: {
+        // Test name
+        testName: false,
+        // Shorter method names
+        fit: false,
+        fdescribe: false,
+        xit: false,
+        xdescribe: false,
+
+        captureOutput: false,
+        dedent: false,
+      },
+      extends: [
+        'plugin:vitest/recommended',
+        'plugin:vitest-globals/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',
+          },
+        ],
+        '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'],
+      },
+    },
     // no-process-exit
     // We need to send clear exit codes in yarn run scripts
     {

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

@@ -18,8 +18,14 @@ if (pkg.scripts && pkg.scripts.lint) {
   result['*.json'] = ['yarn run lint:fix --json'];
   result['*.js'] = ['yarn run lint:fix --js'];
 }
+
+// Compressing images
+if (pkg.scripts && pkg.scripts.compress) {
+  result['*.png'] = ['yarn run compress --png'];
+}
+
 // 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,19 @@ module.exports = {
    * @returns {object} Result of the run, including .sterr and .stdout
    **/
   async yarnRun(scriptName) {
-    const currentDir = process.cwd();
-    process.chdir(this.hostRoot());
+    return await run(`yarn run ${scriptName}`, { cwd: this.hostRoot() });
+  },
+  /**
+   * Dynamically import a file
+   * This is a wrapper around the default import, but bypasses the cache
+   * It makes sure importing a file several times always loads the last version
+   * TODO: This should probably be moved in firost once firost is moved to ESM
+   * @param {string} filepath Path to the file to load
+   * @returns {object} Content of the loaded file
+   **/
+  async import(filepath) {
+    const content = await import(`${filepath}?cacheBusting=${Date.now()}`);
 
-    try {
-      return await run(`yarn run ${scriptName}`);
-    } finally {
-      process.chdir(currentDir);
-    }
+    return content.default || content;
   },
-  __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,
 };