aberlaas 2.9.0 → 2.11.0

package/commands/setup/helpers/circleci.js

@@ -1,43 +0,0 @@
-import { _, got } from 'golgoth';
-import { firostError } from 'firost';
-
-export default {
-  /**
-   * Returns the CircleCI token saved in ENV
-   * @returns {string} The CircleCI token
-   **/
-  token() {
-    return process.env.CIRCLECI_TOKEN;
-  },
-  /**
-   * Check if a CircleCI token is available
-   * @returns {boolean} True if a token is defined
-   **/
-  hasToken() {
-    return !!this.token();
-  },
-  /**
-   * Make a call to the CircleCI v1 API
-   * @param {string} urlPath Part of the url after the /api/v1.1/
-   * @param {object} userGotOptions Options to pass to the got call
-   * @returns {object} Object returned by the API
-   **/
-  async api(urlPath, userGotOptions = {}) {
-    const token = this.token();
-    const apiUrl = `https://circleci.com/api/v1.1/${urlPath}?circle-token=${token}`;
-    const defaultGotOptions = {
-      responseType: 'json',
-    };
-    const gotOptions = _.merge({}, defaultGotOptions, userGotOptions);
-    try {
-      const response = await this.__got(apiUrl, gotOptions);
-      return response.body;
-    } catch (error) {
-      throw firostError(
-        'ERROR_CIRCLECI',
-        "Can't connect to CircleCI API. Check that you have a valid CIRCLECI_TOKEN",
-      );
-    }
-  },
-  __got: got,
-};

package/commands/setup/helpers/github.js

@@ -1,72 +0,0 @@
-import { run } from 'firost';
-import { Octokit } from '@octokit/rest';
-import parseGithubUrl from 'parse-github-repo-url';
-import { _ } from 'golgoth';
-
-export default {
-  /**
-   * Returns the GitHub token saved in ENV
-   * @returns {string} The GitHub token
-   **/
-  token() {
-    return process.env.GITHUB_TOKEN;
-  },
-  /**
-   * Check if a GitHub token is available
-   * @returns {boolean} True if a token is defined
-   **/
-  hasToken() {
-    return !!this.token();
-  },
-  /**
-   * Returns some data from the git config
-   * @returns {object} Object with .username, .repo and .email keys
-   **/
-  async repoData() {
-    if (this.__cache.repoData) {
-      return this.__cache.repoData;
-    }
-
-    const email = await this.config('user.email');
-    const remoteUrl = await this.config('remote.origin.url');
-    const [username, repo] = parseGithubUrl(remoteUrl);
-
-    const result = { username, repo, email };
-    this.__cache.githubData = result;
-    return result;
-  },
-  /**
-   * Return the value of a git config
-   * @param {string} key Config key
-   * @returns {string} Config value
-   **/
-  async config(key) {
-    const response = await this.__run(`git config ${key}`, {
-      stdout: false,
-    });
-    return response.stdout;
-  },
-  /**
-   * Wraps Octokit and return the results
-   * @param {string} methodPath Path of the method to call
-   * @param {object} options Options to pass to the method
-   * @returns {*} Response from the API
-   **/
-  async octokit(methodPath, options) {
-    // Instanciate Octokit if not available
-    if (!this.__cache.octokit) {
-      const githubToken = this.token();
-      this.__cache.octokit = new this.__Octokit({
-        auth: githubToken,
-      });
-    }
-
-    const octokit = this.__cache.octokit;
-    const method = _.get(octokit, methodPath);
-    const response = await method(options);
-    return response.data;
-  },
-  __run: run,
-  __Octokit: Octokit,
-  __cache: {},
-};

package/commands/setup/helpers/npm.js

@@ -1,16 +0,0 @@
-export default {
-  /**
-   * Returns the npm token saved in ENV
-   * @returns {string} The npm token
-   **/
-  token() {
-    return process.env.NPM_TOKEN;
-  },
-  /**
-   * Check if a npm token is available
-   * @returns {boolean} True if a token is defined
-   **/
-  hasToken() {
-    return !!this.token();
-  },
-};

package/commands/setup/helpers/ssh.js

