aberlaas 2.2.0 → 2.3.0

package/README.md

@@ -161,24 +161,6 @@ what most free CI tier offer). If you have access to higher end machines, you
 can update this value by passing the `--cpu-count=X` flag to your `aberlaas ci`
 call.
 
-### Auto-Releasing
-
-As an optional feature, you can have aberlaas automatically release a new
-version of your module from the CI environment when relevant.
-
-The CI will then check all the commits since the last release. If any commit is
-a `feat()` it will release a new minor version; it any commit is a `fix()` it
-will release a new patch version. For major release, you'll have to do it
-manually.
-
-This option is not enabled by default. If you need it, you need to follow those
-steps:
-
-- Run `aberlaas setup --auto-release`. It will setup the required `ENV` variables
-  and ssh keys
-- Update your `aberlaas ci` script to `aberlaas ci --auto-release`
-- Uncomment the `add_ssh_keys` in your `.circleci.yml` file
-
 ## File structure
 
 `./lib/configs` contain the default configuration for all the tools. They are
@@ -188,7 +170,7 @@ exported by the package and thus can be `require`d in userland.
 extends the configuration exported in the previous files. Copying files to
 userland allows user to change the files if they want to change the behavior.
 
-`.eslintrc.js`, `.stylelintrc.js` and `jest.config.js` are local
+`.eslintrc.js`, `stylelint.config.js` and `vite.config.js` are local
 configuration files for `aberlaas` itself. They eat their own dog food by
 referencing the same configs as above.
 

package/commands/ci/index.js

@@ -1,21 +1,10 @@
-import helper from '../../helper.js';
 import ciInfo from 'ci-info';
-import _ from 'golgoth/lodash.js';
-import pMap from 'golgoth/pMap.js';
-import readJson from 'firost/readJson.js';
 import run from 'firost/run.js';
+import commandTest from '../test/index.js';
+import commandLint from '../lint/index.js';
 import consoleInfo from 'firost/consoleInfo.js';
