aberlaas 2.8.0 → 2.10.0

package/commands/lint/js.js

@@ -1,73 +0,0 @@
-import { _ } from 'golgoth';
-import { firostError } from 'firost';
-import { ESLint } from 'eslint';
-import helper from '../../helper.js';
-
-export default {
-  /**
-   * Find all relevant files
-   * @param {Array} userPatterns Patterns to narrow the search down
-   * @returns {Array} Array of files
-   **/
-  async getInputFiles(userPatterns) {
-    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 {object} userOptions Options to pass to ESLint, including fix
-   * @returns {boolean} True on success
-   **/
-  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.cjs',
-      'configs/eslint.cjs',
-    );
-
-    // 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;
-    }
-
-    // Format errors
-    const formatter = await eslint.loadFormatter('stylish');
-    const errorText = formatter.format(results);
-    throw firostError('JavaScriptLintError', errorText);
-  },
-  /**
-   * Autofix files in place
-   * @param {Array} userPatterns Patterns to narrow the search down
-   * @param {string} userConfigFile Custom config file to use
-   * @returns {boolean} True on success
-   **/
-  async fix(userPatterns, userConfigFile) {
-    return await this.run(userPatterns, userConfigFile, { fix: true });
-  },
-};

package/commands/lint/json.js

@@ -1,60 +0,0 @@
-import path from 'path';
-import { _, pMap } from 'golgoth';
-import { firostError, read } from 'firost';
-import helper from '../../helper.js';
-import { fix as prettierFix } from './helpers/prettier.js';
-
-export default {
-  /**
-   * Find all relevant files
-   * @param {Array} userPatterns Patterns to narrow the search down
-   * @returns {Array} Array of files
-   **/
-  async getInputFiles(userPatterns) {
-    const filePatterns = _.isEmpty(userPatterns)
-      ? ['./**/*.json']
-      : userPatterns;
-    return await helper.findHostFiles(filePatterns, ['.json']);
-  },
-  /**
-   * Lint all files and display results.
-   * @param {Array} userPatterns Patterns to narrow the search down
-   * @returns {boolean} True on success
-   **/
-  async run(userPatterns) {
-    const files = await this.getInputFiles(userPatterns);
-    if (_.isEmpty(files)) {
-      return true;
-    }
-
-    let hasErrors = false;
-    const errorMessages = [];
-    await pMap(files, async (filepath) => {
-      try {
-        JSON.parse(await read(filepath));
-      } catch (error) {
-        hasErrors = true;
-        const relativePath = path.relative(helper.hostRoot(), filepath);
-        errorMessages.push(`Invalid JSON: ${relativePath}`);
-        errorMessages.push(error.message);
-      }
-    });
-
-    if (hasErrors) {
-      throw firostError('JsonLintError', errorMessages.join('\n'));
-    }
-    return true;
-  },
-  /**
-   * Autofix files in place
-   * @param {Array} userPatterns Patterns to narrow the search down
-   * @returns {boolean} True on success
-   **/
-  async fix(userPatterns) {
-    const files = await this.getInputFiles(userPatterns);
-    if (_.isEmpty(files)) {
-      return true;
-    }
-    await prettierFix(files);
-  },
-};

package/commands/lint/yml.js

