aberlaas 2.7.0 → 2.8.0

package/README.md

@@ -161,6 +161,24 @@ 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
@@ -170,133 +188,10 @@ 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`, `stylelint.config.js` and `vite.config.js` are local
+`.eslintrc.js`, `.stylelintrc.js` and `jest.config.js` are local
 configuration files for `aberlaas` itself. They eat their own dog food by
 referencing the same configs as above.
 
-## Tools used and their future
-
-### ESLint
-
-ESLint doesn't yet support ESM config files. We'll upgrade to the latest ESLint
-when it does. This should also help fix the issue with Yarn PnP (see below).
-
-### Yarn
-
-**tl;dr; We'll move to Yarn PnP once ESLint has support for Flat Configs, and
-default `yarn run` doesn't add a ~1s delay overhead**
-
-#### PnP
-
-
-Aberlaas is using Yarn Berry (v2+) as its main package management tool.
-
-Yarn Berry comes with a Plug And Play (PnP) feature that replaces the usage of
-`node_modules` in favor of a `.pnp.cjs` file. Instead of having a very large
-`node_modules` folder, a unique copy of each dependency is stored in the user
-home folder and the `.pnp.cjs` file only keeps references to those folder. This
-makes installing dependencies faster as it needs way less I/O.
-
-By ditching the whole `node_modules` principle, it also removes concepts like
-hoisting of dependencies in a monorepo. This, unfortunately, breaks ESLint.
-
-ESLint expect all its plugins to be defined as `peerDependencies` at the root of
-a mono-repo, as it will always try to include them from there. It works more or
-less correctly at the best of times, and `aberlaas` already has some hacks
-(including `resolvePluginsRelativeTo`) to work around that.
-
-But with PnP, there is no way to make it work correctly, so I will need to wait
-for a better compatibility between ESLint and Yarn 2 before using it.
-
-Sources:
-- [#8](https://github.com/yarnpkg/berry/issues/8), the initial case study of Yarn + ESLint
-- [GitHub issue that explicitly explain the problem](https://github.com/yarnpkg/berry/discussions/3909)
-- [`eslint-patch`, an ESLint plugin that hacks around this issue](https://yarnpkg.com/package?name=@rushstack/eslint-patch)
-- [The `resolvePluginsRelativeTo` bandaid from ESLint](https://eslint.org/docs/latest/use/command-line-interface#--resolve-plugins-relative-to)
-- [A nice postmortem of moving to Yarn 2](https://www.dolthub.com/blog/2022-03-18-migrating-to-yarn-2/)
-- [The Flat Config feature in ESLint that should solve the problem](https://eslint.org/docs/latest/use/configure/configuration-files-new)
-
-#### Calling binaries from the host
-
-In yarn v1, if you install `aberlaas` in your project, all of `aberlaas`
-dependencies (including binaries) were hoisted to the root. This was a design
-flaw, as if several dependencies defined binaries by the same name, they would
-fight in a race condition to take the slot in `node_modules/.bin`.
-
-This has been fixed in Yarn Berry, but it also means it's no longer possible to
-call `yarn run eslint` from a repository that includes `aberlaas`, because
-`eslint` is not a direct dependency of the repo.
-
-It might be possible to define proxy binaries inside of `aberlaas`, but those
-will incur performance issues as they will need to spawn one more yarn context
-(see below).
-
-#### Calling binaries from aberlaas
-
-In Yarn V1, I was calling binaries that `aberlaas` depends on (`eslint`, `vitest`,
-etc) by calling `yarn run`. This was adding some overhead but was acceptable.
-Yarn Berry adds even more overhead and it is becoming noticeable.
-
-Now, my prefered way it to use the NodeJS API of the dependencies instead of
-their CLI, to limit the overhead. I managed to move most tools to this new
-approach, but sometimes I still need to use the CLI (`vitest` for example has
-awesome live watching and display reloading that I don't think I can easily
-replicate through code).
-
-I ran some performance tests to see what would be the fastest way to call
-`vitest` from `aberlaas`
-
-```
-hyperfine \
-    "zsh -i -c 'yarn bin vitest && /home/tim/local/www/projects/aberlaas/node_modules/vitest/vitest.mjs --version'" \
-    "zsh -i -c 'yarn run vitest --version'" \
-    "/home/tim/local/www/projects/aberlaas/node_modules/vitest/vitest.mjs --version" \
-    "/home/tim/local/www/projects/aberlaas/node_modules/.bin/vitest --version" 
-Benchmark 1: zsh -i -c 'yarn run vitest --version'
-  Time (mean ± σ):      1.945 s ±  0.051 s    [User: 1.986 s, System: 0.850 s]
-  Range (min … max):    1.859 s …  2.018 s    10 runs
- 
-Benchmark 2: zsh -i -c 'yarn bin vitest && /home/tim/local/www/projects/aberlaas/node_modules/vitest/vitest.mjs --version'
-  Time (mean ± σ):      2.108 s ±  0.150 s    [User: 2.108 s, System: 0.843 s]
-  Range (min … max):    1.930 s …  2.289 s    10 runs
- 
-Benchmark 3: /home/tim/local/www/projects/aberlaas/node_modules/vitest/vitest.m
-js --version
-  Time (mean ± σ):     482.5 ms ±  40.9 ms    [User: 448.4 ms, System: 327.2 ms]
-  Range (min … max):   442.1 ms … 553.3 ms    10 runs
- 
-Benchmark 4: /home/tim/local/www/projects/aberlaas/node_modules/.bin/vitest --version
-  Time (mean ± σ):     491.9 ms ±  29.6 ms    [User: 454.1 ms, System: 331.2 ms]
-  Range (min … max):   453.8 ms … 535.4 ms    10 runs
-```
-
-Finding the binary through `yarn bin` then calling it is the slowest, but `yarn
-run` isn't much faster. Directly calling the binary is the fastest, but it's
-path can't be easily guessed (apart from reading and parsing a `package.json`).
-But using the symlinks in `node_modules/.bin` is consistent, barely slower than
-calling the binary directly and much faster than using yarn.
-
-This is what I'll be using. Of course, this will break when I'll move to PnP as
-the `node_modules` folder won't be there, but hopefully Yarn will be faster by
-then and I can use `yarn run` reliably.
-
-#### Speed
-
-With Yarn 2+, calling `yarn run` seem to add ~1s of overhead each time. This is
-a known issue (due to the fact Yarn 2 needs to spawn yarn 1, node and a few
-other layers). 
-
-1s is not much in itself, but grows quickly when you have nested `yarn run
-aberlaas` calls that call `yarn run eslint`, and even more when you need to deal
-with monorepos and multiple packages that each have their own yarn scope.
-
-There are open issues on the topic, but nothing merged yet:
-
-- [#3732](https://github.com/yarnpkg/berry/issues/3732), where it is discussed to make yarn run aware that it's running yarn run
-  and keep the same state without spawning new yarns
-- [#2575](https://github.com/yarnpkg/berry/issues/2575), which is the main issue about Yarn performance, with benchmarks against
-  npm/npx/yarn v1.
-
 ## Where does the name Aberlaas come from?
 
 Aberlaas is the base camp from which all great expedition start in the _La Horde
@@ -310,4 +205,4 @@ For your convenience, `aberlass` and `aberlas` are added as aliases by default.
 
 ## Documentation
 
-The complete documentation can be found on https://projects.pixelastic.com/aberlaas/
+The complete documentation can be found on https://projects.pixelastic.com/aberlaas/

package/commands/init/helper.js

@@ -0,0 +1,171 @@
+import path from 'path';
+import Gilmore from 'gilmore';
+import { copy, error as firostError, isFile, move, read, write } from 'firost';
+import { _ } from 'golgoth';
+import helper from '../../helper.js';
+
+/**
+ * This hold functions shared for both the monorepo and simple init scenarios
+ **/
+export default {
+  /**
+   * Return name of the current project, as the name of the current directory
+   * @returns {string} Name of the project
+   **/
+  getProjectName() {
+    return path.basename(helper.hostRoot());
+  },
+
+  /**
+   * Return the name of the current author based on the GitHub project owner
+   * @returns {string} Name of the author, or __placeholder__ if undefined
+   **/
+  async getProjectAuthor() {
+    const repo = this.__getRepo();
+    return (await repo.githubRepoOwner()) || '__placeholder__';
+  },
+
+  /**
+   * Copy a config template to the host
+   * @param {string} source Path to source file, relative to aberlaas
+   * @param {string} destination Path to destination file, relative to the host
+   * @returns {boolean} False if can't copy file, true otherwise
+   **/
+  async copyToHost(source, destination) {
+    const absoluteSource = helper.aberlaasPath(source);
+    const absoluteDestination = helper.hostPath(destination);
+
+    // Source file does not exist
+    if (!(await isFile(absoluteSource))) {
+      throw firostError(
+        'ERROR_INIT_COPY_FILE',
+        `Unable to locate ${absoluteSource} file`,
+      );
+    }
+    // Destination file already exist
+    if (await isFile(absoluteDestination)) {
+      // Do nothing if content is already the same
+      const sourceContent = await read(absoluteSource);
+      const destinationContent = await read(absoluteDestination);
+      if (sourceContent === destinationContent) {
+        return true;
+      }
+
+      // Otherwise create a backup
+      const backupDestination = `${absoluteDestination}.backup`;
+      await move(absoluteDestination, backupDestination);
+    }
+
+    await copy(absoluteSource, absoluteDestination);
+
+    return true;
+  },
+
+  /**
+   * Add MIT license file
+   * @param {string} hostFilepath Path to the LICENSE file, relative to the host
+   **/
+  async addLicenseFile(hostFilepath) {
+    // Start by adding a template
+    await this.copyToHost('templates/LICENSE', hostFilepath);
+
+    // Replace placeholder with real value
+    const licensePath = helper.hostPath(hostFilepath);
+    const author = await this.getProjectAuthor();
+    const templateContent = await read(licensePath);
+    const actualContent = _.replace(templateContent, '{author}', author);
+
+    // Write it again
+    await write(actualContent, licensePath);
+  },
+
+  /**
+   * Add default script files
+   **/
+  async addScripts() {
+    // Common
+    await this.copyToHost('templates/scripts/ci', 'scripts/ci');
+    await this.copyToHost('templates/scripts/compress', 'scripts/compress');
+    await this.copyToHost('templates/scripts/lint', 'scripts/lint');
+    await this.copyToHost('templates/scripts/lint-fix', 'scripts/lint-fix');
+
+    // Hooks
+    await this.copyToHost(
+      './templates/scripts/hooks/pre-commit',
+      './scripts/hooks/pre-commit',
+    );
+
+    // Lib
+    await this.copyToHost(
+      'templates/scripts/lib/release',
+      'scripts/lib/release',
+    );
+    await this.copyToHost('templates/scripts/lib/test', 'scripts/lib/test');
+    await this.copyToHost(
+      'templates/scripts/lib/test-watch',
+      'scripts/lib/test-watch',
+    );
+  },
+
+  /**
+   * Add config files to the host. Each config files reference the default
+   * aberlaas config for its tool. This pattern allow end-users to use aberlaas
+   * 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');
+
+    // ESLint
+    await this.copyToHost('templates/_eslintrc.cjs', '.eslintrc.cjs');
+    await this.copyToHost('templates/_eslintignore.conf', '.eslintignore');
+
+    // Lint-staged
+    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/prettier.config.js', 'prettier.config.js');
+
+    // Stylelint
+    await this.copyToHost(
+      'templates/stylelint.config.js',
+      'stylelint.config.js',
+    );
+
+    // Renovate
+    await this.copyToHost(
+      'templates/_github/renovate.json',
+      '.github/renovate.json',
+    );
+
+    // CircleCI
+    await this.copyToHost(
+      'templates/_circleci/config.yml',
+      '.circleci/config.yml',
+    );
+  },
+
+  /**
+   * Add default files required to have the minimum lib module
+   **/
+  async addLibFiles() {
+    await this.copyToHost('templates/lib/main.js', 'lib/main.js');
+    await this.copyToHost(
+      'templates/lib/__tests__/main.js',
+      'lib/__tests__/main.js',
+    );
+  },
+  __getRepo() {
+    return new Gilmore(helper.hostRoot());
+  },
+};

package/commands/init/index.js

@@ -1,21 +1,10 @@
-import { _ } from 'golgoth';
-import {
-  consoleInfo,
-  copy,
-  firostError,
-  isFile,
-  move,
-  read,
-  readJson,
-  run,
-  spinner,
-  write,
-  writeJson,
-} from 'firost';
+import { consoleInfo, run, spinner, write } from 'firost';
 
 import Gilmore from 'gilmore';
 import helper from '../../helper.js';
 import nodeConfig from '../../configs/node.cjs';
+import initMonorepo from './monorepo.js';
+import initModule from './module.js';
 
 export default {
   /**
@@ -33,399 +22,38 @@ export default {
     await write(nodeConfig.nodeVersion, nvmrcPath);
   },
   /**
-   * Create the top-level monorepo root workspace
+   * Run yarn install to install all deps
    **/
-  async createRootWorkspace() {
-    const aberlaasData = await readJson(helper.aberlaasPath('./package.json'));
-    const sharedProjectData = await this.getSharedProjectData();
-
-    const packageContent = {
-      // Visibility
-      private: true,
-      workspaces: ['docs', 'lib'],
-
-      // Name and version
-      name: `${sharedProjectData.name}-monorepo`,
-      version: '0.0.1',
-
-      // Metadata
-      author: sharedProjectData.author,
-      description: `${sharedProjectData.name} monorepo`,
-      repository: sharedProjectData.repository,
-      homepage: sharedProjectData.homepage,
-
-      // Compatibility
-      type: 'module',
-      license: sharedProjectData.license,
-      packageManager: `yarn@${nodeConfig.yarnVersion}`,
-
-      // Exports
-
-      // Dependencies
-      dependencies: {},
-      devDependencies: {
-        aberlaas: aberlaasData.version,
-        lerna: nodeConfig.lernaVersion,
-      },
-
-      // Scripts
-      scripts: {
-        // ==> Docs-specific
-        build: './scripts/docs/build',
-        'build:prod': './scripts/docs/build-prod',
-        cms: './scripts/docs/cms',
-        serve: './scripts/docs/serve',
-        // ==> Lib-specific
-        release: './scripts/lib/release',
-        test: './scripts/lib/test',
-        'test:watch': './scripts/lib/test-watch',
-        // Common
-        ci: './scripts/ci',
-        compress: './scripts/compress',
-        lint: './scripts/lint',
-        'lint:fix': './scripts/lint-fix',
-
-        // Global (called as aliases from any workspace)
-        // ==> Docs-specific
-        'g:build': './scripts/docs/build',
-        'g:build:prod': './scripts/docs/build-prod',
-        'g:cms': './scripts/docs/cms',
-        'g:serve': './scripts/docs/serve',
-        // ==> Lib-specific
-        'g:release': './scripts/lib/release',
-        'g:test': './scripts/lib/test',
-        'g:test:watch': './scripts/lib/test-watch',
-        // Common
-        'g:compress': './scripts/compress',
-        'g:lint': './scripts/lint',
-        'g:lint:fix': './scripts/lint-fix',
-      },
-    };
-    await writeJson(packageContent, helper.hostPath('./package.json'), {
-      sort: false,
-    });
-  },
-  /**
-   * Create the docs workspace
-   **/
-  async createDocsWorkspace() {
-    const sharedProjectData = await this.getSharedProjectData();
-
-    const packageContent = {
-      // Visibility
-      private: true,
-
-      // Name & Version
-      name: `${sharedProjectData.name}-docs`,
-      version: '0.0.1',
-
-      // Metadata
-      author: sharedProjectData.author,
-      description: `${sharedProjectData.name} docs`,
-      repository: sharedProjectData.repository,
-      homepage: sharedProjectData.homepage,
-
-      // Compatibility
-      license: sharedProjectData.license,
-
-      // Exports
-
-      // Dependencies
-      dependencies: {
-        norska: nodeConfig.norskaVersion,
-        'norska-theme-docs': nodeConfig.norskaThemeDocsVersion,
-      },
-      devDependencies: {},
-
-      // Scripts
-      scripts: sharedProjectData.scripts,
-    };
-    await writeJson(packageContent, helper.hostPath('./docs/package.json'), {
-      sort: false,
-    });
-  },
-  /**
-   * Create the lib workspace
-   **/
-  async createLibWorkspace() {
-    const sharedProjectData = await this.getSharedProjectData();
-
-    const packageContent = {
-      // Visibility
-      private: false,
-
-      // Name and version
-      name: sharedProjectData.name,
-      version: '0.0.1',
-
-      // Metadata
-      author: sharedProjectData.author,
-      description: '',
-      keywords: [],
-      repository: sharedProjectData.repository,
-      homepage: sharedProjectData.homepage,
-
-      // Compatibility
-      type: 'module',
-      license: sharedProjectData.license,
-      engines: sharedProjectData.engines,
-
-      // Exports
-      files: ['*.js'],
-      exports: {
-        '.': './main.js',
-      },
-      main: './main.js',
-
-      // Dependencies
-      dependencies: {},
-      devDependencies: {},
-
-      // Scripts
-      scripts: sharedProjectData.scripts,
-    };
-    await writeJson(packageContent, helper.hostPath('./lib/package.json'), {
-      sort: false,
-    });
-  },
-  /**
-   * Add config files to the host. Each config files reference the default
-   * aberlaas config for its tool. This pattern allow end-users to use aberlaas
-   * 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');
-
-    // Lerna
-    await this.copyToHost('templates/lerna.json', 'lerna.json');
-
-    // ESLint
-    await this.copyToHost('templates/_eslintrc.cjs', '.eslintrc.cjs');
-    await this.copyToHost('templates/_eslintignore.conf', '.eslintignore');
-
-    // Lint-staged
-    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/prettier.config.js', 'prettier.config.js');
-
-    // Stylelint
-    await this.copyToHost(
-      'templates/stylelint.config.js',
-      'stylelint.config.js',
-    );
-
-    // Renovate
-    await this.copyToHost(
-      'templates/_github/renovate.json',
-      '.github/renovate.json',
-    );
-
-    // CircleCI
-    await this.copyToHost(
-      'templates/_circleci/config.yml',
-      '.circleci/config.yml',
-    );
-  },
-  /**
-   * Add default script files
-   **/
-  async addScripts() {
-    // Docs
-    await this.copyToHost('templates/scripts/docs/build', 'scripts/docs/build');
-    await this.copyToHost(
-      'templates/scripts/docs/build-prod',
-      'scripts/docs/build-prod',
-    );
-    await this.copyToHost('templates/scripts/docs/cms', 'scripts/docs/cms');
-    await this.copyToHost('templates/scripts/docs/serve', 'scripts/docs/serve');
-
-    // Hooks
-    await this.copyToHost(
-      './templates/scripts/hooks/pre-commit',
-      './scripts/hooks/pre-commit',
-    );
-
-    // Lib
-    await this.copyToHost(
-      'templates/scripts/lib/release',
-      'scripts/lib/release',
-    );
-    await this.copyToHost('templates/scripts/lib/test', 'scripts/lib/test');
-    await this.copyToHost(
-      'templates/scripts/lib/test-watch',
-      'scripts/lib/test-watch',
-    );
-
-    // Common
-    await this.copyToHost('templates/scripts/ci', 'scripts/ci');
-    await this.copyToHost('templates/scripts/compress', 'scripts/compress');
-    await this.copyToHost('templates/scripts/lint', 'scripts/lint');
-    await this.copyToHost('templates/scripts/lint-fix', 'scripts/lint-fix');
-  },
-  /**
-   * Add MIT license files to the repository
-   **/
-  async addLicenseFiles() {
-    // Add the LICENSE template to the root
-    await this.copyToHost('templates/LICENSE', 'LICENSE');
-
-    // Replace placeholder with real value
-    const sharedProjectData = await this.getSharedProjectData();
-    const licensePath = helper.hostPath('LICENSE');
-    const templateContent = await read(licensePath);
-    const actualContent = _.replace(
-      templateContent,
-      '{author}',
-      sharedProjectData.author,
-    );
-
-    // Write the LICENSE to root and lib
-    await write(actualContent, licensePath);
-    await write(actualContent, helper.hostPath('lib/LICENSE'));
-  },
-  /**
-   * Add default files required to have the minimum lib module
-   **/
-  async addLibFiles() {
-    await this.copyToHost('templates/lib/main.js', 'lib/main.js');
-    await this.copyToHost(
-      'templates/lib/__tests__/main.js',
-      'lib/__tests__/main.js',
-    );
-  },
-  /**
-   * Copy a config template to the host
-   * @param {string} source Path to source file, relative to aberlaas
-   * @param {string} destination Path to destination file, relative to the host
-   * @returns {boolean} False if can't copy file, true otherwise
-   **/
-  async copyToHost(source, destination) {
-    const absoluteSource = helper.aberlaasPath(source);
-    const absoluteDestination = helper.hostPath(destination);
-
-    // Source file does not exist
-    if (!(await isFile(absoluteSource))) {
-      throw firostError(
-        'ERROR_INIT_COPY_FILE',
-        `Unable to locate ${absoluteSource} file`,
-      );
-    }
-    // Destination file already exist
-    if (await isFile(absoluteDestination)) {
-      // Do nothing if content is already the same
-      const sourceContent = await read(absoluteSource);
-      const destinationContent = await read(absoluteDestination);
-      if (sourceContent === destinationContent) {
-        return true;
-      }
-
-      // Otherwise create a backup
-      const backupDestination = `${absoluteDestination}.backup`;
-      await move(absoluteDestination, backupDestination);
-    }
-
-    await copy(absoluteSource, absoluteDestination);
-
-    return true;
-  },
-  /**
-   * Return name of the current project based on the GitHub project name
-   * @returns {string} Name of the project
-   **/
-  async getProjectName() {
-    const repo = new Gilmore(helper.hostRoot());
-    return await repo.githubRepoName();
-  },
-  /**
-   * Return the name of the current author based on the GitHub project owner
-   * @returns {string} Name of the author
-   **/
-  async getProjectAuthor() {
-    const repo = new Gilmore(helper.hostRoot());
-    return await repo.githubRepoOwner();
-  },
-  /**
-   * Returns shared project data, like name, author, scripts, etc
-   * @returns {object} Object of common keys
-   **/
-  async getSharedProjectData() {
-    const name = await this.getProjectName();
-    const author = await this.getProjectAuthor();
-    const homepage = `https://projects.pixelastic.com/${name}`;
-    const repository = `${author}/${name}`;
-    const license = 'MIT';
-    const engines = {
-      node: `>=${nodeConfig.nodeVersion}`,
-    };
-    const scripts = {
-      // Docs
-      build: 'ABERLAAS_CWD=$INIT_CWD yarn g:build',
-      'build:prod': 'ABERLAAS_CWD=$INIT_CWD yarn g:build:prod',
-      cms: 'ABERLAAS_CWD=$INIT_CWD yarn g:cms',
-      serve: 'ABERLAAS_CWD=$INIT_CWD yarn g:serve',
-
-      // Lib
-      release: 'ABERLAAS_CWD=$INIT_CWD yarn g:release',
-      test: 'ABERLAAS_CWD=$INIT_CWD yarn g:test',
-      'test:watch': 'ABERLAAS_CWD=$INIT_CWD yarn g:test:watch',
-
-      // Common
-      compress: 'ABERLAAS_CWD=$INIT_CWD yarn g:compress',
-      lint: 'ABERLAAS_CWD=$INIT_CWD yarn g:lint',
-      'lint:fix': 'ABERLAAS_CWD=$INIT_CWD yarn g:lint:fix',
-    };
-    return {
-      author,
-      engines,
-      homepage,
-      license,
-      name,
-      repository,
-      scripts,
-    };
+  async yarnInstall() {
+    await run('yarn install');
   },
   /**
    * Copy all config files and configure the scripts
+   * @param {object} args Argument object, as passed by minimist
    **/
