@form8ion/javascript 12.6.2 → 13.0.0-alpha.2

package/lib/index.mjs

@@ -1,6 +1,6 @@
 import { questionNames as questionNames$2, questions } from '@travi/language-scaffolder-prompts';
 import deepmerge from 'deepmerge';
-import { fileTypes, fileExists, validateOptions, applyEnhancers, writeConfigFile } from '@form8ion/core';
+import { fileTypes, fileExists, optionsSchemas, validateOptions, applyEnhancers, writeConfigFile } from '@form8ion/core';
 import { scaffoldChoice, projectTypes as projectTypes$1, packageManagers as packageManagers$1, mergeIntoExistingPackageJson, dialects as dialects$1, writePackageJson, DEV_DEPENDENCY_TYPE, PROD_DEPENDENCY_TYPE } from '@form8ion/javascript-core';
 import joi from 'joi';
 import { prompt as prompt$1, Separator } from '@form8ion/overridable-prompts';
@@ -127,9 +127,7 @@ var coveragePlugin = /*#__PURE__*/Object.freeze({
   test: tester$4
 });
 
-const unitTestFrameworksSchema = joi.object().required().pattern(/^/, joi.object({
-  scaffolder: joi.func().arity(1).required()
-}));
+const unitTestFrameworksSchema = joi.object().pattern(/^/, optionsSchemas.form8ionPlugin).default({});
 
 async function chooseFramework ({frameworks, decisions}) {
   if (!Object.keys(frameworks).length) return 'Other';
@@ -561,8 +559,8 @@ async function scaffoldPackageType ({
           }
         },
         ...dialects$1.ESM === dialect && {
-          main: './lib/index.mjs',
-          exports: './lib/index.mjs'
+          main: './lib/index.js',
+          exports: './lib/index.js'
         },
         ...dialects$1.TYPESCRIPT === dialect && {
           main: './lib/index.js',
@@ -584,6 +582,7 @@ async function scaffoldPackageType ({
       documentation: scaffoldPackageDocumentation({packageName, visibility, scope, packageManager, provideExample}),
       nextSteps: [
         {summary: 'Add the appropriate `save` flag to the installation instructions in the README'},
+        {summary: 'Define supported node.js versions as `engines.node` in the `package.json` file'},
         {summary: 'Publish pre-release versions to npm until package is stable enough to publish v1.0.0'}
       ]
     },
@@ -682,7 +681,7 @@ async function scaffoldCliType ({
       devDependencies: ['rimraf'],
       vcsIgnore: {files: [], directories: [`/${defaultBuildDirectory}/`]},
       buildDirectory: defaultBuildDirectory,
-      nextSteps: []
+      nextSteps: [{summary: 'Define supported node.js versions as `engines.node` in the `package.json` file'}]
     }
   ]);
 }
@@ -1120,7 +1119,7 @@ var packageManagers = /*#__PURE__*/Object.freeze({
   defineLockfilePath: determineLockfilePathFor
 });
 
-async function lift ({projectRoot, vcs, results, pathWithinParent}) {
+async function lift ({projectRoot, vcs, results, pathWithinParent, enhancers = {}}) {
   info('Lifting JavaScript-specific details');
 
   const {
@@ -1138,7 +1137,8 @@ async function lift ({projectRoot, vcs, results, pathWithinParent}) {
 
   const enhancerResults = await applyEnhancers({
     results,
-    enhancers: [
+    enhancers: {
+      ...enhancers,
       huskyPlugin,
       enginesEnhancer,
       coveragePlugin,
@@ -1148,7 +1148,7 @@ async function lift ({projectRoot, vcs, results, pathWithinParent}) {
       npmConfigPlugin,
       projectTypes,
       packageManagers
-    ],
+    },
     options: {packageManager, projectRoot, vcs, packageDetails: JSON.parse(packageContents)}
   });
 
@@ -1162,8 +1162,7 @@ async function lift ({projectRoot, vcs, results, pathWithinParent}) {
   return enhancerResults;
 }
 
-const pluginSchema = joi.object({scaffolder: joi.func().arity(1).required()});
-const pluginMapSchema = joi.object().pattern(joi.string(), pluginSchema);
+const pluginMapSchema = joi.object().pattern(joi.string(), optionsSchemas.form8ionPlugin);
 
 const packageBundlersSchema = pluginMapSchema.default({});
 
@@ -1206,16 +1205,6 @@ function validate(options) {
         remark: joi.string()
       }).default({})
     })
-    .keys({
-      overrides: joi.object({
-        npmAccount: joi.string(),
-        author: joi.object({
-          name: joi.string().required(),
-          email: joi.string().email(),
-          url: joi.string().uri()
-        })
-      }).default({})
-    })
     .keys({
       ciServices: joi.object().pattern(/^/, joi.object({
         scaffolder: joi.func().arity(1).required(),
@@ -1230,13 +1219,13 @@ function validate(options) {
       })).default({})
     })
     .keys({
-      applicationTypes: applicationTypesSchema,
-      packageTypes: packageTypesSchema,
-      monorepoTypes: monorepoTypesSchema
-    })
-    .keys({
-      unitTestFrameworks: unitTestFrameworksSchema,
-      packageBundlers: packageBundlersSchema
+      plugins: {
+        unitTestFrameworks: unitTestFrameworksSchema,
+        packageBundlers: packageBundlersSchema,
+        applicationTypes: applicationTypesSchema,
+        packageTypes: packageTypesSchema,
+        monorepoTypes: monorepoTypesSchema
+      }
     })
     .keys({
       decisions: joi.object()
@@ -1321,7 +1310,6 @@ function authorQuestions({name, email, url}) {
 }
 
 async function prompt(
-  {npmAccount, author},
   ciServices,
   hosts,
   visibility,
@@ -1398,9 +1386,9 @@ async function prompt(
       message: 'What is the scope?',
       when: scopePromptShouldBePresentedFactory(visibility),
       validate: scope(visibility),
-      default: npmAccount || maybeLoggedInNpmUsername
+      default: maybeLoggedInNpmUsername
     },
-    ...authorQuestions(author || {
+    ...authorQuestions({
       name: npmConf$1.get('init.author.name'),
       email: npmConf$1.get('init.author.email'),
       url: npmConf$1.get('init.author.url')
@@ -1671,17 +1659,18 @@ async function scaffolder (options) {
     vcs,
     description,
     configs,
-    overrides,
     ciServices,
     hosts,
-    applicationTypes,
-    packageTypes,
-    packageBundlers,
-    monorepoTypes,
     decisions,
-    unitTestFrameworks,
     pathWithinParent,
-    registries
+    registries,
+    plugins: {
+      applicationTypes,
+      packageTypes,
+      monorepoTypes,
+      packageBundlers,
+      unitTestFrameworks
+    }
   } = validate(options);
 
   const {
@@ -1696,7 +1685,7 @@ async function scaffolder (options) {
     provideExample,
     packageManager,
     dialect
-  } = await prompt(overrides, ciServices, hosts, visibility, vcs, decisions, configs, pathWithinParent);
+  } = await prompt(ciServices, hosts, visibility, vcs, decisions, configs, pathWithinParent);
 
   info('Writing project files', {level: 'secondary'});