@form8ion/javascript 2.2.0 → 3.1.0-alpha.1

package/README.md

@@ -45,7 +45,13 @@ $ npm install @form8ion/javascript --save
 
 ```javascript
 const {dialects, projectTypes} = require('@form8ion/javascript-core');
-const {scaffold: scaffoldJavaScript, scaffoldUnitTesting, questionNames} = require('./lib/index.cjs');
+const {
+  scaffold: scaffoldJavaScript,
+  lift: liftJavascript,
+  test: thisIsAJavaScriptProject,
+  scaffoldUnitTesting,
+  questionNames
+} = require('@form8ion/javascript');
 ```
 
 #### Execute
@@ -53,9 +59,10 @@ const {scaffold: scaffoldJavaScript, scaffoldUnitTesting, questionNames} = requi
 ```javascript
 (async () => {
   const accountName = 'form8ion';
+  const projectRoot = process.cwd();
 
   await scaffoldJavaScript({
-    projectRoot: process.cwd(),
+    projectRoot,
     projectName: 'project-name',
     visibility: 'Public',
     license: 'MIT',
@@ -83,6 +90,20 @@ const {scaffold: scaffoldJavaScript, scaffoldUnitTesting, questionNames} = requi
     }
   });
 
+  if (await thisIsAJavaScriptProject({projectRoot})) {
+    await liftJavascript({
+      projectRoot,
+      configs: {eslint: {scope: '@foo'}},
+      results: {
+        dependencies: [],
+        devDependencies: [],
+        scripts: {},
+        eslintConfigs: [],
+        packageManager: 'npm'
+      }
+    });
+  }
+
   await scaffoldUnitTesting({
     projectRoot: process.cwd(),
     frameworks: {

package/example.js

@@ -5,9 +5,10 @@ import stubbedFs from 'mock-fs';
 import td from 'testdouble';
 import 'validate-npm-package-name';
 
-// remark-usage-ignore-next 9
+// remark-usage-ignore-next 10
 stubbedFs({
   node_modules: stubbedFs.load(resolve(...[__dirname, 'node_modules'])),
+  '.nvmrc': 'v1.2.3',
   lib: stubbedFs.load(resolve(...[__dirname, 'lib'])),
   templates: stubbedFs.load(resolve(...[__dirname, 'templates']))
 });
@@ -17,14 +18,21 @@ td.when(execa('. ~/.nvm/nvm.sh && nvm ls-remote --lts', {shell: true}))
 td.when(execa('. ~/.nvm/nvm.sh && nvm install', {shell: true})).thenReturn({stdout: {pipe: () => undefined}});
 
 const {dialects, projectTypes} = require('@form8ion/javascript-core');
-const {scaffold: scaffoldJavaScript, scaffoldUnitTesting, questionNames} = require('./lib/index.cjs');
+const {
+  scaffold: scaffoldJavaScript,
+  lift: liftJavascript,
+  test: thisIsAJavaScriptProject,
+  scaffoldUnitTesting,
+  questionNames
+} = require('./lib/index.cjs');
 
 // #### Execute
 (async () => {
   const accountName = 'form8ion';
+  const projectRoot = process.cwd();
 
   await scaffoldJavaScript({
-    projectRoot: process.cwd(),
+    projectRoot,
     projectName: 'project-name',
     visibility: 'Public',
     license: 'MIT',
@@ -52,6 +60,20 @@ const {scaffold: scaffoldJavaScript, scaffoldUnitTesting, questionNames} = requi
     }
   });
 
+  if (await thisIsAJavaScriptProject({projectRoot})) {
+    await liftJavascript({
+      projectRoot,
+      configs: {eslint: {scope: '@foo'}},
+      results: {
+        dependencies: [],
+        devDependencies: [],
+        scripts: {},
+        eslintConfigs: [],
+        packageManager: 'npm'
+      }
+    });
+  }
+
   await scaffoldUnitTesting({
     projectRoot: process.cwd(),
     frameworks: {

package/lib/index.cjs.js

@@ -5,13 +5,13 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var languageScaffolderPrompts = require('@travi/language-scaffolder-prompts');
 var deepmerge = require('deepmerge');
 var javascriptCore = require('@form8ion/javascript-core');
-var codecov = require('@form8ion/codecov');
-var fs = require('fs');
 var joi = require('joi');
 var inquirer = require('inquirer');
 var overridablePrompts = require('@form8ion/overridable-prompts');
+var codecov = require('@form8ion/codecov');
+var fs = require('fs');
+var core = require('@form8ion/core');
 var cliMessages = require('@travi/cli-messages');
-var liftJavascript = require('@form8ion/lift-javascript');
 var commitConvention = require('@form8ion/commit-convention');
 var hoek = require('@hapi/hoek');
 var execa = require('execa');
@@ -150,6 +150,42 @@ async function scaffoldCoverage ({
   }));
 }
 
+function nycIsConfigured ({
+  projectRoot
+}) {
+  return core.fileExists(`${projectRoot}/.nycrc`);
+}
+
+async function removeNyc ({
+  projectRoot
+}) {
+  await fs.promises.unlink(`${projectRoot}/.nycrc`);
+}
+
+async function lift$2({
+  projectRoot
+}) {
+  if (await nycIsConfigured({
+    projectRoot
+  })) {
+    const [c8Results] = await Promise.all([scaffoldC8({
+      projectRoot
+    }), removeNyc({
+      projectRoot
+    })]);
+    return c8Results;
+  }
+
+  return {};
+}
+
+var coveragePlugin = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  scaffold: scaffoldCoverage,
+  lift: lift$2,
+  test: nycIsConfigured
+});
+
 const unitTestFrameworksSchema = joi__namespace.object().required().pattern(/^/, joi__namespace.object({
   scaffolder: joi__namespace.func().arity(1).required()
 }));
@@ -195,6 +231,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
+});
+
+function enhanceHuskyEnhancer(packageManager) {
+  return {
+    test: husky.test,
+    lift: ({
+      projectRoot,
+      results
+    }) => husky.lift({
+      projectRoot,
+      results,
+      packageManager
+    })
+  };
+}
+
+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');
+}
+
+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, coveragePlugin],
+    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(),
@@ -1477,7 +1664,7 @@ async function scaffolder (options) {
     scripts: mergedContributions.scripts,
     pathWithinParent
   });
-  const liftResults = await liftJavascript.lift({
+  const liftResults = await lift({
     results: deepmerge__default["default"]({
       devDependencies: ['npm-run-all'],
       packageManager
@@ -1501,9 +1688,17 @@ async function scaffolder (options) {
   };
 }
 
+async function test ({
+  projectRoot
+}) {
+  return core.fileExists(`${projectRoot}/.nvmrc`);
+}
+
 const questionNames = _objectSpread2(_objectSpread2({}, languageScaffolderPrompts.questionNames), questionNames$1);
 
+exports.lift = lift;
 exports.questionNames = questionNames;
 exports.scaffold = scaffolder;
 exports.scaffoldUnitTesting = scaffoldUnitTesting;
+exports.test = test;
 //# sourceMappingURL=index.cjs.js.map