@@ -1,77 +0,0 @@
-import path from 'path';
-import { _ } from 'golgoth';
-import { exists, mkdirp, read, run, which } from 'firost';
-import helper from '../../../helper.js';
-import githubHelper from './github.js';
-
-export default {
-  /**
-   * Check if ssh-keygen is available
-   * @returns {boolean} True if available, false otherwise
-   **/
-  async hasBinary() {
-    const sshKeygenPath = await this.__which('ssh-keygen');
-    return !!sshKeygenPath;
-  },
-  /**
-   * Returns SSH keys (generate them if needed)
-   * @returns {object} Object with .public, .private and .privateFingerprint
-   **/
-  async getKeys() {
-    const keyPath = helper.hostPath('./tmp/ssh/key');
-
-    // Generating keys if do not exist
-    const keyExists = await exists(keyPath);
-    if (!keyExists) {
-      await this.generateKeys(keyPath);
-    }
-
-    const publicKeyPath = `${keyPath}.pub`;
-    const publicKey = await read(publicKeyPath);
-    const privateKey = await read(keyPath);
-    const privateFingerprint = await this.getFingerprint(keyPath);
-
-    return {
-      public: publicKey,
-      private: privateKey,
-      privateFingerprint,
-    };
-  },
-  /**
-   * Generate SSH keys
-   * @param {string} keyPath Path to the public key
-   **/
-  async generateKeys(keyPath) {
-    const keyDirectory = path.dirname(keyPath);
-    await mkdirp(keyDirectory);
-    const { email: keyEmail } = await githubHelper.repoData();
-    const sshKeygenArguments = [
-      '-m PEM',
-      '-t rsa',
-      `-C ${keyEmail}`,
-      `-f ${keyPath}`,
-      "-N ''",
-    ];
-    const command = `ssh-keygen ${sshKeygenArguments.join(' ')}`;
-    // Need to run in shell mode, otherwise does not understand the empty
-    // passphrase
-    await this.__run(command, { shell: true, stdout: false });
-  },
-  /**
-   * Returns the md5 fingerprint from a key path
-   * @param {string} keyPath Filepath to the key file
-   * @returns {string} Fingerprint as used by CircleCI and GitHub
-   **/
-  async getFingerprint(keyPath) {
-    const command = `ssh-keygen -E md5 -l -f ${keyPath}`;
-    const result = await this.__run(command, { stdout: false });
-    return _.chain(result)
-      .get('stdout')
-      .split(' ')
-      .nth(1)
-      .replace('MD5:', '')
-      .value();
-  },
-  __which: which,
-  __run: run,
-};

package/commands/setup/index.js

@@ -1,52 +0,0 @@
-import { _ } from 'golgoth';
-import github from './github.js';
-import circleci from './circleci.js';
-import renovate from './renovate.js';
-
-export default {
-  /**
-   * Enable external services.
-   * Will enable CircleCI, GitHub and Renovate by default.
-   * @param {object} cliArgs CLI Argument object, as created by minimist
-   **/
-  async run(cliArgs = {}) {
-    const defaultServices = {
-      circleci: true,
-      renovate: true,
-      github: true,
-    };
-    const cliServices = _.omit(cliArgs, ['_']);
-    const servicesToEnable = {
-      ...defaultServices,
-      ...cliServices,
-    };
-
-    if (servicesToEnable.github) {
-      await this.github();
-    }
-    if (servicesToEnable.circleci) {
-      await this.circleci();
-    }
-    if (servicesToEnable.renovate) {
-      await this.renovate();
-    }
-  },
-  /**
-   * Configure GitHub
-   **/
-  async github() {
-    await github.enable();
-  },
-  /**
-   * Enable CircleCI
-   **/
-  async circleci() {
-    await circleci.enable();
-  },
-  /**
-   * Enable renovate
-   **/
-  async renovate() {
-    await renovate.enable();
-  },
-};

package/commands/setup/renovate.js

@@ -1,54 +0,0 @@
-import { consoleError, consoleSuccess } from 'firost';
-import githubHelper from './helpers/github.js';
-
-export default {
-  renovateId: 2471197,
-  /**
-   * Returns the GitHub repository Id
-   * @returns {number} Repository Id
-   **/
-  async getRepositoryId() {
-    const { username, repo } = await githubHelper.repoData();
-    const { id } = await githubHelper.octokit('repos.get', {
-      owner: username,
-      repo,
-    });
-    return id;
-  },
-  /**
-   * Attempt to automatically add the current repo to renovate, otherwise
-   * display the link to do it manually
-   * @returns {boolean} True if enabled, false otherwise
-   **/
-  async enable() {
-    const { username, repo } = await githubHelper.repoData();
-    const manualUrl = `https://github.com/settings/installations/${this.renovateId}`;
-    const renovateDashboardUrl = `https://app.renovatebot.com/dashboard#github/${username}/${repo}`;
-
-    // Fail early if no token available
-    if (!githubHelper.hasToken()) {
-      this.__consoleError(
-        `[renovate]: No GITHUB_TOKEN found, please visit ${manualUrl} to enable manually.`,
-      );
-      return false;
-    }
-
-    try {
-      const repositoryId = await this.getRepositoryId();
-      await githubHelper.octokit('apps.addRepoToInstallation', {
-        installation_id: this.renovateId,
-        repository_id: repositoryId,
-      });
-    } catch (err) {
-      this.__consoleError(
-        `Renovate is not installed with this GitHub account, please visit ${manualUrl} to install it first.`,
-      );
-      return false;
-    }
-
-    this.__consoleSuccess(`Renovate enabled: ${renovateDashboardUrl}`);
-    return true;
-  },
-  __consoleSuccess: consoleSuccess,
-  __consoleError: consoleError,
-};

