aberlaas-init 2.21.1 → 2.22.0

package/lib/layouts/__tests__/libdocs.js

@@ -0,0 +1,219 @@
+import {
+  exists,
+  glob,
+  readJson,
+  remove,
+  tmpDirectory,
+  writeJson,
+} from 'firost';
+import { hostGitPath, hostGitRoot, mockHelperPaths } from 'aberlaas-helper';
+import {
+  nodeVersion,
+  norskaThemeDocsVersion,
+  norskaVersion,
+  yarnVersion,
+} from 'aberlaas-versions';
+import { __ as initHelper } from '../../helper.js';
+import { __, run } from '../libdocs.js';
+
+describe('init > libdocs', () => {
+  const testDirectory = tmpDirectory('aberlaas/init/libdocs');
+  beforeEach(async () => {
+    mockHelperPaths(testDirectory);
+
+    // Create a package.json with aberlaas in devDependencies
+    await writeJson(
+      { devDependencies: { aberlaas: '1.2.3' } },
+      hostGitPath('package.json'),
+    );
+
+    vi.spyOn(initHelper, 'getProjectName').mockReturnValue('my-project');
+    vi.spyOn(initHelper, 'getProjectAuthor').mockReturnValue('my-name');
+  });
+  afterEach(async () => {
+    await remove(hostGitRoot());
+  });
+
+  // WORKSPACES
+  describe('createRootWorkspace', () => {
+    it.each([
+      [
+        'should have correct metadata',
+        {
+          name: 'my-project-root',
+          author: 'my-name',
+          description: 'my-project root workspace',
+          repository: 'my-name/my-project',
+          homepage: 'https://projects.pixelastic.com/my-project',
+          license: 'MIT',
+        },
+      ],
+      [
+        'should have root specific data',
+        {
+          private: true,
+          workspaces: ['docs', 'lib'],
+          type: 'module',
+          packageManager: `yarn@${yarnVersion}`,
+          dependencies: {},
+          devDependencies: {
+            aberlaas: '1.2.3',
+          },
+          scripts: {
+            build: './scripts/build',
+            release: './scripts/release',
+            lint: './scripts/lint',
+          },
+        },
+      ],
+    ])('%s', async (_title, expected) => {
+      await __.createRootWorkspace();
+
+      const actual = await readJson(hostGitPath('package.json'));
+
+      expect(actual).toMatchObject(expected);
+    });
+  });
+  describe('createDocsWorkspace', () => {
+    it.each([
+      [
+        'should have correct metadata',
+        {
+          name: 'my-project-docs',
+          version: '0.0.1',
+          author: 'my-name',
+          description: 'my-project docs',
+          repository: 'my-name/my-project',
+          homepage: 'https://projects.pixelastic.com/my-project',
+          license: 'MIT',
+        },
+      ],
+      [
+        'should have docs specific data',
+        {
+          private: true,
+          devDependencies: {},
+          dependencies: {
+            norska: norskaVersion,
+            'norska-theme-docs': norskaThemeDocsVersion,
+          },
+          scripts: {
+            build: 'cd .. && ./scripts/build',
+            release: 'cd .. && ./scripts/release',
+            lint: 'cd .. && ./scripts/lint',
+          },
+        },
+      ],
+    ])('%s', async (_title, expected) => {
+      await __.createDocsWorkspace();
+
+      const actual = await readJson(hostGitPath('docs/package.json'));
+
+      expect(actual).toMatchObject(expected);
+    });
+  });
+  describe('createLibWorkspace', () => {
+    it.each([
+      [
+        'should have correct metadata',
+        {
+          name: 'my-project',
+          version: '0.0.1',
+          author: 'my-name',
+          description: '',
+          keywords: [],
+          repository: 'my-name/my-project',
+          homepage: 'https://projects.pixelastic.com/my-project',
+          license: 'MIT',
+        },
+      ],
+      [
+        'should have lib specific data',
+        {
+          private: false,
+          type: 'module',
+          sideEffects: false,
+          engines: {
+            node: `>=${nodeVersion}`,
+          },
+
+          files: ['*.js'],
+          exports: { '.': './main.js' },
+          // Some tools have trouble parsing the .exports field, so we keep the
+          // .main field for backward compatibility
+          main: './main.js',
+
+          devDependencies: {},
+          dependencies: {},
+
+          scripts: {
+            build: 'cd .. && ./scripts/build',
+            release: 'cd .. && ./scripts/release',
+            lint: 'cd .. && ./scripts/lint',
+          },
+        },
+      ],
+    ])('%s', async (_title, expected) => {
+      await __.createLibWorkspace();
+
+      const actual = await readJson(hostGitPath('lib/package.json'));
+
+      expect(actual).toMatchObject(expected);
+    });
+  });
+
+  describe('addLicenseFiles', () => {
+    it('creates license file in root and ./lib', async () => {
+      await __.addLicenseFiles();
+
+      expect(await exists(hostGitPath('LICENSE'))).toBe(true);
+      expect(await exists(hostGitPath('lib/LICENSE'))).toBe(true);
+    });
+  });
+
+  describe('run', () => {
+    vi.setConfig({ testTimeout: 10_000 });
+    it('should build a libdocs structure', async () => {
+      await run();
+
+      const actual = await glob('**/*', {
+        cwd: hostGitPath(),
+        absolutePaths: false,
+        directories: false,
+      });
+
+      expect(actual).toEqual([
+        '.circleci/config.yml',
+        '.editorconfig',
+        '.github/renovate.json',
+        '.gitignore',
+        '.README.template.md',
+        '.yarnrc.yml',
+        'docs/package.json',
+        'eslint.config.js',
+        'lib/__tests__/main.js',
+        'lib/LICENSE',
+        'lib/main.js',
+        'lib/package.json',
+        'LICENSE',
+        'lintstaged.config.js',
+        'package.json',
+        'prettier.config.js',
+        'scripts/build',
+        'scripts/build-prod',
+        'scripts/ci',
+        'scripts/cms',
+        'scripts/compress',
+        'scripts/hooks/pre-commit',
+        'scripts/lint',
+        'scripts/lint-fix',
+        'scripts/release',
+        'scripts/serve',
+        'scripts/test',
+        'scripts/test-watch',
+        'stylelint.config.js',
+        'vite.config.js',
+      ]);
+    });
+  });
+});

