aberlaas 2.2.0 → 2.4.0

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, registerConsoleShortcuts } 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,76 @@ 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._;
 
-    await run(`yarn run vitest ${options.join(' ')}`, { stdin: true });
-    return true;
-  },
+    const vitest = await createVitest('test', options);
 
-  /**
-   * Transform all aberlaas test cli options into suitable vitest CLI options
-   * @param {object} cliArgs CLI Argument object, as created by minimist
-   * @returns {Array} Array of cli arguments and values
-   **/
-  async vitestCliOptions(cliArgs = {}) {
-    // Options that have special meaning in aberlaas and shouldn't be passed
-    // as-is to vitest
-    const aberlaasOptions = ['_', 'watch', 'config', 'failFast', 'related'];
+    // Enable keyboard interaction in watch mode
+    if (options.watch) {
+      registerConsoleShortcuts(vitest);
+    }
 
-    // Input files
-    const inputFiles = _.isEmpty(cliArgs._) ? [helper.hostPath()] : cliArgs._;
-    const vitestOptions = [...inputFiles];
+    // Note: vitest sets process.exitCode to 1 if tests fail
+    const initialExitCode = process.exitCode;
+    await vitest.start(files);
 
-    // Run "vitest related" when --related is passed
-    if (cliArgs.related) {
-      vitestOptions.unshift('related');
+    // Close vitest if not watching files
+    if (!options.watch) {
+      await vitest.close();
     }
 
-    // Stop early as soon as one test fails
-    if (cliArgs.failFast) {
-      vitestOptions.push('--bail=1');
+    if (process.exitCode == 1) {
+      process.exitCode = initialExitCode;
+      throw firostError('ERROR_TEST', 'Error while testing files');
     }
 
-    // Disable watch by default
-    vitestOptions.push(cliArgs.watch ? '--watch=true' : '--watch=false');
-
-    // Allow a success, even if no files are passed
-    vitestOptions.push('--passWithNoTests');
+    return true;
+  },
 
-    // Hide skipped tests, allowing less noisy debug with fit/fdescribe
-    vitestOptions.push('--hideSkippedTests');
+  /**
+   * Transform all aberlaas test cli options into suitable vitest options
+   * @param {object} cliArgs CLI Argument object, as created by minimist
+   * @returns {Array} Array of options for vitest
+   **/
+  async vitestOptions(cliArgs = {}) {
+    // Options that have special meaning in aberlaas and shouldn't be passed
+    // as-is to vitest
+    const specialMeaningCliArgs = ['_', 'config', 'failFast', 'related'];
 
-    // 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: {
@@ -17,8 +19,8 @@ module.exports = {
   ],
   settings: {
     // eslint-plugin-import doesn't currently support the "exports" syntax in
-    // package.json. This allow mapping between custom entrypoints and
-    // files on disk.
+    // package.json. This is supposed to allow mapping between custom
+    // entrypoints and files on disk.
     // For example, it doesn't understand "import * from 'vitest/config';" as
     // "vitest/config/" isn't really an existing filepath, but a mapping defined
     // in vitest package.json
@@ -59,6 +61,11 @@ module.exports = {
         property: 'export',
         message: 'Typo: Use module.exports instead',
       },
+      {
+        object: '_',
+        property: 'contains',
+        message: 'Typo: Use _.includes instead',
+      },
     ],
     'no-unused-vars': [
       'error',

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,8 @@
 // which we also have to keep in cjs format
 module.exports = {
   nodeVersion: '18.18.0', // Also see templates/_circleci/config.yml
+  yarnVersion: '4.0.2',
+  norskaVersion: '2.9.0',
+  norskaThemeDocsVersion: '5.0.3',
+  lernaVersion: '4.0.0',
 };

package/configs/{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

@@ -1,12 +1,14 @@
 import minimist from 'minimist';
 import consoleError from 'firost/consoleError.js';
 import exit from 'firost/exit.js';
+import env from 'firost/env.js';
+import absolute from 'firost/absolute.js';
 import _ from 'golgoth/lodash.js';
+import path from 'path';
 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,11 +27,34 @@ export default {
       lint: commandLint,
       precommit: commandPrecommit,
       readme: commandReadme,
-      release: commandRelease,
       setup: commandSetup,
       test: commandTest,
     };
   },
+  /**
+   * Converts a list of filepaths to absolute filepaths
+   * Note: We want to be able to call commands like "aberlaas lint" from the
+   * workspace root or any child workspace. We also want to be able to use
+   * relative or absolute filepaths as arguments.
+   * INIT_CWD is always set to the directory where the command was called, but
+   * because scripts in child workspaces are actually calling scripts in the
+   * root workspace, that value is overwritten. This is why we save the original
+   * calling directory in ABERLAAS_CWD, and use that value if available.
+   * @param {Array} filepaths Array of filepaths
+   * @returns {Array} Array of absolute filepaths
+   **/
+  convertFilepathsToAbsolute(filepaths) {
+    const callingDirectory =
+      this.__env('ABERLAAS_CWD') || this.__env('INIT_CWD');
+    return _.map(filepaths, (inputFilepath) => {
+      const filepath =
+        inputFilepath[0] == '/'
+          ? inputFilepath
+          : path.resolve(callingDirectory, inputFilepath);
+
+      return absolute(filepath);
+    });
+  },
   /**
    * Run the command specified on the command-line, along with specific
    * arguments
@@ -51,6 +76,9 @@ export default {
     // Remove the initial method from args passed to the command
     args._ = _.drop(args._, 1);
 
+    // Make all filepaths absolute
+    args._ = this.convertFilepathsToAbsolute(args._);
+
     try {
       await command.run(args);
     } catch (err) {
@@ -58,6 +86,7 @@ export default {
       this.__exit(1);
     }
   },
+  __env: env,
   __consoleError: consoleError,
   __exit: exit,
 };

package/package.json

@@ -2,22 +2,13 @@
   "name": "aberlaas",
   "type": "module",
   "description": "Scaffold your JavaScript projects with tests, lint and release scripts",
-  "version": "2.2.0",
+  "version": "2.4.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/",
-    "scripts/",
-    "*.js",
     "commands/ci/*.js",
     "commands/compress/*.js",
     "commands/init/*.js",
@@ -25,20 +16,28 @@
     "commands/lint/helpers/*.js",
     "commands/precommit/*.js",
     "commands/readme/*.js",
-    "commands/release/*.js",
     "commands/setup/*.js",
-    "commands/setup/autoRelease/*.js",
     "commands/setup/helpers/*.js",
     "commands/test/*.js",
     "configs/",
-    "templates/"
+    "scripts/",
+    "templates/",
+    "*.js"
   ],
+  "exports": {
+    ".": "./main.js",
+    "./configs/vite": "./configs/vite.js",
+    "./configs/lintstaged": "./configs/lintstaged.js",
+    "./configs/prettier": "./configs/prettier.js",
+    "./configs/stylelint": "./configs/stylelint.js"
+  },
+  "main": "./main.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",
@@ -66,15 +65,17 @@
     "node": ">=18"
   },
   "scripts": {
-    "build": "../scripts/docs/build",
-    "build:prod": "../scripts/docs/build-prod",
-    "lint": "../scripts/lib/lint",
-    "lint:fix": "../scripts/lib/lint-fix",
-    "release": "../scripts/release",
-    "serve": "../scripts/docs/serve",
-    "test": "../scripts/lib/test",
-    "test:watch": "../scripts/lib/test-watch",
+    "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",
+    "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",
+    "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": "bbf9f5024d007deca00abf451ddf879c876d80aa"
+  "gitHead": "fc4d64e02a654a347026a5c00b9dbb0fa3c92be2"
 }

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,4 @@
+/.yarn/**            linguist-vendored
+/.yarn/releases/*    binary
+/.yarn/plugins/**/*  binary
+/.pnp.*              binary linguist-generated

package/templates/_gitignore

@@ -0,0 +1,29 @@
+# Hidden files
+.DS_Store
+.envrc
+
+# Directories
+build/
+dist/
+node_modules/
+tmp/
+
+# Files
+Thumbs.db
+lerna-debug.log
+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/lerna.json

@@ -0,0 +1,6 @@
+{
+  "version": "0.0.1",
+  "useWorkspaces": true,
+  "packages": ["lib", "docs"],
+  "npmClient": "yarn"
+}

package/templates/lib/__tests__/main.js

@@ -1,11 +1,13 @@
 import current from '../main.js';
 
-describe('current', () => {
-  it('should do something', async () => {
-    const input = 'foo';
+describe('main', () => {
+  describe('run', () => {
+    it('should pass', async () => {
+      const input = 'something';
 
-    const actual = current.run(input);
+      const actual = current.run(input);
 
-    expect(actual).toBe(true);
+      expect(actual).toBe('something');
+    });
   });
 });

package/templates/lib/main.js

@@ -1,5 +1,5 @@
 export default {
-  run() {
-    return true;
+  run(input) {
+    return input;
   },
 };

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/ci

@@ -1,4 +1,6 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 set -e
 
+echo "node $(node --version), yarn $(yarn --version)"
+
 aberlaas ci "$@"

package/templates/scripts/compress

@@ -1,4 +1,4 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 set -e
 
-aberlaas compress "$@"
+aberlaas compress "${@:-$INIT_CWD}"

package/templates/scripts/docs/build

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+echo "TODO: Set a default script"

package/templates/scripts/docs/build-prod

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+echo "TODO: Set a default script"

package/templates/scripts/docs/cms

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+echo "TODO: Set a default script"

package/templates/scripts/docs/serve

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+echo "TODO: Set a default script"

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/scripts/lib/release

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -e
+
+yarn run test
+lerna publish --yes "$@"

package/templates/scripts/lib/test

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+aberlaas test "${@:-./lib}"

package/templates/scripts/lib/test-watch

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+aberlaas test --watch "${@:-./lib}"

package/templates/scripts/lint

@@ -1,4 +1,4 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 set -e
 
-aberlaas lint "$@"
+aberlaas lint "${@:-$INIT_CWD}"

package/templates/scripts/lint-fix

@@ -1,4 +1,4 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 set -e
 
-aberlaas lint "$@" --fix
+aberlaas lint --fix "${@:-$INIT_CWD}"

package/templates/stylelint.config.js

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