-import autoRelease from './autoRelease.js';
 
 export default {
-  /**
-   * Return the value of an environment variable
-   * @param {string} key Name of the variable
-   * @returns {*} Key value
-   **/
-  getEnv(key) {
-    return _.get(process, `env.${key}`);
-  },
   /**
    * Checks if currently running on a CI server
    * @returns {boolean} True if on a CI server
@@ -23,111 +12,37 @@ export default {
   isCI() {
     return ciInfo.isCI;
   },
-  /**
-   * Checks if currently running on CircleCI
-   * @returns {boolean} True if on CircleCI
-   **/
-  isCircleCI() {
-    return ciInfo.CIRCLE;
-  },
-  /**
-   * Checks if currently on a PR
-   * @returns {boolean} True if on a PR
-   **/
-  isPR() {
-    return ciInfo.isPR;
-  },
-  /**
-   * Return the name of the originating branch of the PR
-   * @returns {string} Name of the PR branch
-   **/
-  prBranch() {
-    if (!this.isPR()) {
-      return false;
-    }
-    if (this.isCircleCI()) {
-      return this.getEnv('CIRCLE_BRANCH');
-    }
-    return false;
-  },
-  /**
-   * Returns the list of scripts defined in the package.json
-   * @returns {Array} List of scripts defined
-   **/
-  async availableScripts() {
-    // Get scripts in package.json
-    const currentPackage = await readJson(helper.hostPath('package.json'));
-    return _.chain(currentPackage).get('scripts').keys().value();
-  },
-  /**
-   * Returns a list of available scripts to run
-   * @returns {Array} List of scripts to run
-   **/
-  async scriptsToRun() {
-    const availableScripts = await this.availableScripts();
-
-    // Get potential scripts to run
-    const potentialScripts = ['test', 'lint', 'build:prod'];
-
-    return _.intersection(potentialScripts, availableScripts);
-  },
-  /**
-   * Display the current node and yarn versions
-   **/
-  async displayVersion() {
-    const { stdout: nodeVersion } = await this.__run('node --version', {
-      stdout: false,
-    });
-    const { stdout: yarnVersion } = await this.__run('yarn --version', {
-      stdout: false,
-    });
-    this.__consoleInfo(`node ${nodeVersion}, yarn v${yarnVersion}`);
-  },
   /**
    * Run CI scripts and fail the job if any fails
+   * Runs lint and test by default, but can be changed with --no-test and
+   * --no-lint
    * @param {object} cliArgs CLI Argument object, as created by minimist
    * @returns {boolean} True on success, throws on error
    **/
   async run(cliArgs = {}) {
     const args = {
-      'auto-release': false,
-      'cpu-count': 2,
+      test: true,
+      lint: true,
       ...cliArgs,
     };
 
     if (!this.isCI()) {
+      this.__consoleInfo('Current system is not a CI, skipping');
       return true;
     }
 
-    await this.displayVersion();
-
-    const scripts = await this.scriptsToRun();
-    await pMap(
-      scripts,
-      async (scriptName) => {
-        let command = scriptName;
-        if (command === 'test') {
-          command = `test --maxWorkers=${args['cpu-count']}`;
-        }
-
-        await helper.yarnRun(command);
-      },
-      { concurrency: 1 },
-    );
+    if (args.test) {
+      await this.__runTest();
+    }
 
-    // Attempt to release the package if --auto-release is set
-    if (args['auto-release']) {
-      await this.autoRelease();
+    if (args.lint) {
+      await this.__runLint();
     }
 
     return true;
   },
-  /**
-   * Attempt to perform an auto-release
-   **/
-  async autoRelease() {
-    await autoRelease.run();
-  },
+  __runTest: commandTest.run.bind(commandTest),
+  __runLint: commandLint.run.bind(commandLint),
   __run: run,
   __consoleInfo: consoleInfo,
 };

package/commands/init/index.js

@@ -45,6 +45,10 @@ export default {
    * default rules and overwrite them as they see fit
    **/
   async addConfigFiles() {
+    // Git
+    await this.copyToHost('./templates/_gitignore', './.gitignore');
+    await this.copyToHost('./templates/_gitattributes', './.gitattributes');
+
     // Yarn
     await this.copyToHost('templates/_yarnrc.yml', '.yarnrc.yml');
 
@@ -53,16 +57,22 @@ export default {
     await this.copyToHost('templates/_eslintignore.conf', '.eslintignore');
 
     // Lint-staged
-    await this.copyToHost('templates/_lintstagedrc.cjs', '.lintstagedrc.cjs');
+    await this.copyToHost(
+      'templates/lintstaged.config.js',
+      'lintstaged.config.js',
+    );
 
     // Vite
     await this.copyToHost('templates/vite.config.js', 'vite.config.js');
 
     // Prettier
-    await this.copyToHost('templates/_prettierrc.cjs', '.prettierrc.cjs');
+    await this.copyToHost('templates/prettier.config.js', 'prettier.config.js');
 
     // Stylelint
-    await this.copyToHost('templates/_stylelintrc.cjs', '.stylelintrc.cjs');
+    await this.copyToHost(
+      'templates/stylelint.config.js',
+      'stylelint.config.js',
+    );
 
     // Renovate
     await this.copyToHost(
@@ -252,7 +262,9 @@ export default {
     await write(nodeConfig.nodeVersion, nvmrcPath);
 
     // Download latest yarn version
-    await this.__run('yarn set version', { stdout: false });
+    await this.__run(`yarn set version ${nodeConfig.yarnVersion}`, {
+      stdout: false,
+    });
   },
   /**
    * Configure git hooks to use scripts/hooks instead of .git/hooks
@@ -274,6 +286,9 @@ export default {
   async run() {
     const progress = spinner();
 
+    progress.tick('Configuring Git');
+    await this.configureGit();
+
     progress.tick('Pinning node and yarn versions');
     await this.pinNodeAndYarn();
     await this.addEngineNodeVersion();
@@ -284,9 +299,6 @@ export default {
     progress.tick('Adding yarn scripts');
     await this.addScripts();
 
-    progress.tick('Configuring git hooks');
-    await this.configureGitHooks();
-
     progress.tick('Updating LICENSE');
     await this.addLicenseFile();
     await this.addLicenseField();

package/commands/lint/css.js

@@ -36,8 +36,8 @@ export default {
     // Config
     const configFile = await helper.configFile(
       userConfigFile,
-      '.stylelintrc.cjs',
-      'configs/stylelint.cjs',
+      'stylelint.config.js',
+      'configs/stylelint.js',
     );
     const config = await helper.import(configFile);
 

package/commands/lint/helpers/prettier.js

@@ -14,8 +14,8 @@ export async function fix(inputFiles) {
   // Config file
   const configFile = await helper.configFile(
     null,
-    '.prettierrc.cjs',
-    'lib/configs/prettier.cjs',
+    'prettier.config.js',
+    'configs/prettier.js',
   );
   const config = await prettier.resolveConfig(configFile);
 

package/commands/lint/index.js

@@ -21,7 +21,7 @@ export default {
    * @param {object} cliArgs CLI Argument object, as created by minimist
    * @returns {boolean} True on success
    **/
-  async run(cliArgs) {
+  async run(cliArgs = {}) {
     const allTypesKeys = _.keys(this.linters);
     const userTypes = _.intersection(_.keys(cliArgs), allTypesKeys);
     const typesToLint = _.isEmpty(userTypes) ? allTypesKeys : userTypes;

package/commands/lint/js.js

@@ -34,7 +34,7 @@ export default {
     const configFile = await helper.configFile(
       userConfigFile,
       '.eslintrc.cjs',
-      'lib/configs/eslint.cjs',
+      'configs/eslint.cjs',
     );
 
     // Run the actual lint

package/commands/precommit/index.js

@@ -7,13 +7,14 @@ export default {
     // Config
     const configPath = await helper.configFile(
       cliArgs.config,
-      '.lintstagedrc.cjs',
-      'lib/configs/lintstaged.cjs',
+      'lintstaged.config.js',
+      'configs/lintstaged.js',
     );
+    const config = await helper.import(configPath);
 
     try {
       const result = await lintStaged({
-        configPath,
+        config,
       });
       // Linting failed
       if (!result) {

package/commands/setup/index.js

@@ -1,14 +1,12 @@
 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';
 
 export default {
   /**
    * Enable external services.
    * Will enable CircleCI, GitHub and Renovate by default.
-   * If --auto-release is passed, will configure CircleCI
    * @param {object} cliArgs CLI Argument object, as created by minimist
    **/
   async run(cliArgs = {}) {
@@ -16,7 +14,6 @@ export default {
       circleci: true,
       renovate: true,
       github: true,
-      'auto-release': false,
     };
     const cliServices = _.omit(cliArgs, ['_']);
     const servicesToEnable = {
@@ -33,9 +30,6 @@ export default {
     if (servicesToEnable.renovate) {
       await this.renovate();
     }
-    if (servicesToEnable['auto-release']) {
-      await this.autoRelease();
-    }
   },
   /**
    * Configure GitHub
@@ -55,10 +49,4 @@ export default {
   async renovate() {
     await renovate.enable();
   },
-  /**
-   * Enable autoRelease on CircleCI
-   **/
-  async autoRelease() {
-    await autoRelease.enable();
-  },
 };

package/commands/test/index.js

@@ -1,5 +1,6 @@
+import { createVitest } from 'vitest/node';
 import helper from '../../helper.js';
-import run from 'firost/run.js';
+import firostError from 'firost/error.js';
 import _ from 'golgoth/lodash.js';
 
 export default {
@@ -15,69 +16,70 @@ export default {
    * @param {object} cliArgs CLI Argument object, as created by minimist
    * @returns {boolean} true on success
    **/
-  async run(cliArgs) {
-    const options = await this.vitestCliOptions(cliArgs);
+  async run(cliArgs = {}) {
+    const options = await this.vitestOptions(cliArgs);
+    const files = _.isEmpty(cliArgs._) ? [helper.hostPath()] : cliArgs._;
+
+    const vitest = await createVitest('test', options);
+
+    // Note: vitest sets process.exitCode to 1 if tests fail
+    const initialExitCode = process.exitCode;
+    await vitest.start(files);
+
+    if (!options.watch) {
+      await vitest.close();
+    }
+
+    if (process.exitCode == 1) {
+      process.exitCode = initialExitCode;
+      throw firostError('ERROR_TEST', 'Error while testing files');
+    }
 
-    await run(`yarn run vitest ${options.join(' ')}`, { stdin: true });
     return true;
   },
 
   /**
-   * Transform all aberlaas test cli options into suitable vitest CLI options
+   * Transform all aberlaas test cli options into suitable vitest options
    * @param {object} cliArgs CLI Argument object, as created by minimist
-   * @returns {Array} Array of cli arguments and values
+   * @returns {Array} Array of options for vitest
    **/
-  async vitestCliOptions(cliArgs = {}) {
+  async vitestOptions(cliArgs = {}) {
     // Options that have special meaning in aberlaas and shouldn't be passed
     // as-is to vitest
-    const aberlaasOptions = ['_', 'watch', 'config', 'failFast', 'related'];
+    const specialMeaningCliArgs = ['_', '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
+    // Reading base options from the config file
     const configFile = await helper.configFile(
       cliArgs.config,
       'vite.config.js',
-      'lib/configs/vite.js',
+      'configs/vite.js',
     );
-    vitestOptions.push(`--config=${configFile}`);
+    const optionsFromConfig = (await helper.import(configFile)).test;
 
-    // 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;
-      }
+    // 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-01-19): The related option is not documented, but should
+    // contain the list of files
+    if (cliArgs.related) {
+      optionsFromAberlaas.related = cliArgs._;
+    }
 
-      vitestOptions.push(`--${argKey}=${argValue}`);
-    });
+    // Passing other CLI options directly to vitest
+    const optionsFromCli = _.omit(cliArgs, specialMeaningCliArgs);
 
-    return vitestOptions;
+    return {
+      ...optionsFromConfig,
+      ...optionsFromAberlaas,
+      ...optionsFromCli,
+    };
   },
 };

package/configs/eslint.cjs

@@ -1,3 +1,5 @@
+// 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: {

package/configs/lintstaged.js

@@ -0,0 +1,25 @@
+const readmeCommands = [
+  'yarn run aberlaas readme',
+  'git add ./README.md ./lib/README.md',
+];
+
+export default {
+  // Lint
+  '*.css': ['yarn run lint:fix --css'],
+  '*.{yml,yaml}': ['yarn run lint:fix --yml'],
+  '.circleci/config.yml': ['yarn run lint --circleci'],
+  '*.json': ['yarn run lint:fix --json'],
+  '*.js': ['yarn run lint:fix --js'],
+
+  // Test
+  './lib/**/*.js': ['yarn run test --failFast --related'],
+
+  // Compress
+  '*.png': ['yarn run compress --png'],
+
+  // Documentation
+  // Update the README whenever the documentation, or the README template
+  // changes
+  'docs/src/**/*.md': readmeCommands,
+  '.github/README.template.md': readmeCommands,
+};

package/configs/node.cjs

@@ -2,4 +2,5 @@
 // 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',
 };

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   singleQuote: true,
   printWidth: 80,
 };

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

@@ -1,6 +1,6 @@
 // Initially exported from
 // https://github.com/stylelint/stylelint-config-recommended/blob/master/index.js
-module.exports = {
+export default {
   rules: {
     'at-rule-no-unknown': [
       true,

package/configs/vite.js

@@ -3,8 +3,13 @@ const configDir = new URL('./vite/', import.meta.url).pathname;
 
 export default defineConfig({
   test: {
-    // Make describe, it, beforeEach and other globally available
-    globals: true,
+    // vitest default is to run in watch mode, we revert that
+    watch: false,
+    // Allow a success, even if no files are passed
+    passWithNoTests: true,
+    // Hide skipped tests, allowing less noisy debug with fit/fdescribe
+    hideSkippedTests: true,
+
     // Tests should be in a __tests__ folder next to their code
     include: ['**/__tests__/**/*.js?(x)'],
     // We ignore temporary folders from the tests
@@ -13,6 +18,8 @@ export default defineConfig({
     // Restore mocks after each tests
     restoreMocks: true,
 
+    // Make describe, it, beforeEach and other globally available
+    globals: true,
     // Run before each test file
     setupFiles: [
       `${configDir}/test/setupFiles/dedent.js`,

package/main.js

@@ -6,7 +6,6 @@ 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';
@@ -25,7 +24,6 @@ export default {
       lint: commandLint,
       precommit: commandPrecommit,
       readme: commandReadme,
-      release: commandRelease,
       setup: commandSetup,
       test: commandTest,
     };

package/package.json

@@ -2,17 +2,11 @@
   "name": "aberlaas",
   "type": "module",
   "description": "Scaffold your JavaScript projects with tests, lint and release scripts",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "repository": "pixelastic/aberlaas",
   "homepage": "https://projects.pixelastic.com/aberlaas/",
   "author": "Tim Carry (@pixelastic)",
   "license": "MIT",
-  "exports": {
-    ".": "./main.js",
-    "./configs/lintstaged.cjs": "./configs/lintstaged.cjs",
-    "./configs/prettier.cjs": "./configs/prettier.cjs",
-    "./configs/styleling.cjs": "./configs/styleling.cjs"
-  },
   "files": [
     "bin/",
     "lib/",
@@ -27,18 +21,23 @@
     "commands/readme/*.js",
     "commands/release/*.js",
     "commands/setup/*.js",
-    "commands/setup/autoRelease/*.js",
     "commands/setup/helpers/*.js",
     "commands/test/*.js",
     "configs/",
     "templates/"
   ],
+  "exports": {
+    ".": "./main.js",
+    "./configs/lintstaged": "./configs/lintstaged.js",
+    "./configs/prettier": "./configs/prettier.js",
+    "./configs/stylelint": "./configs/stylelint.js"
+  },
   "bin": "bin/aberlaas.js",
   "dependencies": {
     "@octokit/rest": "18.12.0",
     "ci-info": "3.9.0",
     "dedent": "1.5.1",
-    "eslint": "8.54.0",
+    "eslint": "8.56.0",
     "eslint-config-prettier": "9.0.0",
     "eslint-plugin-import": "2.29.0",
     "eslint-plugin-jsdoc": "46.9.0",
@@ -76,5 +75,5 @@
     "test:watch": "../scripts/lib/test-watch",
     "postinstall": "./scripts/postinstall"
   },
-  "gitHead": "bbf9f5024d007deca00abf451ddf879c876d80aa"
+  "gitHead": "cca93623a1219558bd311aefde796d75d6790009"
 }

package/templates/_circleci/config.yml

@@ -20,7 +20,6 @@ jobs:
     <<: *defaults
     steps:
       - checkout
-      # - add_ssh_keys # Uncomment to enable --autoRelease
       - *restore_cache
       - *yarn_install
       - *save_cache

package/templates/_eslintignore.conf

@@ -1,4 +1,4 @@
-# Hidden files (.prettierrc.js, etc) are ignored by default by ESLint
+# Hidden files are ignored by default by ESLint
 # The following line will unignore them
 !.*
 
@@ -7,3 +7,6 @@ node_modules/
 
 # .yarn contains the yarn source code, we don't need to lint it
 .yarn/
+
+# Ignore the documentation for now, I haven't migrated it to ESM yet
+docs/

package/templates/_gitattributes

@@ -0,0 +1,3 @@
+# Yarn
+/.yarn/releases/** binary
+/.yarn/plugins/** binary

package/templates/_gitignore

@@ -0,0 +1,28 @@
+# Hidden files
+.DS_Store
+.envrc
+
+# Directories
+build/
+dist/
+node_modules/
+tmp/
+
+# Files
+Thumbs.db
+npm-debug.log
+yarn-error.log
+*~
+
+# Yarn
+# https://yarnpkg.com/getting-started/qa#which-files-should-be-gitignored
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+
+# Netlify
+.netlify

package/templates/lintstaged.config.js

@@ -0,0 +1,4 @@
+import config from 'aberlaas/configs/lintstaged';
+export default {
+  ...config,
+};

package/templates/prettier.config.js

@@ -0,0 +1,4 @@
+import config from 'aberlaas/configs/prettier';
+export default {
+  ...config,
+};

package/templates/scripts/hooks/pre-commit

@@ -8,4 +8,4 @@
 # $ git config core.hooksPath scripts/hooks
 set -e
 
-aberlaas precommit "$@"
+yarn run aberlaas precommit

package/templates/stylelint.config.js

@@ -0,0 +1,4 @@
+import config from 'aberlaas/configs/stylelint';
+export default {
+  ...config,
+};

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/lintstaged.cjs

@@ -1,31 +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'];
-}
-
-// 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 --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,
-};