@form8ion/javascript 2.0.0-alpha.1 → 2.2.0

package/README.md

@@ -17,14 +17,7 @@ toolset
   * [Example](#example)
     * [Import](#import)
     * [Execute](#execute)
-  * [API](#api)
-    * [`scaffoldUnitTesting`](#scaffoldunittesting)
-      * [`projectRoot` __string__ (_required_)](#projectroot-string-required)
-      * [`frameworks` __object__ (_required_)](#frameworks-object-required)
-      * [`decisions` __object__ (_optional_)](#decisions-object-optional)
-      * [`visibility` __string__ (_required_)](#visibility-string-required)
-      * [`vcs` __object__ (_required_)](#vcs-object-required)
-    * [`questionNames`](#questionnames)
+  * [Documentation](#documentation)
 * [Contributing](#contributing)
   * [Dependencies](#dependencies)
   * [Verification](#verification)
@@ -51,13 +44,45 @@ $ npm install @form8ion/javascript --save
 #### Import
 
 ```javascript
-import {scaffoldUnitTesting, questionNames} from '@form8ion/javascript';
+const {dialects, projectTypes} = require('@form8ion/javascript-core');
+const {scaffold: scaffoldJavaScript, scaffoldUnitTesting, questionNames} = require('./lib/index.cjs');
 ```
 
 #### Execute
 
 ```javascript
 (async () => {
+  const accountName = 'form8ion';
+
+  await scaffoldJavaScript({
+    projectRoot: process.cwd(),
+    projectName: 'project-name',
+    visibility: 'Public',
+    license: 'MIT',
+    configs: {
+      eslint: {scope: `@${accountName}`},
+      remark: `@${accountName}/remark-lint-preset`,
+      babelPreset: {name: `@${accountName}`, packageName: `@${accountName}/babel-preset`},
+      commitlint: {name: `@${accountName}`, packageName: `@${accountName}/commitlint-config`}
+    },
+    overrides: {npmAccount: accountName},
+    ciServices: {},
+    unitTestFrameworks: {},
+    decisions: {
+      [questionNames.DIALECT]: dialects.BABEL,
+      [questionNames.NODE_VERSION_CATEGORY]: 'LTS',
+      [questionNames.PACKAGE_MANAGER]: 'npm',
+      [questionNames.PROJECT_TYPE]: projectTypes.PACKAGE,
+      [questionNames.SHOULD_BE_SCOPED]: true,
+      [questionNames.SCOPE]: accountName,
+      [questionNames.AUTHOR_NAME]: 'Your Name',
+      [questionNames.AUTHOR_EMAIL]: 'you@domain.tld',
+      [questionNames.AUTHOR_URL]: 'https://your.website.tld',
+      [questionNames.UNIT_TESTS]: true,
+      [questionNames.INTEGRATION_TESTS]: true
+    }
+  });
+
   await scaffoldUnitTesting({
     projectRoot: process.cwd(),
     frameworks: {
@@ -71,48 +96,10 @@ import {scaffoldUnitTesting, questionNames} from '@form8ion/javascript';
 })();
 ```
 
-### API
-
-#### `scaffoldUnitTesting`
-
-Scaffolder for enabling unit-testing in a project with the ability to choose a
-desired framework from provided options.
-
-Takes a single options object as an argument, containing:
-
-##### `projectRoot` __string__ (_required_)
-
-path to the root of the project
-
-##### `frameworks` __object__ (_required_)
-
-A [`choices` object](https://github.com/form8ion/javascript-core#choices-object-required)
-for defining [unit-testing framework options](https://github.com/form8ion/awesome#unit-testing-frameworks)
-
-##### `decisions` __object__ (_optional_)
-
-Answers for prompt questions so that the prompt is skipped at execution time
-
-* keys: __string__ Name of the prompt question
-* values: Hard-coded answer for the prompt question
-
-##### `visibility` __string__ (_required_)
-
-visibility of the project (`Public` or `Private`)
-
-##### `vcs` __object__ (_required_)
-
-* `host` __string__ (_required_)
-  VCS hosting service
-* `owner` __string__ (_required_)
-  account name on the host service for the repository
-* `name` __string__ (_required_)
-  repository name
-
-#### `questionNames`
+### Documentation
 
-Constants defining the question names for the prompts implemented in this
-package
+* [API](./docs/api)
+* [Constants](./docs/constants)
 
 ## Contributing
 

package/example.js

@@ -1,14 +1,57 @@
 // #### Import
-// remark-usage-ignore-next
+// remark-usage-ignore-next 4
+import {resolve} from 'path';
 import stubbedFs from 'mock-fs';
-import {scaffoldUnitTesting, questionNames} from './lib/index.cjs';
+import td from 'testdouble';
+import 'validate-npm-package-name';
 
-// remark-usage-ignore-next
-stubbedFs();
+// remark-usage-ignore-next 9
+stubbedFs({
+  node_modules: stubbedFs.load(resolve(...[__dirname, 'node_modules'])),
+  lib: stubbedFs.load(resolve(...[__dirname, 'lib'])),
+  templates: stubbedFs.load(resolve(...[__dirname, 'templates']))
+});
+const execa = td.replace('execa');
+td.when(execa('. ~/.nvm/nvm.sh && nvm ls-remote --lts', {shell: true}))
+  .thenResolve({stdout: ['v16.5.4', ''].join('\n')});
+td.when(execa('. ~/.nvm/nvm.sh && nvm install', {shell: true})).thenReturn({stdout: {pipe: () => undefined}});
 
-// #### Execute
+const {dialects, projectTypes} = require('@form8ion/javascript-core');
+const {scaffold: scaffoldJavaScript, scaffoldUnitTesting, questionNames} = require('./lib/index.cjs');
 
+// #### Execute
 (async () => {
+  const accountName = 'form8ion';
+
+  await scaffoldJavaScript({
+    projectRoot: process.cwd(),
+    projectName: 'project-name',
+    visibility: 'Public',
+    license: 'MIT',
+    configs: {
+      eslint: {scope: `@${accountName}`},
+      remark: `@${accountName}/remark-lint-preset`,
+      babelPreset: {name: `@${accountName}`, packageName: `@${accountName}/babel-preset`},
+      commitlint: {name: `@${accountName}`, packageName: `@${accountName}/commitlint-config`}
+    },
+    overrides: {npmAccount: accountName},
+    ciServices: {},
+    unitTestFrameworks: {},
+    decisions: {
+      [questionNames.DIALECT]: dialects.BABEL,
+      [questionNames.NODE_VERSION_CATEGORY]: 'LTS',
+      [questionNames.PACKAGE_MANAGER]: 'npm',
+      [questionNames.PROJECT_TYPE]: projectTypes.PACKAGE,
+      [questionNames.SHOULD_BE_SCOPED]: true,
+      [questionNames.SCOPE]: accountName,
+      [questionNames.AUTHOR_NAME]: 'Your Name',
+      [questionNames.AUTHOR_EMAIL]: 'you@domain.tld',
+      [questionNames.AUTHOR_URL]: 'https://your.website.tld',
+      [questionNames.UNIT_TESTS]: true,
+      [questionNames.INTEGRATION_TESTS]: true
+    }
+  });
+
   await scaffoldUnitTesting({
     projectRoot: process.cwd(),
     frameworks: {

package/lib/index.cjs.js

@@ -7,7 +7,7 @@ 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');
@@ -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: {
@@ -824,7 +816,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 +1163,8 @@ async function scaffoldTesting ({
   vcs,
   unitTestFrameworks,
   decisions,
-  dialect
+  dialect,
+  pathWithinParent
 }) {
   const unitResults = unit ? await scaffoldUnitTesting({
     projectRoot,
@@ -1179,7 +1172,8 @@ async function scaffoldTesting ({
     vcs,
     frameworks: unitTestFrameworks,
     decisions,
-    dialect
+    dialect,
+    pathWithinParent
   }) : {};
   return deepmerge__default["default"]({
     devDependencies: [...(unit || integration ? ['@travi/any'] : [])],
@@ -1328,7 +1322,8 @@ async function scaffoldVerification({
   unitTestFrameworks,
   decisions,
   buildDirectory,
-  eslintConfigs
+  eslintConfigs,
+  pathWithinParent
 }) {
   const [testingResults, huskyResults] = await Promise.all([scaffoldTesting({
     projectRoot,
@@ -1337,7 +1332,8 @@ async function scaffoldVerification({
     vcs,
     unitTestFrameworks,
     decisions,
-    dialect
+    dialect,
+    pathWithinParent
   }), husky.scaffold({
     projectRoot,
     packageManager
@@ -1361,7 +1357,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 +1423,7 @@ async function scaffold(options) {
     tests,
     unitTestFrameworks,
     decisions,
+    pathWithinParent,
     buildDirectory: projectTypeResults.buildDirectory,
     eslintConfigs: projectTypeResults.eslintConfigs
   });
@@ -1507,6 +1504,6 @@ async function scaffold(options) {
 const questionNames = _objectSpread2(_objectSpread2({}, languageScaffolderPrompts.questionNames), questionNames$1);
 
 exports.questionNames = questionNames;
-exports.scaffold = scaffold;
+exports.scaffold = scaffolder;
 exports.scaffoldUnitTesting = scaffoldUnitTesting;
 //# sourceMappingURL=index.cjs.js.map