package/commands/test/index.js

@@ -1,124 +0,0 @@
-import { createVitest, registerConsoleShortcuts } from 'vitest/node';
-import { firostError, firostImport } from 'firost';
-import { _ } from 'golgoth';
-import helper from '../../helper.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.vitestOptions(cliArgs);
-    const isWatchMode = !!options.watch;
-    const isRelatedMode = options.related?.length > 0;
-    let files = _.isEmpty(cliArgs._) ? [helper.hostPath()] : cliArgs._;
-    // If --related is passed, the list of files will already by in the .related
-    // key, and need to be removed from the files
-    if (isRelatedMode) files = [];
-
-    // Vitest will change process.exitCode, so we save it to revert it later
-    const initialExitCode = process.exitCode;
-
-    const vitest = await createVitest('test', options);
-
-    // Enable keyboard interaction in watch mode
-    if (isWatchMode) {
-      registerConsoleShortcuts(vitest);
-    }
-
-    try {
-      await vitest.start(files);
-    } catch (err) {
-      // We can safely swallow the VITEST_FILES_NOT_FOUND error. It's ok to
-      // continue if no files are found
-      if (err.code != 'VITEST_FILES_NOT_FOUND') {
-        throw err;
-      }
-    }
-
-    const testsAreFailing = process.exitCode == 1;
-    process.exitCode = initialExitCode;
-
-    if (isWatchMode) {
-      return;
-    }
-
-    // Stop vitest, it doesn't stop itself by default
-    await vitest.close();
-
-    if (testsAreFailing) {
-      throw firostError('ERROR_TEST_FAIL', 'Tests are failing');
-    }
-
-    return true;
-  },
-
-  /**
-   * Transform all aberlaas test cli options into suitable vitest options
-   * @param {object} cliArgs CLI Argument object, as created by minimist
-   * @returns {Array} Array of options for vitest
-   **/
-  async vitestOptions(cliArgs = {}) {
-    // Options that have special meaning in aberlaas and shouldn't be passed
-    // as-is to vitest
-    const specialMeaningCliArgs = [
-      '_',
-      'config',
-      'failFast',
-      'related',
-      'exclude',
-    ];
-
-    // Reading base options from the config file
-    const configFile = await helper.configFile(
-      cliArgs.config,
-      'vite.config.js',
-      'configs/vite.js',
-    );
-    const optionsFromConfig = (await firostImport(configFile)).test;
-
-    // Enhancing options with custom CLI arguments
-    const optionsFromAberlaas = {
-      // We always allow fit/fdescribe, even in CI. Those errors will be caught
-      // by the lint command instead
-      allowOnly: true,
-    };
-    // --failFast stops early as soon as one test fails
-    if (cliArgs.failFast) {
-      optionsFromAberlaas.bail = 1;
-    }
-    // --related runs also related files
-    // Note (2024-10-01): The related option is not documented, but should
-    // contain the list of files.
-    if (cliArgs.related) {
-      optionsFromAberlaas.related = cliArgs._;
-    }
-    // --exclude arguments should be added to the existing list of exclude
-    // patterns
-    // TODO: Add test for that
-    if (cliArgs.exclude) {
-      optionsFromAberlaas.exclude = [
-        ...optionsFromConfig.exclude,
-        cliArgs.exclude,
-      ];
-    }
-
-    // Passing other CLI options directly to vitest
-    const optionsFromCli = _.omit(cliArgs, specialMeaningCliArgs);
-
-    return {
-      ...optionsFromConfig,
-      ...optionsFromAberlaas,
-      ...optionsFromCli,
-    };
-  },
-};

package/configs/eslint.cjs