package/lib/layouts/__tests__/module.js

@@ -0,0 +1,148 @@
+import { glob, read, readJson, remove, tmpDirectory, writeJson } from 'firost';
+import { hostGitPath, hostGitRoot, mockHelperPaths } from 'aberlaas-helper';
+import { nodeVersion, yarnVersion } from 'aberlaas-versions';
+import { __ as initHelper } from '../../helper.js';
+import { __, run } from '../module.js';
+
+describe('init > module', () => {
+  const testDirectory = tmpDirectory('aberlaas/init/module');
+  beforeEach(async () => {
+    mockHelperPaths(testDirectory);
+
+    // Create a package.json with aberlaas in devDependencies
+    await writeJson(
+      { devDependencies: { aberlaas: '1.2.3' } },
+      hostGitPath('package.json'),
+    );
+
+    vi.spyOn(initHelper, 'getProjectName').mockReturnValue('my-project');
+    vi.spyOn(initHelper, 'getProjectAuthor').mockReturnValue('my-name');
+  });
+  afterEach(async () => {
+    await remove(hostGitRoot());
+  });
+
+  describe('createPackageJson', () => {
+    it.each([
+      [
+        'should have correct metadata',
+        {
+          name: 'my-project',
+          version: '0.0.1',
+          author: 'my-name',
+          description: '',
+          keywords: [],
+          repository: 'my-name/my-project',
+          homepage: 'https://github.com/my-name/my-project',
+        },
+      ],
+      [
+        'should have correct license',
+        {
+          license: 'MIT',
+        },
+      ],
+      [
+        'should have ESM information',
+        {
+          type: 'module',
+          sideEffects: false,
+        },
+      ],
+      [
+        'should have language and yarn version',
+        {
+          engines: {
+            node: `>=${nodeVersion}`,
+          },
+          packageManager: `yarn@${yarnVersion}`,
+        },
+      ],
+      [
+        'should export the right files',
+        {
+          files: ['lib/*.js'],
+          exports: { '.': './lib/main.js' },
+          main: './lib/main.js',
+        },
+      ],
+      [
+        'should have the right dependencies',
+        {
+          devDependencies: {
+            aberlaas: '1.2.3',
+          },
+          dependencies: {},
+        },
+      ],
+      [
+        'should have scripts',
+        {
+          scripts: {
+            release: './scripts/release',
+            test: './scripts/test',
+            lint: './scripts/lint',
+          },
+        },
+      ],
+    ])('%s', async (_title, expected) => {
+      await __.createPackageJson();
+
+      const actual = await readJson(hostGitPath('package.json'));
+
+      expect(actual).toMatchObject(expected);
+    });
+  });
+
+  describe('run', () => {
+    it('should build a module structure', async () => {
+      await run();
+
+      const actual = await glob('**/*', {
+        cwd: hostGitPath(),
+        absolutePaths: false,
+        directories: false,
+      });
+
+      expect(actual).toEqual([
+        '.circleci/config.yml',
+        '.editorconfig',
+        '.github/renovate.json',
+        '.gitignore',
+        '.README.template.md',
+        '.yarnrc.yml',
+        'eslint.config.js',
+        'lib/__tests__/main.js',
+        'lib/main.js',
+        'LICENSE',
+        'lintstaged.config.js',
+        'package.json',
+        'prettier.config.js',
+        'scripts/ci',
+        'scripts/compress',
+        'scripts/hooks/pre-commit',
+        'scripts/lint',
+        'scripts/lint-fix',
+        'scripts/release',
+        'scripts/test',
+        'scripts/test-watch',
+        'stylelint.config.js',
+        'vite.config.js',
+      ]);
+    });
+
+    it('should write a correct circleCI file', async () => {
+      await run();
+
+      const circleciConfig = await read(hostGitPath('.circleci/config.yml'));
+
+      // Should not contain literal template placeholders
+      expect(circleciConfig).not.toContain('{nodeVersion}');
+      expect(circleciConfig).not.toContain('{yarnVersion}');
+
+      // Should contain actual versions
+      expect(circleciConfig).toContain(`cimg/node:${nodeVersion}`);
+      expect(circleciConfig).toContain(`yarn set version ${yarnVersion}`);
+    });
+  });
+});

