aberlaas 2.1.0 → 2.3.0

package/commands/ci/autoRelease.js

@@ -1,143 +0,0 @@
-import release from '../release/index.js';
-import consoleInfo from 'firost/consoleInfo.js';
-import _ from 'golgoth/lodash.js';
-import run from 'firost/run.js';
-import write from 'firost/write.js';
-import exists from 'firost/exists.js';
-import helper from '../../helper.js';
-
-export default {
-  /**
-   * Run a git command in the repo
-   *
-   * @param {string} gitCommand Git command to run
-   * @returns {string} Command output
-   */
-  async gitRun(gitCommand) {
-    const repoPath = helper.hostPath();
-    const result = await run(`cd ${repoPath} && ${gitCommand}`, {
-      shell: true,
-      stdout: false,
-    });
-    return result.stdout;
-  },
-  /**
-   * Set a git config value only if wasn't set before
-   * @param {string} name Name of the config
-   * @param {string} value Value of the config
-   **/
-  async gitConfigSet(name, value) {
-    // We test to see if there is already a value. If no, we write it
-    try {
-      await this.gitRun(`git config ${name}`);
-    } catch (err) {
-      await this.gitRun(`git config ${name} ${value}`);
-    }
-  },
-  /**
-   * Returns the latest tag of the repo
-   *
-   * @returns {string} Latest tag
-   **/
-  async gitGetLatestTag() {
-    const allTags = await this.gitRun('git tag -l --sort=creatordate');
-    return _.chain(allTags).split('\n').last().value();
-  },
-  /**
-   * Returns an array of all commit description since last release
-   *
-   * @returns {Array} List of all commit description
-   **/
-  async getCommitsSinceLastRelease() {
-    const latestTag = await this.gitGetLatestTag();
-    const range = latestTag ? `${latestTag}..HEAD` : 'HEAD';
-    const commitList = await this.gitRun(`git log ${range} --format=%B`);
-    return _.chain(commitList).split('\n').compact().reverse().value();
-  },
-  /**
-   * Determines what version should be released based on the commits since the
-   * last release
-   * @returns {string|boolean} False if no release, otherwise minor or patch
-   **/
-  async getReleaseVersion() {
-    const commits = await this.getCommitsSinceLastRelease();
-    const status = {
-      isMinor: false,
-      isPatch: false,
-    };
-    _.each(commits, (commit) => {
-      const isMinor = _.startsWith(commit, 'feat(');
-      const isPatch = _.startsWith(commit, 'fix(');
-      status.isMinor = status.isMinor || isMinor;
-      status.isPatch = status.isPatch || isPatch;
-    });
-
-    if (status.isMinor) {
-      return 'minor';
-    }
-    if (status.isPatch) {
-      return 'patch';
-    }
-    return false;
-  },
-  /**
-   * Run the auto-release script.
-   * If there had been any feat() of fix() commits since last release,
-   * automatically release a new one
-   **/
-  async run() {
-    this.__consoleInfo('Attempt to auto-release...');
-
-    const releaseVersion = await this.getReleaseVersion();
-    // Don't release if no relevant changes
-    if (!releaseVersion) {
-      this.__consoleInfo('No relevant commits since last release.');
-      return;
-    }
-
-    this.__consoleInfo(`Releasing a ${releaseVersion} version`);
-    await this.configureGit();
-    await this.configureNpm();
-
-    const releaseArguments = {
-      _: [releaseVersion],
-      test: false,
-    };
-    await this.__releaseRun(releaseArguments);
-  },
-  /**
-   * Set git user name and email
-   * */
-  async configureGit() {
-    const email = this.getEnvVar('GIT_USER_EMAIL');
-    const name = this.getEnvVar('GIT_USER_NAME');
-    await this.gitConfigSet('user.email', email);
-    await this.gitConfigSet('user.name', name);
-  },
-  /**
-   * Write a ~/.npmrc with the token
-   * @returns {boolean} true on success, false if already a .npmrc
-   **/
-  async configureNpm() {
-    const npmRcPath = '~/.npmrc';
-    if (await this.__exists(npmRcPath)) {
-      return false;
-    }
-    const token = this.getEnvVar('NPM_TOKEN');
-    const content = `//registry.npmjs.org/:_authToken=${token}`;
-    await this.__write(content, npmRcPath);
-    return true;
-  },
-  /**
-   * Return an ENV var value
-   * @param {string} key ENV var key
-   * @returns {string} ENV var value
-   **/
-  getEnvVar(key) {
-    return _.get(process, `env.${key}`);
-  },
-  __releaseRun: release.run.bind(release),
-  __consoleInfo: consoleInfo,
-  __write: write,
-  __exists: exists,
-};