@@ -1,154 +0,0 @@
-// Note: ESLint doesn't support ESM configuration as of 2024-02-19. This file
-// needs to stay as a CommonJS file
-const nodeConfig = require('./node.cjs');
-
-module.exports = {
-  env: { browser: true, es2023: true, node: true },
-  parserOptions: { sourceType: 'module', ecmaVersion: 'latest' },
-  extends: [
-    'eslint:recommended',
-    'plugin:n/recommended',
-    'plugin:import/recommended',
-    'plugin:prettier/recommended',
-  ],
-  settings: {
-    // eslint-plugin-import doesn't currently support the "exports" syntax in
-    // package.json. This is supposed to 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: ['jsdoc', 'prettier'],
-  rules: {
-    'dot-notation': ['error'],
-    'max-len': [
-      'error',
-      {
-        code: 80,
-        ignoreComments: true,
-        ignoreRegExpLiterals: true,
-        ignoreStrings: true,
-        ignoreTemplateLiterals: true,
-        ignoreTrailingComments: true,
-        ignoreUrls: true,
-        // Ignore long lines in test headers, allowing us to write descriptive
-        // tests
-        ignorePattern: '^\\s*it\\(',
-      },
-    ],
-    'no-console': ['off'],
-    'no-irregular-whitespace': ['error', { skipRegExps: true }],
-    'no-restricted-properties': [
-      'error',
-      {
-        object: 'module',
-        property: 'export',
-        message: 'Typo: Use module.exports instead',
-      },
-      {
-        object: '_',
-        property: 'contains',
-        message: 'Typo: Use _.includes instead',
-      },
-    ],
-    'no-unused-vars': [
-      'error',
-      { argsIgnorePattern: '^_.', varsIgnorePattern: '^_.' },
-    ],
-    'no-shadow': ['error'],
-    'object-shorthand': ['error', 'always'],
-    // TODO: Should be updated to consistent-as-needed when
-    // https://github.com/prettier/prettier/issues/6064 is fixed
-    'quote-props': ['error', 'as-needed'],
-    quotes: ['error', 'single', { avoidEscape: true }],
-    // Used to sort the members inside an import statement
-    // Example:
-    // import { foo, bar } from 'something';
-    // => import { bar, foo } from 'something'
-    'sort-imports': ['error', { ignoreDeclarationSort: true }],
-    // Node
-    'n/no-unsupported-features/es-syntax': [
-      'error',
-      { version: `>=${nodeConfig.nodeVersion}` },
-    ],
-    // Import
-    'import/first': ['error'],
-    'import/no-cycle': ['error'],
-    'import/order': ['error'],
-    'import/newline-after-import': ['error'],
-    // JSDoc
-    'jsdoc/check-param-names': ['warn'],
-    'jsdoc/check-types': ['warn'],
-    'jsdoc/no-undefined-types': ['warn'],
-    'jsdoc/check-alignment': ['warn'],
-    'jsdoc/check-examples': ['off'],
-    'jsdoc/check-syntax': ['warn'],
-    'jsdoc/check-tag-names': ['warn'],
-    'jsdoc/require-jsdoc': ['warn'],
-    'jsdoc/require-param': ['warn'],
-    'jsdoc/require-param-description': ['warn'],
-    'jsdoc/require-param-name': ['warn'],
-    'jsdoc/require-param-type': ['warn'],
-    'jsdoc/require-returns': ['warn'],
-    'jsdoc/require-returns-check': ['warn'],
-    'jsdoc/require-returns-description': ['warn'],
-    'jsdoc/require-returns-type': ['warn'],
-    'jsdoc/valid-types': ['warn'],
-    // Prettier
-    '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' },
-        ],
-        // In tests, we like to have the variable 'current' hold the object
-        // under test. The import/no-named-as-default-member would have warned
-        // us about using current.foo rather than foo directly, so we disable
-        // it.
-        'import/no-named-as-default-member': ['off'],
-        '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
-    { files: ['**/scripts/**/*.js'], rules: { 'no-process-exit': ['off'] } },
-  ],
-};

package/configs/node.cjs

@@ -1,9 +0,0 @@
-// 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
-  yarnVersion: '4.0.2',
-  norskaVersion: '2.9.0',
-  norskaThemeDocsVersion: '5.0.3',
-  lernaVersion: '4.0.0',
-};

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

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

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

@@ -1,4 +0,0 @@
-// 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

@@ -1,13 +0,0 @@
-/**
- * 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

@@ -1,10 +0,0 @@
-// 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

@@ -1,9 +0,0 @@
-/* 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();
-});