@form8ion/javascript 12.1.0 → 12.2.0

package/lib/index.mjs

@@ -392,14 +392,18 @@ async function liftProvenance ({projectRoot, packageDetails}) {
 }
 
 async function liftPublishable ({projectRoot, packageDetails}) {
-  const {name: packageName, publishConfig: {access: pacakgeAccessLevel}} = packageDetails;
+  const {name: packageName, publishConfig: {access: packageAccessLevel}} = packageDetails;
+  const homepage = `https://npm.im/${packageName}`;
+
+  await mergeIntoExistingPackageJson({projectRoot, config: {homepage}});
 
   return deepmerge(
     await liftProvenance({packageDetails, projectRoot}),
     {
+      homepage,
       devDependencies: ['publint'],
       scripts: {'lint:publish': 'publint --strict'},
-      badges: defineBadges(packageName, pacakgeAccessLevel)
+      badges: defineBadges(packageName, packageAccessLevel)
     }
   );
 }
@@ -614,6 +618,10 @@ async function scaffoldApplicationType ({projectRoot}) {
   };
 }
 
+function isApplication ({packageDetails}) {
+  return !!packageDetails.private;
+}
+
 async function scaffoldMonorepoType ({projectRoot}) {
   info('Scaffolding Monorepo Details');
 
@@ -692,7 +700,6 @@ async function scaffoldProjectType ({
   visibility,
   packageBundlers,
   scope,
-  vcs,
   decisions,
   dialect,
   provideExample,
@@ -708,7 +715,6 @@ async function scaffoldProjectType ({
         visibility,
         scope,
         packageBundlers,
-        vcs,
         decisions,
         dialect,
         provideExample,
@@ -736,14 +742,28 @@ async function scaffoldProjectType ({
 }
 
 async function tester$1 ({projectRoot, packageDetails}) {
-  return await isPackage({projectRoot, packageDetails}) || isCli({projectRoot, packageDetails});
+  return await isPackage({projectRoot, packageDetails})
+    || await isCli({projectRoot, packageDetails})
+    || isApplication({projectRoot, packageDetails});
 }
 
-async function lifter$1 ({projectRoot, packageDetails}) {
+function vcsRepositoryHostedOnGithub(vcs) {
+  return vcs && 'github' === vcs.host;
+}
+
+async function lifter$1 ({projectRoot, packageDetails, vcs}) {
   if (await isPackage({projectRoot, packageDetails})) return liftPackage$1({projectRoot, packageDetails});
   if (await isCli({projectRoot, packageDetails})) return liftCli({projectRoot, packageDetails});
 
-  return {};
+  let homepage;
+
+  if (vcsRepositoryHostedOnGithub(vcs)) {
+    homepage = `https://github.com/${vcs.owner}/${vcs.name}#readme`;
+
+    await mergeIntoExistingPackageJson({projectRoot, config: {homepage}});
+  }
+
+  return {homepage};
 }
 
 var projectTypes = /*#__PURE__*/Object.freeze({
@@ -759,7 +779,7 @@ function write ({projectRoot, config}) {
 
 async function addIgnore ({projectRoot, ignore}) {
   if (ignore) {
-    const existingConfig = JSON.parse(await promises.readFile(`${projectRoot}/.babelrc.json`, 'utf-8'));
+    const existingConfig = JSON.parse(await promises$1.readFile(`${projectRoot}/.babelrc.json`, 'utf-8'));
 
     await write({projectRoot, config: {...existingConfig, ignore: [`./${ignore}/`]}});
   }
@@ -835,97 +855,44 @@ var dialects = /*#__PURE__*/Object.freeze({
   lift: lifter
 });
 
-function scaffoldScripts () {
-  return {};
-}
-
-function projectWillBeTested(scripts) {
-  return Object.keys(scripts).find(scriptName => scriptName.startsWith('test:'));
-}
-
-function projectShouldBeBuiltForVerification(scripts) {
-  return 'run-s build' === scripts['pregenerate:md'];
-}
-
-function updateTestScript (scripts) {
-  return {
-    ...scripts,
-    test: `npm-run-all --print-label${
-      projectShouldBeBuiltForVerification(scripts) ? ' build' : ''
-    } --parallel lint:*${
-      projectWillBeTested(scripts) ? ' --parallel test:*' : ''
-    }`
-  };
-}
-
-function liftScripts ({existingScripts, scripts}) {
-  return updateTestScript({...existingScripts, ...scripts});
-}
-
-function defineVcsHostDetails(vcs, packageType, packageName, pathWithinParent) {
-  return vcs && 'github' === vcs.host && {
-    repository: pathWithinParent
-      ? {
-        type: 'git',
-        url: `https://github.com/${vcs.owner}/${vcs.name}.git`,
-        directory: pathWithinParent
-      }
-      : `${vcs.owner}/${vcs.name}`,
-    bugs: `https://github.com/${vcs.owner}/${vcs.name}/issues`,
-    homepage: (projectTypes$1.PACKAGE === packageType)
-      ? `https://npm.im/${packageName}`
-      : `https://github.com/${vcs.owner}/${vcs.name}#readme`
-  };
-}
-
 function buildPackageDetails ({
   packageName,
-  projectType,
   dialect,
   license,
-  vcs,
   author,
-  description,
-  pathWithinParent
+  description
 }) {
   return {
     name: packageName,
     description,
     license,
     type: dialects$1.ESM === dialect ? 'module' : 'commonjs',
-    ...defineVcsHostDetails(vcs, projectType, packageName, pathWithinParent),
     author: `${author.name}${author.email ? ` <${author.email}>` : ''}${author.url ? ` (${author.url})` : ''}`,
-    scripts: scaffoldScripts()
+    scripts: {}
   };
 }
 
 async function scaffoldPackage ({
   projectRoot,
-  projectType,
   dialect,
   packageName,
   license,
-  vcs,
   author,
-  description,
-  pathWithinParent
+  description
 }) {
   info('Configuring package.json');
 
   const packageData = await buildPackageDetails({
     packageName,
-    projectType,
     dialect,
     license,
-    vcs,
     author,
-    description,
-    pathWithinParent
+    description
   });
 
   await writePackageJson({projectRoot, config: packageData});
 
-  return {homepage: packageData.homepage};
+  return {};
 }
 
 function sortPackageProperties (packageContents) {
@@ -964,6 +931,19 @@ function sortPackageProperties (packageContents) {
   );
 }
 
+function defineVcsHostDetails (vcs, pathWithinParent) {
+  return vcs && 'github' === vcs.host && {
+    repository: pathWithinParent
+      ? {
+        type: 'git',
+        url: `https://github.com/${vcs.owner}/${vcs.name}.git`,
+        directory: pathWithinParent
+      }
+      : `${vcs.owner}/${vcs.name}`,
+    bugs: `https://github.com/${vcs.owner}/${vcs.name}/issues`
+  };
+}
+
 const details = {
   [packageManagers.NPM]: {
     installationCommand: 'install',
@@ -1010,13 +990,38 @@ async function install$1 (dependencies, dependenciesType, projectRoot, packageMa
   } else warn(`No ${dependenciesType} dependencies to install`);
 }
 
+function projectWillBeTested(scripts) {
+  return Object.keys(scripts).find(scriptName => scriptName.startsWith('test:'));
+}
+
+function projectShouldBeBuiltForVerification(scripts) {
+  return 'run-s build' === scripts['pregenerate:md'];
+}
+
+function updateTestScript (scripts) {
+  return {
+    ...scripts,
+    test: `npm-run-all --print-label${
+      projectShouldBeBuiltForVerification(scripts) ? ' build' : ''
+    } --parallel lint:*${
+      projectWillBeTested(scripts) ? ' --parallel test:*' : ''
+    }`
+  };
+}
+
+function liftScripts ({existingScripts, scripts}) {
+  return updateTestScript({...existingScripts, ...scripts});
+}
+
 async function liftPackage ({
   projectRoot,
   scripts,
   tags,
   dependencies,
   devDependencies,
-  packageManager
+  packageManager,
+  vcs,
+  pathWithinParent
 }) {
   if (scripts || tags) {
     info('Updating `package.json`', {level: 'secondary'});
@@ -1029,7 +1034,11 @@ async function liftPackage ({
       projectRoot,
       config: sortPackageProperties({
         ...existingPackageJsonContents,
-        scripts: liftScripts({existingScripts: existingPackageJsonContents.scripts, scripts}),
+        ...defineVcsHostDetails(vcs, pathWithinParent),
+        scripts: liftScripts({
+          existingScripts: existingPackageJsonContents.scripts,
+          scripts
+        }),
         ...tags && {
           keywords: existingPackageJsonContents.keywords ? [...existingPackageJsonContents.keywords, ...tags] : tags
         }
@@ -1062,7 +1071,7 @@ async function resolvePackageManager ({projectRoot, packageManager}) {
   throw new Error('Package-manager could not be determined');
 }
 
-async function lift ({projectRoot, vcs, results}) {
+async function lift ({projectRoot, vcs, results, pathWithinParent}) {
   info('Lifting JavaScript-specific details');
 
   const {
@@ -1095,7 +1104,7 @@ async function lift ({projectRoot, vcs, results}) {
 
   await liftPackage(
     deepmerge.all([
-      {projectRoot, scripts, tags, dependencies, devDependencies, packageManager},
+      {projectRoot, scripts, tags, dependencies, devDependencies, packageManager, vcs, pathWithinParent},
       enhancerResults
     ])
   );
@@ -1647,16 +1656,13 @@ async function scaffolder (options) {
   info('Writing project files', {level: 'secondary'});
 
   const packageName = buildPackageName(projectName, scope);
-  const {homepage: projectHomepage} = await scaffoldPackage({
+  await scaffoldPackage({
     projectRoot,
-    projectType,
     dialect,
     packageName,
     license,
-    vcs,
     author,
-    description,
-    pathWithinParent
+    description
   });
   const projectTypeResults = await scaffoldProjectType({
     projectType,
@@ -1739,7 +1745,8 @@ async function scaffolder (options) {
     results: deepmerge({devDependencies: ['npm-run-all2'], packageManager}, mergedContributions),
     projectRoot,
     configs,
-    vcs
+    vcs,
+    pathWithinParent
   });
 
   return {
@@ -1748,7 +1755,7 @@ async function scaffolder (options) {
     tags: projectTypeResults.tags,
     vcsIgnore: buildVcsIgnoreLists(mergedContributions.vcsIgnore),
     verificationCommand: `${buildDocumentationCommand(packageManager)} && ${packageManager} test`,
-    projectDetails: {...projectHomepage && {homepage: projectHomepage}},
+    projectDetails: {...liftResults.homepage && {homepage: liftResults.homepage}},
     nextSteps: mergedContributions.nextSteps
   };
 }