@form8ion/javascript 8.4.0 → 8.5.0

package/README.md

@@ -86,7 +86,8 @@ const {
       [questionNames.AUTHOR_EMAIL]: 'you@domain.tld',
       [questionNames.AUTHOR_URL]: 'https://your.website.tld',
       [questionNames.UNIT_TESTS]: true,
-      [questionNames.INTEGRATION_TESTS]: true
+      [questionNames.INTEGRATION_TESTS]: true,
+      [questionNames.PROVIDE_EXAMPLE]: true
     }
   });
 

package/example.js

@@ -56,7 +56,8 @@ const {
       [questionNames.AUTHOR_EMAIL]: 'you@domain.tld',
       [questionNames.AUTHOR_URL]: 'https://your.website.tld',
       [questionNames.UNIT_TESTS]: true,
-      [questionNames.INTEGRATION_TESTS]: true
+      [questionNames.INTEGRATION_TESTS]: true,
+      [questionNames.PROVIDE_EXAMPLE]: true
     }
   });
 

package/lib/index.js

@@ -80,6 +80,7 @@ const questionNames$1 = {
   AUTHOR_URL: 'authorUrl',
   HOST: 'host',
   CONFIGURE_LINTING: 'configureLint',
+  PROVIDE_EXAMPLE: 'provideExample',
   DIALECT: 'dialect'
 };
 
@@ -195,7 +196,7 @@ async function scaffoldUnitTesting ({projectRoot, frameworks, decisions, visibil
   ]);
 }
 
