@form8ion/javascript 11.8.0 → 11.10.0

package/lib/index.js

@@ -14,11 +14,10 @@ var cliMessages = require('@travi/cli-messages');
 var commitConventionPlugin = require('@form8ion/commit-convention');
 var execa = require('@form8ion/execa-wrapper');
 var npmConf = require('npm-conf');
-var fs = require('fs');
-var ini = require('ini');
 var os = require('os');
 var validatePackageName = require('validate-npm-package-name');
 var rollup = require('@form8ion/rollup');
+var fs = require('fs');
 var mustache = require('mustache');
 var mkdir = require('make-dir');
 var touch = require('touch');
@@ -26,6 +25,7 @@ var camelcase = require('camelcase');
 var path = require('path');
 var filedirname = require('filedirname');
 var huskyPlugin = require('@form8ion/husky');
+var ini = require('ini');
 var prettier = require('@form8ion/prettier');
 var eslint = require('@form8ion/eslint');
 var node_fs = require('node:fs');
@@ -150,7 +150,7 @@ function c8IsConfigured ({projectRoot}) {
   return core.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;
@@ -160,7 +160,7 @@ var coveragePlugin = /*#__PURE__*/Object.freeze({
   __proto__: null,
   scaffold: scaffoldCoverage,
   lift: lift$2,
-  test: tester$2
+  test: tester$4
 });
 
 const unitTestFrameworksSchema = joi__default["default"].object().required().pattern(/^/, joi__default["default"].object({
@@ -250,11 +250,71 @@ async function scaffoldCodeStyle ({
   ].filter(Boolean)));
 }
 
+function lifter$3 (options) {
+  return eslint.lift(options);
+}
+
+function tester$3 (options) {
+  return eslint.test(options);
+}
+
 var codeStylePlugin = /*#__PURE__*/Object.freeze({
   __proto__: null,
-  lift: eslint.lift,
-  test: eslint.test,
-  scaffold: scaffoldCodeStyle
+  scaffold: scaffoldCodeStyle,
+  lift: lifter$3,
+  test: tester$3
+});
+
+function projectWillNotBeConsumed(projectType) {
+  return javascriptCore.projectTypes.APPLICATION === projectType || javascriptCore.projectTypes.CLI === projectType;
+}
+
+async function scaffoldNpmConfig ({
+  projectRoot,
+  projectType,
+  registries
+}) {
+  await fs.promises.writeFile(
+    `${projectRoot}/.npmrc`,
+    ini.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 core.fileExists(`${projectRoot}/.npmrc`);
+}
+
+async function lifter$2 ({projectRoot}) {
+  const pathToConfig = `${projectRoot}/.npmrc`;
+
+  const {
+    provenance,
+    'engines-strict': enginesStrict,
+    ...remainingProperties
+  } = ini.parse(await node_fs.promises.readFile(pathToConfig, 'utf-8'));
+
+  await node_fs.promises.writeFile(pathToConfig, ini.stringify(remainingProperties));
+
+  return {};
+}
+
+var npmConfigPlugin = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  scaffold: scaffoldNpmConfig,
+  test: tester$2,
+  lift: lifter$2
 });
 
 async function test({projectRoot}) {
@@ -318,10 +378,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',
@@ -333,6 +393,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';
 
@@ -443,6 +507,7 @@ async function scaffoldPackageType ({
 }) {
   cliMessages.info('Scaffolding Package Details');
 
+  const packageAccessLevel = determinePackageAccessLevelFromProjectVisibility({projectVisibility: visibility});
   const [detailsForBuild] = await Promise.all([
     buildDetails({
       projectRoot,
@@ -459,7 +524,7 @@ async function scaffoldPackageType ({
       config: {
         files: ['example.js', ...javascriptCore.dialects.COMMON_JS === dialect ? ['index.js'] : ['lib/']],
         publishConfig: {
-          access: 'Public' === visibility ? 'public' : 'restricted',
+          access: packageAccessLevel,
           ...publishRegistry && {registry: publishRegistry}
         },
         sideEffects: false,
@@ -498,7 +563,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
   ]);
@@ -535,9 +600,15 @@ async function liftProvenance ({projectRoot, packageDetails}) {
 }
 
 async function liftPublishable ({projectRoot, packageDetails}) {
+  const {name: packageName, publishConfig: {access: pacakgeAccessLevel}} = packageDetails;
+
   return deepmerge__default["default"](
     await liftProvenance({packageDetails, projectRoot}),
-    {devDependencies: ['publint'], scripts: {'lint:publish': 'publint --strict'}}
+    {
+      devDependencies: ['publint'],
+      scripts: {'lint:publish': 'publint --strict'},
+      badges: defineBadges(packageName, pacakgeAccessLevel)
+    }
   );
 }
 
@@ -589,6 +660,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([
     rollup.scaffold({projectRoot, dialect, projectType: javascriptCore.projectTypes.CLI}),
     javascriptCore.mergeIntoExistingPackageJson({
@@ -597,7 +669,7 @@ async function scaffoldCliType ({packageName, visibility, projectRoot, dialect,
         bin: {},
         files: [`${defaultBuildDirectory}/`],
         publishConfig: {
-          access: 'Public' === visibility ? 'public' : 'restricted',
+          access: packageAccessLevel,
           ...publishRegistry && {registry: publishRegistry}
         }
       }
@@ -617,7 +689,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: []
     }
   );
@@ -1027,6 +1099,7 @@ async function lift ({projectRoot, vcs, results}) {
       commitConventionPlugin__namespace,
       dialects,
       codeStylePlugin,
+      npmConfigPlugin,
       projectTypes
     ],
     options: {packageManager, projectRoot, vcs, packageDetails: JSON.parse(packageContents)}
@@ -1322,33 +1395,6 @@ async function prompt(
   };
 }
 
-function projectWillNotBeConsumed(projectType) {
-  return javascriptCore.projectTypes.APPLICATION === projectType || javascriptCore.projectTypes.CLI === projectType;
-}
-
-async function scaffoldNpmConfig ({
-  projectRoot,
-  projectType,
-  registries
-}) {
-  await fs.promises.writeFile(
-    `${projectRoot}/.npmrc`,
-    ini.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`,