use metadata for templates

sw-yx · sw-yx · commit b3f4ff9aab3f · 2019-03-15T15:28:14.000-07:00
diff --git a/src/commands/functions/create.js b/src/commands/functions/create.js
@@ -17,12 +17,20 @@ class FunctionsCreateCommand extends Command {
         name: 'templatePath',
         message: 'pick a template',
         type: 'list',
-        choices: templates.map(t => ({ name: path.basename(t, '.js') }))
+        choices: templates.map(t => {
+          return require(path.resolve(__dirname, '../../functions-templates/', t)).metadata
+          // ({ name: path.basename(t, '.js') })
+        })
       }
     ])
-    const template =
-      '// scaffolded from Netlify Dev \n\n' +
-      fs.readFileSync(path.resolve(__dirname, `../../functions-templates/${templatePath}.js`)).toString()
+
+    let template = fs
+      .readFileSync(path.resolve(__dirname, `../../functions-templates/${templatePath}.js`))
+      .toString()
+      .split('// --- Netlify Template Below -- //')
+    if (template.length !== 2) throw new Error('template ' + templatePath + ' badly formatted')
+    template = '// scaffolded from `netlify functions:create` \n' + template[1]
+
     this.log(`Creating function ${name}`)
 
     const functionsDir = flags.functions || (config.build && config.build.functions)
@@ -95,7 +103,9 @@ async function getNameFromArgs(args) {
         name: 'name',
         message: 'name your function: ',
         type: 'input',
-        validate: val => !!val && /^[a-z0-9]+$/i.test(val) // make sure it is not undefined and is alphanumeric
+        validate: val => !!val && /^[\w\-.]+$/i.test(val)
+        // make sure it is not undefined and is a valid filename.
+        // this has some nuance i have ignored, eg crossenv and i18n concerns
       }
     ])
     name = responses.name
diff --git a/src/functions-templates/README.md b/src/functions-templates/README.md
@@ -6,6 +6,10 @@ place new templates here and our CLI will pick it up. currently only works for s
 
 we dont colocate this inside `src/commands/functions` because oclif will think it's a new command.
 
+## 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.
+
 ## future dev thoughts
 
 we will want a way to scale this to TS and Go as well.
diff --git a/src/functions-templates/hello-world.js b/src/functions-templates/hello-world.js
@@ -1,3 +1,10 @@
+// --- Netlify Template Metadata -- //
+exports.metadata = {
+  name: 'Basic Hello World function: shows async/await usage, and proper formatting with statusCode and body',
+  value: 'hello-world',
+  short: 'hello-world'
+}
+// --- Netlify Template Below -- //
 async function hello() {
   return Promise.resolve('Hello, World')
 }
diff --git a/src/functions-templates/node-fetch.js b/src/functions-templates/node-fetch.js
@@ -1,5 +1,12 @@
-import fetch from 'node-fetch'
-export async function handler(event, context) {
+// --- Netlify Template Metadata -- //
+exports.metadata = {
+  name: 'Fetch function: uses node-fetch to hit an external API without CORS issues',
+  value: 'node-fetch',
+  short: 'node-fetch'
+}
+// --- Netlify Template Below -- //
+const fetch = require('node-fetch')
+exports.handler = async function(event, context) {
   try {
     const response = await fetch('https://api.chucknorris.io/jokes/random')
     if (!response.ok) {