-async function scaffoldRemark ({config, projectRoot, projectType, vcs, dialect}) {
+async function scaffoldRemark ({config, projectRoot, projectType, vcs}) {
   await configFile.write({
     format: core.fileTypes.JSON,
     path: projectRoot,
@@ -225,19 +226,13 @@ async function scaffoldRemark ({config, projectRoot, projectType, vcs, dialect})
         'generate:md': 'remark . --output'
       }
     },
-    {
-      ...javascriptCore.projectTypes.PACKAGE === projectType && {
-        devDependencies: ['remark-usage'],
-        ...javascriptCore.dialects.COMMON_JS !== dialect && {scripts: {'pregenerate:md': 'run-s build'}}
-      }
-    }
+    {...javascriptCore.projectTypes.PACKAGE === projectType && {devDependencies: ['remark-usage']}}
   );
 }
 
 async function scaffoldCodeStyle ({
   projectRoot,
   projectType,
-  dialect,
   configs,
   vcs,
   configureLinting
@@ -249,7 +244,6 @@ async function scaffoldCodeStyle ({
     scaffoldRemark({
       projectRoot,
       projectType,
-      dialect,
       vcs,
       config: configs.remark || '@form8ion/remark-lint-preset'
     }),
@@ -715,14 +709,14 @@ function buildDialectChoices ({babelPreset, typescript}) {
   ];
 }
 
-function projectIsPackage(answers) {
-  return javascriptCore.projectTypes.PACKAGE === answers[questionNames$1.PROJECT_TYPE];
-}
-
 function projectIsCLI(answers) {
   return javascriptCore.projectTypes.CLI === answers[questionNames$1.PROJECT_TYPE];
 }
 
+function projectIsPackage(answers) {
+  return javascriptCore.projectTypes.PACKAGE === answers[questionNames$1.PROJECT_TYPE];
+}
+
 function projectIsApplication(answers) {
   return javascriptCore.projectTypes.APPLICATION === answers[questionNames$1.PROJECT_TYPE];
 }
@@ -814,6 +808,7 @@ async function prompt(
     [questionNames$1.AUTHOR_EMAIL]: authorEmail,
     [questionNames$1.AUTHOR_URL]: authorUrl,
     [questionNames$1.CONFIGURE_LINTING]: configureLinting,
+    [questionNames$1.PROVIDE_EXAMPLE]: provideExample,
     [questionNames$1.PACKAGE_MANAGER]: packageManager,
     [questionNames$1.DIALECT]: dialect
   } = await overridablePrompts.prompt([
@@ -871,6 +866,12 @@ async function prompt(
       type: 'confirm',
       when: lintingPromptShouldBePresented
     },
+    {
+      name: questionNames$1.PROVIDE_EXAMPLE,
+      message: 'Should an example be provided in the README?',
+      type: 'confirm',
+      when: projectIsPackage
+    },
     {
       name: questionNames$1.HOST,
       type: 'list',
@@ -889,6 +890,7 @@ async function prompt(
     nodeVersionCategory,
     author: {name: authorName, email: authorEmail, url: authorUrl},
     configureLinting: false !== configureLinting,
+    provideExample,
     packageManager,
     dialect
   };
@@ -1019,7 +1021,7 @@ function getInstallationCommand(packageManager) {
   );
 }
 
-function scaffoldPackageDocumentation ({scope, packageName, packageManager, visibility}) {
+function scaffoldPackageDocumentation ({scope, packageName, packageManager, visibility, provideExample}) {
   return {
     usage: `### Installation
 ${'Private' === visibility ? `
@@ -1029,11 +1031,14 @@ access to private packages under \`@${scope}\`
 }
 \`\`\`sh
 $ ${getInstallationCommand(packageManager)} ${packageName}
-\`\`\`
+\`\`\`${provideExample
+    ? `
 
 ### Example
 
 run \`${buildDocumentationCommand(packageManager)}\` to inject the usage example`
+    : ''
+}`
   };
 }
 
@@ -1083,10 +1088,12 @@ async function createExample(projectRoot, projectName) {
   );
 }
 
-async function buildDetailsForCommonJsProject({projectRoot, projectName}) {
+async function buildDetailsForCommonJsProject({projectRoot, projectName, provideExample}) {
   await Promise.all([
     touch__default["default"](`${projectRoot}/index.js`),
-    fs.promises.writeFile(`${projectRoot}/example.js`, `const ${camelcase__default["default"](projectName)} = require('.');\n`)
+    provideExample
+      ? fs.promises.writeFile(`${projectRoot}/example.js`, `const ${camelcase__default["default"](projectName)} = require('.');\n`)
+      : Promise.resolve()
   ]);
 
   return {};
@@ -1099,16 +1106,17 @@ async function buildDetails ({
   packageName,
   packageBundlers,
   dialect,
+  provideExample,
   decisions
 }) {
-  if (javascriptCore.dialects.COMMON_JS === dialect) return buildDetailsForCommonJsProject({projectRoot, projectName});
+  if (javascriptCore.dialects.COMMON_JS === dialect) return buildDetailsForCommonJsProject({projectRoot, projectName, provideExample});
 
   const chosenBundler = await chooseBundler({bundlers: packageBundlers, decisions});
 
   const pathToCreatedSrcDirectory = await makeDir__default["default"](`${projectRoot}/src`);
   const [bundlerResults] = await Promise.all([
     javascriptCore.scaffoldChoice(packageBundlers, chosenBundler, {projectRoot, dialect, projectType: javascriptCore.projectTypes.PACKAGE}),
-    await createExample(projectRoot, projectName),
+    provideExample ? await createExample(projectRoot, projectName) : Promise.resolve,
     touch__default["default"](`${pathToCreatedSrcDirectory}/index.js`)
   ]);
 
@@ -1120,7 +1128,8 @@ async function buildDetails ({
         clean: `rimraf ./${defaultBuildDirectory$2}`,
         prebuild: 'run-s clean',
         build: 'npm-run-all --print-label --parallel build:*',
-        prepack: 'run-s build'
+        prepack: 'run-s build',
+        ...provideExample && {'pregenerate:md': 'run-s build'}
       },
       vcsIgnore: {directories: [`/${defaultBuildDirectory$2}/`]},
       buildDirectory: defaultBuildDirectory$2,
@@ -1149,12 +1158,22 @@ async function scaffoldPackageType ({
   packageBundlers,
   decisions,
   dialect,
+  provideExample,
   publishRegistry
 }) {
   cliMessages.info('Scaffolding Package Details');
 
   const [detailsForBuild] = await Promise.all([
-    buildDetails({projectRoot, projectName, packageBundlers, visibility, packageName, dialect, decisions}),
+    buildDetails({
+      projectRoot,
+      projectName,
+      packageBundlers,
+      visibility,
+      packageName,
+      dialect,
+      provideExample,
+      decisions
+    }),
     javascriptCore.mergeIntoExistingPackageJson({
       projectRoot,
       config: {
@@ -1193,7 +1212,7 @@ async function scaffoldPackageType ({
 
   return deepmerge__default["default"].all([
     {
-      documentation: scaffoldPackageDocumentation({packageName, visibility, scope, packageManager}),
+      documentation: scaffoldPackageDocumentation({packageName, visibility, scope, packageManager, provideExample}),
       nextSteps: [
         {summary: 'Add the appropriate `save` flag to the installation instructions in the README'},
         {summary: 'Publish pre-release versions to npm until package is stable enough to publish v1.0.0'}
@@ -1291,6 +1310,7 @@ async function scaffoldProjectType ({
   vcs,
   decisions,
   dialect,
+  provideExample,
   publishRegistry
 }) {
   switch (projectType) {
@@ -1306,6 +1326,7 @@ async function scaffoldProjectType ({
         vcs,
         decisions,
         dialect,
+        provideExample,
         publishRegistry
       });
     case javascriptCore.projectTypes.APPLICATION:
@@ -1508,6 +1529,7 @@ async function scaffolder (options) {
     nodeVersionCategory,
     author,
     configureLinting,
+    provideExample,
     packageManager,
     dialect
   } = await prompt(overrides, ciServices, hosts, visibility, vcs, decisions, configs, pathWithinParent);
@@ -1542,6 +1564,7 @@ async function scaffolder (options) {
     vcs,
     decisions,
     dialect,
+    provideExample,
     publishRegistry: registries.publish
   });
   const verificationResults = await scaffoldVerification({
@@ -1566,7 +1589,7 @@ async function scaffolder (options) {
       projectType,
       testFilenamePattern: verificationResults.testFilenamePattern
     }),
-    scaffoldCodeStyle({projectRoot, projectType, dialect, configs, vcs, configureLinting})
+    scaffoldCodeStyle({projectRoot, projectType, configs, vcs, configureLinting})
   ]);
   const projectTypePluginResults = await scaffoldProjectTypePlugin({
     projectRoot,