package/commands/release/index.js

@@ -1,76 +0,0 @@
-import _ from 'golgoth/lodash.js';
-import run from 'firost/run.js';
-import readJson from 'firost/readJson.js';
-import helper from '../../helper.js';
-
-export default {
-  /**
-   * Release the host package.
-   * @param {object} cliArgs CLI Argument object, as created by minimist
-   * @returns {boolean} True on success, false otherwise
-   **/
-  async run(cliArgs = {}) {
-    this.fixNpmRegistry();
-    await this.fetchOrigin();
-
-    const binary = await helper.which('np');
-    const npOptions = await this.getNpArguments(cliArgs);
-    const command = `FORCE_COLOR=1 ${binary} ${npOptions}`;
-    await this.__run(command, {
-      stdin: true,
-      shell: true,
-    });
-  },
-  /**
-   * Returns the CLI options to pass to np
-   * @param {object} cliArgs CLI Argument object, as created by minimist
-   * @returns {string} Arguments to pass to np
-   **/
-  async getNpArguments(cliArgs = {}) {
-    const options = [
-      cliArgs._,
-      '--no-release-draft',
-      '--no-2fa',
-      '--any-branch',
-    ];
-    const packageJson = await this.getHostPackageJson();
-
-    // Skip tests if called with --no-test or if no scripts.test entry
-    const cliTestStatus = _.get(cliArgs, 'test', true);
-    const cliPackageStatus = _.get(packageJson, 'scripts.test', false);
-    if (!cliTestStatus || !cliPackageStatus) {
-      options.push('--no-tests');
-    }
-
-    // Run in preview mode if --dry-run is set
-    const isDryRun = _.get(cliArgs, 'dry-run', false);
-    if (isDryRun) {
-      options.push('--preview');
-    }
-
-    return _.chain(options).compact().join(' ').value();
-  },
-  /**
-   * Yarn changes the npm_config_registry value, preventing npm publish to
-   * actually work. We revert it to its default value for publishing to work
-   **/
-  fixNpmRegistry() {
-    // eslint-disable-next-line camelcase
-    process.env.npm_config_registry = 'https://registry.npmjs.org/';
-  },
-  /**
-   * Fetches origin information, so np can correctly keep the branch up to date
-   **/
-  async fetchOrigin() {
-    await this.__run('git fetch --all', { stdout: false });
-  },
-  /**
-   * Returns the content of the host package.json
-   * @returns {object} The content of the host package.json
-   **/
-  async getHostPackageJson() {
-    return await this.__readJson(helper.hostPath('package.json'));
-  },
-  __run: run,
-  __readJson: readJson,
-};

package/commands/setup/autoRelease/envVars.js