package/lib/layouts/__tests__/monorepo.js

@@ -0,0 +1,218 @@
+import {
+  exists,
+  glob,
+  readJson,
+  remove,
+  tmpDirectory,
+  writeJson,
+} from 'firost';
+import { hostGitPath, hostGitRoot, mockHelperPaths } from 'aberlaas-helper';
+import {
+  nodeVersion,
+  norskaThemeDocsVersion,
+  norskaVersion,
+  yarnVersion,
+} from 'aberlaas-versions';
+import { __ as initHelper } from '../../helper.js';
+import { __, run } from '../monorepo.js';
+
+describe('init > monorepo', () => {
+  const testDirectory = tmpDirectory('aberlaas/init/monorepo');
+  beforeEach(async () => {
+    mockHelperPaths(testDirectory);
+
+    // Create a package.json with aberlaas in devDependencies
+    await writeJson(
+      { devDependencies: { aberlaas: '1.2.3' } },
+      hostGitPath('package.json'),
+    );
+
+    vi.spyOn(initHelper, 'getProjectName').mockReturnValue('my-project');
+    vi.spyOn(initHelper, 'getProjectAuthor').mockReturnValue('my-name');
+  });
+  afterEach(async () => {
+    await remove(hostGitRoot());
+  });
+
+  // WORKSPACES
+  describe('createRootWorkspace', () => {
+    it.each([
+      [
+        'should have correct metadata',
+        {
+          name: 'my-project-monorepo',
+          author: 'my-name',
+          description: 'my-project monorepo',
+          repository: 'my-name/my-project',
+          homepage: 'https://projects.pixelastic.com/my-project',
+          license: 'MIT',
+        },
+      ],
+      [
+        'should have root specific data',
+        {
+          private: true,
+          workspaces: ['modules/*'],
+          type: 'module',
+          packageManager: `yarn@${yarnVersion}`,
+          dependencies: {},
+          devDependencies: {
+            aberlaas: '1.2.3',
+          },
+          scripts: {
+            build: './scripts/build',
+            release: './scripts/release',
+            lint: './scripts/lint',
+          },
+        },
+      ],
+    ])('%s', async (_title, expected) => {
+      await __.createRootWorkspace();
+
+      const actual = await readJson(hostGitPath('package.json'));
+
+      expect(actual).toMatchObject(expected);
+    });
+  });
+  describe('createDocsWorkspace', () => {
+    it.each([
+      [
+        'should have correct metadata',
+        {
+          name: 'my-project-docs',
+          version: '0.0.1',
+          author: 'my-name',
+          description: 'my-project docs',
+          repository: 'my-name/my-project',
+          homepage: 'https://projects.pixelastic.com/my-project',
+          license: 'MIT',
+        },
+      ],
+      [
+        'should have docs specific data',
+        {
+          private: true,
+          devDependencies: {},
+          dependencies: {
+            norska: norskaVersion,
+            'norska-theme-docs': norskaThemeDocsVersion,
+          },
+          scripts: {
+            build: 'cd ../.. && ./scripts/build',
+            release: 'cd ../.. && ./scripts/release',
+            lint: 'cd ../.. && ./scripts/lint',
+          },
+        },
+      ],
+    ])('%s', async (_title, expected) => {
+      await __.createDocsWorkspace();
+
+      const actual = await readJson(hostGitPath('modules/docs/package.json'));
+
+      expect(actual).toMatchObject(expected);
+    });
+  });
+  describe('createLibWorkspace', () => {
+    it.each([
+      [
+        'should have correct metadata',
+        {
+          name: 'my-project',
+          version: '0.0.1',
+          author: 'my-name',
+          description: '',
+          keywords: [],
+          repository: 'my-name/my-project',
+          homepage: 'https://projects.pixelastic.com/my-project',
+          license: 'MIT',
+        },
+      ],
+      [
+        'should have lib specific data',
+        {
+          private: false,
+          type: 'module',
+          sideEffects: false,
+          engines: {
+            node: `>=${nodeVersion}`,
+          },
+
+          files: ['*.js'],
+          exports: { '.': './main.js' },
+          // Some tools have trouble parsing the .exports field, so we keep the
+          // .main field for backward compatibility
+          main: './main.js',
+
+          devDependencies: {},
+          dependencies: {},
+
+          scripts: {
+            build: 'cd ../.. && ./scripts/build',
+            release: 'cd ../.. && ./scripts/release',
+            lint: 'cd ../.. && ./scripts/lint',
+          },
+        },
+      ],
+    ])('%s', async (_title, expected) => {
+      await __.createLibWorkspace();
+
+      const actual = await readJson(hostGitPath('modules/lib/package.json'));
+
+      expect(actual).toMatchObject(expected);
+    });
+  });
+
+  describe('addLicenseFiles', () => {
+    it('creates license file in root and ./lib', async () => {
+      await __.addLicenseFiles();
+
+      expect(await exists(hostGitPath('LICENSE'))).toBe(true);
+      expect(await exists(hostGitPath('modules/lib/LICENSE'))).toBe(true);
+    });
+  });
+
+  describe('run', () => {
+    it('should build a monorepo structure', async () => {
+      await run();
+
+      const actual = await glob('**/*', {
+        cwd: hostGitPath(),
+        absolutePaths: false,
+        directories: false,
+      });
+
+      expect(actual).toEqual([
+        '.circleci/config.yml',
+        '.editorconfig',
+        '.github/renovate.json',
+        '.gitignore',
+        '.README.template.md',
+        '.yarnrc.yml',
+        'eslint.config.js',
+        'LICENSE',
+        'lintstaged.config.js',
+        'modules/docs/package.json',
+        'modules/lib/__tests__/main.js',
+        'modules/lib/LICENSE',
+        'modules/lib/main.js',
+        'modules/lib/package.json',
+        'package.json',
+        'prettier.config.js',
+        'scripts/build',
+        'scripts/build-prod',
+        'scripts/ci',
+        'scripts/cms',
+        'scripts/compress',
+        'scripts/hooks/pre-commit',
+        'scripts/lint',
+        'scripts/lint-fix',
+        'scripts/release',
+        'scripts/serve',
+        'scripts/test',
+        'scripts/test-watch',
+        'stylelint.config.js',
+        'vite.config.js',
+      ]);
+    });
+  });
+});

