@form8ion/javascript 12.6.2 → 13.0.0-alpha.2

package/README.md

@@ -74,9 +74,13 @@ const {
       babelPreset: {name: `@${accountName}`, packageName: `@${accountName}/babel-preset`},
       commitlint: {name: `@${accountName}`, packageName: `@${accountName}/commitlint-config`}
     },
-    overrides: {npmAccount: accountName},
+    plugins: {
+      unitTestFrameworks: {},
+      applicationTypes: {},
+      packageTypes: {},
+      packageBundlers: {}
+    },
     ciServices: {},
-    unitTestFrameworks: {},
     decisions: {
       [questionNames.DIALECT]: dialects.BABEL,
       [questionNames.NODE_VERSION_CATEGORY]: 'LTS',
@@ -103,6 +107,12 @@ const {
         scripts: {},
         eslint: {configs: [], ignore: {directories: []}},
         packageManager: 'npm'
+      },
+      enhancers: {
+        PluginName: {
+          test: () => true,
+          lift: () => ({})
+        }
       }
     });
   }
@@ -110,8 +120,8 @@ const {
   await scaffoldUnitTesting({
     projectRoot: process.cwd(),
     frameworks: {
-      Mocha: {scaffolder: options => options},
-      Jest: {scaffolder: options => options}
+      Mocha: {scaffold: options => options},
+      Jest: {scaffold: options => options}
     },
     visibility: 'Public',
     vcs: {host: 'GitHub', owner: 'foo', name: 'bar'},

package/example.js

@@ -42,9 +42,13 @@ const {
       babelPreset: {name: `@${accountName}`, packageName: `@${accountName}/babel-preset`},
       commitlint: {name: `@${accountName}`, packageName: `@${accountName}/commitlint-config`}
     },
-    overrides: {npmAccount: accountName},
+    plugins: {
+      unitTestFrameworks: {},
+      applicationTypes: {},
+      packageTypes: {},
+      packageBundlers: {}
+    },
     ciServices: {},
-    unitTestFrameworks: {},
     decisions: {
       [questionNames.DIALECT]: dialects.BABEL,
       [questionNames.NODE_VERSION_CATEGORY]: 'LTS',
@@ -71,6 +75,12 @@ const {
         scripts: {},
         eslint: {configs: [], ignore: {directories: []}},
         packageManager: 'npm'
+      },
+      enhancers: {
+        PluginName: {
+          test: () => true,
+          lift: () => ({})
+        }
       }
     });
   }
@@ -78,8 +88,8 @@ const {
   await scaffoldUnitTesting({
     projectRoot: process.cwd(),
     frameworks: {
-      Mocha: {scaffolder: options => options},
-      Jest: {scaffolder: options => options}
+      Mocha: {scaffold: options => options},
+      Jest: {scaffold: options => options}
     },
     visibility: 'Public',
     vcs: {host: 'GitHub', owner: 'foo', name: 'bar'},

package/lib/index.js

@@ -163,9 +163,7 @@ var coveragePlugin = /*#__PURE__*/Object.freeze({
   test: tester$4
 });
 
-const unitTestFrameworksSchema = joi__default["default"].object().required().pattern(/^/, joi__default["default"].object({
-  scaffolder: joi__default["default"].func().arity(1).required()
-}));
+const unitTestFrameworksSchema = joi__default["default"].object().pattern(/^/, core.optionsSchemas.form8ionPlugin).default({});
 
 async function chooseFramework ({frameworks, decisions}) {
   if (!Object.keys(frameworks).length) return 'Other';
@@ -597,8 +595,8 @@ async function scaffoldPackageType ({
           }
         },
         ...javascriptCore.dialects.ESM === dialect && {
-          main: './lib/index.mjs',
-          exports: './lib/index.mjs'
+          main: './lib/index.js',
+          exports: './lib/index.js'
         },
         ...javascriptCore.dialects.TYPESCRIPT === dialect && {
           main: './lib/index.js',
@@ -620,6 +618,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'}
       ]
     },
@@ -718,7 +717,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'}]
     }
   ]);
 }
@@ -1156,7 +1155,7 @@ var packageManagers = /*#__PURE__*/Object.freeze({
   defineLockfilePath: determineLockfilePathFor
 });
 
-async function lift ({projectRoot, vcs, results, pathWithinParent}) {
+async function lift ({projectRoot, vcs, results, pathWithinParent, enhancers = {}}) {
   cliMessages.info('Lifting JavaScript-specific details');
 
   const {
@@ -1174,17 +1173,18 @@ async function lift ({projectRoot, vcs, results, pathWithinParent}) {
 
   const enhancerResults = await core.applyEnhancers({
     results,
-    enhancers: [
-      huskyPlugin__namespace,
+    enhancers: {
+      ...enhancers,
+      huskyPlugin: huskyPlugin__namespace,
       enginesEnhancer,
       coveragePlugin,
-      commitConventionPlugin__namespace,
+      commitConventionPlugin: commitConventionPlugin__namespace,
       dialects,
       codeStylePlugin,
       npmConfigPlugin,
       projectTypes,
       packageManagers
-    ],
+    },
     options: {packageManager, projectRoot, vcs, packageDetails: JSON.parse(packageContents)}
   });
 
@@ -1198,8 +1198,7 @@ async function lift ({projectRoot, vcs, results, pathWithinParent}) {
   return enhancerResults;
 }
 
-const pluginSchema = joi__default["default"].object({scaffolder: joi__default["default"].func().arity(1).required()});
-const pluginMapSchema = joi__default["default"].object().pattern(joi__default["default"].string(), pluginSchema);
+const pluginMapSchema = joi__default["default"].object().pattern(joi__default["default"].string(), core.optionsSchemas.form8ionPlugin);
 
 const packageBundlersSchema = pluginMapSchema.default({});
 
@@ -1242,16 +1241,6 @@ function validate(options) {
         remark: joi__default["default"].string()
       }).default({})
     })
-    .keys({
-      overrides: joi__default["default"].object({
-        npmAccount: joi__default["default"].string(),
-        author: joi__default["default"].object({
-          name: joi__default["default"].string().required(),
-          email: joi__default["default"].string().email(),
-          url: joi__default["default"].string().uri()
-        })
-      }).default({})
-    })
     .keys({
       ciServices: joi__default["default"].object().pattern(/^/, joi__default["default"].object({
         scaffolder: joi__default["default"].func().arity(1).required(),
@@ -1266,13 +1255,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__default["default"].object()
@@ -1357,7 +1346,6 @@ function authorQuestions({name, email, url}) {
 }
 
 async function prompt(
-  {npmAccount, author},
   ciServices,
   hosts,
   visibility,
@@ -1434,9 +1422,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.get('init.author.name'),
       email: npmConf.get('init.author.email'),
       url: npmConf.get('init.author.url')
@@ -1707,17 +1695,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 {
@@ -1732,7 +1721,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);
 
   cliMessages.info('Writing project files', {level: 'secondary'});