@form8ion/javascript 11.9.0 → 11.10.1

package/lib/index.mjs

@@ -1,7 +1,7 @@
 import { questionNames as questionNames$2, questions } from '@travi/language-scaffolder-prompts';
 import deepmerge from 'deepmerge';
 import { fileTypes, fileExists, validateOptions, writeConfigFile, applyEnhancers } from '@form8ion/core';
-import { scaffoldChoice, projectTypes as projectTypes$1, packageManagers, dialects as dialects$1, mergeIntoExistingPackageJson, writePackageJson, DEV_DEPENDENCY_TYPE, PROD_DEPENDENCY_TYPE } from '@form8ion/javascript-core';
+import { scaffoldChoice, projectTypes as projectTypes$1, packageManagers, 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';
 import { scaffold, lift as lift$3 } from '@form8ion/codecov';
@@ -342,10 +342,14 @@ run \`${buildDocumentationCommand(packageManager)}\` to inject the usage example
   };
 }
 
-function defineBadges (packageName, visibility) {
+function determinePackageAccessLevelFromProjectVisibility ({projectVisibility}) {
+  return 'Public' === projectVisibility ? 'public' : 'restricted';
+}
+
+function defineBadges (packageName, accessLevel) {
   return {
     consumer: {
-      ...'Public' === visibility && {
+      ...'public' === accessLevel && {
         npm: {
           img: `https://img.shields.io/npm/v/${packageName}?logo=npm`,
           text: 'npm',
@@ -357,6 +361,55 @@ function defineBadges (packageName, visibility) {
   };
 }
 
