aberlaas-init 2.18.1 → 2.20.1

package/lib/layouts/monorepo.js

@@ -1,24 +1,52 @@
 import { writeJson } from 'firost';
-
-import helper from 'aberlaas-helper';
+import { hostGitPath } from 'aberlaas-helper';
 import {
-  lernaVersion,
   nodeVersion,
   norskaThemeDocsVersion,
   norskaVersion,
   yarnVersion,
 } from 'aberlaas-versions';
-import initHelper from '../helper.js';
+import {
+  addConfigFiles,
+  addDefaultScripts,
+  addDocsScripts,
+  addLibFiles,
+  addLicenseFile,
+  getAberlaasVersion,
+  getProjectAuthor,
+  getProjectName,
+} from '../helper.js';
+
+export let __;
+
+/**
+ * Scaffold a repo:
+ * - As a monorepo
+ * - With ./libs and ./docs subfolders
+ */
+export async function run() {
+  await __.createRootWorkspace();
+  await __.createDocsWorkspace();
+  await __.createLibWorkspace();
+  await __.addLicenseFiles();
+
+  await addConfigFiles();
+  await addDefaultScripts();
+  await addDocsScripts();
+  await addLibFiles('./modules/lib');
+}
+
+__ = {
+  // Public methods
 
-export default {
   /**
    * Scaffold a repo:
    * - As a monorepo
    * - With ./modules holding all modules, including ./lib and ./docs
    */
   async createRootWorkspace() {
-    const aberlaasVersion = this.__getAberlaasVersion();
-    const sharedProjectData = await this.getSharedProjectData();
+    const aberlaasVersion = await getAberlaasVersion();
+    const sharedProjectData = await __.getSharedProjectData();
     const engines = {
       node: `>=${nodeVersion}`,
     };
@@ -47,39 +75,36 @@ export default {
       dependencies: {},
       devDependencies: {
         aberlaas: aberlaasVersion,
-        lerna: lernaVersion,
       },
 
       // Scripts
       scripts: {
         // Docs
-        build: './scripts/meta/build',
-        'build:prod': './scripts/meta/build-prod',
-        cms: './scripts/meta/cms',
-        serve: './scripts/meta/serve',
+        build: './scripts/build',
+        'build:prod': './scripts/build-prod',
+        cms: './scripts/cms',
+        serve: './scripts/serve',
 
         // Lib
-        release: './scripts/meta/release',
-        test: './scripts/meta/test',
-        'test:watch': './scripts/meta/test-watch',
-        ci: './scripts/meta/ci',
-        compress: './scripts/meta/compress',
-        lint: './scripts/meta/lint',
-        'lint:fix': './scripts/meta/lint-fix',
-
-        // Typo
-        learn: 'lerna',
+        release: './scripts/release',
+        test: './scripts/test',
+        'test:watch': './scripts/test-watch',
+        ci: './scripts/ci',
+        compress: './scripts/compress',
+        lint: './scripts/lint',
+        'lint:fix': './scripts/lint-fix',
       },
     };
-    await writeJson(packageContent, helper.hostPath('./package.json'), {
+    await writeJson(packageContent, hostGitPath('./package.json'), {
       sort: false,
     });
   },
+
   /**
    * Create the docs workspace
    */
   async createDocsWorkspace() {
-    const sharedProjectData = await this.getSharedProjectData();
+    const sharedProjectData = await __.getSharedProjectData();
 
     const packageContent = {
       // Name & Version
@@ -111,17 +136,18 @@ export default {
     };
     await writeJson(
       packageContent,
-      helper.hostPath('./modules/docs/package.json'),
+      hostGitPath('./modules/docs/package.json'),
       {
         sort: false,
       },
     );
   },
+
   /**
    * Create the lib workspace
    */
   async createLibWorkspace() {
-    const sharedProjectData = await this.getSharedProjectData();
+    const sharedProjectData = await __.getSharedProjectData();
     const engines = {
       node: `>=${nodeVersion}`,
     };
@@ -161,54 +187,43 @@ export default {
       // Scripts
       scripts: sharedProjectData.scripts,
     };
-    await writeJson(
-      packageContent,
-      helper.hostPath('./modules/lib/package.json'),
-      {
-        sort: false,
-      },
-    );
+    await writeJson(packageContent, hostGitPath('./modules/lib/package.json'), {
+      sort: false,
+    });
   },
+
   /**
    * Add MIT license files to the repository
    */
   async addLicenseFiles() {
     // One at the repo root, for GitHub
-    await initHelper.addLicenseFile('LICENSE');
+    await addLicenseFile('LICENSE');
     // One in ./lib to be released with the module
-    await initHelper.addLicenseFile('modules/lib/LICENSE');
+    await addLicenseFile('modules/lib/LICENSE');
   },
-  /**
-   * Add config files
-   */
-  async addConfigFiles() {
-    await initHelper.addConfigFiles();
 
-    // Lerna
-    await initHelper.copyTemplateToHost('lerna.json', 'lerna.json');
-  },
   /**
    * Returns shared project data, like name, author, scripts, etc
    * @returns {object} Object of common keys
    */
   async getSharedProjectData() {
-    const name = await this.__getProjectName();
-    const author = await this.__getProjectAuthor();
+    const name = await getProjectName();
+    const author = await getProjectAuthor();
     const homepage = `https://projects.pixelastic.com/${name}`;
     const repository = `${author}/${name}`;
     const license = 'MIT';
     const 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',
-      test: '../../scripts/local/test',
-      'test:watch': '../../scripts/local/test-watch',
-      compress: '../../scripts/local/compress',
-      lint: '../../scripts/local/lint',
-      'lint:fix': '../../scripts/local/lint-fix',
+      build: 'cd ../.. && ./scripts/build',
+      'build:prod': 'cd ../.. && ./scripts/build-prod',
+      cms: 'cd ../.. && ./scripts/cms',
+      serve: 'cd ../.. && ./scripts/serve',
+      ci: 'cd ../.. && ./scripts/ci',
+      release: 'cd ../.. && ./scripts/release',
+      test: 'cd ../.. && ./scripts/test',
+      'test:watch': 'cd ../.. && ./scripts/test-watch',
+      compress: 'cd ../.. && ./scripts/compress',
+      lint: 'cd ../.. && ./scripts/lint',
+      'lint:fix': 'cd ../.. && ./scripts/lint-fix',
     };
     return {
       author,
@@ -219,22 +234,8 @@ export default {
       scripts,
     };
   },
-  /**
-   * Scaffold a repo:
-   * - As a monorepo
-   * - With ./libs and ./docs subfolders
-   */
-  async run() {
-    await this.createRootWorkspace();
-    await this.createDocsWorkspace();
-    await this.createLibWorkspace();
-
-    await this.addLicenseFiles();
-    await this.addConfigFiles();
-    await initHelper.addScripts('__monorepo');
-    await initHelper.addLibFiles('./modules/lib');
-  },
-  __getProjectName: initHelper.getProjectName,
-  __getProjectAuthor: initHelper.getProjectAuthor.bind(initHelper),
-  __getAberlaasVersion: initHelper.getAberlaasVersion,
+};
+
+export default {
+  run,
 };

package/lib/main.js

@@ -1,33 +1,70 @@
-import { consoleInfo, firostError, run, spinner, write } from 'firost';
-
-import Gilmore from 'gilmore';
-import helper from 'aberlaas-helper';
+import {
+  consoleInfo,
+  firostError,
+  run as firostRun,
+  spinner,
+  write,
+} from 'firost';
+import { hostGitPath, hostGitRoot } from 'aberlaas-helper';
 import { nodeVersion } from 'aberlaas-versions';
-import moduleLayout from './layouts/module.js';
+import Gilmore from 'gilmore';
 import libdocsLayout from './layouts/libdocs.js';
+import moduleLayout from './layouts/module.js';
 import monorepoLayout from './layouts/monorepo.js';
 
-export default {
+export let __;
+
+/**
+ * Copy all config files and configure the scripts
+ * @param {object} args Argument object, as passed by minimist
+ */
+export async function run(args = {}) {
+  const progress = __.spinner();
+
+  progress.tick('Configuring Git & Node');
+  await __.configureGit();
+  await __.configureNode();
+
+  progress.tick('Adding default files ');
+
+  // Create a different scaffolding based on if creating a monorepo or not
+  const layout = __.getLayout(args);
+  await layout.run();
+
+  progress.success('aberlaas project initialized');
+
+  __.consoleInfo('Synchronizing dependencies');
+  await __.yarnInstall();
+
+  __.consoleInfo(
+    "Don't forget to run aberlaas setup after pushing your repository",
+  );
+}
+
+__ = {
   /**
    * Configure git hooks to use scripts/hooks instead of .git/hooks
    */
   async configureGit() {
-    const repo = new Gilmore(helper.hostRoot());
+    const repo = new Gilmore(hostGitRoot());
     await repo.setConfig('core.hooksPath', 'scripts/hooks');
   },
+
   /**
    * Pin the node version through nvm
    */
   async configureNode() {
-    const nvmrcPath = helper.hostPath('.nvmrc');
+    const nvmrcPath = hostGitPath('.nvmrc');
     await write(nodeVersion, nvmrcPath);
   },
+
   /**
    * Run yarn install to install all deps
    */
   async yarnInstall() {
-    await run('yarn install');
+    await firostRun('yarn install');
   },
+
   /**
    * Returns the correct layout object, based on args
    * @param {object} args Arguments, as passed by minimist
@@ -37,54 +74,33 @@ export default {
     if (args.monorepo && args.libdocs) {
       throw firostError(
         'ABERLAAS_INIT_LAYOUT_INCOMPATIBLE',
-        "You can't specific both --monorepo and --libdocs",
+        "You can't specify both --monorepo and --libdocs",
       );
     }
 
     if (args.monorepo) {
-      return this.__monorepoLayout();
+      return __.monorepoLayout();
     }
     if (args.libdocs) {
-      return this.__libdocsLayout();
+      return __.libdocsLayout();
     }
-    return this.__moduleLayout();
+    return __.moduleLayout();
   },
-  /**
-   * Copy all config files and configure the scripts
-   * @param {object} args Argument object, as passed by minimist
-   */
-  async run(args = {}) {
-    const progress = this.__spinner();
-
-    progress.tick('Configuring Git & Node');
-    await this.configureGit();
-    await this.configureNode();
-
-    progress.tick('Adding default files ');
 
-    // Create a different scaffolding based on if creating a monorepo or not
-    const layout = this.getLayout(args);
-    await layout.run();
-
-    progress.success('aberlaas project initialized');
-
-    this.__consoleInfo('Synchronizing dependencies');
-    await this.yarnInstall();
-
-    this.__consoleInfo(
-      "Don't forget to run aberlaas setup after pushing your repository",
-    );
-  },
-  __consoleInfo: consoleInfo,
-  __spinner: spinner,
   // Why the old-school getters? So we can mock which layout is returned
-  __moduleLayout() {
+  moduleLayout() {
     return moduleLayout;
   },
-  __libdocsLayout() {
+  libdocsLayout() {
     return libdocsLayout;
   },
-  __monorepoLayout() {
+  monorepoLayout() {
     return monorepoLayout;
   },
+  spinner,
+  consoleInfo,
+};
+
+export default {
+  run,
 };

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "aberlaas-init",
   "type": "module",
+  "sideEffects": false,
   "description": "aberlaas init command: Setup the repository with all needed config",
-  "version": "2.18.1",
+  "version": "2.20.1",
   "repository": "pixelastic/aberlaas",
   "homepage": "https://projects.pixelastic.com/aberlaas/",
   "author": "Tim Carry (@pixelastic)",
@@ -19,27 +20,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": {
-    "aberlaas-helper": "^2.18.1",
-    "aberlaas-versions": "^2.15.0",
-    "firost": "5.2.1",
-    "gilmore": "1.0.0",
+    "aberlaas-helper": "workspace:*",
+    "aberlaas-versions": "workspace:*",
+    "firost": "5.5.1",
+    "gilmore": "1.2.0",
     "golgoth": "3.0.0"
   },
-  "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"
+  }
 }

package/templates/_README.template.md

@@ -0,0 +1,5 @@
+---
+outputs:
+  - lib/README.md
+---
+{file:README.md}

package/templates/_editorconfig

@@ -0,0 +1,8 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true

package/templates/_gitignore

@@ -1,33 +1,25 @@
-# Hidden files
-.DS_Store
+# Important files that should not be committed
+.npmrc
 .envrc
 
-# Directories
+# Build directories
 build/
 dist/
-node_modules/
 tmp/
 
-# Files
+# Junk files
+.DS_Store
 Thumbs.db
 lerna-debug.log
 npm-debug.log
 yarn-error.log
 *~
 
-# Yarn
-# https://yarnpkg.com/getting-started/qa#which-files-should-be-gitignored
-.yarn/*
-!.yarn/patches
-!.yarn/plugins
-!.yarn/releases
-!.yarn/sdks
-!.yarn/versions
-
-# Netlify
-.netlify
-
-# Vibe coding
-.claude/settings.local.json
+# Tool directories
+.claude/
 .cursor/
+.netlify/
 .taskmaster/
+.turbo/
+.yarn/
+node_modules/

package/templates/scripts/build

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+echo "TODO: This should build the docs/"

package/templates/scripts/build-prod

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+echo "TODO: This should build the docs/ for production"

package/templates/scripts/ci

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+./node_modules/.bin/aberlaas ci "$@"

package/templates/scripts/cms

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+echo "TODO: This should start the docs/ CMS"

package/templates/scripts/compress

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+node_modules/.bin/aberlaas compress "$@"

package/templates/scripts/{__module/hooks → hooks}/pre-commit

@@ -8,4 +8,4 @@
 # $ git config core.hooksPath scripts/hooks
 set -e
 
-yarn run aberlaas precommit
+./node_modules/.bin/aberlaas precommit

package/templates/scripts/lint

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+node_modules/.bin/aberlaas lint "$@"

package/templates/scripts/lint-fix

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+node_modules/.bin/aberlaas lint --fix "$@"

package/templates/scripts/release

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+node_modules/.bin/aberlaas release "$@"

package/templates/scripts/serve

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+echo "TODO: This should serve the docs/ locally"

package/templates/scripts/test

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+node_modules/.bin/aberlaas test "$@"

package/templates/scripts/test-watch

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+node_modules/.bin/aberlaas test --watch "$@"

package/templates/_gitattributes

@@ -1,4 +0,0 @@
-/.yarn/**            linguist-vendored
-/.yarn/releases/*    binary
-/.yarn/plugins/**/*  binary
-/.pnp.*              binary linguist-generated

package/templates/lerna.json

@@ -1,6 +0,0 @@
-{
-  "version": "0.0.1",
-  "useWorkspaces": true,
-  "packages": ["lib", "docs"],
-  "npmClient": "yarn"
-}

package/templates/scripts/__libdocs/hooks/pre-commit

@@ -1,11 +0,0 @@
-#!/usr/bin/env sh
-# This script *should be* automatically triggered before each git commit.
-#
-# If it doesn't work, make sure your local git repo is configured to use
-# ./scripts/hooks as the base directory for git hooks.
-#
-# If not, run:
-# $ git config core.hooksPath scripts/hooks
-set -e
-
-yarn run aberlaas precommit

package/templates/scripts/__libdocs/local/build

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-set -e
-
-cd ..
-./scripts/meta/build "$@"

package/templates/scripts/__libdocs/local/build-prod

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-set -e
-
-cd ..
-./scripts/meta/build-prod "$@"

package/templates/scripts/__libdocs/local/ci

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-set -e
-
-cd ..
-./scripts/meta/ci "$@"

package/templates/scripts/__libdocs/local/cms

@@ -1,4 +0,0 @@
-#!/usr/bin/env bash
-set -e
-
-echo "TODO: Should load the CMS UI"

package/templates/scripts/__libdocs/local/compress

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-set -e
-
-cd ..
-./scripts/meta/compress "$@"

package/templates/scripts/__libdocs/local/lint

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-set -e
-
-cd ..
-./scripts/meta/lint "$@"

package/templates/scripts/__libdocs/local/lint-fix

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-set -e
-
-cd ..
-./scripts/meta/lint-fix "$@"

package/templates/scripts/__libdocs/local/release

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-set -e
-
-cd ..
-./scripts/meta/release "$@"

package/templates/scripts/__libdocs/local/serve

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-set -e
-
-cd ..
-./scripts/meta/serve "$@"

package/templates/scripts/__libdocs/local/test

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-set -e
-
-cd ..
-./scripts/meta/test "$@"