docs(lift): capture adjustment to expected dependencies shape

Author: travi

README.md

@@ -46,88 +46,85 @@ $ npm install @form8ion/javascript --save
 #### Import
 
 ```javascript
-const {dialects, projectTypes} = require('@form8ion/javascript-core');
+const {dialects, projectTypes} = await import('@form8ion/javascript-core');
 const {
   scaffold: scaffoldJavaScript,
   lift: liftJavascript,
   test: thisIsAJavaScriptProject,
   scaffoldUnitTesting,
   questionNames
-} = require('@form8ion/javascript');
+} = await import('./lib/index.js');
 ```
 
 #### Execute
 
 ```javascript
-(async () => {
-  const accountName = 'form8ion';
-  const projectRoot = process.cwd();
+const accountName = 'form8ion';
+const projectRoot = process.cwd();
+
+await scaffoldJavaScript({
+  projectRoot,
+  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`}
+  },
+  plugins: {
+    unitTestFrameworks: {},
+    applicationTypes: {},
+    packageTypes: {},
+    packageBundlers: {},
+    ciServices: {}
+  },
+  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]: '[email protected]',
+    [questionNames.AUTHOR_URL]: 'https://your.website.tld',
+    [questionNames.UNIT_TESTS]: true,
+    [questionNames.INTEGRATION_TESTS]: true,
+    [questionNames.PROVIDE_EXAMPLE]: true
+  }
+});
 
-  await scaffoldJavaScript({
+if (await thisIsAJavaScriptProject({projectRoot})) {
+  await liftJavascript({
     projectRoot,
-    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`}
-    },
-    plugins: {
-      unitTestFrameworks: {},
-      applicationTypes: {},
-      packageTypes: {},
-      packageBundlers: {},
-      ciServices: {}
+    configs: {eslint: {scope: '@foo'}},
+    results: {
+      dependencies: {javascript: {production: [], development: []}},
+      scripts: {},
+      eslint: {configs: [], ignore: {directories: []}},
+      packageManager: 'npm'
     },
-    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]: '[email protected]',
-      [questionNames.AUTHOR_URL]: 'https://your.website.tld',
-      [questionNames.UNIT_TESTS]: true,
-      [questionNames.INTEGRATION_TESTS]: true,
-      [questionNames.PROVIDE_EXAMPLE]: true
-    }
-  });
-
-  if (await thisIsAJavaScriptProject({projectRoot})) {
-    await liftJavascript({
-      projectRoot,
-      configs: {eslint: {scope: '@foo'}},
-      results: {
-        dependencies: [],
-        devDependencies: [],
-        scripts: {},
-        eslint: {configs: [], ignore: {directories: []}},
-        packageManager: 'npm'
-      },
-      enhancers: {
-        PluginName: {
-          test: () => true,
-          lift: () => ({})
-        }
+    enhancers: {
+      PluginName: {
+        test: () => true,
+        lift: () => ({})
       }
-    });
-  }
-
-  await scaffoldUnitTesting({
-    projectRoot: process.cwd(),
-    frameworks: {
-      Mocha: {scaffold: options => options},
-      Jest: {scaffold: options => options}
-    },
-    visibility: 'Public',
-    vcs: {host: 'GitHub', owner: 'foo', name: 'bar'},
-    decisions: {[questionNames.UNIT_TEST_FRAMEWORK]: 'Mocha'}
+    }
   });
-})();
+}
+
+await scaffoldUnitTesting({
+  projectRoot: process.cwd(),
+  frameworks: {
+    Mocha: {scaffold: options => options},
+    Jest: {scaffold: options => options}
+  },
+  visibility: 'Public',
+  vcs: {host: 'GitHub', owner: 'foo', name: 'bar'},
+  decisions: {[questionNames.UNIT_TEST_FRAMEWORK]: 'Mocha'}
+});
 ```
 
 ### Documentation

docs/api/scaffold.md

@@ -8,7 +8,7 @@ Language scaffolder for JavaScript projects
   * [`projectRoot` __string__ (_required_)](#projectroot-string-required)
   * [`projectName` __string__ (_required_)](#projectname-string-required)
   * [`description` __string__ (_optional_)](#description-string-optional)
-  * [`pathWithinParent` __string__ (_required_)](#pathwithinparent-string-required)
+  * [`pathWithinParent` __string__ (_optional_)](#pathwithinparent-string-optional)
   * [`license` __string__ (_required_)](#license-string-required)
   * [`decisions` __object__ (_optional_)](#decisions-object-optional)
   * [`visibility` __string__ (_required_)](#visibility-string-required)

example.js

@@ -5,17 +5,18 @@ import stubbedFs from 'mock-fs';
 import * as td from 'testdouble';
 import 'validate-npm-package-name';
 
-// remark-usage-ignore-next 10
+// remark-usage-ignore-next 11
 stubbedFs({
   node_modules: stubbedFs.load(resolve('node_modules')),
   '.nvmrc': 'v1.2.3',
   lib: stubbedFs.load(resolve('lib')),
   templates: stubbedFs.load(resolve('templates'))
 });
-const execa = td.replace('execa');
+const {execa} = await td.replaceEsm('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}});
+td.when(execa('npm', ['--version'])).thenResolve({stdout: '10.6.18'});
 
 const {dialects, projectTypes} = await import('@form8ion/javascript-core');
 const {
@@ -69,8 +70,7 @@ if (await thisIsAJavaScriptProject({projectRoot})) {
     projectRoot,
     configs: {eslint: {scope: '@foo'}},
     results: {
-      dependencies: [],
-      devDependencies: [],
+      dependencies: {javascript: {production: [], development: []}},
       scripts: {},
       eslint: {configs: [], ignore: {directories: []}},
       packageManager: 'npm'