@@ -1,62 +0,0 @@
-import path from 'path';
-import { firostError, read } from 'firost';
-import { _, pMap } from 'golgoth';
-import yamlLint from 'yaml-lint';
-import helper from '../../helper.js';
-import { fix as prettierFix } from './helpers/prettier.js';
-
-export default {
-  /**
-   * Find all relevant files
-   * @param {Array} userPatterns Patterns to narrow the search down
-   * @returns {Array} Array of files
-   **/
-  async getInputFiles(userPatterns) {
-    const filePatterns = _.isEmpty(userPatterns)
-      ? ['./**/*.yml', './**/*.yaml']
-      : userPatterns;
-    return await helper.findHostFiles(filePatterns, ['.yml', '.yaml']);
-  },
-  /**
-   * Lint all files and display results.
-   * @param {Array} userPatterns Patterns to narrow the search down
-   * @returns {boolean} True on success
-   **/
-  async run(userPatterns) {
-    const files = await this.getInputFiles(userPatterns);
-    if (_.isEmpty(files)) {
-      return true;
-    }
-
-    let hasErrors = false;
-    const errorMessages = [];
-    await pMap(files, async (filepath) => {
-      const input = await read(filepath);
-      try {
-        await yamlLint.lint(input);
-      } catch (error) {
-        hasErrors = true;
-        const relativePath = path.relative(helper.hostRoot(), filepath);
-        errorMessages.push(`Invalid YAML: ${relativePath}`);
-        errorMessages.push(error.message);
-      }
-    });
-
-    if (hasErrors) {
-      throw firostError('YamlLintError', errorMessages.join('\n'));
-    }
-    return true;
-  },
-  /**
-   * Autofix files in place
-   * @param {Array} userPatterns Patterns to narrow the search down
-   * @returns {boolean} True on success
-   **/
-  async fix(userPatterns) {
-    const files = await this.getInputFiles(userPatterns);
-    if (_.isEmpty(files)) {
-      return true;
-    }
-    await prettierFix(files);
-  },
-};

package/commands/precommit/index.js

@@ -1,33 +0,0 @@
-import lintStaged from 'lint-staged';
-import { firostError, firostImport } from 'firost';
-import helper from '../../helper.js';
-
-export default {
-  async run(cliArgs) {
-    // Config
-    const configPath = await helper.configFile(
-      cliArgs.config,
-      'lintstaged.config.js',
-      'configs/lintstaged.js',
-    );
-    const config = await firostImport(configPath);
-
-    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) {
-        throw firostError(
-          'ERROR_PRECOMMIT_LINT_FAILED',
-          'Precommit linting failed',
-        );
-      }
-    } catch (error) {
-      throw firostError('ERROR_PRECOMMIT', 'Precommit failed');
-    }
-  },
-};

package/commands/readme/index.js

