aberlaas-setup 2.18.1 → 2.20.2

package/lib/circleci.js

@@ -3,39 +3,42 @@ 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}`;
+export let __;
 
-    // Fail early if no token available
-    if (!circleCiHelper.hasToken()) {
-      this.__consoleError(
-        'CircleCI: ABERLAAS_CIRCLECI_TOKEN environment variable must be set',
-      );
-      this.__consoleInfo('  Create a token at CircleCI account settings');
-      this.__consoleInfo('  https://circleci.com/account/api\n');
-      return false;
-    }
+/**
+ * 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
+ */
+export async function enable() {
+  const { username, repo } = await githubHelper.repoData();
+  const projectUrl = `https://app.circleci.com/pipelines/github/${username}/${repo}`;
 
-    // Do nothing if already enabled
-    if (await this.isEnabled()) {
-      this.__consoleSuccess('CircleCI: Already configured');
-      this.__consoleInfo(`  ${projectUrl}\n`);
-      return true;
-    }
+  // Fail early if no token available
+  if (!circleCiHelper.hasToken()) {
+    __.consoleError(
+      'CircleCI: ABERLAAS_CIRCLECI_TOKEN environment variable must be set',
+    );
+    __.consoleInfo('  Create a token at CircleCI account settings');
+    __.consoleInfo('  https://circleci.com/account/api\n');
+    return false;
+  }
 