-  async run() {
-    const progress = spinner();
+  async run(args = {}) {
+    const isMonorepo = args.monorepo;
+
+    const progress = this.__spinner();
 
     progress.tick('Configuring Git & Node');
     await this.configureGit();
     await this.configureNode();
 
-    progress.tick('Configuring workspaces');
-    await this.createRootWorkspace();
-    await this.createDocsWorkspace();
-    await this.createLibWorkspace();
+    progress.tick('Adding default files ');
 
-    progress.tick('Adding files');
-    await this.addLicenseFiles();
-    await this.addConfigFiles();
-    await this.addScripts();
-    await this.addLibFiles();
+    // Create a different scaffolding based on if creating a monorepo or not
+    isMonorepo ? await initMonorepo.run() : await initModule.run();
 
     progress.success('aberlaas project initialized');
 
     this.__consoleInfo('Synchronizing dependencies');
-    await run('yarn install');
+    await this.yarnInstall();
 
     this.__consoleInfo(
       "Don't forget to run aberlaas setup after pushing your repository",
     );
   },
-  __run: run,
   __consoleInfo: consoleInfo,
+  __spinner: spinner,
 };

package/commands/init/module.js

@@ -0,0 +1,111 @@
+import { readJson, writeJson } from 'firost';
+
+import helper from '../../helper.js';
+import nodeConfig from '../../configs/node.cjs';
+import initHelper from './helper.js';
+
+export default {
+  /**
+   * Create the top-level package.json
+   **/
+  async createPackageJson() {
+    // Get language and dependency version
+    const { version: aberlaasVersion } = await readJson(
+      helper.aberlaasPath('./package.json'),
+    );
+    const { nodeVersion, yarnVersion } = nodeConfig;
+
+    const name = await this.__getProjectName();
+    const version = '0.0.1';
+
+    const author = await this.__getProjectAuthor();
+    const description = '';
+    const keywords = [];
+    const repository = `${author}/${name}`;
+    const homepage = `https://projects.pixelastic.com/${name}`;
+
+    const type = 'module';
+    const license = 'MIT';
+    const engines = {
+      node: `>=${nodeVersion}`,
+    };
+    const packageManager = `yarn@${yarnVersion}`;
+
+    const files = ['*.js'];
+    const exports = {
+      '.': './main.js',
+    };
+    const main = './main.js';
+
+    const dependencies = {};
+    const devDependencies = {
+      aberlaas: aberlaasVersion,
+    };
+
+    const scripts = {
+      // Docs
+      build: './scripts/docs/build',
+      'build:prod': './scripts/docs/build-prod',
+      cms: './scripts/docs/cms',
+      serve: './scripts/docs/serve',
+      // Lib
+      release: './scripts/lib/release',
+      test: './scripts/lib/test',
+      'test:watch': './scripts/lib/test-watch',
+      // Common
+      ci: './scripts/ci',
+      compress: './scripts/compress',
+      lint: './scripts/lint',
+      'lint:fix': './scripts/lint-fix',
+    };
+
+    const packageContent = {
+      // Name and version
+      name,
+      version,
+
+      // Metadata
+      author,
+      description,
+      keywords,
+      repository,
+      homepage,
+
+      // Compatibility
+      type,
+      license,
+      engines,
+      packageManager,
+
+      // Exports
+      files,
+      exports,
+      main,
+
+      // Dependencies
+      dependencies,
+      devDependencies,
+
+      // Scripts
+      scripts,
+    };
+
+    await writeJson(packageContent, helper.hostPath('./package.json'), {
+      sort: false,
+    });
+  },
+
+  /**
+   * Scaffold a repo for use in a simple module contexte
+   **/
+  async run() {
+    await this.createPackageJson();
+
+    await initHelper.addLicenseFile('LICENSE');
+    await initHelper.addConfigFiles();
+    await initHelper.addScripts();
+    await initHelper.addLibFiles();
+  },
+  __getProjectName: initHelper.getProjectName.bind(initHelper),
+  __getProjectAuthor: initHelper.getProjectAuthor.bind(initHelper),
+};

