aberlaas 2.0.0 → 2.2.0

package/commands/lint/helpers/prettier.js

@@ -0,0 +1,57 @@
+import * as prettier from 'prettier';
+import helper from '../../../helper.js';
+import firostError from 'firost/error.js';
+import write from 'firost/write.js';
+import read from 'firost/read.js';
+import pMap from 'golgoth/pMap.js';
+import _ from 'golgoth/lodash.js';
+
+/**
+ * Fix all files using prettier
+ * @param {Array} inputFiles Files to auto-fix
+ **/
+export async function fix(inputFiles) {
+  // Config file
+  const configFile = await helper.configFile(
+    null,
+    '.prettierrc.cjs',
+    'lib/configs/prettier.cjs',
+  );
+  const config = await prettier.resolveConfig(configFile);
+
+  const errors = [];
+
+  // Read all files, run them through the formatter and save them back to disk
+  // If any emits error, store the errors and display them all in one output
+  await pMap(
+    inputFiles,
+    async (filepath) => {
+      try {
+        const content = await read(filepath);
+        const options = { ...config, filepath };
+        const result = await prettier.format(content, options);
+        await write(result, filepath);
+      } catch (error) {
+        const message = error.toString();
+        errors.push({ filepath, message });
+      }
+    },
+    { concurrency: 10 },
+  );
+
+  if (!_.isEmpty(errors)) {
+    let formattedErrors = '';
+    _.each(errors, (error) => {
+      formattedErrors = `${formattedErrors}${error.filepath}\n\n${error.message}\n\n`;
+    });
+
+    throw firostError(
+      'LINT_ERROR_FIX_PRETTIER',
+      `Some files could not be automatically fixed:\n\n${formattedErrors}`,
+    );
+  }
+}
+
+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 { 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();
+    const filePatterns = _.isEmpty(userPatterns) ? ['./**/*.js'] : userPatterns;
+    return await helper.findHostFiles(filePatterns, ['.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,6 @@ 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,22 @@
-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);
+    const filePatterns = _.isEmpty(userPatterns)
+      ? ['./**/*.json']
+      : userPatterns;
+    return await helper.findHostFiles(filePatterns, ['.json']);
   },
   /**
    * Lint all files and display results.
@@ -30,7 +33,7 @@ module.exports = {
     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,7 +57,6 @@ module.exports = {
     if (_.isEmpty(files)) {
       return true;
     }
-    await lint.fixWithPrettier(files);
+    await prettierFix(files);
   },
-  __parse: JSON.parse,
 };

package/commands/lint/yml.js

@@ -1,19 +1,23 @@
-const lint = require('./index.js');
-const helper = require('../../helper.js');
-const firostError = require('firost/error');
-const read = require('firost/read');
-const _ = require('golgoth/lodash');
-const pMap = require('golgoth/pMap');
-const yamlLint = require('yaml-lint');
-const path = require('path');
-module.exports = {
+import helper from '../../helper.js';
+import { fix as prettierFix } from './helpers/prettier.js';
+import firostError from 'firost/error.js';
+import read from 'firost/read.js';
+import _ from 'golgoth/lodash.js';
+import pMap from 'golgoth/pMap.js';
+import yamlLint from 'yaml-lint';
+import path from 'path';
+
+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(['.yml', '.yaml'], userPatterns);
+    const filePatterns = _.isEmpty(userPatterns)
+      ? ['./**/*.yml', './**/*.yaml']
+      : userPatterns;
+    return await helper.findHostFiles(filePatterns, ['.yml', '.yaml']);
   },
   /**
    * Lint all files and display results.
@@ -31,7 +35,7 @@ module.exports = {
     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);
@@ -55,7 +59,6 @@ module.exports = {
     if (_.isEmpty(files)) {
       return true;
     }
-    await lint.fixWithPrettier(files);
+    await prettierFix(files);
   },
-  __lint: yamlLint.lint,
 };

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

@@ -1,14 +1,14 @@
-const lintStaged = require('lint-staged');
-const firostError = require('firost/error');
-const helper = require('../helper');
+import lintStaged from 'lint-staged';
+import firostError from 'firost/error.js';
+import helper from '../../helper.js';
 
-module.exports = {
+export default {
   async run(cliArgs) {
     // Config
     const configPath = await helper.configFile(
       cliArgs.config,
-      '.lintstagedrc.js',
-      'lib/configs/lintstaged.js'
+      '.lintstagedrc.cjs',
+      'lib/configs/lintstaged.cjs',
     );
 
     try {
@@ -19,7 +19,7 @@ module.exports = {
       if (!result) {
         throw firostError(
           'ERROR_PRECOMMIT_LINT_FAILED',
-          'Precommit linting failed'
+          'Precommit linting failed',
         );
       }
     } catch (error) {

package/commands/readme/index.js

@@ -1,16 +1,16 @@
-const helper = require('../../helper.js');
-const _ = require('golgoth/lodash');
-const pMap = require('golgoth/pMap');
-const readJson = require('firost/readJson');
-const read = require('firost/read');
-const write = require('firost/write');
-const glob = require('firost/glob');
-const exists = require('firost/exists');
-const path = require('path');
-const frontMatter = require('front-matter');
-const dedent = require('golgoth/dedent');
-
-module.exports = {
+import helper from '../../helper.js';
+import _ from 'golgoth/lodash.js';
+import pMap from 'golgoth/pMap.js';
+import readJson from 'firost/readJson.js';
+import read from 'firost/read.js';
+import write from 'firost/write.js';
+import glob from 'firost/glob.js';
+import exists from 'firost/exists.js';
+import path from 'path';
+import frontMatter from 'front-matter';
+import dedent from 'golgoth/dedent.js';
+
+export default {
   /**
    * Update the main README.md based on the template and the documentation
    * @param {object} cliArgs CLI Argument object, as created by minimist
@@ -59,7 +59,7 @@ module.exports = {
     }
 
     const aberlaasDefaultTemplate = helper.aberlaasPath(
-      'templates/_github/README.template.md'
+      'templates/_github/README.template.md',
     );
     return await read(aberlaasDefaultTemplate);
   },
@@ -141,7 +141,7 @@ module.exports = {
     const packagePath = await this.getPackagePath(cliArgs);
     const moduleReadmePath = path.resolve(
       path.dirname(packagePath),
-      'README.md'
+      'README.md',
     );
 
     const readmes = _.uniq([hostReadmePath, moduleReadmePath]);
@@ -169,7 +169,7 @@ module.exports = {
       const key = match.groups.key;
       convertedSource = convertedSource.replace(
         `{${key}}`,
-        _.get(data, key, '')
+        _.get(data, key, ''),
       );
     });
     return convertedSource;

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

@@ -1,10 +1,9 @@
-/* eslint-disable jest/no-jest-import */
-const _ = require('golgoth/_');
-const run = require('firost/run');
-const readJson = require('firost/readJson');
-const helper = require('../helper');
+import _ from 'golgoth/lodash.js';
+import run from 'firost/run.js';
+import readJson from 'firost/readJson.js';
+import helper from '../../helper.js';
 