package/lib/layouts/libdocs.js

@@ -0,0 +1,234 @@
+import { writeJson } from 'firost';
+import { hostGitPath } from 'aberlaas-helper';
+import {
+  nodeVersion,
+  norskaThemeDocsVersion,
+  norskaVersion,
+  yarnVersion,
+} from 'aberlaas-versions';
+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();
+}
+
+__ = {
+  // Public methods
+
+  /**
+   * Create the top-level workspace
+   */
+  async createRootWorkspace() {
+    const aberlaasVersion = await getAberlaasVersion();
+    const sharedProjectData = await __.getSharedProjectData();
+    const engines = {
+      node: `>=${nodeVersion}`,
+    };
+
+    const packageContent = {
+      // Name and version
+      name: `${sharedProjectData.name}-root`,
+
+      // Visibility
+      private: true,
+      workspaces: ['docs', 'lib'],
+
+      // Metadata
+      author: sharedProjectData.author,
+      description: `${sharedProjectData.name} root workspace`,
+      repository: sharedProjectData.repository,
+      homepage: sharedProjectData.homepage,
+
+      // Compatibility
+      type: 'module',
+      license: sharedProjectData.license,
+      engines,
+      packageManager: `yarn@${yarnVersion}`,
+
+      // Dependencies
+      dependencies: {},
+      devDependencies: {
+        aberlaas: aberlaasVersion,
+      },
+
+      // Scripts
+      scripts: {
+        // Docs
+        build: './scripts/build',
+        'build:prod': './scripts/build-prod',
+        cms: './scripts/cms',
+        serve: './scripts/serve',
+
+        // Lib
+        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, hostGitPath('./package.json'), {
+      sort: false,
+    });
+  },
+
+  /**
+   * Create the docs workspace
+   */
+  async createDocsWorkspace() {
+    const sharedProjectData = await __.getSharedProjectData();
+
+    const packageContent = {
+      // Name & Version
+      name: `${sharedProjectData.name}-docs`,
+      version: '0.0.1',
+
+      // Visibility
+      private: true,
+
+      // Metadata
+      author: sharedProjectData.author,
+      description: `${sharedProjectData.name} docs`,
+      repository: sharedProjectData.repository,
+      homepage: sharedProjectData.homepage,
+
+      // Compatibility
+      license: sharedProjectData.license,
+
+      // Dependencies
+      dependencies: {
+        norska: norskaVersion,
+        'norska-theme-docs': norskaThemeDocsVersion,
+      },
+      devDependencies: {},
+
+      // Scripts
+      scripts: sharedProjectData.scripts,
+    };
+    await writeJson(packageContent, hostGitPath('./docs/package.json'), {
+      sort: false,
+    });
+  },
+
+  /**
+   * Create the lib workspace
+   */
+  async createLibWorkspace() {
+    const sharedProjectData = await __.getSharedProjectData();
+    const engines = {
+      node: `>=${nodeVersion}`,
+    };
+
+    const packageContent = {
+      // Name and version
+      name: sharedProjectData.name,
+      version: '0.0.1',
+
+      // Visibility
+      private: false,
+
+      // Metadata
+      author: sharedProjectData.author,
+      description: '',
+      keywords: [],
+      repository: sharedProjectData.repository,
+      homepage: sharedProjectData.homepage,
+
+      // Compatibility
+      type: 'module',
+      sideEffects: false,
+      license: sharedProjectData.license,
+      engines,
+
+      // Exports
+      files: ['*.js'],
+      exports: {
+        '.': './main.js',
+      },
+      main: './main.js',
+
+      // Dependencies
+      dependencies: {},
+      devDependencies: {},
+
+      // Scripts
+      scripts: sharedProjectData.scripts,
+    };
+    await writeJson(packageContent, hostGitPath('./lib/package.json'), {
+      sort: false,
+    });
+  },
+
+  /**
+   * Add MIT license files to the repository
+   */
+  async addLicenseFiles() {
+    // One at the repo root, for GitHub
+    await addLicenseFile('LICENSE');
+    // One in ./lib to be released with the module
+    await addLicenseFile('lib/LICENSE');
+  },
+
+  /**
+   * Returns shared project data, like name, author, scripts, etc
+   * @returns {object} Object of common keys
+   */
+  async getSharedProjectData() {
+    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: '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,
+      homepage,
+      license,
+      name,
+      repository,
+      scripts,
+    };
+  },
+};
+
+export default {
+  run,
+};

