aberlaas 2.8.0 → 2.10.0

package/bin/aberlaas.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import aberlaas from '../main.js';
+import aberlaas from '../lib/main.js';
 
 (async () => {
   await aberlaas.run(process.argv.slice(2));

package/configs/eslint.js

@@ -0,0 +1,3 @@
+import config from 'aberlaas-lint/configs/eslint';
+
+export default config;

package/configs/lintstaged.js

@@ -1,25 +1,3 @@
-const readmeCommands = [
-  'yarn run aberlaas readme',
-  'git add ./README.md ./lib/README.md',
-];
+import config from 'aberlaas-precommit/configs/lintstaged';
 
-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': ['FORCE_COLOR=1 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,
-};
+export default config;

package/configs/prettier.js

@@ -1,4 +1,3 @@
-export default {
-  singleQuote: true,
-  printWidth: 80,
-};
+import config from 'aberlaas-lint/configs/prettier';
+
+export default config;

package/configs/stylelint.js

@@ -1,41 +1,3 @@
-// Initially exported from
-// https://github.com/stylelint/stylelint-config-recommended/blob/master/index.js
-export default {
-  rules: {
-    'at-rule-no-unknown': [
-      true,
-      {
-        ignoreAtRules: ['screen', 'tailwind'],
-      },
-    ],
-    'block-no-empty': true,
-    'block-opening-brace-space-before': ['always'],
-    'color-no-invalid-hex': true,
-    'comment-no-empty': true,
-    'declaration-block-no-duplicate-properties': [
-      true,
-      {
-        ignore: ['consecutive-duplicates-with-different-values'],
-      },
-    ],
-    'declaration-block-no-redundant-longhand-properties': true,
-    'declaration-block-no-shorthand-property-overrides': true,
-    'declaration-block-trailing-semicolon': ['always'],
-    'font-family-no-duplicate-names': true,
-    'function-calc-no-unspaced-operator': true,
-    'function-linear-gradient-no-nonstandard-direction': true,
-    'keyframe-declaration-no-important': true,
-    'media-feature-name-no-unknown': true,
-    'no-empty-source': true,
-    'no-extra-semicolons': true,
-    'no-invalid-double-slash-comments': true,
-    'property-no-unknown': true,
-    'selector-pseudo-class-no-unknown': true,
-    'selector-pseudo-element-no-unknown': true,
-    'selector-type-no-unknown': true,
-    'string-quotes': 'single',
-    'shorthand-property-no-redundant-values': true,
-    'string-no-newline': true,
-    'unit-no-unknown': true,
-  },
-};
+import config from 'aberlaas-lint/configs/stylelint';
+
+export default config;

package/configs/vite.js

@@ -1,42 +1,3 @@
-import { defaultExclude, defineConfig } from 'vitest/config';
+import config from 'aberlaas-test/configs/vite';
 
-const aberlaasVitestExclude = [...defaultExclude, '**/tmp/**'];
-
-const configDir = new URL('./vite/', import.meta.url).pathname;
-
-export default defineConfig({
-  test: {
-    // 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
-    exclude: aberlaasVitestExclude,
-    // 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`,
-      `${configDir}/test/setupFiles/captureOutput.js`,
-      `${configDir}/test/setupFiles/fit-xit-fdescribe-xdescribe.js`,
-      `${configDir}/test/setupFiles/jest-extended.js`,
-      `${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,
-    },
-  },
-});
+export default config;

package/{main.js → lib/main.js}

@@ -1,45 +1,40 @@
 import path from 'path';
 import minimist from 'minimist';
-import { absolute, consoleError, env, exit } from 'firost';
+import { absolute, consoleError, env, exit, firostImport } from 'firost';
 import { _ } from 'golgoth';
-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 commandTest from './commands/test/index.js';
-import commandLint from './commands/lint/index.js';
-import commandReadme from './commands/readme/index.js';
-import commandSetup from './commands/setup/index.js';
 
 export default {
-  /**
-   * List of allowed commands to run
-   * @returns {Array} List of allowed commands to run
-   **/
-  allCommands() {
-    return {
-      ci: commandCi,
-      compress: commandCompress,
-      init: commandInit,
-      lint: commandLint,
-      precommit: commandPrecommit,
-      readme: commandReadme,
-      setup: commandSetup,
-      test: commandTest,
+  async getCommand(commandName) {
+    const mapping = {
+      ci: 'aberlaas-ci',
+      compress: 'aberlaas-compress',
+      init: 'aberlaas-init',
+      lint: 'aberlaas-lint',
+      precommit: 'aberlaas-precommit',
+      readme: 'aberlaas-readme',
+      setup: 'aberlaas-setup',
+      test: 'aberlaas-test',
     };
+    const commandModuleName = mapping[commandName];
+    if (!commandModuleName) {
+      return false;
+    }
+
+    return await firostImport(commandModuleName);
   },
   /**
    * 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.
+   * Yarn always sets INIT_CWD to the directory where the command was called,
+   * but because scripts in child workspaces are actually calling scripts in the
+   * root workspace, through the g: syntax, that value is overwritten. This is
+   * why we save the original calling directory in ABERLAAS_CWD, in our
+   * package.json script definitions 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');
@@ -56,14 +51,15 @@ export default {
    * Run the command specified on the command-line, along with specific
    * arguments
    * @param {Array} rawArgs CLI args
-   **/
+   */
   async run(rawArgs) {
     const args = minimist(rawArgs, {
       boolean: true,
     });
 
     const commandName = args._[0];
-    const command = this.allCommands()[commandName];
+    const command = await this.getCommand(commandName);
+
     if (!command) {
       this.__consoleError(`Unknown command ${commandName}`);
       this.__exit(1);

package/package.json

@@ -2,7 +2,7 @@
   "name": "aberlaas",
   "type": "module",
   "description": "Scaffold your JavaScript projects with tests, lint and release scripts",
-  "version": "2.8.0",
+  "version": "2.10.0",
   "repository": "pixelastic/aberlaas",
   "homepage": "https://projects.pixelastic.com/aberlaas/",
   "author": "Tim Carry (@pixelastic)",
@@ -22,61 +22,53 @@
     "configs/",
     "scripts/",
     "templates/",
-    "*.js"
+    "lib/*.js"
   ],
   "exports": {
-    ".": "./main.js",
-    "./configs/vite": "./configs/vite.js",
+    ".": "./lib/main.js",
+    "./configs/eslint": "./configs/eslint.js",
     "./configs/lintstaged": "./configs/lintstaged.js",
     "./configs/prettier": "./configs/prettier.js",
-    "./configs/stylelint": "./configs/stylelint.js"
+    "./configs/stylelint": "./configs/stylelint.js",
+    "./configs/vite": "./configs/vite.js"
   },
-  "main": "./main.js",
+  "main": "./lib/main.js",
   "bin": "bin/aberlaas.js",
   "dependencies": {
-    "@octokit/rest": "18.12.0",
-    "ci-info": "3.9.0",
-    "dedent": "1.5.1",
-    "eslint": "8.57.0",
-    "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-jsdoc": "46.10.1",
-    "eslint-plugin-n": "16.6.2",
-    "eslint-plugin-prettier": "5.1.3",
-    "eslint-plugin-vitest": "0.4.1",
-    "eslint-plugin-vitest-globals": "1.5.0",
-    "find-up": "5.0.0",
-    "firost": "3.5.0",
-    "front-matter": "4.0.2",
-    "gilmore": "0.2.0",
-    "golgoth": "2.1.0",
-    "jest-extended": "4.0.2",
-    "lint-staged": "11.2.6",
+    "aberlaas-ci": "^2.10.0",
+    "aberlaas-compress": "^2.10.0",
+    "aberlaas-helper": "^2.10.0",
+    "aberlaas-init": "^2.10.0",
+    "aberlaas-lint": "^2.10.0",
+    "aberlaas-precommit": "^2.10.0",
+    "aberlaas-readme": "^2.10.0",
+    "aberlaas-setup": "^2.10.0",
+    "aberlaas-test": "^2.10.0",
+    "aberlaas-versions": "^2.10.0",
+    "dedent": "1.5.3",
+    "firost": "4.3.0",
+    "gilmore": "1.0.0",
+    "golgoth": "2.4.0",
     "minimist": "1.2.8",
-    "np": "7.7.0",
-    "parse-github-repo-url": "1.4.1",
-    "prettier": "3.2.5",
-    "std-mocks": "1.0.1",
-    "stylelint": "13.13.1",
-    "vitest": "2.1.1",
-    "yaml-lint": "1.7.0"
+    "std-mocks": "2.0.0"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=18.18.0"
   },
   "scripts": {
-    "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",
-    "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"
+    "build": "../../scripts/local/build",
+    "build:prod": "../../scripts/local/build-prod",
+    "cms": "../../scripts/local/cms",
+    "serve": "../../scripts/local/serve",
+    "ci": "../../scripts/local/ci",
+    "release": "../../scripts/local/release",
+    "update": "node ../../scripts/meta/update.js",
+    "test:meta": "../../scripts/local/test-meta",
+    "test": "../../scripts/local/test",
+    "test:watch": "../../scripts/local/test-watch",
+    "compress": "../../scripts/local/compress",
+    "lint": "../../scripts/local/lint",
+    "lint:fix": "../../scripts/local/lint-fix"
   },
-  "gitHead": "cf8d18533d7a85069d52bb3d2ba5fe1627bef71b"
+  "gitHead": "bcdaf87c198a588e02b5539c222f611e356d3079"
 }

package/commands/ci/index.js

@@ -1,47 +0,0 @@
-import ciInfo from 'ci-info';
-import { consoleInfo, run } from 'firost';
-import commandTest from '../test/index.js';
-import commandLint from '../lint/index.js';
-
-export default {
-  /**
-   * Checks if currently running on a CI server
-   * @returns {boolean} True if on a CI server
-   **/
-  isCI() {
-    return ciInfo.isCI;
-  },
-  /**
-   * Run CI scripts and fail the job if any fails
-   * Runs lint and test by default, but can be changed with --no-test and
-   * --no-lint
-   * @param {object} cliArgs CLI Argument object, as created by minimist
-   * @returns {boolean} True on success, throws on error
-   **/
-  async run(cliArgs = {}) {
-    const args = {
-      test: true,
-      lint: true,
-      ...cliArgs,
-    };
-
-    if (!this.isCI()) {
-      this.__consoleInfo('Current system is not a CI, skipping');
-      return true;
-    }
-
-    if (args.test) {
-      await this.__runTest();
-    }
-
-    if (args.lint) {
-      await this.__runLint();
-    }
-
-    return true;
-  },
-  __runTest: commandTest.run.bind(commandTest),
-  __runLint: commandLint.run.bind(commandLint),
-  __run: run,
-  __consoleInfo: consoleInfo,
-};

package/commands/compress/dummy.js

@@ -1,11 +0,0 @@
-/**
- * This is a temporary, dummy file to be able to test the top-level
- * compress.run() function. I assume I'll add more compression types in addition
- * to png, so this dummy compress is just to test that all compress are
- * correctly called, but it doesn't do anything
- **/
-export default {
-  async run() {
-    return true;
-  },
-};

package/commands/compress/index.js

@@ -1,41 +0,0 @@
-import { _, pMap } from 'golgoth';
-import { consoleError, firostError } from 'firost';
-import compressPng from './png.js';
-import compressDummy from './dummy.js';
-
-export default {
-  types: {
-    png: compressPng,
-    dummy: compressDummy,
-  },
-  /**
-   * Wrapper to compress all supported formats
-   * @param {object} cliArgs CLI Argument object, as created by minimist
-   * @returns {boolean} True on success
-   **/
-  async run(cliArgs) {
-    const allTypesKeys = _.keys(this.types);
-    const userTypes = _.intersection(_.keys(cliArgs), allTypesKeys);
-    const typesToCompress = _.isEmpty(userTypes) ? allTypesKeys : userTypes;
-
-    let hasErrors = false;
-    await pMap(typesToCompress, async (type) => {
-      try {
-        const userPatterns = _.get(cliArgs, '_');
-        const compresser = this.types[type];
-
-        await compresser.run(userPatterns);
-      } catch (error) {
-        this.__consoleError(error.message);
-        hasErrors = true;
-      }
-    });
-
-    if (hasErrors) {
-      throw firostError('ERROR_COMPRESS', 'Error while compressing files');
-    }
-
-    return true;
-  },
-  __consoleError: consoleError,
-};

package/commands/compress/png.js

@@ -1,49 +0,0 @@
-import { _ } from 'golgoth';
-import { firostError, run, which } from 'firost';
-import helper from '../../helper.js';
-
-export default {
-  /**
-   * Find the png files to compress
-   * @param {Array} userPatterns Patterns to narrow the search down
-   * @returns {Array} Array of files
-   **/
-  async getInputFiles(userPatterns) {
-    const filePatterns = _.isEmpty(userPatterns)
-      ? ['./**/*.png']
-      : userPatterns;
-    return await helper.findHostFiles(filePatterns, ['.png']);
-  },
-
-  /**
-   
-   * Returns path to the binary to execute
-   * @returns {string|boolean} Path to the binary, or false if not found
-   **/
-  async getBinaryPath() {
-    return await this.__which('pngmin');
-  },
-  /**
-   * Compress files
-   * @param {Array} userPatterns Patterns to narrow the search down
-   * @returns {boolean} True on success
-   **/
-  async run(userPatterns) {
-    // Stop early if no bin
-    const binaryPath = await this.getBinaryPath();
-    if (!binaryPath) {
-      return true;
-    }
-
-    try {
-      const files = await this.getInputFiles(userPatterns);
-      const command = `${binaryPath} ${files.join(' ')}`;
-      await run(command, { stdout: false });
-    } catch (error) {
-      throw firostError('PngCompressError', error.message);
-    }
-
-    return true;
-  },
-  __which: which,
-};

package/commands/init/helper.js

@@ -1,171 +0,0 @@
-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());
-  },
-};