-module.exports = {
+export default {
   /**
    * Release the host package.
    * @param {object} cliArgs CLI Argument object, as created by minimist

package/commands/setup/autoRelease/envVars.js

@@ -1,10 +1,11 @@
-const circleciHelper = require('../helpers/circleci.js');
-const githubHelper = require('../helpers/github.js');
-const npmHelper = require('../helpers/npm.js');
-const consoleInfo = require('firost/consoleInfo');
-const consoleSuccess = require('firost/consoleSuccess');
-const pMap = require('golgoth/pMap');
-module.exports = {
+import circleciHelper from '../helpers/circleci.js';
+import githubHelper from '../helpers/github.js';
+import npmHelper from '../helpers/npm.js';
+import consoleInfo from 'firost/consoleInfo.js';
+import consoleSuccess from 'firost/consoleSuccess.js';
+import pMap from 'golgoth/pMap.js';
+
+export default {
   /**
    * Save an ENV variable to CircleCI
    * @param {string} name Name of the ENV variable
@@ -17,7 +18,7 @@ module.exports = {
         `project/github/${username}/${repo}/envvar/${name}`,
         {
           method: 'delete',
-        }
+        },
       );
     } catch (err) {
       // Ignoring the error, it means the ENV var wasn't set in the first place

package/commands/setup/autoRelease/index.js

@@ -1,13 +1,14 @@
-const envVars = require('./envVars.js');
-const privateKey = require('./privateKey.js');
-const publicKey = require('./publicKey.js');
-const sshHelper = require('../helpers/ssh.js');
-const npmHelper = require('../helpers/npm.js');
-const githubHelper = require('../helpers/github.js');
-const circleciHelper = require('../helpers/circleci.js');
-const _ = require('golgoth/lodash');
-const consoleError = require('firost/consoleError');
-module.exports = {
+import envVars from './envVars.js';
+import privateKey from './privateKey.js';
+import publicKey from './publicKey.js';
+import sshHelper from '../helpers/ssh.js';
+import npmHelper from '../helpers/npm.js';
+import githubHelper from '../helpers/github.js';
+import circleciHelper from '../helpers/circleci.js';
+import _ from 'golgoth/lodash.js';
+import consoleError from 'firost/consoleError.js';
+
+export default {
   /**
    * Enable autoRelease by configuring CircleCI and GitHub
    * @returns {boolean} True if enabled, false otherwise
@@ -17,7 +18,7 @@ module.exports = {
     const validationErrors = await this.validationErrors();
     if (!_.isEmpty(validationErrors)) {
       this.__consoleError(
-        '[autoRelease] Please fix the following errors and try again:'
+        '[autoRelease] Please fix the following errors and try again:',
       );
       _.each(validationErrors, (error) => {
         this.__consoleError(error);

package/commands/setup/autoRelease/privateKey.js

@@ -1,8 +1,9 @@
-const circleciHelper = require('../helpers/circleci.js');
-const githubHelper = require('../helpers/github.js');
-const sshHelper = require('../helpers/ssh.js');
-const consoleSuccess = require('firost/consoleSuccess');
-module.exports = {
+import circleciHelper from '../helpers/circleci.js';
+import githubHelper from '../helpers/github.js';
+import sshHelper from '../helpers/ssh.js';
+import consoleSuccess from 'firost/consoleSuccess.js';
+
+export default {
   /**
    * Save a private SSH key on CircleCI.
    * The CircleCI API does not allow checking if a SSH key has been defined,

package/commands/setup/autoRelease/publicKey.js

@@ -1,10 +1,11 @@
-const githubHelper = require('../helpers/github.js');
-const sshHelper = require('../helpers/ssh.js');
-const _ = require('golgoth/lodash');
-const consoleInfo = require('firost/consoleInfo');
-const consoleSuccess = require('firost/consoleSuccess');
-const consoleError = require('firost/consoleError');
-module.exports = {
+import githubHelper from '../helpers/github.js';
+import sshHelper from '../helpers/ssh.js';
+import _ from 'golgoth/lodash.js';
+import consoleInfo from 'firost/consoleInfo.js';
+import consoleSuccess from 'firost/consoleSuccess.js';
+import consoleError from 'firost/consoleError.js';
+
+export default {
   /**
    * Check if SSH public key is already added to GitHub
    * @returns {boolean} True if already enabled, false otherwise

package/commands/setup/circleci.js

@@ -1,10 +1,11 @@
-const githubHelper = require('./helpers/github.js');
-const circleCiHelper = require('./helpers/circleci.js');
-const _ = require('golgoth/lodash');
-const consoleInfo = require('firost/consoleInfo');
-const consoleSuccess = require('firost/consoleSuccess');
-const consoleError = require('firost/consoleError');
-module.exports = {
+import githubHelper from './helpers/github.js';
+import circleCiHelper from './helpers/circleci.js';
+import _ from 'golgoth/lodash.js';
+import consoleInfo from 'firost/consoleInfo.js';
+import consoleSuccess from 'firost/consoleSuccess.js';
+import consoleError from 'firost/consoleError.js';
+
+export default {
   /**
    * Attempt to automatically follow the repo in CircleCI if possible, otherwise
    * display the link to follow it manually
@@ -18,7 +19,7 @@ module.exports = {
     // Fail early if no token available
     if (!circleCiHelper.hasToken()) {
       this.__consoleError(
-        `[circleci]: No CIRCLECI_TOKEN found, please visit ${followUrl} to enable manually.`
+        `[circleci]: No CIRCLECI_TOKEN found, please visit ${followUrl} to enable manually.`,
       );
       return false;
     }

package/commands/setup/github.js

@@ -1,7 +1,8 @@
-const githubHelper = require('./helpers/github.js');
-const consoleSuccess = require('firost/consoleSuccess');
-const consoleError = require('firost/consoleError');
-module.exports = {
+import githubHelper from './helpers/github.js';
+import consoleSuccess from 'firost/consoleSuccess.js';
+import consoleError from 'firost/consoleError.js';
+
+export default {
   /**
    * Configure the GitHub repo with default settings:
    * - Do not enable merge commits on PR
@@ -16,7 +17,7 @@ module.exports = {
     // Fail early if no token available
     if (!githubHelper.hasToken()) {
       this.__consoleError(
-        `[github]: No GITHUB_TOKEN found, please visit ${manualUrl} to configure manually.`
+        `[github]: No GITHUB_TOKEN found, please visit ${manualUrl} to configure manually.`,
       );
       return false;
     }

package/commands/setup/helpers/circleci.js

@@ -1,7 +1,8 @@
-const got = require('golgoth/got');
-const _ = require('golgoth/lodash');
-const firostError = require('firost/error');
-module.exports = {
+import got from 'golgoth/got.js';
+import _ from 'golgoth/lodash.js';
+import firostError from 'firost/error.js';
+
+export default {
   /**
    * Returns the CircleCI token saved in ENV
    * @returns {string} The CircleCI token
@@ -35,7 +36,7 @@ module.exports = {
     } catch (error) {
       throw firostError(
         'ERROR_CIRCLECI',
-        "Can't connect to CircleCI API. Check that you have a valid CIRCLECI_TOKEN"
+        "Can't connect to CircleCI API. Check that you have a valid CIRCLECI_TOKEN",
       );
     }
   },