package/lib/layouts/module.js

@@ -0,0 +1,113 @@
+import { writeJson } from 'firost';
+import { hostGitPath } from 'aberlaas-helper';
+import { nodeVersion, yarnVersion } from 'aberlaas-versions';
+import {
+  addConfigFiles,
+  addDefaultScripts,
+  addLibFiles,
+  addLicenseFile,
+  getAberlaasVersion,
+  getProjectAuthor,
+  getProjectName,
+} from '../helper.js';
+
+export let __;
+
+/**
+ * Scaffold a repo:
+ * - With ./lib holding the code
+ */
+export async function run() {
+  await __.createPackageJson();
+
+  await addLicenseFile('LICENSE');
+  await addConfigFiles();
+  await addDefaultScripts();
+  await addLibFiles();
+}
+
+__ = {
+  /**
+   * Create the package.json
+   */
+  async createPackageJson() {
+    const aberlaasVersion = await getAberlaasVersion();
+    const name = await getProjectName();
+    const version = '0.0.1';
+
+    const author = await getProjectAuthor();
+    const description = '';
+    const keywords = [];
+    const repository = `${author}/${name}`;
+    const homepage = `https://github.com/${repository}`;
+
+    const type = 'module';
+    const sideEffects = false;
+    const license = 'MIT';
+    const engines = {
+      node: `>=${nodeVersion}`,
+    };
+    const packageManager = `yarn@${yarnVersion}`;
+
+    const files = ['lib/*.js'];
+    const exports = {
+      '.': './lib/main.js',
+    };
+    const main = './lib/main.js';
+
+    const dependencies = {};
+    const devDependencies = {
+      aberlaas: aberlaasVersion,
+    };
+
+    const scripts = {
+      ci: './scripts/ci',
+      compress: './scripts/compress',
+      lint: './scripts/lint',
+      'lint:fix': './scripts/lint-fix',
+      test: './scripts/test',
+      'test:watch': './scripts/test-watch',
+      release: './scripts/release',
+    };
+
+    const packageContent = {
+      // Name and version
+      name,
+      version,
+
+      // Metadata
+      author,
+      description,
+      keywords,
+      repository,
+      homepage,
+
+      // Compatibility
+      type,
+      sideEffects,
+      license,
+      engines,
+      packageManager,
+
+      // Exports
+      files,
+      exports,
+      main,
+
+      // Dependencies
+      dependencies,
+      devDependencies,
+
+      // Scripts
+      scripts,
+    };
+
+    await writeJson(packageContent, hostGitPath('./package.json'), {
+      sort: false,
+    });
+  },
+};
+
+export default {
+  run,
+};

