aberlaas 2.0.0 → 2.1.0

package/commands/lint/yml.js

@@ -1,19 +1,20 @@
-const lint = require('./index.js');
-const helper = require('../../helper.js');
-const firostError = require('firost/error');
-const read = require('firost/read');
-const _ = require('golgoth/lodash');
-const pMap = require('golgoth/pMap');
-const yamlLint = require('yaml-lint');
-const path = require('path');
-module.exports = {
+import helper from '../../helper.js';
+import { fix as prettierFix } from './helpers/prettier.js';
+import firostError from 'firost/error.js';
+import read from 'firost/read.js';
+import _ from 'golgoth/lodash.js';
+import pMap from 'golgoth/pMap.js';
+import yamlLint from 'yaml-lint';
+import path from 'path';
+
+export default {
   /**
    * Find all relevant files
    * @param {Array} userPatterns Patterns to narrow the search down
    * @returns {Array} Array of files
    **/
   async getInputFiles(userPatterns) {
-    return await lint.getInputFiles(['.yml', '.yaml'], userPatterns);
+    return await helper.findHostFiles(userPatterns, ['.yml', '.yaml']);
   },
   /**
    * Lint all files and display results.
@@ -55,7 +56,8 @@ module.exports = {
     if (_.isEmpty(files)) {
       return true;
     }
-    await lint.fixWithPrettier(files);
+    await this.__prettierFix(files);
   },
+  __prettierFix: prettierFix,
   __lint: yamlLint.lint,
 };

package/commands/{precommit.js → precommit/index.js}

@@ -1,14 +1,14 @@
-const lintStaged = require('lint-staged');
-const firostError = require('firost/error');
-const helper = require('../helper');
+import lintStaged from 'lint-staged';
+import firostError from 'firost/error.js';
+import helper from '../../helper.js';
 
-module.exports = {
+export default {
   async run(cliArgs) {
     // Config
     const configPath = await helper.configFile(
       cliArgs.config,
-      '.lintstagedrc.js',
-      'lib/configs/lintstaged.js'
+      '.lintstagedrc.cjs',
+      'lib/configs/lintstaged.cjs',
     );
 
     try {
@@ -19,7 +19,7 @@ module.exports = {
       if (!result) {
         throw firostError(
           'ERROR_PRECOMMIT_LINT_FAILED',
-          'Precommit linting failed'
+          'Precommit linting failed',
         );
       }
     } catch (error) {

package/commands/readme/index.js

@@ -1,16 +1,16 @@
-const helper = require('../../helper.js');
-const _ = require('golgoth/lodash');
-const pMap = require('golgoth/pMap');
-const readJson = require('firost/readJson');
-const read = require('firost/read');
-const write = require('firost/write');
-const glob = require('firost/glob');
-const exists = require('firost/exists');
-const path = require('path');
-const frontMatter = require('front-matter');
-const dedent = require('golgoth/dedent');
-
-module.exports = {
+import helper from '../../helper.js';
+import _ from 'golgoth/lodash.js';
+import pMap from 'golgoth/pMap.js';
+import readJson from 'firost/readJson.js';
+import read from 'firost/read.js';
+import write from 'firost/write.js';
+import glob from 'firost/glob.js';
+import exists from 'firost/exists.js';
+import path from 'path';
+import frontMatter from 'front-matter';
+import dedent from 'golgoth/dedent.js';
+
+export default {
   /**
    * Update the main README.md based on the template and the documentation
    * @param {object} cliArgs CLI Argument object, as created by minimist
@@ -59,7 +59,7 @@ module.exports = {
     }
 
     const aberlaasDefaultTemplate = helper.aberlaasPath(
-      'templates/_github/README.template.md'
+      'templates/_github/README.template.md',
     );
     return await read(aberlaasDefaultTemplate);
   },
@@ -141,7 +141,7 @@ module.exports = {
     const packagePath = await this.getPackagePath(cliArgs);
     const moduleReadmePath = path.resolve(
       path.dirname(packagePath),
-      'README.md'
+      'README.md',
     );
 
     const readmes = _.uniq([hostReadmePath, moduleReadmePath]);
@@ -169,7 +169,7 @@ module.exports = {
       const key = match.groups.key;
       convertedSource = convertedSource.replace(
         `{${key}}`,
-        _.get(data, key, '')
+        _.get(data, key, ''),
       );
     });
     return convertedSource;

package/commands/{release.js → release/index.js}

@@ -1,10 +1,9 @@
-/* eslint-disable jest/no-jest-import */
-const _ = require('golgoth/_');
-const run = require('firost/run');
-const readJson = require('firost/readJson');
-const helper = require('../helper');
+import _ from 'golgoth/lodash.js';
+import run from 'firost/run.js';
+import readJson from 'firost/readJson.js';
+import helper from '../../helper.js';
 
-module.exports = {
+export default {
   /**
    * Release the host package.
    * @param {object} cliArgs CLI Argument object, as created by minimist

package/commands/setup/autoRelease/envVars.js

@@ -1,10 +1,11 @@
-const circleciHelper = require('../helpers/circleci.js');
-const githubHelper = require('../helpers/github.js');
-const npmHelper = require('../helpers/npm.js');
-const consoleInfo = require('firost/consoleInfo');
-const consoleSuccess = require('firost/consoleSuccess');
-const pMap = require('golgoth/pMap');
-module.exports = {
+import circleciHelper from '../helpers/circleci.js';
+import githubHelper from '../helpers/github.js';
+import npmHelper from '../helpers/npm.js';
+import consoleInfo from 'firost/consoleInfo.js';
+import consoleSuccess from 'firost/consoleSuccess.js';
+import pMap from 'golgoth/pMap.js';
+
+export default {
   /**
    * Save an ENV variable to CircleCI
    * @param {string} name Name of the ENV variable
@@ -17,7 +18,7 @@ module.exports = {
         `project/github/${username}/${repo}/envvar/${name}`,
         {
           method: 'delete',
-        }
+        },
       );
     } catch (err) {
       // Ignoring the error, it means the ENV var wasn't set in the first place

package/commands/setup/autoRelease/index.js

@@ -1,13 +1,14 @@
-const envVars = require('./envVars.js');
-const privateKey = require('./privateKey.js');
-const publicKey = require('./publicKey.js');
-const sshHelper = require('../helpers/ssh.js');
-const npmHelper = require('../helpers/npm.js');
-const githubHelper = require('../helpers/github.js');
-const circleciHelper = require('../helpers/circleci.js');
-const _ = require('golgoth/lodash');
-const consoleError = require('firost/consoleError');
-module.exports = {
+import envVars from './envVars.js';
+import privateKey from './privateKey.js';
+import publicKey from './publicKey.js';
+import sshHelper from '../helpers/ssh.js';
+import npmHelper from '../helpers/npm.js';
+import githubHelper from '../helpers/github.js';
+import circleciHelper from '../helpers/circleci.js';
+import _ from 'golgoth/lodash.js';
+import consoleError from 'firost/consoleError.js';
+
+export default {
   /**
    * Enable autoRelease by configuring CircleCI and GitHub
    * @returns {boolean} True if enabled, false otherwise
@@ -17,7 +18,7 @@ module.exports = {
     const validationErrors = await this.validationErrors();
     if (!_.isEmpty(validationErrors)) {
       this.__consoleError(
-        '[autoRelease] Please fix the following errors and try again:'
+        '[autoRelease] Please fix the following errors and try again:',
       );
       _.each(validationErrors, (error) => {
         this.__consoleError(error);

package/commands/setup/autoRelease/privateKey.js

@@ -1,8 +1,9 @@
-const circleciHelper = require('../helpers/circleci.js');
-const githubHelper = require('../helpers/github.js');
-const sshHelper = require('../helpers/ssh.js');
-const consoleSuccess = require('firost/consoleSuccess');
-module.exports = {
+import circleciHelper from '../helpers/circleci.js';
+import githubHelper from '../helpers/github.js';
+import sshHelper from '../helpers/ssh.js';
+import consoleSuccess from 'firost/consoleSuccess.js';
+
+export default {
   /**
    * Save a private SSH key on CircleCI.
    * The CircleCI API does not allow checking if a SSH key has been defined,

package/commands/setup/autoRelease/publicKey.js

@@ -1,10 +1,11 @@
-const githubHelper = require('../helpers/github.js');
-const sshHelper = require('../helpers/ssh.js');
-const _ = require('golgoth/lodash');
-const consoleInfo = require('firost/consoleInfo');
-const consoleSuccess = require('firost/consoleSuccess');
-const consoleError = require('firost/consoleError');
-module.exports = {
+import githubHelper from '../helpers/github.js';
+import sshHelper from '../helpers/ssh.js';
+import _ from 'golgoth/lodash.js';
+import consoleInfo from 'firost/consoleInfo.js';
+import consoleSuccess from 'firost/consoleSuccess.js';
+import consoleError from 'firost/consoleError.js';
+
+export default {
   /**
    * Check if SSH public key is already added to GitHub
    * @returns {boolean} True if already enabled, false otherwise

package/commands/setup/circleci.js

@@ -1,10 +1,11 @@
-const githubHelper = require('./helpers/github.js');
-const circleCiHelper = require('./helpers/circleci.js');
-const _ = require('golgoth/lodash');
-const consoleInfo = require('firost/consoleInfo');
-const consoleSuccess = require('firost/consoleSuccess');
-const consoleError = require('firost/consoleError');
-module.exports = {
+import githubHelper from './helpers/github.js';
+import circleCiHelper from './helpers/circleci.js';
+import _ from 'golgoth/lodash.js';
+import consoleInfo from 'firost/consoleInfo.js';
+import consoleSuccess from 'firost/consoleSuccess.js';
+import consoleError from 'firost/consoleError.js';
+
+export default {
   /**
    * Attempt to automatically follow the repo in CircleCI if possible, otherwise
    * display the link to follow it manually
@@ -18,7 +19,7 @@ module.exports = {
     // Fail early if no token available
     if (!circleCiHelper.hasToken()) {
       this.__consoleError(
-        `[circleci]: No CIRCLECI_TOKEN found, please visit ${followUrl} to enable manually.`
+        `[circleci]: No CIRCLECI_TOKEN found, please visit ${followUrl} to enable manually.`,
       );
       return false;
     }

package/commands/setup/github.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 {
   /**
    * Configure the GitHub repo with default settings:
    * - Do not enable merge commits on PR
@@ -16,7 +17,7 @@ module.exports = {
     // Fail early if no token available
     if (!githubHelper.hasToken()) {
       this.__consoleError(
-        `[github]: No GITHUB_TOKEN found, please visit ${manualUrl} to configure manually.`
+        `[github]: No GITHUB_TOKEN found, please visit ${manualUrl} to configure manually.`,
       );
       return false;
     }

package/commands/setup/helpers/circleci.js

@@ -1,7 +1,8 @@
-const got = require('golgoth/got');
-const _ = require('golgoth/lodash');
-const firostError = require('firost/error');
-module.exports = {
+import got from 'golgoth/got.js';
+import _ from 'golgoth/lodash.js';
+import firostError from 'firost/error.js';
+
+export default {
   /**
    * Returns the CircleCI token saved in ENV
    * @returns {string} The CircleCI token
@@ -35,7 +36,7 @@ module.exports = {
     } catch (error) {
       throw firostError(
         'ERROR_CIRCLECI',
-        "Can't connect to CircleCI API. Check that you have a valid CIRCLECI_TOKEN"
+        "Can't connect to CircleCI API. Check that you have a valid CIRCLECI_TOKEN",
       );
     }
   },

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,84 @@
+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);
+    const binary = await helper.which('vitest');
+
+    await run(`${binary} ${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,21 @@
-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,
-  },
-  plugins: ['jest', 'jsdoc', 'prettier'],
+  plugins: ['jsdoc', 'prettier'],
   rules: {
     'dot-notation': ['error'],
     'max-len': [
@@ -63,33 +57,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 +87,58 @@ 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,
+        ftest: false,
+        fdescribe: false,
+        xit: false,
+        xtest: false,
+        xdescribe: false,
+
+        captureOutput: false,
+        dedent: false,
+      },
+      extends: [
+        'plugin:vitest/recommended',
+        'plugin:vitest-globals/recommended',
+      ],
+      rules: {
+        'no-restricted-globals': [
+          'warn',
+          {
+            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
     {