aberlaas 2.7.0 → 2.9.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,192 @@
+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';
+import nodeConfig from '../../configs/node.cjs';
+
+/**
+ * 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 CircleCI Config file
+   **/
+  async addCircleCIConfigFile() {
+    const configFilepath = helper.hostPath('./.circleci/config.yml');
+
+    // Start by adding a template
+    await this.copyToHost('templates/_circleci/config.yml', configFilepath);
+
+    // Replace placeholder with real value
+    const templateContent = await read(configFilepath);
+    const actualContent = _.chain(templateContent)
+      .replace('{nodeVersion}', nodeConfig.nodeVersion)
+      .replace('{yarnVersion}', nodeConfig.yarnVersion)
+      .value();
+
+    // Write it again
+    await write(actualContent, configFilepath);
+  },
+
+  /**
+   * 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());
+  },
+};