aberlaas 2.0.0 → 2.1.0

package/README.md

@@ -51,7 +51,6 @@ The following table lists all the scripts added:
 
 | Script                     | Description                                               |
 | -------------------------- | --------------------------------------------------------- |
-| `yarn run husky:precommit` | Run before any commit (through Husky)                     |
 | `yarn run test`            | Run tests using Jest                                      |
 | `yarn run test:watch`      | Run tests using Jest in watch mode                        |
 | `yarn run ci`              | Run testing and linting in CI                             |
@@ -111,7 +110,7 @@ describe('moduleName', () => {
 
 ## Precommit hooks
 
-`aberlaas` uses `husky` and `lint-staged` to make sure all committed code
+`aberlaas` uses `lint-staged` to make sure all committed code
 follows your coding standard.
 
 All `css`, `js`, `json` and `yml` files will be checked for parsing errors
@@ -189,7 +188,7 @@ 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`, `.stylelintrc.js`, `jest.config.js` and `.huskyrc.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.
 

package/bin/{aberlaas → aberlaas.js}

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

package/commands/ci/autoRelease.js

@@ -1,11 +1,12 @@
-const release = require('../release.js');
-const consoleInfo = require('firost/consoleInfo');
-const _ = require('golgoth/lodash');
-const run = require('firost/run');
-const write = require('firost/write');
-const exists = require('firost/exists');
-const helper = require('../../helper.js');
-module.exports = {
+import release from '../release/index.js';
+import consoleInfo from 'firost/consoleInfo.js';
+import _ from 'golgoth/lodash.js';
+import run from 'firost/run.js';
+import write from 'firost/write.js';
+import exists from 'firost/exists.js';
+import helper from '../../helper.js';
+
+export default {
   /**
    * Run a git command in the repo
    *

package/commands/ci/index.js

@@ -1,13 +1,13 @@
-const helper = require('../../helper.js');
-const ciInfo = require('ci-info');
-const _ = require('golgoth/lodash');
-const pMap = require('golgoth/pMap');
-const readJson = require('firost/readJson');
-const run = require('firost/run');
-const consoleInfo = require('firost/consoleInfo');
-const autoRelease = require('./autoRelease.js');
+import helper from '../../helper.js';
+import ciInfo from 'ci-info';
+import _ from 'golgoth/lodash.js';
+import pMap from 'golgoth/pMap.js';
+import readJson from 'firost/readJson.js';
+import run from 'firost/run.js';
+import consoleInfo from 'firost/consoleInfo.js';
+import autoRelease from './autoRelease.js';
 
-module.exports = {
+export default {
   /**
    * Return the value of an environment variable
    * @param {string} key Name of the variable
@@ -112,7 +112,7 @@ module.exports = {
 
         await helper.yarnRun(command);
       },
-      { concurrency: 1 }
+      { concurrency: 1 },
     );
 
     // Attempt to release the package if --auto-release is set

package/commands/compress/index.js

@@ -1,10 +1,10 @@
-const _ = require('golgoth/lodash');
-const pMap = require('golgoth/pMap');
-const consoleError = require('firost/consoleError');
-const firostError = require('firost/error');
-const helper = require('../../helper.js');
+import _ from 'golgoth/lodash.js';
+import pMap from 'golgoth/pMap.js';
+import consoleError from 'firost/consoleError.js';
+import firostError from 'firost/error.js';
+import helper from '../../helper.js';
 
-module.exports = {
+export default {
   types: {
     png: './png.js',
   },

package/commands/compress/png.js

@@ -1,9 +1,9 @@
-const lint = require('./index.js');
-const run = require('firost/run');
-const which = require('firost/which');
-const firostError = require('firost/error');
+import lint from './index.js';
+import run from 'firost/run.js';
+import which from 'firost/which.js';
+import firostError from 'firost/error.js';
 
-module.exports = {
+export default {
   /**
    * Find the png files to compress
    * @param {Array} userPatterns Patterns to narrow the search down

package/commands/{init.js → init/index.js}

@@ -1,19 +1,21 @@
-const _ = require('golgoth/lodash');
-const pMapSeries = require('golgoth/pMapSeries');
-const isFile = require('firost/isFile');
-const copy = require('firost/copy');
-const readJson = require('firost/readJson');
-const writeJson = require('firost/writeJson');
-const exists = require('firost/exists');
-const read = require('firost/read');
-const write = require('firost/write');
-const run = require('firost/run');
-const spinner = require('firost/spinner');
-const helper = require('../helper');
-const path = require('path');
-const nodeConfig = require('../configs/node');
-const consoleInfo = require('firost/consoleInfo');
-module.exports = {
+import _ from 'golgoth/lodash.js';
+import pMapSeries from 'golgoth/pMapSeries.js';
+import isFile from 'firost/isFile.js';
+import copy from 'firost/copy.js';
+import readJson from 'firost/readJson.js';
+import writeJson from 'firost/writeJson.js';
+import exists from 'firost/exists.js';
+import read from 'firost/read.js';
+import write from 'firost/write.js';
+import run from 'firost/run.js';
+import spinner from 'firost/spinner.js';
+import helper from '../../helper.js';
+import path from 'path';
+import nodeConfig from '../../configs/node.cjs';
+import consoleInfo from 'firost/consoleInfo.js';
+import Gilmore from 'gilmore';
+
+export default {
   /**
    * Copy a config template to the host
    * @param {string} source Path to source file, relative to aberlaas
@@ -44,34 +46,31 @@ module.exports = {
    **/
   async addConfigFiles() {
     // ESLint
-    await this.copyToHost('templates/_eslintrc.js', '.eslintrc.js');
+    await this.copyToHost('templates/_eslintrc.cjs', '.eslintrc.cjs');
     await this.copyToHost('templates/_eslintignore.conf', '.eslintignore');
 
-    // Husky
-    await this.copyToHost('templates/_huskyrc.js', '.huskyrc.js');
-
     // Lint-staged
-    await this.copyToHost('templates/_lintstagedrc.js', '.lintstagedrc.js');
+    await this.copyToHost('templates/_lintstagedrc.cjs', '.lintstagedrc.cjs');
 
-    // Jest
-    await this.copyToHost('templates/jest.config.js', 'jest.config.js');
+    // Vite
+    await this.copyToHost('templates/vite.config.js', 'vite.config.js');
 
     // Prettier
-    await this.copyToHost('templates/_prettierrc.js', '.prettierrc.js');
+    await this.copyToHost('templates/_prettierrc.cjs', '.prettierrc.cjs');
 
     // Stylelint
-    await this.copyToHost('templates/_stylelintrc.js', '.stylelintrc.js');
+    await this.copyToHost('templates/_stylelintrc.cjs', '.stylelintrc.cjs');
 
     // Renovate
     await this.copyToHost(
       'templates/_github/renovate.json',
-      '.github/renovate.json'
+      '.github/renovate.json',
     );
 
     // CircleCI
     await this.copyToHost(
       'templates/_circleci/config.yml',
-      '.circleci/config.yml'
+      '.circleci/config.yml',
     );
   },
   /**
@@ -95,7 +94,7 @@ module.exports = {
     const newPackage = _.set(
       _.clone(currentPackage),
       `scripts.${scriptName}`,
-      `./${scriptPath}`
+      `./${scriptPath}`,
     );
     await writeJson(newPackage, packagePath);
     return true;
@@ -109,7 +108,6 @@ module.exports = {
       { key: 'ci', value: 'scripts/ci' },
       { key: 'lint', value: 'scripts/lint' },
       { key: 'lint:fix', value: 'scripts/lint-fix' },
-      { key: 'husky:precommit', value: 'scripts/husky-precommit' },
       { key: 'release', value: 'scripts/release' },
       { key: 'test', value: 'scripts/test' },
       { key: 'test:watch', value: 'scripts/test-watch' },
@@ -122,6 +120,7 @@ module.exports = {
   /**
    * Update package.json with .main and .files keys to use files in ./lib
    * directory by default
+   * TODO: Update this to use exports instead of main
    **/
   async setDefaultReleaseFiles() {
     const packagePath = helper.hostPath('package.json');
@@ -135,7 +134,7 @@ module.exports = {
       await this.copyToHost('templates/lib/main.js', 'lib/main.js');
       await this.copyToHost(
         'templates/lib/__tests__/main.js',
-        'lib/__tests__/main.js'
+        'lib/__tests__/main.js',
       );
     }
 
@@ -251,6 +250,20 @@ module.exports = {
     // Download latest yarn version
     await this.__run('yarn set version', { stdout: false });
   },
+  /**
+   * Configure git hooks to use scripts/hooks instead of .git/hooks
+   **/
+  async configureGitHooks() {
+    // Copy the scripts into ./scripts/hooks
+    await this.copyToHost(
+      './templates/scripts/hooks/pre-commit',
+      './scripts/hooks/pre-commit',
+    );
+
+    // Configure git to use this directory for hooks
+    const repo = new Gilmore(helper.hostRoot());
+    await repo.setConfig('core.hooksPath', 'scripts/hooks');
+  },
   /**
    * Copy all config files and configure the scripts
    **/
@@ -267,6 +280,9 @@ module.exports = {
     progress.tick('Adding yarn scripts');
     await this.addScripts();
 
+    progress.tick('Configuring git hooks');
+    await this.configureGitHooks();
+
     progress.tick('Updating LICENSE');
     await this.addLicenseFile();
     await this.addLicenseField();
@@ -283,7 +299,7 @@ module.exports = {
     progress.success('aberlaas project initialized');
 
     this.__consoleInfo(
-      "Don't forget to run aberlaas setup after pushing your repository"
+      "Don't forget to run aberlaas setup after pushing your repository",
     );
   },
   __run: run,

package/commands/lint/circleci.js

@@ -1,20 +1,19 @@
-const helper = require('../../helper.js');
-const lint = require('./index.js');
-const lintYml = require('./yml.js');
-const ciInfo = require('ci-info');
-const exists = require('firost/exists');
-const run = require('firost/run');
-const which = require('firost/which');
-const firostError = require('firost/error');
+import helper from '../../helper.js';
+import lintYml from './yml.js';
+import ciInfo from 'ci-info';
+import exists from 'firost/exists.js';
+import run from 'firost/run.js';
+import which from 'firost/which.js';
+import firostError from 'firost/error.js';
 
-module.exports = {
+export default {
   configPath: '.circleci/config.yml',
   /**
-   * Find the CircleCI config file
+   * Find all relevant files
    * @returns {Array} Array of files
    **/
   async getInputFiles() {
-    return await lint.getInputFiles(['.yml'], [this.configPath]);
+    return await helper.findHostFiles([this.configPath]);
   },
   /**
    * Check if the code is currently running on CircleCI

package/commands/lint/css.js

@@ -1,16 +1,17 @@
-const helper = require('../../helper.js');
-const lint = require('./index.js');
-const _ = require('golgoth/lodash');
-const firostError = require('firost/error');
-const run = require('firost/run');
-module.exports = {
+import helper from '../../helper.js';
+import { fix as prettierFix } from './helpers/prettier.js';
+import _ from 'golgoth/lodash.js';
+import firostError from 'firost/error.js';
+import run from 'firost/run.js';
+
+export default {
   /**
    * Find all relevant files
    * @param {Array} userPatterns Patterns to narrow the search down
    * @returns {Array} Array of files
    **/
   async getInputFiles(userPatterns) {
-    return await lint.getInputFiles(['.css'], userPatterns);
+    return await helper.findHostFiles(userPatterns, ['.css']);
   },
   /**
    * Lint all files and display results.
@@ -26,8 +27,8 @@ module.exports = {
 
     const configFile = await helper.configFile(
       userConfigFile,
-      '.stylelintrc.js',
-      'configs/stylelint.js'
+      '.stylelintrc.cjs',
+      'configs/stylelint.cjs',
     );
     const binary = await helper.which('stylelint');
     const options = [...files, '--color', '--config', configFile];
@@ -56,10 +57,11 @@ module.exports = {
       return true;
     }
     // Try to pretiffy as much as we can
-    await lint.fixWithPrettier(files);
+    await this.__prettierFix(files);
     // Still run a lint on it so it can fail if not everything is fixed
     await this.run(userPatterns, userConfigFile);
     return true;
   },
+  __prettierFix: prettierFix,
   __run: run,
 };

package/commands/lint/helpers/prettier.js

@@ -0,0 +1,29 @@
+import helper from '../../../helper.js';
+import run from 'firost/run.js';
+import firostError from 'firost/error.js';
+
+/**
+ * Fix all files using prettier
+ * Note: Will be called by child classes
+ * Note: Prettier does not output any information as to why it failed, so
+ * we'll manually run the command on each file individually so we can catch
+ * the file that errors and display it
+ * @param {Array} inputFiles Files to auto-fix
+ **/
+export async function fix(inputFiles) {
+  const binary = await helper.which('prettier');
+  const options = ['--write', ...inputFiles];
+  try {
+    const command = `${binary} ${options.join(' ')}`;
+    await run(command, { stdout: false });
+  } catch (err) {
+    throw firostError(
+      'LINT_ERROR_FIX_PRETTIER',
+      'Some files could not be automatically fixed.\nPlease run `yarn run lint` to further debug',
+    );
+  }
+}
+
+export default {
+  fix,
+};

package/commands/lint/index.js

@@ -1,18 +1,20 @@
-const _ = require('golgoth/lodash');
-const pMap = require('golgoth/pMap');
-const consoleError = require('firost/consoleError');
-const firostError = require('firost/error');
-const run = require('firost/run');
-const helper = require('../../helper.js');
+import _ from 'golgoth/lodash.js';
+import pMap from 'golgoth/pMap.js';
+import consoleError from 'firost/consoleError.js';
+import firostError from 'firost/error.js';
+import linterCircleCI from './circleci.js';
+import linterCss from './css.js';
+import linterJson from './json.js';
+import linterJs from './js.js';
+import linterYml from './yml.js';
 
-module.exports = {
-  types: {
-    circleci: './circleci',
-    css: './css',
-    json: './json',
-    js: './js',
-    yml: './yml',
-    yaml: './yml', // Alias --yaml for --yml
+export default {
+  linters: {
+    circleci: linterCircleCI,
+    css: linterCss,
+    json: linterJson,
+    js: linterJs,
+    yml: linterYml,
   },
   /**
    * Wrapper to lint all supported formats
@@ -20,7 +22,7 @@ module.exports = {
    * @returns {boolean} True on success
    **/
   async run(cliArgs) {
-    const allTypesKeys = _.keys(this.types);
+    const allTypesKeys = _.keys(this.linters);
     const userTypes = _.intersection(_.keys(cliArgs), allTypesKeys);
     const typesToLint = _.isEmpty(userTypes) ? allTypesKeys : userTypes;
 
@@ -30,7 +32,7 @@ module.exports = {
       try {
         const configFile = _.get(cliArgs, `config.${type}`);
         const userPatterns = _.get(cliArgs, '_');
-        const linter = require(this.types[type]);
+        const linter = this.linters[type];
 
         await linter[methodName](userPatterns, configFile);
       } catch (error) {
@@ -45,37 +47,5 @@ module.exports = {
 
     return true;
   },
-  /**
-   * Find all relevant files of the specified extension in the host
-   * Note: Should be used by child classes
-   * @param {Array} safeListExtension List of allowed extensions to keep
-   * @param {Array} userPatterns Patterns to narrow the search down
-   * @returns {Array} Array of files
-   **/
-  async getInputFiles(safeListExtension, userPatterns = []) {
-    const inputPatterns = _.isEmpty(userPatterns) ? '.' : userPatterns;
-    return await helper.findHostFiles(inputPatterns, safeListExtension);
-  },
-  /**
-   * Fix all files using prettier
-   * Note: Will be called by child classes
-   * Note: Prettier does not output any information as to why it failed, so
-   * we'll manually run the command on each file individually so we can catch
-   * the file that errors and display it
-   * @param {Array} inputFiles Files to auto-fix
-   **/
-  async fixWithPrettier(inputFiles) {
-    const binary = await helper.which('prettier');
-    const options = ['--write', ...inputFiles];
-    try {
-      const command = `${binary} ${options.join(' ')}`;
-      await run(command, { stdout: false });
-    } catch (err) {
-      throw firostError(
-        'LINT_ERROR_FIX_PRETTIER',
-        'Some files could not be automatically fixed.\nPlease run `yarn run lint` to further debug'
-      );
-    }
-  },
   __consoleError: consoleError,
 };

package/commands/lint/js.js

@@ -1,76 +1,65 @@
-const helper = require('../../helper.js');
-const lint = require('./index.js');
-const _ = require('golgoth/lodash');
-const firostError = require('firost/error');
-const readJson = require('firost/readJson');
-const exists = require('firost/exists');
-const run = require('firost/run');
-module.exports = {
+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 {
   /**
    * Find all relevant files
    * @param {Array} userPatterns Patterns to narrow the search down
    * @returns {Array} Array of files
    **/
   async getInputFiles(userPatterns) {
-    // Check all JavaScript files and all files defined in .bin in package.json
-    const allJsFiles = await lint.getInputFiles(['.js'], userPatterns);
-    const allBinFiles = await this.getBinFiles();
-
-    return [...allJsFiles, ...allBinFiles];
-  },
-  /**
-   * Returns the list of all bin files defined in the package.json
-   * @returns {Array} List of bin files
-   **/
-  async getBinFiles() {
-    const packagePath = helper.hostPath('package.json');
-    const hasPackage = await exists(packagePath);
-    if (!hasPackage) {
-      return [];
-    }
-    const packageContent = await readJson(packagePath);
-    return _.chain(packageContent)
-      .get('bin', {})
-      .values()
-      .map((filepath) => {
-        return helper.hostPath(filepath);
-      })
-      .value();
+    return await helper.findHostFiles(userPatterns, ['.js']);
   },
   /**
    * Lint all files and display results.
    * @param {Array} userPatterns Patterns to narrow the search down
    * @param {string} userConfigFile Custom config file to use
-   * @param {Array} additionalOptions Other options to pass to the eslint CLI
+   * @param {object} userOptions Options to pass to ESLint, including fix
    * @returns {boolean} True on success
    **/
-  async run(userPatterns, userConfigFile, additionalOptions = []) {
+  async run(userPatterns, userConfigFile, userOptions = {}) {
+    // Options
+    const options = { fix: false, ...userOptions };
+
+    // Files to lint
     const files = await this.getInputFiles(userPatterns);
     if (_.isEmpty(files)) {
       return true;
     }
 
+    // Config file
     const configFile = await helper.configFile(
       userConfigFile,
-      '.eslintrc.js',
-      'lib/configs/eslint.js'
+      '.eslintrc.cjs',
+      'lib/configs/eslint.cjs',
     );
-    const pluginResolveDir = helper.aberlaasRoot();
-    const options = [
-      ...files,
-      ...additionalOptions,
-      '--color',
-      `--config=${configFile}`,
-      `--resolve-plugins-relative-to=${pluginResolveDir}`,
-    ];
-    const binary = await helper.which('eslint');
 
-    try {
-      await run(`${binary} ${options.join(' ')}`, { stdout: false });
-    } catch (error) {
-      throw firostError('JavaScriptLintError', error.stdout);
+    // Run the actual lint
+    const eslint = new ESLint({
+      overrideConfigFile: configFile,
+      resolvePluginsRelativeTo: helper.aberlaasRoot(),
+      ...options,
+    });
+    const results = await eslint.lintFiles(files);
+
+    // Fix
+    if (options.fix) {
+      await ESLint.outputFixes(results);
+    }
+
+    // All good, we can stop
+    const errorCount = _.chain(results).map('errorCount').sum().value();
+    if (errorCount == 0) {
+      return true;
     }
-    return true;
+
+    // Format errors
+    const formatter = await eslint.loadFormatter('stylish');
+    const errorText = formatter.format(results);
+    throw firostError('JavaScriptLintError', errorText);
   },
   /**
    * Autofix files in place
@@ -79,7 +68,7 @@ module.exports = {
    * @returns {boolean} True on success
    **/
   async fix(userPatterns, userConfigFile) {
-    return await this.run(userPatterns, userConfigFile, ['--fix']);
+    return await this.run(userPatterns, userConfigFile, { fix: true });
   },
   __run: run,
 };

package/commands/lint/json.js

@@ -1,19 +1,19 @@
-const helper = require('../../helper.js');
-const path = require('path');
-const lint = require('./index.js');
-const _ = require('golgoth/lodash');
-const pMap = require('golgoth/pMap');
-const firostError = require('firost/error');
-const read = require('firost/read');
+import helper from '../../helper.js';
+import { fix as prettierFix } from './helpers/prettier.js';
+import path from 'path';
+import _ from 'golgoth/lodash.js';
+import pMap from 'golgoth/pMap.js';
+import firostError from 'firost/error.js';
+import read from 'firost/read.js';
 
-module.exports = {
+export default {
   /**
    * Find all relevant files
    * @param {Array} userPatterns Patterns to narrow the search down
    * @returns {Array} Array of files
    **/
   async getInputFiles(userPatterns) {
-    return await lint.getInputFiles(['.json'], userPatterns);
+    return await helper.findHostFiles(userPatterns, ['.json']);
   },
   /**
    * Lint all files and display results.
@@ -54,7 +54,8 @@ module.exports = {
     if (_.isEmpty(files)) {
       return true;
     }
-    await lint.fixWithPrettier(files);
+    await this.__prettierFix(files);
   },
+  __prettierFix: prettierFix,
   __parse: JSON.parse,
 };