@@ -1,56 +0,0 @@
-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
-   * @param {string} value Value of the ENV variable
-   **/
-  async saveEnvVar(name, value) {
-    const { username, repo } = await githubHelper.repoData();
-    try {
-      await circleciHelper.api(
-        `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
-    }
-    await circleciHelper.api(`project/github/${username}/${repo}/envvar`, {
-      method: 'post',
-      json: {
-        name,
-        value,
-      },
-    });
-    this.__consoleSuccess(`${name} saved on CircleCI`);
-  },
-  /**
-   * Save ENV Variables to CircleCI
-   **/
-  async enable() {
-    // Vars to save
-    const npmToken = npmHelper.token();
-    const gitUserEmail = await githubHelper.config('user.email');
-    const gitUserName = await githubHelper.config('user.name');
-    const vars = [
-      { name: 'NPM_TOKEN', value: npmToken },
-      { name: 'GIT_USER_EMAIL', value: gitUserEmail },
-      { name: 'GIT_USER_NAME', value: gitUserName },
-    ];
-
-    // Saving them in parallel
-    await pMap(vars, async ({ name, value }) => {
-      await this.saveEnvVar(name, value);
-    });
-  },
-  __consoleInfo: consoleInfo,
-  __consoleSuccess: consoleSuccess,
-};

package/commands/setup/autoRelease/index.js

@@ -1,59 +0,0 @@
-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
-   **/
-  async enable() {
-    // Fail early if we're missing the required tokens
-    const validationErrors = await this.validationErrors();
-    if (!_.isEmpty(validationErrors)) {
-      this.__consoleError(
-        '[autoRelease] Please fix the following errors and try again:',
-      );
-      _.each(validationErrors, (error) => {
-        this.__consoleError(error);
-      });
-      return false;
-    }
-
-    await this.__envVarsEnable();
-    await this.__privateKeyEnable();
-    await this.__publicKeyEnable();
-  },
-  /**
-   * Returns an array of error messages for every token/binary missing
-   * @returns {Array} List of error messages
-   **/
-  async validationErrors() {
-    const validationErrors = [];
-    if (!circleciHelper.hasToken()) {
-      validationErrors.push('You need a CIRCLECI_TOKEN');
-    }
-    if (!npmHelper.hasToken()) {
-      validationErrors.push('You need a NPM_TOKEN');
-    }
-    if (!githubHelper.hasToken()) {
-      validationErrors.push('You need a GITHUB_TOKEN');
-    }
-    if (!sshHelper.hasBinary()) {
-      validationErrors.push('You need ssh-keygen available in your $PATH');
-    }
-
-    return validationErrors;
-  },
-  __consoleError: consoleError,
-  __envVarsEnable: envVars.enable.bind(envVars),
-  __privateKeyEnable: privateKey.enable.bind(privateKey),
-  __publicKeyEnable: publicKey.enable.bind(publicKey),
-  __cache: {},
-};

package/commands/setup/autoRelease/privateKey.js

@@ -1,41 +0,0 @@
-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,
-   * so we will need to re-add it each time. But to avoid creating duplicates,
-   * we will delete any key with the same fingerprint first
-   **/
-  async enable() {
-    const keys = await sshHelper.getKeys();
-    const privateKey = keys.private;
-    const privateFingerprint = keys.privateFingerprint;
-    const { username, repo } = await githubHelper.repoData();
-    const hostname = 'github.com';
-
-    // Delete it first
-    await circleciHelper.api(`project/github/${username}/${repo}/ssh-key`, {
-      method: 'delete',
-      json: {
-        fingerprint: privateFingerprint,
-        hostname,
-      },
-    });
-
-    // Then, add it
-    await circleciHelper.api(`project/github/${username}/${repo}/ssh-key`, {
-      method: 'post',
-      json: {
-        hostname,
-        private_key: privateKey,
-      },
-    });
-
-    this.__consoleSuccess('SSH private key force saved on CircleCI');
-  },
-  __consoleSuccess: consoleSuccess,
-};

package/commands/setup/autoRelease/publicKey.js

@@ -1,55 +0,0 @@
-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
-   **/
-  async isEnabled() {
-    const { username: owner, repo } = await githubHelper.repoData();
-    const keys = await githubHelper.octokit('repos.listDeployKeys', {
-      owner,
-      repo,
-    });
-    const { public: publicKey } = await sshHelper.getKeys();
-    // GitHub does not save the email as part of the key, so we shave it off our
-    // key
-    const truncatedKey = _.chain(publicKey)
-      .split(' ')
-      .slice(0, 2)
-      .join(' ')
-      .value();
-
-    const foundKey = _.find(keys, { key: truncatedKey });
-    return !!foundKey;
-  },
-  /**
-   * Add the SSH public key to GitHub
-   * @returns {boolean} True on success
-   **/
-  async enable() {
-    if (await this.isEnabled()) {
-      this.__consoleInfo('SSH public key already saved on GitHub');
-      return true;
-    }
-    const { public: key } = await sshHelper.getKeys();
-    const { username: owner, repo } = await githubHelper.repoData();
-    await githubHelper.octokit('repos.createDeployKey', {
-      owner,
-      repo,
-      key,
-      title: 'aberlaas - Push from CircleCI',
-      read_only: false,
-    });
-    this.__consoleSuccess('SSH public key saved on GitHub');
-    return true;
-  },
-  __consoleInfo: consoleInfo,
-  __consoleSuccess: consoleSuccess,
-  __consoleError: consoleError,
-};

package/configs/jest/index.cjs

@@ -1,52 +0,0 @@
-const path = require('path');
-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,
-
-  // Use additional Jest plugins
-  setupFilesAfterEnv: [jestExtendedPath, setupFileAfterEnv],
-
-  // We need to set rootDir to the host directory, otherwise Jest will assume
-  // test are to be looked for in the directory that contains the config (ie.
-  // aberlaas).
-  rootDir: process.cwd(),
-
-  // Tests should be in a __tests__ folder
-  testMatch: ['**/__tests__/**/*.js?(x)'],
-
-  // By default watch mode watches for changes in all directories, and whenever
-  // a test file or associated code file changes, it re-runs tests.
-  // This can cause useless re-render of tests when it catches changes in
-  // directories like ./tmp, etc, so we exclude such directories
-  // watchPathIgnorePatterns only accept RegExp and not globs, so we have to
-  // deal with ((.*)/)? to express any depth of folders
-  watchPathIgnorePatterns: [
-    '<rootDir>/((.*)/)?node_modules/',
-    '<rootDir>/((.*)/)?tmp/',
-    '<rootDir>/((.*)/)?templates/',
-  ],
-  testPathIgnorePatterns: [
-    '<rootDir>/((.*)/)?fixtures/',
-    '<rootDir>/((.*)/)?tmp/',
-    '<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',
-  // },
-
-  // Make sure we don't transform source code and use the default ESM code
-  transform: {},
-
-  bail: true,
-
-  resetMocks: true,
-  restoreMocks: true,
-};

package/configs/jest/jest-extended.cjs

@@ -1,3 +0,0 @@
-// This is a proxy to make sure we load the plugin no matter where it is
-// installed
-module.exports = require('jest-extended');

package/configs/jest/setupFileAfterEnv.cjs

@@ -1,13 +0,0 @@
-/* eslint-disable jest/no-jasmine-globals,no-global-assign */
-const captureOutput = require('firost/captureOutput');
-const dedent = require('dedent');
-
-/**
- * Add new globals to each test file:
- * - captureOutput accepts a callback that will be executed with all output
- *   silenced and returned instead
- * - dedent (https://github.com/dmnd/dedent) to enter multiline strings without
- *   the indentation
- **/
-global.captureOutput = captureOutput;
-global.dedent = dedent;

package/configs/jest/sharedState.cjs

@@ -1,14 +0,0 @@
-/**
- * Jest environments are sandboxed by test suite. To be able to fail fast and
- * stop all tests as soon as one of them failed, we are using this file as an
- * external singleton.
- **/
-module.exports = {
-  __skipAllTests: false,
-  skipAllTests() {
-    this.__skipAllTests = true;
-  },
-  shouldSkipAllTests() {
-    return this.__skipAllTests;
-  },
-};

package/configs/jest/testEnvironment.cjs

@@ -1,46 +0,0 @@
-const NodeEnvironment = require('jest-environment-node');
-const shouldFailFast = process.env.ABERLAAS_TEST_FAIL_FAST;
-const sharedState = require('./sharedState.cjs');
-
-class AberlaasEnvironment extends NodeEnvironment {
-  async handleTestEvent(event, _state) {
-    this.failFast(event);
-    this.setTestName(event);
-  }
-  /**
-   * If one test fails, we skip all other tests
-   * @param {object} event As fired by handleTestEvent
-   */
-  failFast(event) {
-    // Do nothing if --failFast is not passed
-    if (!shouldFailFast) {
-      return;
-    }
-
-    // Whenever a test is failing, we update the shared state to skip all other
-    // tests
-    const eventName = event.name;
-    const isTestFailing = eventName == 'test_fn_failure';
-    const isTestStarting = eventName === 'test_start';
-
-    if (isTestFailing) {
-      sharedState.skipAllTests();
-    }
-    if (isTestStarting && sharedState.shouldSkipAllTests()) {
-      event.test.mode = 'skip';
-    }
-  }
-  /**
-   * When a test starts, we set the global variable testName to the name of the
-   * test
-   * @param {object} event As fired by handleTestEvent
-   **/
-  setTestName(event) {
-    const eventName = event.name;
-    if (eventName === 'test_start') {
-      this.global.testName = event.test.name;
-    }
-  }
-}
-
-module.exports = AberlaasEnvironment;

package/configs/jest.cjs

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

package/configs/lintstaged.cjs

@@ -1,25 +0,0 @@
-const pkg = require(`${process.cwd()}/package.json`);
-
-// We update the README.md and ./lib/README.md whenever documentation changes
-const aberlaasRunCommands = [
-  'yarn run aberlaas readme',
-  'git add ./README.md ./lib/README.md',
-];
-const result = {
-  '.github/README.template.md': aberlaasRunCommands,
-  'docs/src/**/*.md': aberlaasRunCommands,
-};
-
-// Linting and autofixing supported files
-if (pkg.scripts && pkg.scripts.lint) {
-  result['*.css'] = ['yarn run lint:fix --css'];
-  result['*.{yml,yaml}'] = ['yarn run lint:fix --yml'];
-  result['.circleci/config.yml'] = ['yarn run lint --circleci'];
-  result['*.json'] = ['yarn run lint:fix --json'];
-  result['*.js'] = ['yarn run lint:fix --js'];
-}
-// Testing changed js files
-if (pkg.scripts && pkg.scripts.test) {
-  result['./lib/**/*.js'] = ['yarn run test --failFast --related'];
-}
-module.exports = result;

package/templates/_lintstagedrc.cjs

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

package/templates/_prettierrc.cjs

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

package/templates/_stylelintrc.cjs

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

package/templates/jest.config.cjs

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