package/lib/layouts/monorepo.js

@@ -0,0 +1,241 @@
+import { writeJson } from 'firost';
+import { hostGitPath } from 'aberlaas-helper';
+import {
+  nodeVersion,
+  norskaThemeDocsVersion,
+  norskaVersion,
+  yarnVersion,
+} from 'aberlaas-versions';
+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
+
+  /**
+   * Scaffold a repo:
+   * - As a monorepo
+   * - With ./modules holding all modules, including ./lib and ./docs
+   */
+  async createRootWorkspace() {
+    const aberlaasVersion = await getAberlaasVersion();
+    const sharedProjectData = await __.getSharedProjectData();
+    const engines = {
+      node: `>=${nodeVersion}`,
+    };
+
+    const packageContent = {
+      // Name and version
+      name: `${sharedProjectData.name}-monorepo`,
+
+      // Visibility
+      private: true,
+      workspaces: ['modules/*'],
+
+      // Metadata
+      author: sharedProjectData.author,
+      description: `${sharedProjectData.name} monorepo`,
+      repository: sharedProjectData.repository,
+      homepage: sharedProjectData.homepage,
+
+      // Compatibility
+      type: 'module',
+      license: sharedProjectData.license,
+      engines,
+      packageManager: `yarn@${yarnVersion}`,
+
+      // Dependencies
+      dependencies: {},
+      devDependencies: {
+        aberlaas: aberlaasVersion,
+      },
+
+      // Scripts
+      scripts: {
+        // Docs
+        build: './scripts/build',
+        'build:prod': './scripts/build-prod',
+        cms: './scripts/cms',
+        serve: './scripts/serve',
+
+        // Lib
+        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, hostGitPath('./package.json'), {
+      sort: false,
+    });
+  },
+
+  /**
+   * Create the docs workspace
+   */
+  async createDocsWorkspace() {
+    const sharedProjectData = await __.getSharedProjectData();
+
+    const packageContent = {
+      // Name & Version
+      name: `${sharedProjectData.name}-docs`,
+      version: '0.0.1',
+
+      // Visibility
+      private: true,
+
+      // Metadata
+      author: sharedProjectData.author,
+      description: `${sharedProjectData.name} docs`,
+      repository: sharedProjectData.repository,
+      homepage: sharedProjectData.homepage,
+
+      // Compatibility
+      // "type": "module", // TODO: Uncomment once norska is ESM-compliant
+      license: sharedProjectData.license,
+
+      // Dependencies
+      dependencies: {
+        norska: norskaVersion,
+        'norska-theme-docs': norskaThemeDocsVersion,
+      },
+      devDependencies: {},
+
+      // Scripts
+      scripts: sharedProjectData.scripts,
+    };
+    await writeJson(
+      packageContent,
+      hostGitPath('./modules/docs/package.json'),
+      {
+        sort: false,
+      },
+    );
+  },
+
+  /**
+   * Create the lib workspace
+   */
+  async createLibWorkspace() {
+    const sharedProjectData = await __.getSharedProjectData();
+    const engines = {
+      node: `>=${nodeVersion}`,
+    };
+
+    const packageContent = {
+      // Name and version
+      name: sharedProjectData.name,
+      version: '0.0.1',
+
+      // Visibility
+      private: false,
+
+      // Metadata
+      author: sharedProjectData.author,
+      description: '',
+      keywords: [],
+      repository: sharedProjectData.repository,
+      homepage: sharedProjectData.homepage,
+
+      // Compatibility
+      type: 'module',
+      sideEffects: false,
+      license: sharedProjectData.license,
+      engines,
+
+      // Exports
+      files: ['*.js'],
+      exports: {
+        '.': './main.js',
+      },
+      main: './main.js',
+
+      // Dependencies
+      dependencies: {},
+      devDependencies: {},
+
+      // Scripts
+      scripts: sharedProjectData.scripts,
+    };
+    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 addLicenseFile('LICENSE');
+    // One in ./lib to be released with the module
+    await addLicenseFile('modules/lib/LICENSE');
+  },
+
+  /**
+   * Returns shared project data, like name, author, scripts, etc
+   * @returns {object} Object of common keys
+   */
+  async getSharedProjectData() {
+    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: '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,
+      homepage,
+      license,
+      name,
+      repository,
+      scripts,
+    };
+  },
+};
+
+export default {
+  run,
+};

