@form8ion/javascript 11.8.0 → 11.10.0

package/lib/index.mjs

@@ -11,11 +11,10 @@ import * as commitConventionPlugin from '@form8ion/commit-convention';
 import { scaffold as scaffold$5 } from '@form8ion/commit-convention';
 import execa from '@form8ion/execa-wrapper';
 import npmConf from 'npm-conf';
-import { promises } from 'fs';
-import { stringify } from 'ini';
 import { EOL } from 'os';
 import validatePackageName from 'validate-npm-package-name';
 import { scaffold as scaffold$3 } from '@form8ion/rollup';
+import { promises } from 'fs';
 import mustache from 'mustache';
 import mkdir from 'make-dir';
 import touch from 'touch';
@@ -24,6 +23,7 @@ import { resolve } from 'path';
 import filedirname from 'filedirname';
 import * as huskyPlugin from '@form8ion/husky';
 import { scaffold as scaffold$4 } from '@form8ion/husky';
+import { stringify, parse } from 'ini';
 import { scaffold as scaffold$2 } from '@form8ion/prettier';
 import { scaffold as scaffold$1, lift as lift$4, test as test$1 } from '@form8ion/eslint';
 import { promises as promises$1 } from 'node:fs';
@@ -114,7 +114,7 @@ function c8IsConfigured ({projectRoot}) {
   return fileExists(`${projectRoot}/.c8rc.json`);
 }
 
