Plugin generator (#174)

* initial asking

* 🏗️ cleanup

* plugin generator functioning

* lint fix

* conditional advanced features

* small json error

* start asking description

* description prompt

* added create tests

* prep for testing

* finish tests

* add create plugin link to docs

* add reference to plugin creator in docs

* 📈 speed up cov from CI

Author: GantMan

.travis.yml

@@ -10,7 +10,7 @@ script:
   - 'npm run test:ci'
   - yarn danger ci
 after_success:
-  - './node_modules/.bin/jest --coverage && cat ./coverage/lcov.info | ./node_modules/.bin/codecov'
+  - './node_modules/.bin/jest --coverage --runInBand && cat ./coverage/lcov.info | ./node_modules/.bin/codecov'
 notifications:
   webhooks:
     urls:

.vscode/cSpell.json

@@ -31,6 +31,7 @@
         "infinite.red",
         "info",
         "macos",
+        "namespacing",
         "newclear",
         "npmignore",
         "Plugin",
@@ -46,7 +47,8 @@
         "tada",
         "tempy",
         "updtr",
-        "v1"
+        "v1",
+        "walkthrough"
     ],
     // flagWords - list of words to be always considered incorrect
     // This is useful for offensive words and common spelling errors.

__tests__/__mocks__/mockContext.ts

@@ -17,6 +17,9 @@ const mockContext = {
   system: {
     startTimer: jest.fn(() => jest.fn()),
   },
+  template: {
+    generate: jest.fn(),
+  },
   print: {
     error: jest.fn(),
     success: jest.fn(),
@@ -33,19 +36,22 @@ const mockContext = {
       green: jest.fn(),
       red: jest.fn(),
       blue: jest.fn(),
+      magenta: jest.fn(),
     },
     colors: {
       green: jest.fn(),
       red: jest.fn(),
       blue: jest.fn(),
+      magenta: jest.fn(),
     },
   },
   printSeparator: jest.fn(),
   parameters: {
     options: {},
   },
   prompt: {
-    ask: jest.fn(() => Promise.resolve({ createFile: true })),
+    ask: jest.fn(({ name }) => Promise.resolve({ [name]: 'taco', createFile: true })),
+    confirm: jest.fn(() => true)
   },
   solidarity: noConfigSolidarity,
 }

__tests__/command_helpers/__snapshots__/createPlugin.ts.snap

@@ -0,0 +1,20 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`check result shape 1`] = `[Function]`;
+
+exports[`investigate createPlugin 1`] = `
+Array [
+  Array [
+    ".gitignore.ejs",
+    ".gitignore",
+  ],
+  Array [
+    "README.md.ejs",
+    "README.md",
+  ],
+  Array [
+    "package.json.ejs",
+    "package.json",
+  ],
+]
+`;

__tests__/command_helpers/createPlugin.ts

@@ -0,0 +1,16 @@
+const createPlugin: Function = require('../../src/extensions/functions/createPlugin')
+const context = require('mockContext')
+
+test('check result shape', () => {
+  expect(createPlugin).toMatchSnapshot()
+})
+
+test('investigate createPlugin', async () => {
+
+  const result = await createPlugin(context)
+  expect(result).toMatchSnapshot()
+  expect(context.template.generate).toBeCalled()
+  expect(context.prompt.ask).toBeCalled()
+  expect(context.prompt.confirm).toBeCalled()
+  expect(context.print.success).toBeCalled()
+})

__tests__/commands/__snapshots__/create.ts.snap

@@ -0,0 +1,9 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Snapshot create command 1`] = `
+Object {
+  "alias": "c",
+  "description": "Displays this help",
+  "run": [Function],
+}
+`;

__tests__/commands/create.ts

@@ -0,0 +1,34 @@
+import createCommand from '../../src/commands/create'
+const mockContext = require('mockContext')
+
+test('Snapshot create command', () => {
+  expect(createCommand).toMatchSnapshot()
+})
+
+it('enforces required properties', () => {
+  expect(createCommand.description).toBeTruthy()
+  expect(createCommand.run).toBeTruthy()
+  expect(typeof createCommand.run).toBe('function')
+})
+
+test('check solidarity create with no parameter', async () => {
+  const result = await createCommand.run(mockContext)
+  expect(mockContext.print.error.mock.calls).toEqual([["Missing what to create"], ["solidarity create <wut?>"]])
+  expect(mockContext.print.info.mock.calls.length).toBe(1)
+})
+
+test('check solidarity create with plugin', async () => {
+  const goodContext = {
+    ...mockContext,
+    parameters: { first: 'plugin' },
+    solidarity: { createPlugin: jest.fn() }
+  }
+  await createCommand.run(goodContext)
+  expect(goodContext.solidarity.createPlugin).toBeCalled()
+
+  // now make it fail
+  const errorString = 'ER MA GERD ARRAWRS'
+  goodContext.solidarity.createPlugin = jest.fn(() => throw Error(errorString))
+  await createCommand.run(goodContext)
+  expect(goodContext.print.error.mock.calls.slice(-1).toString()).toEqual(`Error: ${errorString}`)
+})

__tests__/extensions/__snapshots__/extensionCheck.ts.snap

@@ -10,6 +10,7 @@ Object {
   "checkENV": [Function],
   "checkFile": [Function],
   "checkRequirement": [Function],
+  "createPlugin": [Function],
   "getLineWithVersion": [Function],
   "getSolidaritySettings": [Function],
   "getVersion": [Function],

docs/plugins.md

@@ -1,6 +1,8 @@
 # Writing your own plugins
 If you're using a technology that doesn't have a plugin, or if you'd just like build your own custom rules to use in solidarity, we've made creating plugins extremely simple.
 
+The following docs will show you all the features of how to create a plugin.  If you'd like, you can generate a plugin-base by typing `solidarity create plugin`. This starts a walkthrough that will ask you questions to help you get started writing your plugin.
+
 ## Plugin Docs
 * [Write the Simplest Plugin](/docs/simplePlugin.md)
 * [Plugins that write Solidarity Files from Code](/docs/solidarityFromCode.md)

src/commands/create.ts

@@ -0,0 +1,25 @@
+import { GluegunCommand } from 'gluegun'
+
+const createables = ['plugin']
+
+module.exports = {
+  alias: 'c',
+  description: 'Displays this help',
+  run: async context => {
+    const { print, solidarity, parameters } = context
+    switch (parameters.first && parameters.first.toLowerCase()) {
+      case 'plugin':
+        // Handle errors like grown-ups
+        try {
+          await solidarity.createPlugin(context)
+        } catch (e) {
+          print.error(e)
+        }
+        break
+      default:
+        print.error('Missing what to create')
+        print.error('solidarity create <wut?>')
+        print.info(`Things you can create: ${createables}`)
+    }
+  },
+} as GluegunCommand