@@ -1,181 +0,0 @@
-import path from 'path';
-import { _, dedent, pMap } from 'golgoth';
-import { exists, glob, read, readJson, write } from 'firost';
-import frontMatter from 'front-matter';
-import helper from '../../helper.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
-   * @param {string} cliArgs.template Path to the template (default to
-   * .github/README.template.md
-   * @param {string} cliArgs.docs Path to the documentation folder
-   * @param {string} cliArgs.lib Path to the library folder
-   * @param {string} cliArgs.output List of files to output. Default to
-   * README at the root, and next to package.json
-   **/
-  async run(cliArgs) {
-    const template = await this.getTemplate(cliArgs);
-
-    const packageData = await this.getPackageData(cliArgs);
-    const docsData = await this.getDocsData(cliArgs);
-    const data = { package: packageData, ...docsData };
-
-    const output = await this.getReadmes(cliArgs);
-
-    const content = await this.convert(template, data);
-    // console.info({ template, data, docsData });
-
-    await pMap(output, async (filepath) => {
-      await write(content, filepath);
-    });
-  },
-  /**
-   * Returns the content of the template
-   * @param {object} cliArgs CLI Argument object, as created by minimist
-   * @param {string} cliArgs.template Path to the template
-   * Will default to .github/README.template.md in the host, or fallback to
-   * a default value in aberllas
-   * @returns {string} Template content
-   **/
-  async getTemplate(cliArgs = {}) {
-    if (cliArgs.template) {
-      const customTemplate = helper.hostPath(cliArgs.template);
-      if (await exists(customTemplate)) {
-        return await read(customTemplate);
-      }
-    }
-
-    const hostDefaultTemplate = helper.hostPath('.github/README.template.md');
-    if (await exists(hostDefaultTemplate)) {
-      return await read(hostDefaultTemplate);
-    }
-
-    const aberlaasDefaultTemplate = helper.aberlaasPath(
-      'templates/_github/README.template.md',
-    );
-    return await read(aberlaasDefaultTemplate);
-  },
-  /**
-   * Returns the content of the library package.json
-   * @param {object} cliArgs CLI Argument object, as created by minimist
-   * Will default search in cliArgs.lib, ./lib, or the root
-   * @returns {object} package.json content
-   **/
-  async getPackageData(cliArgs = {}) {
-    const packagePath = await this.getPackagePath(cliArgs);
-    return await readJson(packagePath);
-  },
-  /**
-   * Returns the path to the package.json
-   * @param {object} cliArgs CLI Argument object, as created by minimist
-   * Will default search in cliArgs.lib, ./lib, or the root
-   * @returns {object} package.json content
-   **/
-  async getPackagePath(cliArgs = {}) {
-    const libFolder = helper.hostPath(cliArgs.lib || './lib');
-    let packagePath = path.resolve(libFolder, 'package.json');
-
-    if (await exists(packagePath)) {
-      return packagePath;
-    }
-
-    return helper.hostPath('package.json');
-  },
-  /**
-   * Returns all documentation as an object
-   * @param {object} cliArgs CLI Argument object, as created by minimist
-   * @param {string} cliArgs.docs Path to the documentation directory
-   * Will default to ./docs/src
-   * @returns {object} Documentation content
-   **/
-  async getDocsData(cliArgs = {}) {
-    const docsPath = helper.hostPath(cliArgs.docs || './docs/src');
-    const mdFiles = await glob(`${docsPath}/**/*.md`);
-    const docsData = {};
-    await pMap(mdFiles, async (filepath) => {
-      // Convert filepath to a (nested) dot key
-      const key = _.chain(path.relative(docsPath, filepath))
-        .replace(/\.md$/, '')
-        .replace(/\//g, '.')
-        .value();
-
-      // Grab the content, excluding front-matter
-      const rawContent = await read(filepath);
-      const { body } = frontMatter(rawContent);
-      _.set(docsData, key, body);
-    });
-    return docsData;
-  },
-  /**
-   * Returns path to all README.md to write
-   * @param {object} cliArgs CLI Argument object, as created by minimist
-   * @param {string} cliArgs.output Comma-separated list of output path
-   * Will default to a README.md at the git root, and one in the module code
-   * (./lib by default)
-   * @returns {Array} List of paths to write the READMEs
-   **/
-  async getReadmes(cliArgs = {}) {
-    // Custom --output passed as a comma-separated list
-    if (cliArgs.output) {
-      return _.chain(cliArgs.output)
-        .split(',')
-        .map((filepath) => {
-          return helper.hostPath(filepath);
-        })
-        .sort()
-        .value();
-    }
-
-    // README.md at the git root for GitHub
-    const hostReadmePath = helper.hostPath('README.md');
-
-    // README.md in the module folder for npm/yarn
-    const packagePath = await this.getPackagePath(cliArgs);
-    const moduleReadmePath = path.resolve(
-      path.dirname(packagePath),
-      'README.md',
-    );
-
-    const readmes = _.uniq([hostReadmePath, moduleReadmePath]);
-    return readmes;
-  },
-  /**
-   * Convert a source string by replace {key} with the matching keys of data
-   * @param {string} source The source string
-   * @param {object} data The data object to use to compile
-   * @returns {string} The converted string
-   **/
-  convert(source, data) {
-    const regexp = /{(?<key>.*?)}/gm;
-    const matches = Array.from(source.matchAll(regexp));
-
-    let convertedSource = dedent`
-    <!--
-      This page was automatically generated by aberlaas readme.
-      DO NOT EDIT IT MANUALLY.
-    -->
-
-    ${source}`;
-
-    _.each(matches, (match) => {
-      const key = match.groups.key;
-      convertedSource = convertedSource.replace(
-        `{${key}}`,
-        _.get(data, key, ''),
-      );
-    });
-    return convertedSource;
-  },
-  /**
-   * Read a file from disk, removing its front-matter if it has one
-   * @param {string} filepath Path to the file
-   * @returns {string} File content, stripped of front-matter
-   **/
-  async read(filepath) {
-    const source = await this.__read(filepath);
-    const { body } = frontMatter(source);
-    return body;
-  },
-};

package/commands/setup/circleci.js

@@ -1,60 +0,0 @@
-import { _ } from 'golgoth';
-import { consoleError, consoleInfo, consoleSuccess } from 'firost';
-import circleCiHelper from './helpers/circleci.js';
-import githubHelper from './helpers/github.js';
-
-export default {
-  /**
-   * Attempt to automatically follow the repo in CircleCI if possible, otherwise
-   * display the link to follow it manually
-   * @returns {boolean} True if enabled, false otherwise
-   **/
-  async enable() {
-    const { username, repo } = await githubHelper.repoData();
-    const projectUrl = `https://app.circleci.com/pipelines/github/${username}/${repo}`;
-    const followUrl = `https://app.circleci.com/projects/project-setup/github/${username}/${repo}`;
-
-    // Fail early if no token available
-    if (!circleCiHelper.hasToken()) {
-      this.__consoleError(
-        `[circleci]: No CIRCLECI_TOKEN found, please visit ${followUrl} to enable manually.`,
-      );
-      return false;
-    }
-
-    // Do nothing if already enabled
-    if (await this.isEnabled()) {
-      this.__consoleInfo(`CircleCI already enabled: ${projectUrl}`);
-      return true;
-    }
-
-    // Follow the repo
-    await this.followRepo();
-    this.__consoleSuccess(`CircleCI enabled: ${projectUrl}`);
-    return true;
-  },
-  /**
-   * Check if CircleCI is already enabled for this project
-   * @returns {boolean} True if already enabled, false otherwise
-   **/
-  async isEnabled() {
-    // There is no endpoint to check if a project is followed or not, so we get
-    // the list of all followed projects and check if the current one is in it
-    const allProjects = await circleCiHelper.api('projects');
-    const { username, repo } = await githubHelper.repoData();
-    const thisProject = _.find(allProjects, { username, reponame: repo });
-    return !!thisProject;
-  },
-  /**
-   * Automatically follow the repo on CircleCI.
-   **/
-  async followRepo() {
-    const { username, repo } = await githubHelper.repoData();
-    await circleCiHelper.api(`project/github/${username}/${repo}/follow`, {
-      method: 'post',
-    });
-  },
-  __consoleInfo: consoleInfo,
-  __consoleSuccess: consoleSuccess,
-  __consoleError: consoleError,
-};

package/commands/setup/github.js

@@ -1,42 +0,0 @@
-import { consoleError, consoleSuccess } from 'firost';
-import githubHelper from './helpers/github.js';
-
-export default {
-  /**
-   * Configure the GitHub repo with default settings:
-   * - Do not enable merge commits on PR
-   * - Automatically delete branches after PR merge
-   * @returns {boolean} True if enabled, false otherwise
-   **/
-  async enable() {
-    const { username, repo } = await githubHelper.repoData();
-    const repoUrl = `https://github.com/${username}/${repo}`;
-    const manualUrl = `${repoUrl}/settings`;
-
-    // Fail early if no token available
-    if (!githubHelper.hasToken()) {
-      this.__consoleError(
-        `[github]: No GITHUB_TOKEN found, please visit ${manualUrl} to configure manually.`,
-      );
-      return false;
-    }
-
-    const settings = {
-      allow_merge_commit: false,
-      allow_rebase_merge: true,
-      allow_squash_merge: true,
-      delete_branch_on_merge: true,
-    };
-
-    await githubHelper.octokit('repos.update', {
-      owner: username,
-      repo,
-      ...settings,
-    });
-
-    this.__consoleSuccess(`GitHub repo configured: ${repoUrl}`);
-    return true;
-  },
-  __consoleSuccess: consoleSuccess,
-  __consoleError: consoleError,
-};

package/commands/setup/helpers/circleci.js

@@ -1,43 +0,0 @@
-import { _, got } from 'golgoth';
-import { firostError } from 'firost';
-
-export default {
-  /**
-   * Returns the CircleCI token saved in ENV
-   * @returns {string} The CircleCI token
-   **/
-  token() {
-    return process.env.CIRCLECI_TOKEN;
-  },
-  /**
-   * Check if a CircleCI token is available
-   * @returns {boolean} True if a token is defined
-   **/
-  hasToken() {
-    return !!this.token();
-  },
-  /**
-   * Make a call to the CircleCI v1 API
-   * @param {string} urlPath Part of the url after the /api/v1.1/
-   * @param {object} userGotOptions Options to pass to the got call
-   * @returns {object} Object returned by the API
-   **/
-  async api(urlPath, userGotOptions = {}) {
-    const token = this.token();
-    const apiUrl = `https://circleci.com/api/v1.1/${urlPath}?circle-token=${token}`;
-    const defaultGotOptions = {
-      responseType: 'json',
-    };
-    const gotOptions = _.merge({}, defaultGotOptions, userGotOptions);
-    try {
-      const response = await this.__got(apiUrl, gotOptions);
-      return response.body;
-    } catch (error) {
-      throw firostError(
-        'ERROR_CIRCLECI',
-        "Can't connect to CircleCI API. Check that you have a valid CIRCLECI_TOKEN",
-      );
-    }
-  },
-  __got: got,
-};

package/commands/setup/helpers/github.js

@@ -1,72 +0,0 @@
-import { run } from 'firost';
-import { Octokit } from '@octokit/rest';
-import parseGithubUrl from 'parse-github-repo-url';
-import { _ } from 'golgoth';
-
-export default {
-  /**
-   * Returns the GitHub token saved in ENV
-   * @returns {string} The GitHub token
-   **/
-  token() {
-    return process.env.GITHUB_TOKEN;
-  },
-  /**
-   * Check if a GitHub token is available
-   * @returns {boolean} True if a token is defined
-   **/
-  hasToken() {
-    return !!this.token();
-  },
-  /**
-   * Returns some data from the git config
-   * @returns {object} Object with .username, .repo and .email keys
-   **/
-  async repoData() {
-    if (this.__cache.repoData) {
-      return this.__cache.repoData;
-    }
-
-    const email = await this.config('user.email');
-    const remoteUrl = await this.config('remote.origin.url');
-    const [username, repo] = parseGithubUrl(remoteUrl);
-
-    const result = { username, repo, email };
-    this.__cache.githubData = result;
-    return result;
-  },
-  /**
-   * Return the value of a git config
-   * @param {string} key Config key
-   * @returns {string} Config value
-   **/
-  async config(key) {
-    const response = await this.__run(`git config ${key}`, {
-      stdout: false,
-    });
-    return response.stdout;
-  },
-  /**
-   * Wraps Octokit and return the results
-   * @param {string} methodPath Path of the method to call
-   * @param {object} options Options to pass to the method
-   * @returns {*} Response from the API
-   **/
-  async octokit(methodPath, options) {
-    // Instanciate Octokit if not available
-    if (!this.__cache.octokit) {
-      const githubToken = this.token();
-      this.__cache.octokit = new this.__Octokit({
-        auth: githubToken,
-      });
-    }
-
-    const octokit = this.__cache.octokit;
-    const method = _.get(octokit, methodPath);
-    const response = await method(options);
-    return response.data;
-  },
-  __run: run,
-  __Octokit: Octokit,
-  __cache: {},
-};

package/commands/setup/helpers/npm.js

@@ -1,16 +0,0 @@
-export default {
-  /**
-   * Returns the npm token saved in ENV
-   * @returns {string} The npm token
-   **/
-  token() {
-    return process.env.NPM_TOKEN;
-  },
-  /**
-   * Check if a npm token is available
-   * @returns {boolean} True if a token is defined
-   **/
-  hasToken() {
-    return !!this.token();
-  },
-};