feat(generator): create types/

package.json

@@ -55,6 +55,7 @@
   "dependencies": {
     "chalk": "^1.1.3",
     "generator-node": "^2.1.0",
+    "gulp-rename": "^1.2.2",
     "inquirer-npm-name": "^2.0.0",
     "lodash": "^4.17.4",
     "mkdirp": "^0.5.1",
@@ -63,7 +64,7 @@
   "jest": {
     "testPathIgnorePatterns": [
       "/node_modules/",
-      "/app/src/templates/src/"
+      "<rootDir>/app/src/templates"
     ]
   },
   "config": {

src/app/index.js

@@ -3,6 +3,7 @@ import Generator from 'yeoman-generator'
 import askName from 'inquirer-npm-name'
 import _ from 'lodash'
 import mkdirp from 'mkdirp'
+import rename from 'gulp-rename'
 
 import { defaultEmail, defaultName } from './values'
 import * as validators from './validators'
@@ -16,10 +17,7 @@ function makeGeneratorName(name) {
 }
 
 function makePluginFunctionName(name) {
-  const functionName = _.camelCase(
-    name.substring(PLUGIN_PREFIX.length, name.length)
-  )
-  return `${functionName}()`
+  return _.camelCase(name.substring(PLUGIN_PREFIX.length, name.length))
 }
 export default class extends Generator {
   initializing() {
@@ -81,6 +79,21 @@ export default class extends Generator {
   }
 
   writing() {
+    this.registerTransformStream(
+      rename(path => {
+        if (path.basename === 'index' && !path.extname) {
+          path.extname = '.js'
+        }
+
+        if (path.extname === '.test') {
+          path.basename += '.test'
+          path.extname = '.js'
+        }
+
+        return path
+      })
+    )
+
     this.fs.copyTpl(
       this.templatePath('package.json'),
       this.destinationPath('package.json'),
@@ -126,16 +139,16 @@ export default class extends Generator {
 
     this.fs.copy(this.templatePath('babelrc'), this.destinationPath('.babelrc'))
 
-    this.fs.copyTpl(
-      this.templatePath('src/index'),
-      this.destinationPath('src/index.js'),
-      { pluginFunctionName: makePluginFunctionName(this.props.pluginName) }
-    )
+    const pluginFunctionName = makePluginFunctionName(this.props.pluginName)
+
+    this.fs.copyTpl(this.templatePath('src/**'), this.destinationPath('src'), {
+      pluginFunctionName,
+    })
 
     this.fs.copyTpl(
-      this.templatePath('src/index.test'),
-      this.destinationPath('src/index.test.js'),
-      { pluginFunctionName: makePluginFunctionName(this.props.pluginName) }
+      this.templatePath('types/**'),
+      this.destinationPath('types'),
+      { pluginFunctionName }
     )
   }
 

src/app/index.test.js

@@ -32,6 +32,10 @@ describe('generator:app', () => {
       '.esdoc.json',
       'src/index.js',
       'src/index.test.js',
+      'types/index.d.ts',
+      'types/test.ts',
+      'types/tsconfig.json',
+      'types/types.test.js',
     ])
   })
   describe('src/', () => {
@@ -44,7 +48,7 @@ describe('generator:app', () => {
       })
       assert.fileContent('src/index.js', 'funTime()')
     })
-    it('generates source file based on plugin name', async () => {
+    it('generates test file based on plugin name', async () => {
       await helpers.run(__dirname).withPrompts({
         pluginName: 'danger-plugin-fun-time',
         description: 'Danger plugin that tells you to have a fun time',
@@ -54,6 +58,28 @@ describe('generator:app', () => {
       assert.fileContent('src/index.test.js', 'funTime()')
     })
   })
+  describe('types/', () => {
+    beforeEach(async () => {
+      await helpers.run(__dirname).withPrompts({
+        pluginName: 'danger-plugin-jest-test-runner',
+        description: 'Danger plugin that runs Jest tests',
+        authorName: 'Macklin Underdown',
+        authorEmail: '[email protected]',
+      })
+    })
+    it('generates TypeScript type defintion', () => {
+      assert.fileContent(
+        'types/index.d.ts',
+        'export default function jestTestRunner(): void'
+      )
+    })
+    it('generates TypeScript test file', () => {
+      assert.fileContent(
+        'types/test.ts',
+        `import jestTestRunner from './'\n\njestTestRunner()`
+      )
+    })
+  })
   describe('CODE_OF_CONDUCT.md', () => {
     it('contains author email', async () => {
       await helpers.run(__dirname).withPrompts({

src/app/templates/src/index

@@ -1,3 +1,3 @@
-export default function <%= pluginFunctionName %> {
+export default function <%= pluginFunctionName %>() {
 
 }

src/app/templates/src/index.test

@@ -1,3 +1,3 @@
-describe('<%= pluginFunctionName %>', () => {
+describe('<%= pluginFunctionName %>()', () => {
   it('does something')
 })

src/app/templates/types/index.d.ts

@@ -0,0 +1 @@
+export default function <%= pluginFunctionName %>(): void

src/app/templates/types/test.ts

@@ -0,0 +1,3 @@
+import <%= pluginFunctionName %> from './'
+
+<%= pluginFunctionName %>()

src/app/templates/types/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es5",
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "strictNullChecks": true,
+    "sourceMap": false
+  }
+}

src/app/templates/types/types.test

@@ -0,0 +1,8 @@
+import { join } from 'path'
+import { check } from 'typings-tester'
+
+test('TypeScript types', () => {
+  expect(() => {
+    check([join(__dirname, 'test.ts')], join(__dirname, 'tsconfig.json'))
+  }).not.toThrow()
+})

yarn.lock

@@ -2177,6 +2177,10 @@ gruntfile-editor@^1.0.0:
     ast-query "^2.0.0"
     lodash "^4.6.1"
 
+gulp-rename@^1.2.2:
+  version "1.2.2"
+  resolved "https://registry.yarnpkg.com/gulp-rename/-/gulp-rename-1.2.2.tgz#3ad4428763f05e2764dec1c67d868db275687817"
+
 handlebars@^4.0.3:
   version "4.0.8"
   resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.0.8.tgz#22b875cd3f0e6cbea30314f144e82bc7a72ff420"