aberlaas 2.7.0 → 2.9.0

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.9.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": "26cb1b6e33199730ccfb693ef92584f35cfa2aea"
 }

package/templates/_circleci/config.yml

@@ -3,12 +3,20 @@ version: 2.1
 aliases:
   - &defaults
     docker:
-      - image: cimg/node:18.18.0
+      - image: cimg/node:{nodeVersion}
   - &restore_cache
     restore_cache:
       key: yarn-cache-{{ checksum "yarn.lock" }}
-  - &yarn_install
-    run: 'yarn install'
+  - &install_yarn
+    run:
+      name: 'Installing correct yarn version'
+      command: |
+        corepack enable --install-directory="/home/circleci/bin"
+        yarn set version {yarnVersion}
+  - &install_dependencies
+    run:
+      name: 'Installing dependencies'
+      command: 'yarn install'
   - &save_cache
     save_cache:
       key: yarn-cache-{{ checksum "yarn.lock" }}
@@ -21,7 +29,8 @@ jobs:
     steps:
       - checkout
       - *restore_cache
-      - *yarn_install
+      - *install_yarn
+      - *install_dependencies
       - *save_cache
       - run: 'yarn run ci'