-async function tester$2 ({projectRoot}) {
+async function tester$4 ({projectRoot}) {
   const [c8Exists, nycExists] = await Promise.all([c8IsConfigured({projectRoot}), nycIsConfigured({projectRoot})]);
 
   return c8Exists || nycExists;
@@ -124,7 +124,7 @@ var coveragePlugin = /*#__PURE__*/Object.freeze({
   __proto__: null,
   scaffold: scaffoldCoverage,
   lift: lift$2,
-  test: tester$2
+  test: tester$4
 });
 
 const unitTestFrameworksSchema = joi.object().required().pattern(/^/, joi.object({
@@ -214,11 +214,71 @@ async function scaffoldCodeStyle ({
   ].filter(Boolean)));
 }
 
+function lifter$3 (options) {
+  return lift$4(options);
+}
+
+function tester$3 (options) {
+  return test$1(options);
+}
+
 var codeStylePlugin = /*#__PURE__*/Object.freeze({
   __proto__: null,
-  lift: lift$4,
-  test: test$1,
-  scaffold: scaffoldCodeStyle
+  scaffold: scaffoldCodeStyle,
+  lift: lifter$3,
+  test: tester$3
+});
+
+function projectWillNotBeConsumed(projectType) {
+  return projectTypes$1.APPLICATION === projectType || projectTypes$1.CLI === projectType;
+}
+
+async function scaffoldNpmConfig ({
+  projectRoot,
+  projectType,
+  registries
+}) {
+  await promises.writeFile(
+    `${projectRoot}/.npmrc`,
+    stringify({
+      'update-notifier': false,
+      ...projectWillNotBeConsumed(projectType) && {'save-exact': true},
+      ...Object.fromEntries(Object.entries(registries)
+        .filter(([scope]) => 'publish' !== scope)
+        .map(([scope, url]) => {
+          if ('registry' === scope) return ['registry', url];
+
+          return [`@${scope}:registry`, url];
+        }))
+    })
+  );
+
+  return {scripts: {'lint:peer': 'npm ls >/dev/null'}};
+}
+
+function tester$2 ({projectRoot}) {
+  return fileExists(`${projectRoot}/.npmrc`);
+}
+
+async function lifter$2 ({projectRoot}) {
+  const pathToConfig = `${projectRoot}/.npmrc`;
+
+  const {
+    provenance,
+    'engines-strict': enginesStrict,
+    ...remainingProperties
+  } = parse(await promises$1.readFile(pathToConfig, 'utf-8'));
+
+  await promises$1.writeFile(pathToConfig, stringify(remainingProperties));
+
+  return {};
+}
+
+var npmConfigPlugin = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  scaffold: scaffoldNpmConfig,
+  test: tester$2,
+  lift: lifter$2
 });
 
 async function test({projectRoot}) {
@@ -282,10 +342,10 @@ run \`${buildDocumentationCommand(packageManager)}\` to inject the usage example
   };
 }
 
-function defineBadges (packageName, visibility) {
+function defineBadges (packageName, accessLevel) {
   return {
     consumer: {
-      ...'Public' === visibility && {
+      ...'public' === accessLevel && {
         npm: {
           img: `https://img.shields.io/npm/v/${packageName}?logo=npm`,
           text: 'npm',
@@ -297,6 +357,10 @@ function defineBadges (packageName, visibility) {
   };
 }
 
+function determinePackageAccessLevelFromProjectVisibility ({projectVisibility}) {
+  return 'Public' === projectVisibility ? 'public' : 'restricted';
+}
+
 async function chooseBundler ({bundlers, decisions}) {
   if (!Object.keys(bundlers).length) return 'Other';
 
@@ -407,6 +471,7 @@ async function scaffoldPackageType ({
 }) {
   info('Scaffolding Package Details');
 
+  const packageAccessLevel = determinePackageAccessLevelFromProjectVisibility({projectVisibility: visibility});
   const [detailsForBuild] = await Promise.all([
     buildDetails({
       projectRoot,
@@ -423,7 +488,7 @@ async function scaffoldPackageType ({
       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,
@@ -462,7 +527,7 @@ async function scaffoldPackageType ({
         {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)
+      badges: defineBadges(packageName, packageAccessLevel)
     },
     detailsForBuild
   ]);
@@ -499,9 +564,15 @@ async function liftProvenance ({projectRoot, packageDetails}) {
 }
 
 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'}}
+    {
+      devDependencies: ['publint'],
+      scripts: {'lint:publish': 'publint --strict'},
+      badges: defineBadges(packageName, pacakgeAccessLevel)
+    }
   );
 }
 
@@ -553,6 +624,7 @@ async function scaffoldMonorepoType ({projectRoot}) {
 const defaultBuildDirectory = 'bin';
 
 async function scaffoldCliType ({packageName, visibility, projectRoot, dialect, publishRegistry}) {
+  const packageAccessLevel = determinePackageAccessLevelFromProjectVisibility({projectVisibility: visibility});
   const [rollupResults] = await Promise.all([
     scaffold$3({projectRoot, dialect, projectType: projectTypes$1.CLI}),
     mergeIntoExistingPackageJson({
@@ -561,7 +633,7 @@ async function scaffoldCliType ({packageName, visibility, projectRoot, dialect,
         bin: {},
         files: [`${defaultBuildDirectory}/`],
         publishConfig: {
-          access: 'Public' === visibility ? 'public' : 'restricted',
+          access: packageAccessLevel,
           ...publishRegistry && {registry: publishRegistry}
         }
       }
@@ -581,7 +653,7 @@ async function scaffoldCliType ({packageName, visibility, projectRoot, dialect,
       devDependencies: ['rimraf'],
       vcsIgnore: {files: [], directories: [`/${defaultBuildDirectory}/`]},
       buildDirectory: defaultBuildDirectory,
-      badges: defineBadges(packageName, visibility),
+      badges: defineBadges(packageName, packageAccessLevel),
       nextSteps: []
     }
   );
@@ -991,6 +1063,7 @@ async function lift ({projectRoot, vcs, results}) {
       commitConventionPlugin,
       dialects,
       codeStylePlugin,
+      npmConfigPlugin,
       projectTypes
     ],
     options: {packageManager, projectRoot, vcs, packageDetails: JSON.parse(packageContents)}
@@ -1286,33 +1359,6 @@ async function prompt(
   };
 }
 
-function projectWillNotBeConsumed(projectType) {
-  return projectTypes$1.APPLICATION === projectType || projectTypes$1.CLI === projectType;
-}
-
-async function scaffoldNpmConfig ({
-  projectRoot,
-  projectType,
-  registries
-}) {
-  await promises.writeFile(
-    `${projectRoot}/.npmrc`,
-    stringify({
-      'update-notifier': false,
-      ...projectWillNotBeConsumed(projectType) && {'save-exact': true},
-      ...Object.fromEntries(Object.entries(registries)
-        .filter(([scope]) => 'publish' !== scope)
-        .map(([scope, url]) => {
-          if ('registry' === scope) return ['registry', url];
-
-          return [`@${scope}:registry`, url];
-        }))
-    })
-  );
-
-  return {scripts: {'lint:peer': 'npm ls >/dev/null'}};
-}
-
 function scaffoldDocumentation ({projectTypeResults, packageManager}) {
   return {
     toc: `Run \`${buildDocumentationCommand(packageManager)}\` to generate a table of contents`,