@form8ion/javascript 11.0.0 → 11.2.0

package/lib/index.js

@@ -29,6 +29,7 @@ var filedirname = require('filedirname');
 var huskyPlugin = require('@form8ion/husky');
 var prettier = require('@form8ion/prettier');
 var eslint = require('@form8ion/eslint');
+var node_fs = require('node:fs');
 var sortObjectKeys = require('sort-object-keys');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
@@ -151,7 +152,7 @@ function c8IsConfigured ({projectRoot}) {
   return core.fileExists(`${projectRoot}/.c8rc.json`);
 }
 
-async function tester ({projectRoot}) {
+async function tester$2 ({projectRoot}) {
   const [c8Exists, nycExists] = await Promise.all([c8IsConfigured({projectRoot}), nycIsConfigured({projectRoot})]);
 
   return c8Exists || nycExists;
@@ -161,7 +162,7 @@ var coveragePlugin = /*#__PURE__*/Object.freeze({
   __proto__: null,
   scaffold: scaffoldCoverage,
   lift: lift$2,
-  test: tester
+  test: tester$2
 });
 
 const unitTestFrameworksSchema = joi__default["default"].object().required().pattern(/^/, joi__default["default"].object({
@@ -258,7 +259,7 @@ var codeStylePlugin = /*#__PURE__*/Object.freeze({
   scaffold: scaffoldCodeStyle
 });
 
-async function test$1({projectRoot}) {
+async function test({projectRoot}) {
   const {engines} = JSON.parse(await fs.promises.readFile(`${projectRoot}/package.json`, 'utf8'));
 
   return !!engines?.node;
@@ -276,10 +277,257 @@ async function lift$1({projectRoot}) {
 
 var enginesEnhancer = /*#__PURE__*/Object.freeze({
   __proto__: null,
-  test: test$1,
+  test: test,
   lift: lift$1
 });
 
+function buildDocumentationCommand (packageManager) {
+  if (javascriptCore.packageManagers.NPM === packageManager) return 'npm run generate:md';
+  if (javascriptCore.packageManagers.YARN === packageManager) return 'yarn generate:md';
+
+  throw new Error(
+    `The ${packageManager} package manager is currently not supported. `
+    + `Only ${Object.values(javascriptCore.packageManagers).join(' and ')} are currently supported.`
+  );
+}
+
+function getInstallationCommand(packageManager) {
+  if (javascriptCore.packageManagers.NPM === packageManager) return 'npm install';
+  if (javascriptCore.packageManagers.YARN === packageManager) return 'yarn add';
+
+  throw new Error(
+    `The ${packageManager} package manager is currently not supported. `
+    + `Only ${Object.values(javascriptCore.packageManagers).join(' and ')} are currently supported.`
+  );
+}
+
+function scaffoldPackageDocumentation ({scope, packageName, packageManager, visibility, provideExample}) {
+  return {
+    usage: `### Installation
+${'Private' === visibility ? `
+:warning: this is a private package, so you will need to use an npm token with
+access to private packages under \`@${scope}\`
+` : ''
+}
+\`\`\`sh
+$ ${getInstallationCommand(packageManager)} ${packageName}
+\`\`\`${provideExample
+    ? `
+
+### Example
+
+run \`${buildDocumentationCommand(packageManager)}\` to inject the usage example`
+    : ''
+}`
+  };
+}
+
+function defineBadges (packageName, visibility) {
+  return {
+    consumer: {
+      ...'Public' === visibility && {
+        npm: {
+          img: `https://img.shields.io/npm/v/${packageName}?logo=npm`,
+          text: 'npm',
+          link: `https://www.npmjs.com/package/${packageName}`
+        }
+      }
+    },
+    status: {}
+  };
+}
+
+async function chooseBundler ({bundlers, decisions}) {
+  if (!Object.keys(bundlers).length) return 'Other';
+
+  const answers = await overridablePrompts.prompt([{
+    name: questionNames$1.PACKAGE_BUNDLER,
+    type: 'list',
+    message: 'Which bundler should be used?',
+    choices: [...Object.keys(bundlers), new overridablePrompts.Separator(), 'Other']
+  }], decisions);
+
+  return answers[questionNames$1.PACKAGE_BUNDLER];
+}
+
+function determinePathToTemplateFile (fileName) {
+  const [, __dirname] = filedirname__default["default"]();
+
+  return path.resolve(__dirname, '..', 'templates', fileName);
+}
+
+const defaultBuildDirectory$2 = 'lib';
+
+async function createExample(projectRoot, projectName) {
+  return fs.promises.writeFile(
+    `${projectRoot}/example.js`,
+    mustache__default["default"].render(
+      await fs.promises.readFile(determinePathToTemplateFile('example.mustache'), 'utf8'),
+      {projectName: camelcase__default["default"](projectName)}
+    )
+  );
+}
+
+async function buildDetailsForCommonJsProject({projectRoot, projectName, provideExample}) {
+  await Promise.all([
+    touch__default["default"](`${projectRoot}/index.js`),
+    provideExample
+      ? fs.promises.writeFile(`${projectRoot}/example.js`, `const ${camelcase__default["default"](projectName)} = require('.');\n`)
+      : Promise.resolve()
+  ]);
+
+  return {};
+}
+
+async function buildDetails ({
+  projectRoot,
+  projectName,
+  visibility,
+  packageName,
+  packageBundlers,
+  dialect,
+  provideExample,
+  decisions
+}) {
+  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}),
+    provideExample ? await createExample(projectRoot, projectName) : Promise.resolve,
+    touch__default["default"](`${pathToCreatedSrcDirectory}/index.js`)
+  ]);
+
+  return deepmerge__default["default"](
+    bundlerResults,
+    {
+      devDependencies: ['rimraf'],
+      scripts: {
+        clean: `rimraf ./${defaultBuildDirectory$2}`,
+        prebuild: 'run-s clean',
+        build: 'npm-run-all --print-label --parallel build:*',
+        prepack: 'run-s build',
+        ...provideExample && {'pregenerate:md': 'run-s build'}
+      },
+      vcsIgnore: {directories: [`/${defaultBuildDirectory$2}/`]},
+      buildDirectory: defaultBuildDirectory$2,
+      badges: {
+        consumer: {
+          ...'Public' === visibility && {
+            runkit: {
+              img: `https://badge.runkitcdn.com/${packageName}.svg`,
+              text: `Try ${packageName} on RunKit`,
+              link: `https://npm.runkit.com/${packageName}`
+            }
+          }
+        }
+      }
+    }
+  );
+}
+
+async function scaffoldPackageType ({
+  projectRoot,
+  projectName,
+  packageName,
+  packageManager,
+  visibility,
+  scope,
+  packageBundlers,
+  decisions,
+  dialect,
+  provideExample,
+  publishRegistry
+}) {
+  cliMessages.info('Scaffolding Package Details');
+
+  const [detailsForBuild] = await Promise.all([
+    buildDetails({
+      projectRoot,
+      projectName,
+      packageBundlers,
+      visibility,
+      packageName,
+      dialect,
+      provideExample,
+      decisions
+    }),
+    javascriptCore.mergeIntoExistingPackageJson({
+      projectRoot,
+      config: {
+        files: ['example.js', ...javascriptCore.dialects.COMMON_JS === dialect ? ['index.js'] : ['lib/']],
+        publishConfig: {
+          access: 'Public' === visibility ? 'public' : 'restricted',
+          provenance: true,
+          ...publishRegistry && {registry: publishRegistry}
+        },
+        sideEffects: false,
+        ...'Public' === visibility && {runkitExampleFilename: './example.js'},
+        ...javascriptCore.dialects.BABEL === dialect && {
+          main: './lib/index.js',
+          module: './lib/index.mjs',
+          exports: {
+            require: './lib/index.js',
+            import: './lib/index.mjs'
+          }
+        },
+        ...javascriptCore.dialects.ESM === dialect && {
+          main: './lib/index.mjs',
+          exports: './lib/index.mjs'
+        },
+        ...javascriptCore.dialects.TYPESCRIPT === dialect && {
+          main: './lib/index.js',
+          module: './lib/index.mjs',
+          types: './lib/index.d.ts',
+          exports: {
+            types: './lib/index.d.ts',
+            require: './lib/index.js',
+            import: './lib/index.mjs'
+          }
+        }
+      }
+    })
+  ]);
+
+  return deepmerge__default["default"].all([
+    {
+      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'}
+      ],
+      scripts: {'lint:publish': 'publint'},
+      badges: defineBadges(packageName, visibility),
+      devDependencies: ['publint']
+    },
+    detailsForBuild
+  ]);
+}
+
+async function lifter$1 ({projectRoot}) {
+  await javascriptCore.mergeIntoExistingPackageJson({projectRoot, config: {publishConfig: {provenance: true}}});
+
+  return {
+    devDependencies: ['publint'],
+    scripts: {'lint:publish': 'publint'}
+  };
+}
+
+async function tester$1 ({projectRoot}) {
+  const {exports, publishConfig} = JSON.parse(await node_fs.promises.readFile(`${projectRoot}/package.json`, 'utf-8'));
+
+  return !!exports || !!publishConfig;
+}
+
+var projectTypes = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  scaffold: scaffoldPackageType,
+  lift: lifter$1,
+  test: tester$1
+});
+
 function write ({projectRoot, config}) {
   return configFile.write({path: projectRoot, name: 'babel', format: core.fileTypes.JSON, config});
 }
