Use manifest to declare input values (#27)

Author: satyarohith

README.md

@@ -69,11 +69,13 @@ package = "netlify-plugin-nimbella"
 You may provide additional configuration in the `netlify.toml` file to configure the resources available to your serverless functions, or to configure the API path for your functions. Here is an example.
 
 ```toml
-[nimbella]
+[[plugins]]
+package = "netlify-plugin-nimbella"
+[plugins.inputs]
 functions = "functions" # Functions source directory. Use this if you would like to use Nimbella to deploy your functions.
-timeout = 6000 # Function timeout limit in milliseconds.
 memory = 256 # Function memory limit in MB.
 path = "/api/" # The prefix path to access your deployed packages.
+timeout = 6000 # Function timeout limit in milliseconds.
 ```
 
 ## Usage
@@ -112,13 +114,13 @@ You will invoke the function `auth/login.js` via the API end point `https://your
 
 You can deploy your existing Netlify Functions to Nimbella Cloud with very minimal changes.
 
-Move the `functions` property under `build` to `nimbella` inside `netlify.toml`.
+Specify the `functions` input value under `[plugins.inputs]` inside `netlify.toml`.
 
 ```diff
-[build]
--functions = './functions'
-+[nimbella]
-+functions = './functions' # Source directory
+[[plugins]]
+package = "netlify-plugin-nimbella"
++ [plugins.inputs]
++ functions = "functions" # Functions source directory. Use this if you would like to use Nimbella to deploy your functions.
 ```
 
 This plugin builds your functions using a modified version of [netlify-lambda](https://github.com/netlify/netlify-lambda). You can get rid of any build steps you're performing on functions since the plugin handles it for you.

index.js

@@ -9,12 +9,6 @@ const functionsBuildDir = `functions-build-${Date.now()}`;
 let netlifyToml = {};
 let isProject = false;
 let isActions = false;
-let options = {
-  functions: '',
-  timeout: 6000,
-  memory: 256,
-  path: '/api/'
-};
 
 // Disable auto updates of nim.
 process.env.NIM_DISABLE_AUTOUPDATE = '1';
@@ -62,7 +56,7 @@ async function deployActions({run, functionsDir, timeout, memory}) {
 
 module.exports = {
   // Execute before build starts.
-  onPreBuild: async ({utils, constants}) => {
+  onPreBuild: async ({utils, constants, inputs}) => {
     try {
       if (!process.env.NIMBELLA_LOGIN_TOKEN) {
         utils.build.failBuild(
@@ -89,34 +83,30 @@ module.exports = {
 
       if (constants.CONFIG_PATH && existsSync(constants.CONFIG_PATH)) {
         netlifyToml = toml.parse(await readFile(constants.CONFIG_PATH));
-
-        if (netlifyToml.nimbella) {
-          options = {...options, ...netlifyToml.nimbella};
-        }
       }
 
-      isActions = options.functions ? existsSync(options.functions) : false;
+      isActions = inputs.functions ? existsSync(inputs.functions) : false;
       isProject = existsSync('packages');
     } catch (error) {
       utils.build.failBuild(error.message);
     }
   },
   // Build the functions
-  onBuild: async ({utils}) => {
+  onBuild: async ({utils, inputs}) => {
     try {
       if (isActions) {
-        // Here we're passing the build directory instead of source because source is extracted from options.functions.
+        // Here we're passing the build directory instead of source because source is extracted from inputs.functions.
         const stats = await build.run(functionsBuildDir);
         console.log(stats.toString(stats.compilation.options.stats));
         // Copy any files that do not end with .js. T
-        cpx.copy(options.functions + '/**/*.!(js)', functionsBuildDir);
+        cpx.copy(inputs.functions + '/**/*.!(js)', functionsBuildDir);
       }
     } catch (error) {
       utils.build.failBuild(error.message);
     }
   },
   // Execute after build is done.
-  onPostBuild: async ({constants, utils}) => {
+  onPostBuild: async ({constants, utils, inputs}) => {
     try {
       const {stdout: namespace} = await utils.run.command(
         `npx nim auth current`
@@ -131,8 +121,8 @@ module.exports = {
           await deployActions({
             run: utils.run,
             functionsDir: functionsBuildDir,
-            timeout: options.timeout, // Default is 6 seconds
-            memory: options.memory // Default is 256MB (max for free tier)
+            timeout: inputs.timeout, // Default is 6 seconds
+            memory: inputs.memory // Default is 256MB (max for free tier)
           });
         }
       } else {
@@ -175,7 +165,7 @@ module.exports = {
         }
       }
 
-      let {path: redirectPath} = options;
+      let {path: redirectPath} = inputs;
       redirectPath = redirectPath.endsWith('/')
         ? redirectPath
         : redirectPath + '/';

manifest.yml

@@ -1 +1,13 @@
 name: netlify-plugin-nimbella
+inputs:
+  - name: functions
+    description: The source directory of the functions.
+  - name: timeout
+    description: Timeout LIMIT in milliseconds after which the function is terminated (functions input value is required to utilize this option).
+    default: 6000
+  - name: memory
+    description: Maximum memory LIMIT in MB for the function (functions input value is required to utilize this option).
+    default: 256
+  - name: path
+    description: The API prefix path you would like to use to access your functions.
+    default: '/api/'