Merge pull request #24 from netlify/netlify-functions/addOnComplete

add onComplete lifecycle to netlify functions template

Author: swyxio

src/commands/functions/create.js

@@ -4,28 +4,29 @@ const { flags } = require('@oclif/command')
 const Command = require('@netlify/cli-utils')
 const inquirer = require('inquirer')
 
+const templatesDir = path.resolve(__dirname, '../../functions-templates')
 class FunctionsCreateCommand extends Command {
   async run() {
     const { flags, args } = this.parse(FunctionsCreateCommand)
     const name = await getNameFromArgs(args)
     const { config } = this.netlify
     const templates = fs
-      .readdirSync(path.resolve(__dirname, '../../functions-templates'))
+      .readdirSync(templatesDir)
       .filter(x => path.extname(x) === '.js') // only js templates for now
     const { templatePath } = await inquirer.prompt([
       {
         name: 'templatePath',
         message: 'pick a template',
         type: 'list',
         choices: templates.map(t => {
-          return require(path.resolve(__dirname, '../../functions-templates/', t)).metadata
+          return require(path.join(templatesDir, t)).metadata
           // ({ name: path.basename(t, '.js') })
         })
       }
     ])
 
     let template = fs
-      .readFileSync(path.resolve(__dirname, `../../functions-templates/${templatePath}.js`))
+      .readFileSync(path.join(templatesDir, `${templatePath}.js`))
       .toString()
       .split('// --- Netlify Template Below -- //')
     if (template.length !== 2) throw new Error('template ' + templatePath + ' badly formatted')
@@ -69,6 +70,9 @@ class FunctionsCreateCommand extends Command {
     }
 
     fs.writeFileSync(functionPath, template)
+
+    const onComplete = require(path.join(templatesDir, templatePath)).onComplete
+    if (onComplete) onComplete() // do whatever the template wants to do after it is scaffolded
   }
 }
 
@@ -94,7 +98,6 @@ FunctionsCreateCommand.flags = {
 module.exports = FunctionsCreateCommand
 
 // prompt for a name if name not supplied
-// we tried using required:true in oclif args (see below) but the error msg was very ugly
 async function getNameFromArgs(args) {
   let { name } = args
   if (!name) {

src/functions-templates/README.md

@@ -8,7 +8,11 @@ we dont colocate this inside `src/commands/functions` because oclif will think i
 
 ## providing metadata (and other functionality)
 
-we split the file based on the `// --- Netlify Template Below -- //` string. everything below it is cloned as the template. everything above it can be required and run as a module for configuring the template. for now we simply export a `metadata` object that fits [`inquirer's choices spec`](https://www.npmjs.com/package/inquirer#question). in future we can think about other options we may want to offer.
+we split the file based on the `// --- Netlify Template Below -- //` string. everything below it is cloned as the template. everything above it can be required and run as a module for configuring the template. for now we simply export a `metadata` object that fits [`inquirer's choices spec`](https://www.npmjs.com/package/inquirer#question). 
+
+once the templating is done we can also call an `onComplete` hook to print a reminder or execute other logic - see `node-fetch.js` for an example.
+
+in future we can think about other options we may want to offer.
 
 ## future dev thoughts
 

src/functions-templates/hello-world.js

@@ -4,6 +4,7 @@ exports.metadata = {
   value: 'hello-world',
   short: 'hello-world'
 }
+// exports.onComplete = () => {} // optional
 // --- Netlify Template Below -- //
 async function hello() {
   return Promise.resolve('Hello, World')

src/functions-templates/node-fetch.js

@@ -4,6 +4,10 @@ exports.metadata = {
   value: 'node-fetch',
   short: 'node-fetch'
 }
+exports.onComplete = () => {
+  console.log(`node-fetch function created from template!`)
+  console.log('REMINDER: make sure to install `node-fetch` if you dont have it.')
+}
 // --- Netlify Template Below -- //
 const fetch = require('node-fetch')
 exports.handler = async function(event, context) {