package/commands/init/monorepo.js

@@ -0,0 +1,261 @@
+import { readJson, writeJson } from 'firost';
+
+import helper from '../../helper.js';
+import nodeConfig from '../../configs/node.cjs';
+import initHelper from './helper.js';
+
+export default {
+  /**
+   * Create the top-level monorepo root workspace
+   **/
+  async createRootWorkspace() {
+    const aberlaasData = await readJson(helper.aberlaasPath('./package.json'));
+    const sharedProjectData = await this.getSharedProjectData();
+
+    const packageContent = {
+      // Visibility
+      private: true,
+      workspaces: ['docs', 'lib'],
+
+      // Name and version
+      name: `${sharedProjectData.name}-monorepo`,
+      version: '0.0.1',
+
+      // Metadata
+      author: sharedProjectData.author,
+      description: `${sharedProjectData.name} monorepo`,
+      repository: sharedProjectData.repository,
+      homepage: sharedProjectData.homepage,
+
+      // Compatibility
+      type: 'module',
+      license: sharedProjectData.license,
+      packageManager: `yarn@${nodeConfig.yarnVersion}`,
+
+      // Exports
+
+      // Dependencies
+      dependencies: {},
+      devDependencies: {
+        aberlaas: aberlaasData.version,
+        lerna: nodeConfig.lernaVersion,
+      },
+
+      // Scripts
+      scripts: {
+        // ==> Docs-specific
+        build: './scripts/docs/build',
+        'build:prod': './scripts/docs/build-prod',
+        cms: './scripts/docs/cms',
+        serve: './scripts/docs/serve',
+        // ==> Lib-specific
+        release: './scripts/lib/release',
+        test: './scripts/lib/test',
+        'test:watch': './scripts/lib/test-watch',
+        // Common
+        ci: './scripts/ci',
+        compress: './scripts/compress',
+        lint: './scripts/lint',
+        'lint:fix': './scripts/lint-fix',
+
+        // Global (called as aliases from any workspace)
+        // ==> Docs-specific
+        'g:build': './scripts/docs/build',
+        'g:build:prod': './scripts/docs/build-prod',
+        'g:cms': './scripts/docs/cms',
+        'g:serve': './scripts/docs/serve',
+        // ==> Lib-specific
+        'g:release': './scripts/lib/release',
+        'g:test': './scripts/lib/test',
+        'g:test:watch': './scripts/lib/test-watch',
+        // Common
+        'g:compress': './scripts/compress',
+        'g:lint': './scripts/lint',
+        'g:lint:fix': './scripts/lint-fix',
+      },
+    };
+    await writeJson(packageContent, helper.hostPath('./package.json'), {
+      sort: false,
+    });
+  },
+  /**
+   * Create the docs workspace
+   **/
+  async createDocsWorkspace() {
+    const sharedProjectData = await this.getSharedProjectData();
+
+    const packageContent = {
+      // Visibility
+      private: true,
+
+      // Name & Version
+      name: `${sharedProjectData.name}-docs`,
+      version: '0.0.1',
+
+      // Metadata
+      author: sharedProjectData.author,
+      description: `${sharedProjectData.name} docs`,
+      repository: sharedProjectData.repository,
+      homepage: sharedProjectData.homepage,
+
+      // Compatibility
+      license: sharedProjectData.license,
+
+      // Exports
+
+      // Dependencies
+      dependencies: {
+        norska: nodeConfig.norskaVersion,
+        'norska-theme-docs': nodeConfig.norskaThemeDocsVersion,
+      },
+      devDependencies: {},
+
+      // Scripts
+      scripts: sharedProjectData.scripts,
+    };
+    await writeJson(packageContent, helper.hostPath('./docs/package.json'), {
+      sort: false,
+    });
+  },
+  /**
+   * Create the lib workspace
+   **/
+  async createLibWorkspace() {
+    const sharedProjectData = await this.getSharedProjectData();
+    const engines = {
+      node: `>=${nodeConfig.nodeVersion}`,
+    };
+
+    const packageContent = {
+      // Visibility
+      private: false,
+
+      // Name and version
+      name: sharedProjectData.name,
+      version: '0.0.1',
+
+      // Metadata
+      author: sharedProjectData.author,
+      description: '',
+      keywords: [],
+      repository: sharedProjectData.repository,
+      homepage: sharedProjectData.homepage,
+
+      // Compatibility
+      type: 'module',
+      license: sharedProjectData.license,
+      engines,
+
+      // Exports
+      files: ['*.js'],
+      exports: {
+        '.': './main.js',
+      },
+      main: './main.js',
+
+      // Dependencies
+      dependencies: {},
+      devDependencies: {},
+
+      // Scripts
+      scripts: sharedProjectData.scripts,
+    };
+    await writeJson(packageContent, helper.hostPath('./lib/package.json'), {
+      sort: false,
+    });
+  },
+  /**
+   * Add MIT license files to the repository
+   **/
+  async addLicenseFiles() {
+    // One at the repo root, for GitHub
+    await initHelper.addLicenseFile('LICENSE');
+    // One in ./lib to be released with the module
+    await initHelper.addLicenseFile('lib/LICENSE');
+  },
+  /**
+   * Add config files
+   **/
+  async addConfigFiles() {
+    await initHelper.addConfigFiles();
+
+    // Lerna
+    await initHelper.copyToHost('templates/lerna.json', 'lerna.json');
+  },
+  /**
+   * Add scripts to the repo
+   **/
+  async addScripts() {
+    // Common scripts
+    await initHelper.addScripts('LICENSE');
+
+    // Docs scripts
+    await initHelper.copyToHost(
+      'templates/scripts/docs/build',
+      'scripts/docs/build',
+    );
+    await initHelper.copyToHost(
+      'templates/scripts/docs/build-prod',
+      'scripts/docs/build-prod',
+    );
+    await initHelper.copyToHost(
+      'templates/scripts/docs/cms',
+      'scripts/docs/cms',
+    );
+    await initHelper.copyToHost(
+      'templates/scripts/docs/serve',
+      'scripts/docs/serve',
+    );
+  },
+  /**
+   * Returns shared project data, like name, author, scripts, etc
+   * @returns {object} Object of common keys
+   **/
+  async getSharedProjectData() {
+    const name = await this.__getProjectName();
+    const author = await this.__getProjectAuthor();
+    const homepage = `https://projects.pixelastic.com/${name}`;
+    const repository = `${author}/${name}`;
+    const license = 'MIT';
+    const scripts = {
+      // Docs
+      build: 'ABERLAAS_CWD=$INIT_CWD yarn g:build',
+      'build:prod': 'ABERLAAS_CWD=$INIT_CWD yarn g:build:prod',
+      cms: 'ABERLAAS_CWD=$INIT_CWD yarn g:cms',
+      serve: 'ABERLAAS_CWD=$INIT_CWD yarn g:serve',
+
+      // Lib
+      release: 'ABERLAAS_CWD=$INIT_CWD yarn g:release',
+      test: 'ABERLAAS_CWD=$INIT_CWD yarn g:test',
+      'test:watch': 'ABERLAAS_CWD=$INIT_CWD yarn g:test:watch',
+
+      // Common
+      compress: 'ABERLAAS_CWD=$INIT_CWD yarn g:compress',
+      lint: 'ABERLAAS_CWD=$INIT_CWD yarn g:lint',
+      'lint:fix': 'ABERLAAS_CWD=$INIT_CWD yarn g:lint:fix',
+    };
+    return {
+      author,
+      homepage,
+      license,
+      name,
+      repository,
+      scripts,
+    };
+  },
+  /**
+   * Scaffold a repo for use in a monorepo module contexte
+   **/
+  async run() {
+    await this.createRootWorkspace();
+    await this.createDocsWorkspace();
+    await this.createLibWorkspace();
+
+    await this.addLicenseFiles();
+    await this.addScripts();
+    await this.addConfigFiles();
+    await initHelper.addLibFiles();
+  },
+  __getProjectName: initHelper.getProjectName,
+  __getProjectAuthor: initHelper.getProjectAuthor.bind(initHelper),
+};

