@form8ion/javascript 2.0.0 → 3.0.0-alpha.1

package/lib/index.cjs.js

@@ -7,11 +7,13 @@ var deepmerge = require('deepmerge');
 var javascriptCore = require('@form8ion/javascript-core');
 var codecov = require('@form8ion/codecov');
 var fs = require('fs');
-var joi = require('@hapi/joi');
+var joi = require('joi');
 var inquirer = require('inquirer');
 var overridablePrompts = require('@form8ion/overridable-prompts');
 var cliMessages = require('@travi/cli-messages');
-var liftJavascript = require('@form8ion/lift-javascript');
+var eslint = require('@form8ion/eslint');
+var core = require('@form8ion/core');
+var husky = require('@form8ion/husky');
 var commitConvention = require('@form8ion/commit-convention');
 var hoek = require('@hapi/hoek');
 var execa = require('execa');
@@ -24,8 +26,6 @@ var camelcase = require('camelcase');
 var makeDir = require('make-dir');
 var touch = require('touch');
 var path = require('path');
-var husky = require('@form8ion/husky');
-var eslint = require('@form8ion/eslint');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -62,14 +62,9 @@ function ownKeys(object, enumerableOnly) {
 
   if (Object.getOwnPropertySymbols) {
     var symbols = Object.getOwnPropertySymbols(object);
-
-    if (enumerableOnly) {
-      symbols = symbols.filter(function (sym) {
-        return Object.getOwnPropertyDescriptor(object, sym).enumerable;
-      });
-    }
-
-    keys.push.apply(keys, symbols);
+    enumerableOnly && (symbols = symbols.filter(function (sym) {
+      return Object.getOwnPropertyDescriptor(object, sym).enumerable;
+    })), keys.push.apply(keys, symbols);
   }
 
   return keys;
@@ -77,19 +72,12 @@ function ownKeys(object, enumerableOnly) {
 
 function _objectSpread2(target) {
   for (var i = 1; i < arguments.length; i++) {
-    var source = arguments[i] != null ? arguments[i] : {};
-
-    if (i % 2) {
-      ownKeys(Object(source), true).forEach(function (key) {
-        _defineProperty(target, key, source[key]);
-      });
-    } else if (Object.getOwnPropertyDescriptors) {
-      Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
-    } else {
-      ownKeys(Object(source)).forEach(function (key) {
-        Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
-      });
-    }
+    var source = null != arguments[i] ? arguments[i] : {};
+    i % 2 ? ownKeys(Object(source), !0).forEach(function (key) {
+      _defineProperty(target, key, source[key]);
+    }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) {
+      Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+    });
   }
 
   return target;
@@ -150,13 +138,15 @@ async function scaffoldC8 ({
 async function scaffoldCoverage ({
   projectRoot,
   vcs,
-  visibility
+  visibility,
+  pathWithinParent
 }) {
   return deepmerge__default["default"](await scaffoldC8({
     projectRoot
   }), await codecov.scaffold({
     vcs,
-    visibility
+    visibility,
+    pathWithinParent
   }));
 }
 
@@ -183,7 +173,8 @@ async function scaffoldUnitTesting ({
   frameworks,
   decisions,
   visibility,
-  vcs
+  vcs,
+  pathWithinParent
 }) {
   const validatedFrameworks = javascriptCore.validateOptions(unitTestFrameworksSchema, frameworks);
   const [framework, coverage] = await Promise.all([chooseFramework({
@@ -194,7 +185,8 @@ async function scaffoldUnitTesting ({
   })), scaffoldCoverage({
     projectRoot,
     vcs,
-    visibility
+    visibility,
+    pathWithinParent
   })]);
   return deepmerge__default["default"].all([{
     scripts: {
@@ -203,6 +195,157 @@ async function scaffoldUnitTesting ({
   }, framework, coverage]);
 }
 
+async function applyEnhancers ({
+  results,
+  enhancers = {},
+  projectRoot
+}) {
+  cliMessages.info('Applying Enhancers');
+  return Object.values(enhancers).reduce(async (acc, enhancer) => {
+    if (await enhancer.test({
+      projectRoot
+    })) {
+      const previousResults = await acc;
+      return deepmerge__default["default"](previousResults, await enhancer.lift({
+        results: previousResults,
+        projectRoot
+      }));
+    }
+
+    return acc;
+  }, results);
+}
+
+async function test$1({
+  projectRoot
+}) {
+  const {
+    engines
+  } = JSON.parse(await fs.promises.readFile(`${projectRoot}/package.json`, 'utf8'));
+  return !!(engines !== null && engines !== void 0 && engines.node);
+}
+async function lift$1({
+  projectRoot
+}) {
+  const {
+    name
+  } = JSON.parse(await fs.promises.readFile(`${projectRoot}/package.json`, 'utf8'));
+  return {
+    devDependencies: ['ls-engines'],
+    scripts: {
+      'lint:engines': 'ls-engines'
+    },
+    badges: {
+      consumer: {
+        node: {
+          img: `https://img.shields.io/node/v/${name}?logo=node.js`,
+          text: 'node'
+        }
+      }
+    }
+  };
+}
+
+var enginesEnhancer = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  test: test$1,
+  lift: lift$1
+});
+
+async function liftPackage ({
+  projectRoot,
+  scripts,
+  tags,
+  dependencies,
+  devDependencies,
+  packageManager
+}) {
+  if (scripts || tags) {
+    cliMessages.info('Updating `package.json`', {
+      level: 'secondary'
+    });
+    const pathToPackageJson = `${projectRoot}/package.json`;
+    const existingPackageJsonContents = JSON.parse(await fs.promises.readFile(pathToPackageJson, 'utf8'));
+    await fs.promises.writeFile(pathToPackageJson, JSON.stringify(_objectSpread2(_objectSpread2({}, existingPackageJsonContents), {}, {
+      scripts: _objectSpread2(_objectSpread2({}, existingPackageJsonContents.scripts), scripts)
+    }, tags && {
+      keywords: existingPackageJsonContents.keywords ? [...existingPackageJsonContents.keywords, ...tags] : tags
+    }), null, 2));
+  }
+
+  cliMessages.info('Installing dependencies');
+  await javascriptCore.installDependencies(dependencies || [], javascriptCore.PROD_DEPENDENCY_TYPE, projectRoot, packageManager);
+  await javascriptCore.installDependencies([...(devDependencies || [])], javascriptCore.DEV_DEPENDENCY_TYPE, projectRoot, packageManager);
+}
+
+async function resolvePackageManager ({
+  projectRoot,
+  packageManager
+}) {
+  if (packageManager) return packageManager;
+
+  if (await core.fileExists(`${projectRoot}/package-lock.json`)) {
+    return javascriptCore.packageManagers.NPM;
+  }
+
+  if (await core.fileExists(`${projectRoot}/yarn.lock`)) {
+    return javascriptCore.packageManagers.YARN;
+  }
+
+  throw new Error('Package-manager could not be determined');
+}
+
+function enhanceHuskyEnhancer(packageManager) {
+  return {
+    test: husky.test,
+    lift: ({
+      projectRoot,
+      results
+    }) => husky.lift({
+      projectRoot,
+      results,
+      packageManager
+    })
+  };
+}
+
+async function lift ({
+  projectRoot,
+  results
+}) {
+  cliMessages.info('Lifting JavaScript-specific details');
+  const {
+    scripts,
+    tags,
+    eslintConfigs,
+    dependencies,
+    devDependencies,
+    packageManager: manager
+  } = results;
+  const packageManager = await resolvePackageManager({
+    projectRoot,
+    packageManager: manager
+  });
+  const eslintResults = await eslint.lift({
+    projectRoot,
+    configs: eslintConfigs
+  });
+  const enhancerResults = await applyEnhancers({
+    results,
+    enhancers: [enhanceHuskyEnhancer(packageManager), enginesEnhancer],
+    projectRoot
+  });
+  await liftPackage(deepmerge__default["default"].all([{
+    projectRoot,
+    scripts,
+    tags,
+    dependencies,
+    devDependencies,
+    packageManager
+  }, enhancerResults, eslintResults]));
+  return enhancerResults;
+}
+
 function validate(options) {
   const schema = joi__namespace.object().required().keys({
     projectRoot: joi__namespace.string().required(),
@@ -824,7 +967,7 @@ function defineBadges (packageName, visibility) {
   return {
     consumer: _objectSpread2({}, 'Public' === visibility && {
       npm: {
-        img: `https://img.shields.io/npm/v/${packageName}.svg`,
+        img: `https://img.shields.io/npm/v/${packageName}?logo=npm`,
         text: 'npm',
         link: `https://www.npmjs.com/package/${packageName}`
       }
@@ -1171,7 +1314,8 @@ async function scaffoldTesting ({
   vcs,
   unitTestFrameworks,
   decisions,
-  dialect
+  dialect,
+  pathWithinParent
 }) {
   const unitResults = unit ? await scaffoldUnitTesting({
     projectRoot,
@@ -1179,7 +1323,8 @@ async function scaffoldTesting ({
     vcs,
     frameworks: unitTestFrameworks,
     decisions,
-    dialect
+    dialect,
+    pathWithinParent
   }) : {};
   return deepmerge__default["default"]({
     devDependencies: [...(unit || integration ? ['@travi/any'] : [])],
@@ -1328,7 +1473,8 @@ async function scaffoldVerification({
   unitTestFrameworks,
   decisions,
   buildDirectory,
-  eslintConfigs
+  eslintConfigs,
+  pathWithinParent
 }) {
   const [testingResults, huskyResults] = await Promise.all([scaffoldTesting({
     projectRoot,
@@ -1337,7 +1483,8 @@ async function scaffoldVerification({
     vcs,
     unitTestFrameworks,
     decisions,
-    dialect
+    dialect,
+    pathWithinParent
   }), husky.scaffold({
     projectRoot,
     packageManager
@@ -1361,7 +1508,7 @@ async function scaffoldVerification({
   return deepmerge__default["default"].all([testingResults, lintingResults, huskyResults]);
 }
 
-async function scaffold(options) {
+async function scaffolder (options) {
   cliMessages.info('Initializing JavaScript project');
   const {
     projectRoot,
@@ -1427,6 +1574,7 @@ async function scaffold(options) {
     tests,
     unitTestFrameworks,
     decisions,
+    pathWithinParent,
     buildDirectory: projectTypeResults.buildDirectory,
     eslintConfigs: projectTypeResults.eslintConfigs
   });
@@ -1480,7 +1628,7 @@ async function scaffold(options) {
     scripts: mergedContributions.scripts,
     pathWithinParent
   });
-  const liftResults = await liftJavascript.lift({
+  const liftResults = await lift({
     results: deepmerge__default["default"]({
       devDependencies: ['npm-run-all'],
       packageManager
@@ -1504,9 +1652,23 @@ async function scaffold(options) {
   };
 }
 
+async function test ({
+  projectRoot
+}) {
+  try {
+    const stats = await fs.promises.stat(`${projectRoot}/.nvmrc`);
+    return stats.isFile();
+  } catch (e) {
+    if ('ENOENT' === e.code) return false;
+    throw e;
+  }
+}
+
 const questionNames = _objectSpread2(_objectSpread2({}, languageScaffolderPrompts.questionNames), questionNames$1);
 
+exports.lift = lift;
 exports.questionNames = questionNames;
-exports.scaffold = scaffold;
+exports.scaffold = scaffolder;
 exports.scaffoldUnitTesting = scaffoldUnitTesting;
+exports.test = test;
 //# sourceMappingURL=index.cjs.js.map