+function enhanceSlsa ({provenance}) {
+  if (provenance) {
+    return {
+      badges: {
+        status: {
+          slsa: {
+            img: 'https://slsa.dev/images/gh-badge-level2.svg',
+            url: 'https://slsa.dev',
+            text: 'SLSA Level 2'
+          }
+        }
+      }
+    };
+  }
+
+  return {};
+}
+
+async function liftProvenance ({projectRoot, packageDetails}) {
+  const {publishConfig: {access}} = packageDetails;
+
+  if ('public' === access) {
+    await mergeIntoExistingPackageJson({projectRoot, config: {publishConfig: {provenance: true}}});
+
+    return enhanceSlsa({provenance: true});
+  }
+
+  return {};
+}
+
+async function liftPublishable ({projectRoot, packageDetails}) {
+  const {name: packageName, publishConfig: {access: pacakgeAccessLevel}} = packageDetails;
+
+  return deepmerge(
+    await liftProvenance({packageDetails, projectRoot}),
+    {
+      devDependencies: ['publint'],
+      scripts: {'lint:publish': 'publint --strict'},
+      badges: defineBadges(packageName, pacakgeAccessLevel)
+    }
+  );
+}
+
+async function scaffoldPublishable ({packageName, packageAccessLevel}) {
+  return {
+    badges: await defineBadges(packageName, packageAccessLevel)
+  };
+}
+
 async function chooseBundler ({bundlers, decisions}) {
   if (!Object.keys(bundlers).length) return 'Other';
 
@@ -467,7 +520,8 @@ async function scaffoldPackageType ({
 }) {
   info('Scaffolding Package Details');
 
-  const [detailsForBuild] = await Promise.all([
+  const packageAccessLevel = determinePackageAccessLevelFromProjectVisibility({projectVisibility: visibility});
+  const [detailsForBuild, publishableResults] = await Promise.all([
     buildDetails({
       projectRoot,
       projectName,
@@ -478,12 +532,13 @@ async function scaffoldPackageType ({
       provideExample,
       decisions
     }),
+    scaffoldPublishable({packageName, packageAccessLevel}),
     mergeIntoExistingPackageJson({
       projectRoot,
       config: {
         files: ['example.js', ...dialects$1.COMMON_JS === dialect ? ['index.js'] : ['lib/']],
         publishConfig: {
-          access: 'Public' === visibility ? 'public' : 'restricted',
+          access: packageAccessLevel,
           ...publishRegistry && {registry: publishRegistry}
         },
         sideEffects: false,
@@ -516,55 +571,18 @@ async function scaffoldPackageType ({
   ]);
 
   return deepmerge.all([
+    publishableResults,
     {
       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'}
-      ],
-      badges: defineBadges(packageName, visibility)
+      ]
     },
     detailsForBuild
   ]);
 }
 
-function enhanceSlsa ({provenance}) {
-  if (provenance) {
-    return {
-      badges: {
-        status: {
-          slsa: {
-            img: 'https://slsa.dev/images/gh-badge-level2.svg',
-            url: 'https://slsa.dev',
-            text: 'SLSA Level 2'
-          }
-        }
-      }
-    };
-  }
-
-  return {};
-}
-
-async function liftProvenance ({projectRoot, packageDetails}) {
-  const {publishConfig: {access}} = packageDetails;
-
-  if ('public' === access) {
-    await mergeIntoExistingPackageJson({projectRoot, config: {publishConfig: {provenance: true}}});
-
-    return enhanceSlsa({provenance: true});
-  }
-
-  return {};
-}
-
-async function liftPublishable ({projectRoot, packageDetails}) {
-  return deepmerge(
-    await liftProvenance({packageDetails, projectRoot}),
-    {devDependencies: ['publint'], scripts: {'lint:publish': 'publint --strict'}}
-  );
-}
-
 function liftPackage$1 ({projectRoot, packageDetails}) {
   return liftPublishable({projectRoot, packageDetails});
 }
@@ -613,22 +631,25 @@ async function scaffoldMonorepoType ({projectRoot}) {
 const defaultBuildDirectory = 'bin';
 
 async function scaffoldCliType ({packageName, visibility, projectRoot, dialect, publishRegistry}) {
-  const [rollupResults] = await Promise.all([
+  const packageAccessLevel = determinePackageAccessLevelFromProjectVisibility({projectVisibility: visibility});
+  const [rollupResults, publishableResults] = await Promise.all([
     scaffold$3({projectRoot, dialect, projectType: projectTypes$1.CLI}),
+    scaffoldPublishable({packageName, packageAccessLevel}),
     mergeIntoExistingPackageJson({
       projectRoot,
       config: {
         bin: {},
         files: [`${defaultBuildDirectory}/`],
         publishConfig: {
-          access: 'Public' === visibility ? 'public' : 'restricted',
+          access: packageAccessLevel,
           ...publishRegistry && {registry: publishRegistry}
         }
       }
     })
   ]);
 
-  return deepmerge(
+  return deepmerge.all([
+    publishableResults,
     rollupResults,
     {
       scripts: {
@@ -641,10 +662,9 @@ async function scaffoldCliType ({packageName, visibility, projectRoot, dialect,
       devDependencies: ['rimraf'],
       vcsIgnore: {files: [], directories: [`/${defaultBuildDirectory}/`]},
       buildDirectory: defaultBuildDirectory,
-      badges: defineBadges(packageName, visibility),
       nextSteps: []
     }
-  );
+  ]);
 }
 
 async function isCli ({packageDetails: {bin}}) {
@@ -699,6 +719,10 @@ async function scaffoldProjectType ({
   }
 }
 
+async function tester$1 ({projectRoot, packageDetails}) {
+  return await isPackage({projectRoot, packageDetails}) || isCli({projectRoot, packageDetails});
+}
+
 async function lifter$1 ({projectRoot, packageDetails}) {
   if (await isPackage({projectRoot, packageDetails})) return liftPackage$1({projectRoot, packageDetails});
   if (await isCli({projectRoot, packageDetails})) return liftCli({projectRoot, packageDetails});
@@ -706,15 +730,11 @@ async function lifter$1 ({projectRoot, packageDetails}) {
   return {};
 }
 
-async function tester$1 ({projectRoot, packageDetails}) {
-  return await isPackage({projectRoot, packageDetails}) || isCli({projectRoot, packageDetails});
-}
-
 var projectTypes = /*#__PURE__*/Object.freeze({
   __proto__: null,
   scaffold: scaffoldProjectType,
-  lift: lifter$1,
-  test: tester$1
+  test: tester$1,
+  lift: lifter$1
 });
 
 function write ({projectRoot, config}) {