aberlaas 2.8.0 → 2.10.0

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();
-});

package/helper.js

@@ -1,115 +0,0 @@
-import path from 'path';
-import * as url from 'url';
-import { _ } from 'golgoth';
-import { glob } from 'firost';
-import findUp from 'find-up';
-
-export default {
-  /**
-   * Return absolute path to the host dir
-   * @returns {string} Absolute path to host dir
-   **/
-  hostRoot() {
-    return process.cwd();
-  },
-  /**
-   * Return an absolute path to a file in the host
-   * @param {string} relativePath Relative path from the host root
-   * @returns {string} Absolute path to the host file
-   **/
-  hostPath(relativePath = '') {
-    return path.resolve(this.hostRoot(), relativePath);
-  },
-  /**
-   * Return absolute path to the aberlaas directory
-   * @returns {string} Absolute path to aberlaas dir
-   **/
-  aberlaasRoot() {
-    return url.fileURLToPath(new URL('.', import.meta.url));
-  },
-  /**
-   * Return an absolute path to a file in the aberlaas directory
-   * @param {string} relativePath Relative path from the aberlaas root
-   * @returns {string} Absolute path to the aberlaas file
-   **/
-  aberlaasPath(relativePath = '') {
-    return path.resolve(this.aberlaasRoot(), relativePath);
-  },
-  /**
-   * Find files in host directory following glob patterns. Will exclude some
-   * directories by default, and allow specifying only specific file extensions
-   * @param {Array} userPattern Patterns to match
-   * @param {Array} safeExtensions Optional array of extensions to safelist. If
-   * set, only files of this extensions will be returned
-   * @returns {Array} Array of files matching the patterns
-   **/
-  async findHostFiles(userPattern, safeExtensions = []) {
-    const patterns = _.castArray(userPattern);
-    // Making all path relative to the host
-    const globs = _.map(patterns, (pattern) => {
-      return this.hostPath(pattern);
-    });
-
-    // Exclude folders that shouldn't be included
-    const blockedFolders = [
-      'build',
-      'dist',
-      'fixtures',
-      'node_modules',
-      'tmp',
-      'vendors',
-      '.git',
-      '.yarn',
-    ];
-    _.each(blockedFolders, (blockedFolder) => {
-      const deepFolder = `**/${blockedFolder}/**`;
-      globs.push(`!${this.hostPath(deepFolder)}`);
-    });
-
-    // Expanding globs
-    let allFiles = await glob(globs, { directories: false });
-
-    if (_.isEmpty(safeExtensions)) {
-      return allFiles;
-    }
-
-    // Keep only files of specified extensions
-    allFiles = _.filter(allFiles, (filepath) => {
-      const extension = path.extname(filepath);
-      const extensionWithoutDot = _.replace(extension, '.', '');
-      return (
-        _.includes(safeExtensions, extension) ||
-        _.includes(safeExtensions, extensionWithoutDot)
-      );
-    });
-
-    return allFiles;
-  },
-  /**
-   * Guess a path to a config file by first checking the specific path, then the
-   * host folder and finally fallbacking on the aberlaas default
-   * @param {string} userPath User specific config file
-   * @param {string} upFile File to look for up the directory tree
-   * @param {string} aberlaasPath Path to the aberlaas default file, relative to the aberlaas directory
-   * @returns {string} Path to config file
-   **/
-  async configFile(userPath, upFile, aberlaasPath) {
-    // Taking value from --config in CLI in priority
-    if (userPath) {
-      return this.hostPath(userPath);
-    }
-
-    // Checking for custom config in the host
-    if (upFile) {
-      const upPath = await findUp(upFile, {
-        cwd: this.hostRoot(),
-      });
-      if (upPath) {
-        return upPath;
-      }
-    }
-
-    // Fallback on default config in aberlaas
-    return this.aberlaasPath(aberlaasPath);
-  },
-};

package/templates/LICENSE

@@ -1,9 +0,0 @@
-MIT License
-
-Copyright (c) {author}
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/templates/_circleci/config.yml

@@ -1,33 +0,0 @@
-version: 2.1
-
-aliases:
-  - &defaults
-    docker:
-      - image: cimg/node:18.18.0
-  - &restore_cache
-    restore_cache:
-      key: yarn-cache-{{ checksum "yarn.lock" }}
-  - &yarn_install
-    run: 'yarn install'
-  - &save_cache
-    save_cache:
-      key: yarn-cache-{{ checksum "yarn.lock" }}
-      paths:
-        - ~/.cache/yarn
-
-jobs:
-  ci:
-    <<: *defaults
-    steps:
-      - checkout
-      - *restore_cache
-      - *yarn_install
-      - *save_cache
-      - run: 'yarn run ci'
-
-workflows:
-  version: 2
-  # On every commit
-  commit:
-    jobs:
-      - ci