Merge pull request #1064 from form8ion/alpha

Author: travi

.github/workflows/node-ci.yml

@@ -30,8 +30,6 @@ jobs:
     strategy:
       matrix:
         node:
-          - 14.15.0
-          - 14
           - 16.0.0
           - 16
     steps:

README.md

@@ -73,7 +73,7 @@ a wrapper.
 #### Import
 
 ```javascript
-import {lift, scaffold, questionNames} from '@form8ion/project';
+import {lift, questionNames, scaffold} from '@form8ion/project';
 ```
 
 #### Execute

example.js

@@ -3,19 +3,13 @@
 import {promises as fs} from 'fs';
 import {resolve} from 'path';
 import stubbedFs from 'mock-fs';
-import {lift, scaffold, questionNames} from './lib/index.js';
+import {lift, questionNames, scaffold} from './lib/index.js';
 
 // #### Execute
 
-// remark-usage-ignore-next 8
+// remark-usage-ignore-next 2
 (async () => {
-  const projectTemplatePath = [__dirname, 'templates'];
-  stubbedFs({
-    templates: {
-      'README.mustache': await fs.readFile(resolve(...projectTemplatePath, 'README.mustache')),
-      'editorconfig.txt': await fs.readFile(resolve(...projectTemplatePath, 'editorconfig.txt'))
-    }
-  });
+  stubbedFs({templates: {'editorconfig.txt': await fs.readFile(resolve(__dirname, 'templates', 'editorconfig.txt'))}});
 
   await scaffold({
     decisions: {

package-lock.json

@@ -4,7 +4,7 @@
   "license": "MIT",
   "version": "0.0.0-semantically-released",
   "engines": {
-    "node": "^14.15 || ^16"
+    "node": "^16"
   },
   "author": "Matt Travi <[email protected]> (https://matt.travi.org/)",
   "repository": "form8ion/project",
@@ -53,7 +53,7 @@
     }
   },
   "dependencies": {
-    "@form8ion/core": "^1.6.0-alpha.2",
+    "@form8ion/core": "^2.0.0",
     "@form8ion/execa-wrapper": "^1.0.0",
     "@form8ion/nodegit-wrapper": "^1.1.0-alpha.1",
     "@form8ion/overridable-prompts": "^1.1.0",

package.json

@@ -1,15 +1,9 @@
-import {promises as fs} from 'fs';
 import any from '@travi/any';
 import * as readme from '@form8ion/readme';
 import sinon from 'sinon';
 import {assert} from 'chai';
 import scaffoldReadme from './readme';
 
-const badgeFactory = () => ({img: any.url(), link: any.url(), text: any.sentence()});
-const consumerBadges = any.objectWithKeys(any.listOf(any.word), {factory: badgeFactory});
-const statusBadges = any.objectWithKeys(any.listOf(any.word), {factory: badgeFactory});
-const contributionBadges = any.objectWithKeys(any.listOf(any.word), {factory: badgeFactory});
-
 suite('scaffold readme', () => {
   let sandbox;
   const projectName = any.word();
@@ -19,118 +13,19 @@ suite('scaffold readme', () => {
   setup(() => {
     sandbox = sinon.createSandbox();
 
+    sandbox.stub(readme, 'scaffold');
     sandbox.stub(readme, 'lift');
-    sandbox.stub(fs, 'writeFile');
   });
 
   teardown(() => sandbox.restore());
 
-  test('that the README has a top-level heading of the project name and includes the description', async () => {
-    const badges = {consumer: {}, status: {}, contribution: {}};
-
-    await scaffoldReadme({projectName, projectRoot, description, badges});
-
-    assert.calledWith(
-      fs.writeFile,
-      `${projectRoot}/README.md`,
-      sinon.match(`# ${projectName}
-
-${description}`)
-    );
-    assert.calledWith(readme.lift, {projectRoot, results: {badges}});
-  });
-
-  suite('documentation', () => {
-    const markdownWithBackticksAndForwardSlashes = `\`\`\`sh${any.sentence()}\`\`\`https://any.url`;
-
-    test('that usage docs are shown after the contributing badges', async () => {
-      const usageDocs = markdownWithBackticksAndForwardSlashes;
-      const badges = {consumer: consumerBadges, status: statusBadges, contribution: contributionBadges};
-
-      await scaffoldReadme({
-        projectRoot,
-        badges,
-        documentation: {usage: usageDocs}
-      });
-
-      assert.calledWith(
-        fs.writeFile,
-        `${projectRoot}/README.md`,
-        sinon.match(`
-<!--status-badges start -->
-<!--status-badges end -->
-
-## Usage
-
-<!--consumer-badges start -->
-<!--consumer-badges end -->
-
-${usageDocs}
-
-<!--contribution-badges start -->
-<!--contribution-badges end -->
-`)
-      );
-    });
-
-    test('that consumer badges are lifted to top level when toc is present and no usage content', async () => {
-      const toc = `${any.word()} \`${any.word()}\` ${any.word()}`;
-      const badges = {consumer: consumerBadges, status: statusBadges, contribution: contributionBadges};
-
-      await scaffoldReadme({
-        projectRoot,
-        badges,
-        documentation: {toc}
-      });
-
-      assert.calledWith(
-        fs.writeFile,
-        `${projectRoot}/README.md`,
-        sinon.match(`
-<!--status-badges start -->
-<!--status-badges end -->
-
-<!--consumer-badges start -->
-<!--consumer-badges end -->
-
-## Table of Contents
-
-${toc}
-
-<!--contribution-badges start -->
-<!--contribution-badges end -->
-`)
-      );
-    });
-
-    test('that contribution docs are shown after the contributing badges', async () => {
-      const contributingDocs = markdownWithBackticksAndForwardSlashes;
-      const badges = {consumer: consumerBadges, status: statusBadges, contribution: contributionBadges};
-
-      await scaffoldReadme({
-        projectRoot,
-        badges,
-        documentation: {contributing: contributingDocs}
-      });
-
-      assert.calledWith(
-        fs.writeFile,
-        `${projectRoot}/README.md`,
-        sinon.match(`
-<!--status-badges start -->
-<!--status-badges end -->
-
-<!--consumer-badges start -->
-<!--consumer-badges end -->
-
-## Contributing
+  test('that the README created and lifted', async () => {
+    const badges = any.simpleObject();
+    const documentation = any.simpleObject();
 
-<!--contribution-badges start -->
-<!--contribution-badges end -->
+    await scaffoldReadme({projectName, projectRoot, description, badges, documentation});
 
-${contributingDocs}
-`)
-      );
-    });
+    assert.calledWith(readme.scaffold, {projectRoot, projectName, description});
+    assert.calledWith(readme.lift, {projectRoot, results: {badges, documentation}});
   });
 });

src/readme-test.js

@@ -1,22 +1,7 @@
-import {promises as fs} from 'fs';
-import path from 'path';
-
-import filedirname from 'filedirname';
-import mustache from 'mustache';
-import {info} from '@travi/cli-messages';
-import {lift as liftReadme} from '@form8ion/readme';
-
-const [, __dirname] = filedirname();
+import {lift as liftReadme, scaffold as scaffoldReadme} from '@form8ion/readme';
 
 export default async function ({projectName, projectRoot, description, badges, documentation}) {
-  info('Generating README');
-
-  const initialRender = mustache.render(
-    await fs.readFile(path.resolve(__dirname, '..', 'templates/README.mustache'), 'utf8'),
-    {projectName, description, documentation}
-  );
-
-  await fs.writeFile(`${projectRoot}/README.md`, initialRender);
+  await scaffoldReadme({projectRoot, projectName, description});
 
-  return liftReadme({projectRoot, results: {badges}});
+  return liftReadme({projectRoot, results: {badges, documentation}});
 }

src/readme.js

@@ -28,10 +28,7 @@ Before({timeout: 20 * 1000}, async function () {
 
   stubbedFs({
     node_modules: stubbedNodeModules,
-    templates: {
-      'README.mustache': await fs.readFile(resolve(...projectTemplatePath, 'README.mustache')),
-      'editorconfig.txt': await fs.readFile(resolve(...projectTemplatePath, 'editorconfig.txt'))
-    }
+    templates: {'editorconfig.txt': await fs.readFile(resolve(...projectTemplatePath, 'editorconfig.txt'))}
   });
 });