@form8ion/javascript 5.7.0 → 5.8.0

package/lib/index.es.js

@@ -1,12 +1,12 @@
 import { questionNames as questionNames$2, questions } from '@travi/language-scaffolder-prompts';
 import deepmerge from 'deepmerge';
-import { validateOptions, scaffoldChoice, installDependencies, PROD_DEPENDENCY_TYPE, DEV_DEPENDENCY_TYPE, packageManagers, dialects, projectTypes } from '@form8ion/javascript-core';
+import { validateOptions, scaffoldChoice, dialects, projectTypes, installDependencies, PROD_DEPENDENCY_TYPE, DEV_DEPENDENCY_TYPE, packageManagers } from '@form8ion/javascript-core';
 import * as joi from 'joi';
 import { Separator } from 'inquirer';
 import { prompt as prompt$1 } from '@form8ion/overridable-prompts';
 import { scaffold, lift as lift$3 } from '@form8ion/codecov';
 import { promises } from 'fs';
-import { fileExists, applyEnhancers, fileTypes } from '@form8ion/core';
+import { fileExists, writeConfigFile, fileTypes, applyEnhancers } from '@form8ion/core';
 import { info, error, warn } from '@travi/cli-messages';
 import * as commitConventionPlugin from '@form8ion/commit-convention';
 import { scaffold as scaffold$4 } from '@form8ion/commit-convention';
@@ -24,7 +24,7 @@ import { resolve } from 'path';
 import * as huskyPlugin from '@form8ion/husky';
 import { scaffold as scaffold$3 } from '@form8ion/husky';
 import { lift as lift$4, scaffold as scaffold$2 } from '@form8ion/eslint';