@@ -603,7 +851,15 @@ async function lift ({projectRoot, vcs, results}) {
 
   const enhancerResults = await core.applyEnhancers({
     results,
-    enhancers: [huskyPlugin__namespace, enginesEnhancer, coveragePlugin, commitConventionPlugin__namespace, dialects, codeStylePlugin],
+    enhancers: [
+      huskyPlugin__namespace,
+      enginesEnhancer,
+      coveragePlugin,
+      commitConventionPlugin__namespace,
+      dialects,
+      codeStylePlugin,
+      projectTypes
+    ],
     options: {packageManager, projectRoot, vcs}
   });
 
@@ -926,16 +1182,6 @@ async function scaffoldNpmConfig ({
   return {scripts: {'lint:peer': 'npm ls >/dev/null'}};
 }
 
-function buildDocumentationCommand (packageManager) {
-  if (javascriptCore.packageManagers.NPM === packageManager) return 'npm run generate:md';
-  if (javascriptCore.packageManagers.YARN === packageManager) return 'yarn generate:md';
-
-  throw new Error(
-    `The ${packageManager} package manager is currently not supported. `
-    + `Only ${Object.values(javascriptCore.packageManagers).join(' and ')} are currently supported.`
-  );
-}
-
 function scaffoldDocumentation ({projectTypeResults, packageManager}) {
   return {
     toc: `Run \`${buildDocumentationCommand(packageManager)}\` to generate a table of contents`,
@@ -1014,221 +1260,6 @@ function buildPackageName (projectName, scope) {
   throw new Error(`The package name ${name} is invalid:${os.EOL}\t* ${errors.join(`${os.EOL}\t* `)}`);
 }
 
-function getInstallationCommand(packageManager) {
-  if (javascriptCore.packageManagers.NPM === packageManager) return 'npm install';
-  if (javascriptCore.packageManagers.YARN === packageManager) return 'yarn add';
-
-  throw new Error(
-    `The ${packageManager} package manager is currently not supported. `
-    + `Only ${Object.values(javascriptCore.packageManagers).join(' and ')} are currently supported.`
-  );
-}
-
-function scaffoldPackageDocumentation ({scope, packageName, packageManager, visibility, provideExample}) {
-  return {
-    usage: `### Installation
-${'Private' === visibility ? `
-:warning: this is a private package, so you will need to use an npm token with
-access to private packages under \`@${scope}\`
-` : ''
-}
-\`\`\`sh
-$ ${getInstallationCommand(packageManager)} ${packageName}
-\`\`\`${provideExample
-    ? `
-
-### Example
-
-run \`${buildDocumentationCommand(packageManager)}\` to inject the usage example`
-    : ''
-}`
-  };
-}
-
-function defineBadges (packageName, visibility) {
-  return {
-    consumer: {
-      ...'Public' === visibility && {
-        npm: {
-          img: `https://img.shields.io/npm/v/${packageName}?logo=npm`,
-          text: 'npm',
-          link: `https://www.npmjs.com/package/${packageName}`
-        }
-      }
-    },
-    status: {}
-  };
-}
-
-async function chooseBundler ({bundlers, decisions}) {
-  if (!Object.keys(bundlers).length) return 'Other';
-
-  const answers = await overridablePrompts.prompt([{
-    name: questionNames$1.PACKAGE_BUNDLER,
-    type: 'list',
-    message: 'Which bundler should be used?',
-    choices: [...Object.keys(bundlers), new overridablePrompts.Separator(), 'Other']
-  }], decisions);
-
-  return answers[questionNames$1.PACKAGE_BUNDLER];
-}
-
-function determinePathToTemplateFile (fileName) {
-  const [, __dirname] = filedirname__default["default"]();
-
-  return path.resolve(__dirname, '..', 'templates', fileName);
-}
-
-const defaultBuildDirectory$2 = 'lib';
-
-async function createExample(projectRoot, projectName) {
-  return fs.promises.writeFile(
-    `${projectRoot}/example.js`,
-    mustache__default["default"].render(
-      await fs.promises.readFile(determinePathToTemplateFile('example.mustache'), 'utf8'),
-      {projectName: camelcase__default["default"](projectName)}
-    )
-  );
-}
-
-async function buildDetailsForCommonJsProject({projectRoot, projectName, provideExample}) {
-  await Promise.all([
-    touch__default["default"](`${projectRoot}/index.js`),
-    provideExample
-      ? fs.promises.writeFile(`${projectRoot}/example.js`, `const ${camelcase__default["default"](projectName)} = require('.');\n`)
-      : Promise.resolve()
-  ]);
-
-  return {};
-}
-
-async function buildDetails ({
-  projectRoot,
-  projectName,
-  visibility,
-  packageName,
-  packageBundlers,
-  dialect,
-  provideExample,
-  decisions
-}) {
-  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}),
-    provideExample ? await createExample(projectRoot, projectName) : Promise.resolve,
-    touch__default["default"](`${pathToCreatedSrcDirectory}/index.js`)
-  ]);
-
-  return deepmerge__default["default"](
-    bundlerResults,
-    {
-      devDependencies: ['rimraf'],
-      scripts: {
-        clean: `rimraf ./${defaultBuildDirectory$2}`,
-        prebuild: 'run-s clean',
-        build: 'npm-run-all --print-label --parallel build:*',
-        prepack: 'run-s build',
-        ...provideExample && {'pregenerate:md': 'run-s build'}
-      },
-      vcsIgnore: {directories: [`/${defaultBuildDirectory$2}/`]},
-      buildDirectory: defaultBuildDirectory$2,
-      badges: {
-        consumer: {
-          ...'Public' === visibility && {
-            runkit: {
-              img: `https://badge.runkitcdn.com/${packageName}.svg`,
-              text: `Try ${packageName} on RunKit`,
-              link: `https://npm.runkit.com/${packageName}`
-            }
-          }
-        }
-      }
-    }
-  );
-}
-
-async function scaffoldPackageType ({
-  projectRoot,
-  projectName,
-  packageName,
-  packageManager,
-  visibility,
-  scope,
-  packageBundlers,
-  decisions,
-  dialect,
-  provideExample,
-  publishRegistry
-}) {
-  cliMessages.info('Scaffolding Package Details');
-
-  const [detailsForBuild] = await Promise.all([
-    buildDetails({
-      projectRoot,
-      projectName,
-      packageBundlers,
-      visibility,
-      packageName,
-      dialect,
-      provideExample,
-      decisions
-    }),
-    javascriptCore.mergeIntoExistingPackageJson({
-      projectRoot,
-      config: {
-        files: ['example.js', ...javascriptCore.dialects.COMMON_JS === dialect ? ['index.js'] : ['lib/']],
-        publishConfig: {
-          access: 'Public' === visibility ? 'public' : 'restricted',
-          provenance: true,
-          ...publishRegistry && {registry: publishRegistry}
-        },
-        sideEffects: false,
-        ...'Public' === visibility && {runkitExampleFilename: './example.js'},
-        ...javascriptCore.dialects.BABEL === dialect && {
-          main: './lib/index.js',
-          module: './lib/index.mjs',
-          exports: {
-            require: './lib/index.js',
-            import: './lib/index.mjs'
-          }
-        },
-        ...javascriptCore.dialects.ESM === dialect && {
-          main: './lib/index.mjs',
-          exports: './lib/index.mjs'
-        },
-        ...javascriptCore.dialects.TYPESCRIPT === dialect && {
-          main: './lib/index.js',
-          module: './lib/index.mjs',
-          types: './lib/index.d.ts',
-          exports: {
-            types: './lib/index.d.ts',
-            require: './lib/index.js',
-            import: './lib/index.mjs'
-          }
-        }
-      }
-    })
-  ]);
-
-  return deepmerge__default["default"].all([
-    {
-      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'}
-      ],
-      scripts: {'lint:publish': 'publint'},
-      badges: defineBadges(packageName, visibility),
-      devDependencies: ['publint']
-    },
-    detailsForBuild
-  ]);
-}
-
 const defaultBuildDirectory$1 = 'public';
 
 async function scaffoldApplicationType ({projectRoot}) {
@@ -1649,7 +1680,7 @@ async function scaffolder (options) {
   };
 }
 
-async function test ({projectRoot}) {
+async function tester ({projectRoot}) {
   const [nvmIsConfigured, packageLockExists, yarnLockExists] = await Promise.all([
     core.fileExists(`${projectRoot}/.nvmrc`),
     core.fileExists(`${projectRoot}/package-lock.json`),
@@ -1665,5 +1696,5 @@ exports.lift = lift;
 exports.questionNames = questionNames;
 exports.scaffold = scaffolder;
 exports.scaffoldUnitTesting = scaffoldUnitTesting;
-exports.test = test;
+exports.test = tester;
 //# sourceMappingURL=index.js.map