aberlaas 2.1.0 → 2.3.0

package/commands/lint/js.js

@@ -1,7 +1,6 @@
 import helper from '../../helper.js';
 import _ from 'golgoth/lodash.js';
 import firostError from 'firost/error.js';
-import run from 'firost/run.js';
 import { ESLint } from 'eslint';
 
 export default {
@@ -11,7 +10,8 @@ export default {
    * @returns {Array} Array of files
    **/
   async getInputFiles(userPatterns) {
-    return await helper.findHostFiles(userPatterns, ['.js']);
+    const filePatterns = _.isEmpty(userPatterns) ? ['./**/*.js'] : userPatterns;
+    return await helper.findHostFiles(filePatterns, ['.js']);
   },
   /**
    * Lint all files and display results.
@@ -34,7 +34,7 @@ export default {
     const configFile = await helper.configFile(
       userConfigFile,
       '.eslintrc.cjs',
-      'lib/configs/eslint.cjs',
+      'configs/eslint.cjs',
     );
 
     // Run the actual lint
@@ -70,5 +70,4 @@ export default {
   async fix(userPatterns, userConfigFile) {
     return await this.run(userPatterns, userConfigFile, { fix: true });
   },
-  __run: run,
 };

package/commands/lint/json.js

@@ -13,7 +13,10 @@ export default {
    * @returns {Array} Array of files
    **/
   async getInputFiles(userPatterns) {
-    return await helper.findHostFiles(userPatterns, ['.json']);
+    const filePatterns = _.isEmpty(userPatterns)
+      ? ['./**/*.json']
+      : userPatterns;
+    return await helper.findHostFiles(filePatterns, ['.json']);
   },
   /**
    * Lint all files and display results.
@@ -30,7 +33,7 @@ export default {
     const errorMessages = [];
     await pMap(files, async (filepath) => {
       try {
-        this.__parse(await read(filepath));
+        JSON.parse(await read(filepath));
       } catch (error) {
         hasErrors = true;
         const relativePath = path.relative(helper.hostRoot(), filepath);
@@ -54,8 +57,6 @@ export default {
     if (_.isEmpty(files)) {
       return true;
     }
-    await this.__prettierFix(files);
+    await prettierFix(files);
   },
-  __prettierFix: prettierFix,
-  __parse: JSON.parse,
 };

package/commands/lint/yml.js

@@ -14,7 +14,10 @@ export default {
    * @returns {Array} Array of files
    **/
   async getInputFiles(userPatterns) {
-    return await helper.findHostFiles(userPatterns, ['.yml', '.yaml']);
+    const filePatterns = _.isEmpty(userPatterns)
+      ? ['./**/*.yml', './**/*.yaml']
+      : userPatterns;
+    return await helper.findHostFiles(filePatterns, ['.yml', '.yaml']);
   },
   /**
    * Lint all files and display results.
@@ -32,7 +35,7 @@ export default {
     await pMap(files, async (filepath) => {
       const input = await read(filepath);
       try {
-        await this.__lint(input);
+        await yamlLint.lint(input);
       } catch (error) {
         hasErrors = true;
         const relativePath = path.relative(helper.hostRoot(), filepath);
@@ -56,8 +59,6 @@ export default {
     if (_.isEmpty(files)) {
       return true;
     }
-    await this.__prettierFix(files);
+    await prettierFix(files);
   },
-  __prettierFix: prettierFix,
-  __lint: yamlLint.lint,
 };

package/commands/precommit/index.js

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

package/commands/setup/index.js

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

package/commands/test/index.js

@@ -1,5 +1,6 @@
+import { createVitest } from 'vitest/node';
 import helper from '../../helper.js';
-import run from 'firost/run.js';
+import firostError from 'firost/error.js';
 import _ from 'golgoth/lodash.js';
 
 export default {
@@ -15,70 +16,70 @@ export default {
    * @param {object} cliArgs CLI Argument object, as created by minimist
    * @returns {boolean} true on success
    **/
-  async run(cliArgs) {
-    const options = await this.vitestCliOptions(cliArgs);
-    const binary = await helper.which('vitest');
+  async run(cliArgs = {}) {
+    const options = await this.vitestOptions(cliArgs);
+    const files = _.isEmpty(cliArgs._) ? [helper.hostPath()] : cliArgs._;
+
+    const vitest = await createVitest('test', options);
+
+    // Note: vitest sets process.exitCode to 1 if tests fail
+    const initialExitCode = process.exitCode;
+    await vitest.start(files);
+
+    if (!options.watch) {
+      await vitest.close();
+    }
+
+    if (process.exitCode == 1) {
+      process.exitCode = initialExitCode;
+      throw firostError('ERROR_TEST', 'Error while testing files');
+    }
 
-    await run(`${binary} ${options.join(' ')}`, { stdin: true });
     return true;
   },
 
   /**
-   * Transform all aberlaas test cli options into suitable vitest CLI options
+   * Transform all aberlaas test cli options into suitable vitest options
    * @param {object} cliArgs CLI Argument object, as created by minimist
-   * @returns {Array} Array of cli arguments and values
+   * @returns {Array} Array of options for vitest
    **/
-  async vitestCliOptions(cliArgs = {}) {
+  async vitestOptions(cliArgs = {}) {
     // Options that have special meaning in aberlaas and shouldn't be passed
     // as-is to vitest
-    const aberlaasOptions = ['_', 'watch', 'config', 'failFast', 'related'];
+    const specialMeaningCliArgs = ['_', 'config', 'failFast', 'related'];
 
-    // Input files
-    const inputFiles = _.isEmpty(cliArgs._) ? [helper.hostPath()] : cliArgs._;
-    const vitestOptions = [...inputFiles];
-
-    // Run "vitest related" when --related is passed
-    if (cliArgs.related) {
-      vitestOptions.unshift('related');
-    }
-
-    // Stop early as soon as one test fails
-    if (cliArgs.failFast) {
-      vitestOptions.push('--bail=1');
-    }
-
-    // Disable watch by default
-    vitestOptions.push(cliArgs.watch ? '--watch=true' : '--watch=false');
-
-    // Allow a success, even if no files are passed
-    vitestOptions.push('--passWithNoTests');
-
-    // Hide skipped tests, allowing less noisy debug with fit/fdescribe
-    vitestOptions.push('--hideSkippedTests');
-
-    // Config file
+    // Reading base options from the config file
     const configFile = await helper.configFile(
       cliArgs.config,
       'vite.config.js',
-      'lib/configs/vite.js',
+      'configs/vite.js',
     );
-    vitestOptions.push(`--config=${configFile}`);
+    const optionsFromConfig = (await helper.import(configFile)).test;
 
-    // Pass any unknown options to vitest
-    _.each(cliArgs, (argValue, argKey) => {
-      // Skip keys that we already handled
-      if (_.includes(aberlaasOptions, argKey)) {
-        return;
-      }
-
-      if (argValue === true) {
-        vitestOptions.push(`--${argKey}`);
-        return;
-      }
+    // Enhancing options with custom CLI arguments
+    const optionsFromAberlaas = {
+      // We always allow fit/fdescribe, even in CI. Those errors will be caught
+      // by the lint command instead
+      allowOnly: true,
+    };
+    // --failFast stops early as soon as one test fails
+    if (cliArgs.failFast) {
+      optionsFromAberlaas.bail = 1;
+    }
+    // --related runs also related files
+    // Note (2024-01-19): The related option is not documented, but should
+    // contain the list of files
+    if (cliArgs.related) {
+      optionsFromAberlaas.related = cliArgs._;
+    }
 
-      vitestOptions.push(`--${argKey}=${argValue}`);
-    });
+    // Passing other CLI options directly to vitest
+    const optionsFromCli = _.omit(cliArgs, specialMeaningCliArgs);
 
-    return vitestOptions;
+    return {
+      ...optionsFromConfig,
+      ...optionsFromAberlaas,
+      ...optionsFromCli,
+    };
   },
 };

package/configs/eslint.cjs

@@ -1,3 +1,5 @@
+// Note: ESLint doesn't support ESM configuration as of 2024-02-19. This file
+// needs to stay as a CommonJS file
 const nodeConfig = require('./node.cjs');
 module.exports = {
   env: {
@@ -15,6 +17,23 @@ module.exports = {
     'plugin:import/recommended',
     'plugin:prettier/recommended',
   ],
+  settings: {
+    // eslint-plugin-import doesn't currently support the "exports" syntax in
+    // package.json. This 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
+    //
+    // Until this is fixed (see
+    // https://github.com/import-js/eslint-plugin-import/issues/2430)
+    // we manually define the most common extensions
+    'import/resolver': {
+      node: {
+        extensions: ['.js', '.cjs', '.mjs', '.d.ts'],
+      },
+    },
+  },
   plugins: ['jsdoc', 'prettier'],
   rules: {
     'dot-notation': ['error'],
@@ -98,10 +117,8 @@ module.exports = {
         testName: false,
         // Shorter method names
         fit: false,
-        ftest: false,
         fdescribe: false,
         xit: false,
-        xtest: false,
         xdescribe: false,
 
         captureOutput: false,
@@ -113,7 +130,7 @@ module.exports = {
       ],
       rules: {
         'no-restricted-globals': [
-          'warn',
+          'error',
           {
             name: 'fit',
             message: 'No focused test',

package/configs/lintstaged.js

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

package/configs/node.cjs

@@ -2,4 +2,5 @@
 // which we also have to keep in cjs format
 module.exports = {
   nodeVersion: '18.18.0', // Also see templates/_circleci/config.yml
+  yarnVersion: '4.0.2',
 };

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

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

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

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

package/configs/vite.js

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

package/helper.js

@@ -159,4 +159,17 @@ export default {
   async yarnRun(scriptName) {
     return await run(`yarn run ${scriptName}`, { cwd: this.hostRoot() });
   },
+  /**
+   * Dynamically import a file
+   * This is a wrapper around the default import, but bypasses the cache
+   * It makes sure importing a file several times always loads the last version
+   * TODO: This should probably be moved in firost once firost is moved to ESM
+   * @param {string} filepath Path to the file to load
+   * @returns {object} Content of the loaded file
+   **/
+  async import(filepath) {
+    const content = await import(`${filepath}?cacheBusting=${Date.now()}`);
+
+    return content.default || content;
+  },
 };

package/main.js

@@ -6,7 +6,6 @@ import commandCi from './commands/ci/index.js';
 import commandCompress from './commands/compress/index.js';
 import commandInit from './commands/init/index.js';
 import commandPrecommit from './commands/precommit/index.js';
-import commandRelease from './commands/release/index.js';
 import commandTest from './commands/test/index.js';
 import commandLint from './commands/lint/index.js';
 import commandReadme from './commands/readme/index.js';
@@ -25,7 +24,6 @@ export default {
       lint: commandLint,
       precommit: commandPrecommit,
       readme: commandReadme,
-      release: commandRelease,
       setup: commandSetup,
       test: commandTest,
     };

package/package.json

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

package/templates/_circleci/config.yml

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

package/templates/_eslintignore.conf

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

package/templates/_gitattributes

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

package/templates/_gitignore

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

package/templates/_yarnrc.yml

@@ -0,0 +1,9 @@
+compressionLevel: 0
+
+defaultSemverRangePrefix: ''
+
+enableGlobalCache: true
+
+nmMode: hardlinks-local
+
+nodeLinker: node-modules

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

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+set -e
+
+aberlaas compress "$@"

package/templates/scripts/hooks/pre-commit

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

package/templates/stylelint.config.js

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