-import { write } from '@form8ion/config-file';
+import { write as write$1 } from '@form8ion/config-file';
 
 function ownKeys(object, enumerableOnly) {
   var keys = Object.keys(object);
@@ -284,6 +284,109 @@ var enginesEnhancer = /*#__PURE__*/Object.freeze({
   lift: lift$1
 });
 
+function write({
+  projectRoot,
+  config
+}) {
+  return writeConfigFile({
+    format: fileTypes.JSON,
+    name: 'package',
+    path: projectRoot,
+    config
+  });
+}
+
+function projectWillBeTested(scripts) {
+  return Object.keys(scripts).find(scriptName => scriptName.startsWith('test:'));
+}
+
+function projectShouldBeBuiltForVerification(scripts) {
+  return 'run-s build' === scripts['pregenerate:md'];
+}
+
+function defineScripts(scripts) {
+  return {
+    test: `npm-run-all --print-label${projectShouldBeBuiltForVerification(scripts) ? ' build' : ''} --parallel lint:*${projectWillBeTested(scripts) ? ' --parallel test:*' : ''}`
+  };
+}
+
+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.PACKAGE === packageType ? `https://npm.im/${packageName}` : `https://github.com/${vcs.owner}/${vcs.name}#readme`
+  };
+}
+
+function buildPackageDetails ({
+  packageName,
+  projectType,
+  dialect,
+  license,
+  vcs,
+  author,
+  description,
+  scripts,
+  packageProperties,
+  pathWithinParent
+}) {
+  return _objectSpread2(_objectSpread2(_objectSpread2({
+    name: packageName,
+    description,
+    license,
+    type: dialects.ESM === dialect ? 'module' : 'commonjs'
+  }, packageProperties), defineVcsHostDetails(vcs, projectType, packageName, pathWithinParent)), {}, {
+    author: `${author.name}${author.email ? ` <${author.email}>` : ''}${author.url ? ` (${author.url})` : ''}`,
+    scripts: defineScripts(scripts)
+  });
+}
+
+async function scaffoldPackage ({
+  projectRoot,
+  projectType,
+  dialect,
+  scripts,
+  packageName,
+  license,
+  vcs,
+  author,
+  description,
+  packageProperties,
+  pathWithinParent
+}) {
+  info('Configuring package.json');
+  const packageData = await buildPackageDetails({
+    packageName,
+    projectType,
+    dialect,
+    license,
+    vcs,
+    author,
+    description,
+    scripts,
+    packageProperties,
+    pathWithinParent
+  });
+  await write({
+    projectRoot,
+    config: packageData
+  });
+  return {
+    homepage: packageData.homepage
+  };
+}
+
+function liftScripts ({
+  existingScripts,
+  scripts
+}) {
+  return _objectSpread2(_objectSpread2({}, existingScripts), scripts);
+}
+
 async function liftPackage ({
   projectRoot,
   scripts,
@@ -298,11 +401,17 @@ async function liftPackage ({
     });
     const pathToPackageJson = `${projectRoot}/package.json`;
     const existingPackageJsonContents = JSON.parse(await promises.readFile(pathToPackageJson, 'utf8'));
-    await promises.writeFile(pathToPackageJson, JSON.stringify(_objectSpread2(_objectSpread2({}, existingPackageJsonContents), {}, {
-      scripts: _objectSpread2(_objectSpread2({}, existingPackageJsonContents.scripts), scripts)
-    }, tags && {
-      keywords: existingPackageJsonContents.keywords ? [...existingPackageJsonContents.keywords, ...tags] : tags
-    }), null, 2));
+    await write({
+      projectRoot,
+      config: _objectSpread2(_objectSpread2({}, existingPackageJsonContents), {}, {
+        scripts: liftScripts({
+          existingScripts: existingPackageJsonContents.scripts,
+          scripts
+        })
+      }, tags && {
+        keywords: existingPackageJsonContents.keywords ? [...existingPackageJsonContents.keywords, ...tags] : tags
+      })
+    });
   }
 
   info('Installing dependencies');
@@ -664,7 +773,7 @@ async function scaffoldBabel ({
     throw new Error('No babel preset provided. Cannot configure babel transpilation');
   }
 
-  await write({
+  await write$1({
     path: projectRoot,
     name: 'babel',
     format: fileTypes.JSON,
@@ -856,87 +965,6 @@ function buildVcsIgnoreLists (vcsIgnoreLists = {}) {
   };
 }
 
-function projectWillBeTested(scripts) {
-  return Object.keys(scripts).find(scriptName => scriptName.startsWith('test:'));
-}
-
-function projectShouldBeBuiltForVerification(scripts) {
-  return 'run-s build' === scripts['pregenerate:md'];
-}
-
-function defineScripts(scripts) {
-  return {
-    test: `npm-run-all --print-label${projectShouldBeBuiltForVerification(scripts) ? ' build' : ''} --parallel lint:*${projectWillBeTested(scripts) ? ' --parallel test:*' : ''}`
-  };
-}
-
-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.PACKAGE === packageType ? `https://npm.im/${packageName}` : `https://github.com/${vcs.owner}/${vcs.name}#readme`
-  };
-}
-
-function buildPackageDetails ({
-  packageName,
-  projectType,
-  dialect,
-  license,
-  vcs,
-  author,
-  description,
-  scripts,
-  packageProperties,
-  pathWithinParent
-}) {
-  return _objectSpread2(_objectSpread2(_objectSpread2({
-    name: packageName,
-    description,
-    license,
-    type: dialects.ESM === dialect ? 'module' : 'commonjs'
-  }, packageProperties), defineVcsHostDetails(vcs, projectType, packageName, pathWithinParent)), {}, {
-    author: `${author.name}${author.email ? ` <${author.email}>` : ''}${author.url ? ` (${author.url})` : ''}`,
-    scripts: defineScripts(scripts)
-  });
-}
-
-async function scaffoldPackage ({
-  projectRoot,
-  projectType,
-  dialect,
-  scripts,
-  packageName,
-  license,
-  vcs,
-  author,
-  description,
-  packageProperties,
-  pathWithinParent
-}) {
-  info('Configuring package.json');
-  const packageData = await buildPackageDetails({
-    packageName,
-    projectType,
-    dialect,
-    license,
-    vcs,
-    author,
-    description,
-    scripts,
-    packageProperties,
-    pathWithinParent
-  });
-  await promises.writeFile(`${projectRoot}/package.json`, JSON.stringify(packageData));
-  return {
-    homepage: packageData.homepage
-  };
-}
-
 function buildPackageName (projectName, scope) {
   const name = `${scope ? `@${scope}/` : ''}${projectName}`;
   const {
@@ -1437,22 +1465,27 @@ async function scaffoldRemark ({
   vcs,
   dialect
 }) {
-  await promises.writeFile(`${projectRoot}/.remarkrc.json`, JSON.stringify({
-    settings: {
-      listItemIndent: 1,
-      emphasis: '_',
-      strong: '_',
-      bullet: '*',
-      incrementListMarker: false
-    },
-    plugins: [config, ['remark-toc', {
-      tight: true
-    }], ...(projectTypes.PACKAGE === projectType ? [['remark-usage', {
-      heading: 'example'
-    }]] : []), ...(!vcs ? [['validate-links', {
-      repository: false
-    }]] : [])]
-  }));
+  await write$1({
+    format: fileTypes.JSON,
+    path: projectRoot,
+    name: 'remark',
+    config: {
+      settings: {
+        listItemIndent: 1,
+        emphasis: '_',
+        strong: '_',
+        bullet: '*',
+        incrementListMarker: false
+      },
+      plugins: [config, ['remark-toc', {
+        tight: true
+      }], ...(projectTypes.PACKAGE === projectType ? [['remark-usage', {
+        heading: 'example'
+      }]] : []), ...(!vcs ? [['validate-links', {
+        repository: false
+      }]] : [])]
+    }
+  });
   return deepmerge({
     devDependencies: [config, 'remark-cli', 'remark-toc'],
     scripts: {