package/commands/precommit/index.js

@@ -15,6 +15,9 @@ export default {
     try {
       const result = await lintStaged({
         config,
+        // Allow use extended shell syntax in config, like pipes, redirects or
+        // env variables
+        shell: true,
       });
       // Linting failed
       if (!result) {

package/commands/test/index.js

@@ -18,27 +18,45 @@ export default {
    **/
   async run(cliArgs = {}) {
     const options = await this.vitestOptions(cliArgs);
-    const files = _.isEmpty(cliArgs._) ? [helper.hostPath()] : 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 (options.watch) {
+    if (isWatchMode) {
       registerConsoleShortcuts(vitest);
     }
 
-    // Note: vitest sets process.exitCode to 1 if tests fail
-    const initialExitCode = process.exitCode;
-    await vitest.start(files);
+    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;
+      }
+    }
 
-    // Close vitest if not watching files
-    if (!options.watch) {
-      await vitest.close();
+    const testsAreFailing = process.exitCode == 1;
+    process.exitCode = initialExitCode;
+
+    if (isWatchMode) {
+      return;
     }
 
-    if (process.exitCode == 1) {
-      process.exitCode = initialExitCode;
-      throw firostError('ERROR_TEST', 'Error while testing files');
+    // Stop vitest, it doesn't stop itself by default
+    await vitest.close();
+
+    if (testsAreFailing) {
+      throw firostError('ERROR_TEST_FAIL', 'Tests are failing');
     }
 
     return true;
@@ -52,7 +70,13 @@ export default {
   async vitestOptions(cliArgs = {}) {
     // Options that have special meaning in aberlaas and shouldn't be passed
     // as-is to vitest
-    const specialMeaningCliArgs = ['_', 'config', 'failFast', 'related'];
+    const specialMeaningCliArgs = [
+      '_',
+      'config',
+      'failFast',
+      'related',
+      'exclude',
+    ];
 
     // Reading base options from the config file
     const configFile = await helper.configFile(
@@ -73,11 +97,20 @@ export default {
       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
+    // 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);

package/configs/eslint.cjs

@@ -134,6 +134,11 @@ module.exports = {
           { 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

package/configs/lintstaged.js

@@ -12,7 +12,7 @@ export default {
   '*.js': ['yarn run lint:fix --js'],
 
   // Test
-  './lib/**/*.js': ['yarn run test --failFast --related'],
+  './lib/**/*.js': ['FORCE_COLOR=1 yarn run test --failFast --related'],
 
   // Compress
   '*.png': ['yarn run compress --png'],

package/configs/vite.js

@@ -1,4 +1,6 @@
-import { configDefaults, defineConfig } from 'vitest/config';
+import { defaultExclude, defineConfig } from 'vitest/config';
+
+const aberlaasVitestExclude = [...defaultExclude, '**/tmp/**'];
 
 const configDir = new URL('./vite/', import.meta.url).pathname;
 
@@ -14,8 +16,7 @@ export default defineConfig({
     // Tests should be in a __tests__ folder next to their code
     include: ['**/__tests__/**/*.js?(x)'],
     // We ignore temporary folders from the tests
-    exclude: [...configDefaults.exclude, '**/tmp/**'],
-    watchExclude: [...configDefaults.watchExclude, '**/tmp/**'],
+    exclude: aberlaasVitestExclude,
     // Restore mocks after each tests
     restoreMocks: true,
 
@@ -30,4 +31,12 @@ export default defineConfig({
       `${configDir}/test/setupFiles/testName.js`,
     ],
   },
+  server: {
+    watch: {
+      // Vitest 2.0 uses vite watcher, so files to exclude from watching are at
+      // the server level
+      // Source: https://vitest.dev/guide/migration.html#removal-of-the-watchexclude-option
+      ignored: aberlaasVitestExclude,
+    },
+  },
 });

package/package.json

@@ -2,7 +2,7 @@
   "name": "aberlaas",
   "type": "module",
   "description": "Scaffold your JavaScript projects with tests, lint and release scripts",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "repository": "pixelastic/aberlaas",
   "homepage": "https://projects.pixelastic.com/aberlaas/",
   "author": "Tim Carry (@pixelastic)",
@@ -58,7 +58,7 @@
     "prettier": "3.2.5",
     "std-mocks": "1.0.1",
     "stylelint": "13.13.1",
-    "vitest": "1.4.0",
+    "vitest": "2.1.1",
     "yaml-lint": "1.7.0"
   },
   "engines": {
@@ -72,10 +72,11 @@
     "release": "ABERLAAS_CWD=$INIT_CWD yarn g:release",
     "test": "ABERLAAS_CWD=$INIT_CWD yarn g:test",
     "test:watch": "ABERLAAS_CWD=$INIT_CWD yarn g:test:watch",
+    "test:meta": "ABERLAAS_CWD=$INIT_CWD yarn g:test:meta",
     "compress": "ABERLAAS_CWD=$INIT_CWD yarn g:compress",
     "lint": "ABERLAAS_CWD=$INIT_CWD yarn g:lint",
     "lint:fix": "ABERLAAS_CWD=$INIT_CWD yarn g:lint:fix",
     "postinstall": "./scripts/postinstall"
   },
-  "gitHead": "901e0aff17a63a548edcba92d984c8610d6e4362"
+  "gitHead": "cf8d18533d7a85069d52bb3d2ba5fe1627bef71b"
 }