-    // Follow the repo
-    await this.followRepo();
-    this.__consoleSuccess('CircleCI: Repository configured');
-    this.__consoleInfo(`  ${projectUrl}\n`);
+  // Do nothing if already enabled
+  if (await __.isEnabled()) {
+    __.consoleSuccess('CircleCI: Already configured');
+    __.consoleInfo(`  ${projectUrl}\n`);
     return true;
-  },
+  }
+
+  // Follow the repo
+  await __.followRepo();
+  __.consoleSuccess('CircleCI: Repository configured');
+  __.consoleInfo(`  ${projectUrl}\n`);
+  return true;
+}
+
+__ = {
   /**
    * Check if CircleCI is already enabled for this project
    * @returns {boolean} True if already enabled, false otherwise
@@ -57,7 +60,9 @@ export default {
       method: 'post',
     });
   },
-  __consoleInfo: consoleInfo,
-  __consoleSuccess: consoleSuccess,
-  __consoleError: consoleError,
+  consoleInfo,
+  consoleSuccess,
+  consoleError,
 };
+
+export default { enable };

package/lib/github.js

@@ -1,7 +1,9 @@
-import { consoleError, consoleInfo, consoleSuccess } from 'firost';
 import { _ } from 'golgoth';
+import { consoleError, consoleInfo, consoleSuccess } from 'firost';
 import githubHelper from './helpers/github.js';
 
+export let __;
+
 const gitHubSettings = {
   allow_merge_commit: false,
   allow_rebase_merge: true,
@@ -9,54 +11,55 @@ const gitHubSettings = {
   delete_branch_on_merge: true,
 };
 
-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 settingsUrl = `https://github.com/${username}/${repo}/settings`;
+/**
+ * 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
+ */
+export async function enable() {
+  const { username, repo } = await githubHelper.repoData();
+  const settingsUrl = `https://github.com/${username}/${repo}/settings`;
+
+  // Fail early if no token available
+  if (!githubHelper.hasToken()) {
+    __.consoleError(
+      'GitHub: ABERLAAS_GITHUB_TOKEN environment variable must be set',
+    );
+    __.consoleInfo("  Create a Classic token with 'repo' scope");
+    __.consoleInfo('  https://github.com/settings/tokens\n');
+    return false;
+  }
 
-    // Fail early if no token available
-    if (!githubHelper.hasToken()) {
-      this.__consoleError(
-        'GitHub: ABERLAAS_GITHUB_TOKEN environment variable must be set',
-      );
-      this.__consoleInfo("  Create a Classic token with 'repo' scope");
-      this.__consoleInfo('  https://github.com/settings/tokens\n');
+  // Check if already configured
+  try {
+    if (await __.isAlreadyConfigured()) {
+      __.consoleSuccess('GitHub: Already configured');
+      __.consoleInfo(`  ${settingsUrl}\n`);
+      return true;
+    }
+  } catch (error) {
+    if (error.status === 401) {
+      __.consoleError('GitHub: ABERLAAS_GITHUB_TOKEN is invalid');
+      __.consoleInfo("  Create a Classic token with 'repo' scope");
+      __.consoleInfo('  https://github.com/settings/tokens\n');
       return false;
     }
+    throw error;
+  }
 
-    // Check if already configured
-    try {
-      if (await this.isAlreadyConfigured()) {
-        this.__consoleSuccess('GitHub: Already configured');
-        this.__consoleInfo(`  ${settingsUrl}\n`);
-        return true;
-      }
-    } catch (error) {
-      if (error.status === 401) {
-        this.__consoleError('GitHub: ABERLAAS_GITHUB_TOKEN is invalid');
-        this.__consoleInfo("  Create a Classic token with 'repo' scope");
-        this.__consoleInfo('  https://github.com/settings/tokens\n');
-        return false;
-      }
-      throw error;
-    }
+  await githubHelper.octokit('repos.update', {
+    owner: username,
+    repo,
+    ...gitHubSettings,
+  });
 
-    await githubHelper.octokit('repos.update', {
-      owner: username,
-      repo,
-      ...gitHubSettings,
-    });
+  __.consoleSuccess('GitHub: Repository configured');
+  __.consoleInfo(`  ${settingsUrl}\n`);
+  return true;
+}
 
-    this.__consoleSuccess('GitHub: Repository configured');
-    this.__consoleInfo(`  ${settingsUrl}\n`);
-    return true;
-  },
+__ = {
   /**
    * Check if GitHub repo is already configured with desired settings
    * @returns {boolean} True if already configured, false otherwise
@@ -70,7 +73,9 @@ export default {
 
     return _.isMatch(repoData, gitHubSettings);
   },
-  __consoleSuccess: consoleSuccess,
-  __consoleInfo: consoleInfo,
-  __consoleError: consoleError,
+  consoleSuccess,
+  consoleInfo,
+  consoleError,
 };
+
+export default { enable };

package/lib/helpers/circleci.js

@@ -34,7 +34,7 @@ export default {
       return response.body;
     } catch (_error) {
       throw firostError(
-        'ERROR_CIRCLECI',
+        'ABERLAAS_SETUP_CIRCLECI_API',
         "Can't connect to CircleCI API. Check that you have a valid ABERLAAS_CIRCLECI_TOKEN",
       );
     }

package/lib/helpers/github.js

@@ -1,7 +1,7 @@
+import { _ } from 'golgoth';
 import { run } from 'firost';
 import { Octokit } from '@octokit/rest';
 import parseGithubUrl from 'parse-github-repo-url';
-import { _ } from 'golgoth';
 
 export default {
   /**

package/lib/helpers/ssh.js

@@ -1,7 +1,7 @@
 import path from 'node:path';
 import { _ } from 'golgoth';
 import { exists, mkdirp, read, run, which } from 'firost';
-import helper from 'aberlaas-helper';
+import { hostGitPath } from 'aberlaas-helper';
 import githubHelper from './github.js';
 
 export default {
@@ -18,7 +18,7 @@ export default {
    * @returns {object} Object with .public, .private and .privateFingerprint
    */
   async getKeys() {
-    const keyPath = helper.hostPath('./tmp/ssh/key');
+    const keyPath = hostGitPath('./tmp/ssh/key');
 
     // Generating keys if do not exist
     const keyExists = await exists(keyPath);

package/lib/main.js

@@ -1,52 +1,42 @@
 import { _ } from 'golgoth';
-import github from './github.js';
-import circleci from './circleci.js';
-import renovate from './renovate.js';
+import { enable as enableCircleci } from './circleci.js';
+import { enable as enableGithub } from './github.js';
+import { enable as enableRenovate } from './renovate.js';
 
-export default {
-  /**
-   * Enable external services.
-   * Will enable CircleCI, GitHub and Renovate by default.
-   * @param {object} cliArgs CLI Argument object, as created by minimist
-   */
-  async run(cliArgs = {}) {
-    const defaultServices = {
-      circleci: true,
-      renovate: true,
-      github: true,
-    };
-    const cliServices = _.omit(cliArgs, ['_']);
-    const servicesToEnable = {
-      ...defaultServices,
-      ...cliServices,
-    };
+export let __;
 
-    if (servicesToEnable.github) {
-      await this.github();
-    }
-    if (servicesToEnable.circleci) {
-      await this.circleci();
-    }
-    if (servicesToEnable.renovate) {
-      await this.renovate();
-    }
-  },
-  /**
-   * Configure GitHub
-   */
-  async github() {
-    await github.enable();
-  },
-  /**
-   * Enable CircleCI
-   */
-  async circleci() {
-    await circleci.enable();
-  },
-  /**
-   * Enable renovate
-   */
-  async renovate() {
-    await renovate.enable();
-  },
+/**
+ * Enable external services.
+ * Will enable CircleCI, GitHub and Renovate by default.
+ * @param {object} cliArgs CLI Argument object, as created by minimist
+ */
+export async function run(cliArgs = {}) {
+  const defaultServices = {
+    circleci: true,
+    renovate: true,
+    github: true,
+  };
+  const cliServices = _.omit(cliArgs, ['_']);
+  const servicesToEnable = {
+    ...defaultServices,
+    ...cliServices,
+  };
+
+  if (servicesToEnable.github) {
+    await __.enableGithub();
+  }
+  if (servicesToEnable.circleci) {
+    await __.enableCircleci();
+  }
+  if (servicesToEnable.renovate) {
+    await __.enableRenovate();
+  }
+}
+
+__ = {
+  enableGithub,
+  enableCircleci,
+  enableRenovate,
 };
+
+export default { run };

package/lib/renovate.js

@@ -1,8 +1,56 @@
 import { consoleError, consoleInfo, consoleSuccess } from 'firost';
 import githubHelper from './helpers/github.js';
 
-export default {
-  renovateId: 2471197,
+export let __;
+
+const RENOVATE_ID = 2471197;
+
+/**
+ * Attempt to automatically add the current repo to renovate, otherwise
+ * display the link to do it manually
+ * @returns {boolean} True if enabled, false otherwise
+ */
+export async function enable() {
+  const { username, repo } = await githubHelper.repoData();
+  const manualUrl = `https://github.com/settings/installations/${RENOVATE_ID}`;
+  const renovateDashboardUrl = `https://developer.mend.io/github/${username}/${repo}`;
+
+  // Fail early if no token available
+  if (!githubHelper.hasToken()) {
+    __.consoleError(
+      'Renovate: ABERLAAS_GITHUB_TOKEN environment variable must be set',
+    );
+    __.consoleInfo("  Create a Classic token with 'repo' scope");
+    __.consoleInfo('  https://github.com/settings/tokens\n');
+    return false;
+  }
+
+  // Check if already enabled
+  if (await __.isAlreadyEnabled()) {
+    __.consoleSuccess('Renovate: Already configured');
+    __.consoleInfo(`  ${renovateDashboardUrl}\n`);
+    return true;
+  }
+
+  try {
+    const repositoryId = await __.getRepositoryId();
+    await githubHelper.octokit('apps.addRepoToInstallation', {
+      installation_id: RENOVATE_ID,
+      repository_id: repositoryId,
+    });
+  } catch (_err) {
+    __.consoleError('Renovate is not installed with this GitHub account');
+    __.consoleInfo('  Please visit the installation page to install it first');
+    __.consoleInfo(`  ${manualUrl}\n`);
+    return false;
+  }
+
+  __.consoleSuccess('Renovate: Repository configured');
+  __.consoleInfo(`  ${renovateDashboardUrl}\n`);
+  return true;
+}
+
+__ = {
   /**
    * Returns the GitHub repository Id
    * @returns {number} Repository Id
@@ -15,52 +63,6 @@ export default {
     });
     return id;
   },
-  /**
-   * Attempt to automatically add the current repo to renovate, otherwise
-   * display the link to do it manually
-   * @returns {boolean} True if enabled, false otherwise
-   */
-  async enable() {
-    const { username, repo } = await githubHelper.repoData();
-    const manualUrl = `https://github.com/settings/installations/${this.renovateId}`;
-    const renovateDashboardUrl = `https://developer.mend.io/github/${username}/${repo}`;
-
-    // Fail early if no token available
-    if (!githubHelper.hasToken()) {
-      this.__consoleError(
-        'Renovate: ABERLAAS_GITHUB_TOKEN environment variable must be set',
-      );
-      this.__consoleInfo("  Create a Classic token with 'repo' scope");
-      this.__consoleInfo('  https://github.com/settings/tokens\n');
-      return false;
-    }
-
-    // Check if already enabled
-    if (await this.isAlreadyEnabled()) {
-      this.__consoleSuccess('Renovate: Already configured');
-      this.__consoleInfo(`  ${renovateDashboardUrl}\n`);
-      return true;
-    }
-
-    try {
-      const repositoryId = await this.getRepositoryId();
-      await githubHelper.octokit('apps.addRepoToInstallation', {
-        installation_id: this.renovateId,
-        repository_id: repositoryId,
-      });
-    } catch (_err) {
-      this.__consoleError('Renovate is not installed with this GitHub account');
-      this.__consoleInfo(
-        '  Please visit the installation page to install it first',
-      );
-      this.__consoleInfo(`  ${manualUrl}\n`);
-      return false;
-    }
-
-    this.__consoleSuccess('Renovate: Repository configured');
-    this.__consoleInfo(`  ${renovateDashboardUrl}\n`);
-    return true;
-  },
   /**
    * Check if Renovate is already enabled for this repository
    * @returns {boolean} True if already enabled, false otherwise
@@ -71,7 +73,7 @@ export default {
       const installations = await githubHelper.octokit(
         'apps.listReposAccessibleToInstallation',
         {
-          installation_id: this.renovateId,
+          installation_id: RENOVATE_ID,
         },
       );
 
@@ -84,7 +86,9 @@ export default {
       return false;
     }
   },
-  __consoleSuccess: consoleSuccess,
-  __consoleInfo: consoleInfo,
-  __consoleError: consoleError,
+  consoleSuccess,
+  consoleInfo,
+  consoleError,
 };
+
+export default { enable };

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "aberlaas-setup",
   "type": "module",
+  "sideEffects": false,
   "description": "aberlaas setup helper: Setup third parties like GitHub, Netlify or CircleCI",
-  "version": "2.18.1",
+  "version": "2.20.2",
   "repository": "pixelastic/aberlaas",
   "homepage": "https://projects.pixelastic.com/aberlaas/",
   "author": "Tim Carry (@pixelastic)",
@@ -18,27 +19,24 @@
   "engines": {
     "node": ">=18.18.0"
   },
-  "scripts": {
-    "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-dependencies": "node ../../scripts/meta/update-dependencies.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"
-  },
   "dependencies": {
-    "@octokit/rest": "21.0.2",
-    "aberlaas-helper": "^2.18.1",
-    "firost": "5.2.1",
-    "golgoth": "3.0.0",
+    "@octokit/rest": "22.0.1",
+    "aberlaas-helper": "workspace:*",
+    "firost": "5.5.1",
+    "golgoth": "3.1.0",
     "parse-github-repo-url": "1.4.1"
   },
-  "gitHead": "00b60dcf9aebab442a809ccc81942005d87d1b5c"
+  "scripts": {
+    "build": "cd ../docs && yarn run build",
+    "build:prod": "cd ../docs && yarn run build:prod",
+    "cms": "cd ../docs && yarn run cms",
+    "serve": "cd ../docs && yarn run serve",
+    "release": "cd ../.. && ./scripts/release",
+    "test:meta": "cd ../.. && ./scripts/test-meta",
+    "test": "cd ../.. && ./scripts/test",
+    "test:watch": "cd ../.. && ./scripts/test-watch",
+    "compress": "cd ../.. && ./scripts/compress",
+    "lint": "cd ../.. && ./scripts/lint",
+    "lint:fix": "cd ../.. && ./scripts/lint-fix"
+  }
 }