package/package.json

@@ -1,28 +1,28 @@
 {
   "name": "aberlaas-init",
+  "version": "2.22.0",
   "type": "module",
-  "sideEffects": false,
   "description": "aberlaas init command: Setup the repository with all needed config",
-  "version": "2.21.1",
-  "repository": "pixelastic/aberlaas",
+  "author": "Tim Carry <tim@pixelastic.com>",
   "homepage": "https://projects.pixelastic.com/aberlaas/",
-  "author": "Tim Carry (@pixelastic)",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pixelastic/aberlaas"
+  },
+  "sideEffects": false,
   "license": "MIT",
   "files": [
     "lib/*.js",
-    "lib/layouts/",
-    "templates/"
+    "lib/layouts/**/*",
+    "templates/**/*"
   ],
   "exports": {
     ".": "./lib/main.js"
   },
   "main": "./lib/main.js",
-  "engines": {
-    "node": ">=18.18.0"
-  },
   "dependencies": {
-    "aberlaas-helper": "2.21.1",
-    "aberlaas-versions": "2.21.1",
+    "aberlaas-helper": "2.22.0",
+    "aberlaas-versions": "2.22.0",
     "firost": "5.5.1",
     "gilmore": "1.2.0",
     "golgoth": "3.1.0"
@@ -31,13 +31,13 @@
     "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"
+    "lint:fix": "cd ../.. && ./scripts/lint-fix",
+    "release": "cd ../.. && ./scripts/release",
+    "serve": "cd ../docs && yarn run serve",
+    "test": "cd ../.. && ./scripts/test",
+    "test:meta": "cd ../.. && ./scripts/test-meta",
+    "test:watch": "cd ../.. && ./scripts/test-watch"
   }
 }