aberlaas-init 2.22.2 → 2.23.0

package/lib/helper.js

@@ -217,7 +217,6 @@ export const __ = {
 
 // Named exports of public methods, but wrapped in dynamic method so we can
 // still mock the inner methods in tests
-//
 export const addConfigFiles = wrap(__, 'addConfigFiles');
 export const addDefaultScripts = wrap(__, 'addDefaultScripts');
 export const addDocsScripts = wrap(__, 'addDocsScripts');

package/lib/layouts/__tests__/libdocs.js

@@ -16,8 +16,8 @@ import {
 import { __ as initHelper } from '../../helper.js';
 import { __, run } from '../libdocs.js';
 
-describe('init > libdocs', () => {
-  const testDirectory = tmpDirectory('aberlaas/init/libdocs');
+describe('init/libdocs', () => {
+  const testDirectory = tmpDirectory(`aberlaas/${describeName}`);
   beforeEach(async () => {
     mockHelperPaths(testDirectory);
 
@@ -43,7 +43,10 @@ describe('init > libdocs', () => {
           name: 'my-project-root',
           author: 'my-name',
           description: 'my-project root workspace',
-          repository: 'my-name/my-project',
+          repository: {
+            type: 'git',
+            url: 'https://github.com/my-name/my-project',
+          },
           homepage: 'https://projects.pixelastic.com/my-project',
           license: 'MIT',
         },
@@ -55,7 +58,6 @@ describe('init > libdocs', () => {
           workspaces: ['docs', 'lib'],
           type: 'module',
           packageManager: `yarn@${yarnVersion}`,
-          dependencies: {},
           devDependencies: {
             aberlaas: '1.2.3',
           },
@@ -83,7 +85,10 @@ describe('init > libdocs', () => {
           version: '0.0.1',
           author: 'my-name',
           description: 'my-project docs',
-          repository: 'my-name/my-project',
+          repository: {
+            type: 'git',
+            url: 'https://github.com/my-name/my-project',
+          },
           homepage: 'https://projects.pixelastic.com/my-project',
           license: 'MIT',
         },
@@ -92,7 +97,6 @@ describe('init > libdocs', () => {
         'should have docs specific data',
         {
           private: true,
-          devDependencies: {},
           dependencies: {
             norska: norskaVersion,
             'norska-theme-docs': norskaThemeDocsVersion,
@@ -120,9 +124,12 @@ describe('init > libdocs', () => {
           name: 'my-project',
           version: '0.0.1',
           author: 'my-name',
-          description: '',
-          keywords: [],
-          repository: 'my-name/my-project',
+          description: 'my-project module',
+          keywords: ['my-project'],
+          repository: {
+            type: 'git',
+            url: 'https://github.com/my-name/my-project',
+          },
           homepage: 'https://projects.pixelastic.com/my-project',
           license: 'MIT',
         },
@@ -130,7 +137,6 @@ describe('init > libdocs', () => {
       [
         'should have lib specific data',
         {
-          private: false,
           type: 'module',
           sideEffects: false,
           engines: {
@@ -143,9 +149,6 @@ describe('init > libdocs', () => {
           // .main field for backward compatibility
           main: './main.js',
 
-          devDependencies: {},
-          dependencies: {},
-
           scripts: {
             build: 'cd .. && ./scripts/build',
             release: 'cd .. && ./scripts/release',
@@ -171,8 +174,7 @@ describe('init > libdocs', () => {
     });
   });
 
-  describe('run', () => {
-    vi.setConfig({ testTimeout: 10_000 });
+  describe.slow('run', () => {
     it('should build a libdocs structure', async () => {
       await run();
 

package/lib/layouts/__tests__/module.js

@@ -4,8 +4,8 @@ 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');
+describe('init/module', () => {
+  const testDirectory = tmpDirectory(`aberlaas/${describeName}`);
   beforeEach(async () => {
     mockHelperPaths(testDirectory);
 
@@ -30,9 +30,12 @@ describe('init > module', () => {
           name: 'my-project',
           version: '0.0.1',
           author: 'my-name',
-          description: '',
-          keywords: [],
-          repository: 'my-name/my-project',
+          description: 'my-project module',
+          keywords: ['my-project'],
+          repository: {
+            type: 'git',
+            url: 'https://github.com/my-name/my-project',
+          },
           homepage: 'https://github.com/my-name/my-project',
         },
       ],

package/lib/layouts/__tests__/monorepo.js

@@ -16,8 +16,8 @@ import {
 import { __ as initHelper } from '../../helper.js';
 import { __, run } from '../monorepo.js';
 
-describe('init > monorepo', () => {
-  const testDirectory = tmpDirectory('aberlaas/init/monorepo');
+describe('init/monorepo', () => {
+  const testDirectory = tmpDirectory(`aberlaas/${describeName}`);
   beforeEach(async () => {
     mockHelperPaths(testDirectory);
 
@@ -43,7 +43,10 @@ describe('init > monorepo', () => {
           name: 'my-project-monorepo',
           author: 'my-name',
           description: 'my-project monorepo',
-          repository: 'my-name/my-project',
+          repository: {
+            type: 'git',
+            url: 'https://github.com/my-name/my-project',
+          },
           homepage: 'https://projects.pixelastic.com/my-project',
           license: 'MIT',
         },
@@ -55,7 +58,6 @@ describe('init > monorepo', () => {
           workspaces: ['modules/*'],
           type: 'module',
           packageManager: `yarn@${yarnVersion}`,
-          dependencies: {},
           devDependencies: {
             aberlaas: '1.2.3',
           },
@@ -83,7 +85,10 @@ describe('init > monorepo', () => {
           version: '0.0.1',
           author: 'my-name',
           description: 'my-project docs',
-          repository: 'my-name/my-project',
+          repository: {
+            type: 'git',
+            url: 'https://github.com/my-name/my-project',
+          },
           homepage: 'https://projects.pixelastic.com/my-project',
           license: 'MIT',
         },
@@ -92,7 +97,6 @@ describe('init > monorepo', () => {
         'should have docs specific data',
         {
           private: true,
-          devDependencies: {},
           dependencies: {
             norska: norskaVersion,
             'norska-theme-docs': norskaThemeDocsVersion,
@@ -120,9 +124,12 @@ describe('init > monorepo', () => {
           name: 'my-project',
           version: '0.0.1',
           author: 'my-name',
-          description: '',
-          keywords: [],
-          repository: 'my-name/my-project',
+          description: 'my-project module',
+          keywords: ['my-project'],
+          repository: {
+            type: 'git',
+            url: 'https://github.com/my-name/my-project',
+          },
           homepage: 'https://projects.pixelastic.com/my-project',
           license: 'MIT',
         },
@@ -130,7 +137,6 @@ describe('init > monorepo', () => {
       [
         'should have lib specific data',
         {
-          private: false,
           type: 'module',
           sideEffects: false,
           engines: {
@@ -143,9 +149,6 @@ describe('init > monorepo', () => {
           // .main field for backward compatibility
           main: './main.js',
 
-          devDependencies: {},
-          dependencies: {},
-
           scripts: {
             build: 'cd ../.. && ./scripts/build',
             release: 'cd ../.. && ./scripts/release',

package/lib/layouts/libdocs.js

@@ -53,44 +53,40 @@ __ = {
       // Name and version
       name: `${sharedProjectData.name}-root`,
 
-      // Visibility
+      // Dev info
       private: true,
+      type: 'module',
       workspaces: ['docs', 'lib'],
 
       // Metadata
-      author: sharedProjectData.author,
       description: `${sharedProjectData.name} root workspace`,
-      repository: sharedProjectData.repository,
+      author: sharedProjectData.author,
       homepage: sharedProjectData.homepage,
+      repository: sharedProjectData.repository,
 
       // 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',
+        cms: './scripts/cms',
         compress: './scripts/compress',
         lint: './scripts/lint',
         'lint:fix': './scripts/lint-fix',
+        release: './scripts/release',
+        serve: './scripts/serve',
+        test: './scripts/test',
+        'test:watch': './scripts/test-watch',
       },
     };
     await writeJson(packageContent, hostGitPath('./package.json'), {
@@ -109,14 +105,15 @@ __ = {
       name: `${sharedProjectData.name}-docs`,
       version: '0.0.1',
 
-      // Visibility
+      // Dev info
       private: true,
+      type: 'commonjs',
 
       // Metadata
-      author: sharedProjectData.author,
       description: `${sharedProjectData.name} docs`,
-      repository: sharedProjectData.repository,
+      author: sharedProjectData.author,
       homepage: sharedProjectData.homepage,
+      repository: sharedProjectData.repository,
 
       // Compatibility
       license: sharedProjectData.license,
@@ -126,7 +123,6 @@ __ = {
         norska: norskaVersion,
         'norska-theme-docs': norskaThemeDocsVersion,
       },
-      devDependencies: {},
 
       // Scripts
       scripts: sharedProjectData.scripts,
@@ -141,6 +137,7 @@ __ = {
    */
   async createLibWorkspace() {
     const sharedProjectData = await __.getSharedProjectData();
+    const projectName = sharedProjectData.name;
     const engines = {
       node: `>=${nodeVersion}`,
     };
@@ -150,18 +147,17 @@ __ = {
       name: sharedProjectData.name,
       version: '0.0.1',
 
-      // Visibility
-      private: false,
+      // Dev info
+      type: 'module',
 
       // Metadata
+      description: `${projectName} module`,
       author: sharedProjectData.author,
-      description: '',
-      keywords: [],
-      repository: sharedProjectData.repository,
       homepage: sharedProjectData.homepage,
+      keywords: [projectName],
+      repository: sharedProjectData.repository,
 
       // Compatibility
-      type: 'module',
       sideEffects: false,
       license: sharedProjectData.license,
       engines,
@@ -173,10 +169,6 @@ __ = {
       },
       main: './main.js',
 
-      // Dependencies
-      dependencies: {},
-      devDependencies: {},
-
       // Scripts
       scripts: sharedProjectData.scripts,
     };
@@ -203,20 +195,23 @@ __ = {
     const name = await getProjectName();
     const author = await getProjectAuthor();
     const homepage = `https://projects.pixelastic.com/${name}`;
-    const repository = `${author}/${name}`;
+    const repository = {
+      type: 'git',
+      url: `https://github.com/${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',
+      cms: 'cd .. && ./scripts/cms',
       compress: 'cd .. && ./scripts/compress',
       lint: 'cd .. && ./scripts/lint',
       'lint:fix': 'cd .. && ./scripts/lint-fix',
+      release: 'cd .. && ./scripts/release',
+      serve: 'cd .. && ./scripts/serve',
+      test: 'cd .. && ./scripts/test',
+      'test:watch': 'cd .. && ./scripts/test-watch',
     };
     return {
       author,

package/lib/layouts/module.js

@@ -32,16 +32,21 @@ __ = {
    */
   async createPackageJson() {
     const aberlaasVersion = await getAberlaasVersion();
+
     const name = await getProjectName();
     const version = '0.0.1';
 
+    const type = 'module';
+
+    const description = `${name} module`;
     const author = await getProjectAuthor();
-    const description = '';
-    const keywords = [];
-    const repository = `${author}/${name}`;
-    const homepage = `https://github.com/${repository}`;
+    const homepage = `https://github.com/${author}/${name}`;
+    const keywords = [name];
+    const repository = {
+      type: 'git',
+      url: homepage,
+    };
 
-    const type = 'module';
     const sideEffects = false;
     const license = 'MIT';
     const engines = {
@@ -65,9 +70,9 @@ __ = {
       compress: './scripts/compress',
       lint: './scripts/lint',
       'lint:fix': './scripts/lint-fix',
+      release: './scripts/release',
       test: './scripts/test',
       'test:watch': './scripts/test-watch',
-      release: './scripts/release',
     };
 
     const packageContent = {
@@ -75,15 +80,17 @@ __ = {
       name,
       version,
 
+      // Dev info
+      type,
+
       // Metadata
-      author,
       description,
+      author,
+      homepage,
       keywords,
       repository,
-      homepage,
 
       // Compatibility
-      type,
       sideEffects,
       license,
       engines,

package/lib/layouts/monorepo.js

@@ -55,44 +55,39 @@ __ = {
       // Name and version
       name: `${sharedProjectData.name}-monorepo`,
 
-      // Visibility
+      // Dev info
       private: true,
+      type: 'module',
       workspaces: ['modules/*'],
 
       // Metadata
-      author: sharedProjectData.author,
       description: `${sharedProjectData.name} monorepo`,
-      repository: sharedProjectData.repository,
+      author: sharedProjectData.author,
       homepage: sharedProjectData.homepage,
+      repository: sharedProjectData.repository,
 
       // 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',
+        release: './scripts/release',
+        serve: './scripts/serve',
+        test: './scripts/test',
+        'test:watch': './scripts/test-watch',
       },
     };
     await writeJson(packageContent, hostGitPath('./package.json'), {
@@ -111,17 +106,17 @@ __ = {
       name: `${sharedProjectData.name}-docs`,
       version: '0.0.1',
 
-      // Visibility
+      // Dev info
       private: true,
+      type: 'commonjs',
 
       // Metadata
-      author: sharedProjectData.author,
       description: `${sharedProjectData.name} docs`,
-      repository: sharedProjectData.repository,
+      author: sharedProjectData.author,
       homepage: sharedProjectData.homepage,
+      repository: sharedProjectData.repository,
 
       // Compatibility
-      // "type": "module", // TODO: Uncomment once norska is ESM-compliant
       license: sharedProjectData.license,
 
       // Dependencies
@@ -129,7 +124,6 @@ __ = {
         norska: norskaVersion,
         'norska-theme-docs': norskaThemeDocsVersion,
       },
-      devDependencies: {},
 
       // Scripts
       scripts: sharedProjectData.scripts,
@@ -148,6 +142,7 @@ __ = {
    */
   async createLibWorkspace() {
     const sharedProjectData = await __.getSharedProjectData();
+    const projectName = sharedProjectData.name;
     const engines = {
       node: `>=${nodeVersion}`,
     };
@@ -157,18 +152,17 @@ __ = {
       name: sharedProjectData.name,
       version: '0.0.1',
 
-      // Visibility
-      private: false,
+      // Dev info
+      type: 'module',
 
       // Metadata
+      description: `${projectName} module`,
       author: sharedProjectData.author,
-      description: '',
-      keywords: [],
-      repository: sharedProjectData.repository,
       homepage: sharedProjectData.homepage,
+      keywords: [projectName],
+      repository: sharedProjectData.repository,
 
       // Compatibility
-      type: 'module',
       sideEffects: false,
       license: sharedProjectData.license,
       engines,
@@ -180,10 +174,6 @@ __ = {
       },
       main: './main.js',
 
-      // Dependencies
-      dependencies: {},
-      devDependencies: {},
-
       // Scripts
       scripts: sharedProjectData.scripts,
     };
@@ -210,20 +200,23 @@ __ = {
     const name = await getProjectName();
     const author = await getProjectAuthor();
     const homepage = `https://projects.pixelastic.com/${name}`;
-    const repository = `${author}/${name}`;
+    const repository = {
+      type: 'git',
+      url: `https://github.com/${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',
+      cms: 'cd ../.. && ./scripts/cms',
       compress: 'cd ../.. && ./scripts/compress',
       lint: 'cd ../.. && ./scripts/lint',
       'lint:fix': 'cd ../.. && ./scripts/lint-fix',
+      release: 'cd ../.. && ./scripts/release',
+      serve: 'cd ../.. && ./scripts/serve',
+      test: 'cd ../.. && ./scripts/test',
+      'test:watch': 'cd ../.. && ./scripts/test-watch',
     };
     return {
       author,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aberlaas-init",
-  "version": "2.22.2",
+  "version": "2.23.0",
   "type": "module",
   "description": "aberlaas init command: Setup the repository with all needed config",
   "author": "Tim Carry <tim@pixelastic.com>",
@@ -23,13 +23,13 @@
       "templates/scripts/ci",
       "templates/scripts/cms",
       "templates/scripts/compress",
+      "templates/scripts/hooks/pre-commit",
       "templates/scripts/lint",
       "templates/scripts/lint-fix",
       "templates/scripts/release",
       "templates/scripts/serve",
       "templates/scripts/test",
-      "templates/scripts/test-watch",
-      "templates/scripts/hooks/pre-commit"
+      "templates/scripts/test-watch"
     ]
   },
   "exports": {
@@ -37,9 +37,9 @@
   },
   "main": "./lib/main.js",
   "dependencies": {
-    "aberlaas-helper": "2.22.2",
-    "aberlaas-versions": "2.22.2",
-    "firost": "5.5.1",
+    "aberlaas-helper": "2.23.0",
+    "aberlaas-versions": "2.23.0",
+    "firost": "5.5.2",
     "gilmore": "1.2.0",
     "golgoth": "3.1.0"
   },

package/templates/_gitignore

@@ -1,4 +1,5 @@
 # Important files that should not be committed
+.env
 .envrc
 
 # Build directories