do-functions-cli 1.4.0 → 1.5.1

package/README.md

@@ -82,6 +82,39 @@ your-project/
 └── project.yml                 # DigitalOcean project configuration
 ```
 
+## Bundling with esbuild
+
+The generated function templates include [esbuild](https://esbuild.github.io/) for bundling your code. This ensures compatibility with DigitalOcean Functions by:
+
+- **Bundling all dependencies** — All `node_modules` are bundled into a single file (`dist/bundle.js`)
+- **CommonJS output** — Code is transpiled to CommonJS format (`--format=cjs`) for compatibility with the DigitalOcean Functions runtime
+- **Node.js 18 targeting** — The bundle is optimized for Node.js 18 (`--target=node18`)
+- **Minification** — Output is minified to reduce file size and improve cold start times
+
+### Build Script
+
+Each function includes a `build` script in `package.json`:
+
+```bash
+# JavaScript
+esbuild ./index.js --bundle --platform=node --target=node18 --format=cjs --outfile=./dist/bundle.js --minify
+
+# TypeScript (includes type checking)
+tsc --noEmit && esbuild ./index.ts --bundle --platform=node --target=node18 --format=cjs --outfile=./dist/bundle.js --minify
+```
+
+DigitalOcean automatically runs `npm run build` during deployment, so you don't need to build manually before deploying.
+
+### The .include File
+
+Each function contains a `.include` file that tells DigitalOcean which files to include in the deployed function. By default, it points to the bundled output:
+
+```
+dist/bundle.js
+```
+
+This means only the bundled file is deployed, keeping your function package small and fast.
+
 ## project.yml Configuration
 
 The CLI automatically manages your `project.yml` file:
@@ -97,7 +130,7 @@ packages:
 
 ## Requirements
 
-- Node.js 18 or later
+- Node.js 20.12.0 or later
 - npm or compatible package manager
 
 ## Roadmap

package/dist/cli.js

@@ -3,13 +3,9 @@ import { Command } from 'commander';
 import fs from 'fs-extra/esm';
 import createCommand from './commands/create.js';
 const packageJson = await fs.readJSON(new URL('../package.json', import.meta.url));
-const cliVersion = packageJson.version;
 // Initialize the main CLI program
 const program = new Command();
-program
-    .name('do-functions-cli')
-    .description('CLI tool for managing DigitalOcean serverless functions')
-    .version(cliVersion);
+program.name(packageJson.name).description(packageJson.description).version(packageJson.version);
 // Register the 'create' command for creating new serverless functions
 program.addCommand(createCommand);
 // Parse command-line arguments and execute

package/dist/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,MAAM,cAAc,CAAC;AAE9B,OAAO,aAAa,MAAM,sBAAsB,CAAC;AAEjD,MAAM,WAAW,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACnF,MAAM,UAAU,GAAG,WAAW,CAAC,OAAO,CAAC;AAEvC,kCAAkC;AAClC,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAC9B,OAAO;KACJ,IAAI,CAAC,kBAAkB,CAAC;KACxB,WAAW,CAAC,yDAAyD,CAAC;KACtE,OAAO,CAAC,UAAU,CAAC,CAAC;AAEvB,sEAAsE;AACtE,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AAElC,2CAA2C;AAC3C,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAE5B;;;;GAIG;AACH,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,CAAC,KAAK,EAAE,EAAE;IACxC,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;QAC/D,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;QACnC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,MAAM,cAAc,CAAC;AAE9B,OAAO,aAAa,MAAM,sBAAsB,CAAC;AAEjD,MAAM,WAAW,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAEnF,kCAAkC;AAClC,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAC9B,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEjG,sEAAsE;AACtE,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AAElC,2CAA2C;AAC3C,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAE5B;;;;GAIG;AACH,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,CAAC,KAAK,EAAE,EAAE;IACxC,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;QAC/D,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;QACnC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC"}

package/dist/schemas/doFunction.d.ts

@@ -1,12 +1,15 @@
 import * as z from 'zod';
 /**
  * Zod schema for validating a DigitalOcean function entry in project.yml
+ *
+ * Uses .passthrough() to preserve custom properties (e.g., environment variables,
+ * limits, annotations) that may exist in function configurations
  */
 export declare const DOFunctionSchema: z.ZodObject<{
     name: z.ZodString;
     runtime: z.ZodOptional<z.ZodString>;
     web: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-}, z.core.$strip>;
+}, z.core.$loose>;
 /**
  * TypeScript type derived from the DOFunctionSchema
  */

package/dist/schemas/doFunction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"doFunction.d.ts","sourceRoot":"","sources":["../../src/schemas/doFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;iBAI3B,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC"}
+{"version":3,"file":"doFunction.d.ts","sourceRoot":"","sources":["../../src/schemas/doFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB;;;;iBAMb,CAAC;AAEjB;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC"}

package/dist/schemas/doFunction.js

@@ -1,10 +1,15 @@
 import * as z from 'zod';
 /**
  * Zod schema for validating a DigitalOcean function entry in project.yml
+ *
+ * Uses .passthrough() to preserve custom properties (e.g., environment variables,
+ * limits, annotations) that may exist in function configurations
  */
-export const DOFunctionSchema = z.object({
+export const DOFunctionSchema = z
+    .object({
     name: z.string(),
     runtime: z.string().optional(),
     web: z.boolean().optional().default(true),
-});
+})
+    .passthrough();
 //# sourceMappingURL=doFunction.js.map

package/dist/schemas/doFunction.js.map

@@ -1 +1 @@
-{"version":3,"file":"doFunction.js","sourceRoot":"","sources":["../../src/schemas/doFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,GAAG,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;CAC1C,CAAC,CAAC"}
+{"version":3,"file":"doFunction.js","sourceRoot":"","sources":["../../src/schemas/doFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,GAAG,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;CAC1C,CAAC;KACD,WAAW,EAAE,CAAC"}

package/dist/schemas/doPackage.d.ts

@@ -5,6 +5,8 @@ import * as z from 'zod';
  * Properties:
  * - name: The package name (required, used for namespacing functions)
  * - functions: Array of functions belonging to this package (defaults to empty array)
+ *
+ * Uses .passthrough() to preserve custom properties that may exist in package configurations
  */
 export declare const DOPackageSchema: z.ZodObject<{
     name: z.ZodString;
@@ -12,8 +14,8 @@ export declare const DOPackageSchema: z.ZodObject<{
         name: z.ZodString;
         runtime: z.ZodOptional<z.ZodString>;
         web: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-    }, z.core.$strip>>>>;
-}, z.core.$strip>;
+    }, z.core.$loose>>>>;
+}, z.core.$loose>;
 /**
  * TypeScript type derived from the DOPackageSchema
  */

package/dist/schemas/doPackage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"doPackage.d.ts","sourceRoot":"","sources":["../../src/schemas/doPackage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAIzB;;;;;;GAMG;AACH,eAAO,MAAM,eAAe;;;;;;;iBAG1B,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC"}
+{"version":3,"file":"doPackage.d.ts","sourceRoot":"","sources":["../../src/schemas/doPackage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAIzB;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe;;;;;;;iBAKZ,CAAC;AAEjB;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC"}

package/dist/schemas/doPackage.js

@@ -6,9 +6,13 @@ import { DOFunctionSchema } from './doFunction.js';
  * Properties:
  * - name: The package name (required, used for namespacing functions)
  * - functions: Array of functions belonging to this package (defaults to empty array)
+ *
+ * Uses .passthrough() to preserve custom properties that may exist in package configurations
  */
-export const DOPackageSchema = z.object({
+export const DOPackageSchema = z
+    .object({
     name: z.string(),
     functions: z.array(DOFunctionSchema).optional().default([]),
-});
+})
+    .passthrough();
 //# sourceMappingURL=doPackage.js.map

package/dist/schemas/doPackage.js.map

@@ -1 +1 @@
-{"version":3,"file":"doPackage.js","sourceRoot":"","sources":["../../src/schemas/doPackage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAEnD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;CAC5D,CAAC,CAAC"}
+{"version":3,"file":"doPackage.js","sourceRoot":"","sources":["../../src/schemas/doPackage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAEnD;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC;KAC7B,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;CAC5D,CAAC;KACD,WAAW,EAAE,CAAC"}

package/dist/schemas/doProjectYml.d.ts

@@ -4,6 +4,9 @@ import * as z from 'zod';
  *
  * Properties:
  * - packages: Array of packages that make up the project (defaults to empty array)
+ *
+ * Uses .passthrough() to preserve custom properties (e.g., environment, targetNamespace)
+ * that may exist in the project.yml file
  */
 export declare const DOProjectYmlSchema: z.ZodObject<{
     packages: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -12,9 +15,9 @@ export declare const DOProjectYmlSchema: z.ZodObject<{
             name: z.ZodString;
             runtime: z.ZodOptional<z.ZodString>;
             web: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-        }, z.core.$strip>>>>;
-    }, z.core.$strip>>>>;
-}, z.core.$strip>;
+        }, z.core.$loose>>>>;
+    }, z.core.$loose>>>>;
+}, z.core.$loose>;
 /**
  * TypeScript type derived from the DOProjectYmlSchema
  */

package/dist/schemas/doProjectYml.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"doProjectYml.d.ts","sourceRoot":"","sources":["../../src/schemas/doProjectYml.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAIzB;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;iBAE7B,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC"}
+{"version":3,"file":"doProjectYml.d.ts","sourceRoot":"","sources":["../../src/schemas/doProjectYml.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAIzB;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;iBAIf,CAAC;AAEjB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC"}

package/dist/schemas/doProjectYml.js

@@ -5,8 +5,13 @@ import { DOPackageSchema } from './doPackage.js';
  *
  * Properties:
  * - packages: Array of packages that make up the project (defaults to empty array)
+ *
+ * Uses .passthrough() to preserve custom properties (e.g., environment, targetNamespace)
+ * that may exist in the project.yml file
  */
-export const DOProjectYmlSchema = z.object({
+export const DOProjectYmlSchema = z
+    .object({
     packages: z.array(DOPackageSchema).optional().default([]),
-});
+})
+    .passthrough();
 //# sourceMappingURL=doProjectYml.js.map

package/dist/schemas/doProjectYml.js.map

@@ -1 +1 @@
-{"version":3,"file":"doProjectYml.js","sourceRoot":"","sources":["../../src/schemas/doProjectYml.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;CAC1D,CAAC,CAAC"}
+{"version":3,"file":"doProjectYml.js","sourceRoot":"","sources":["../../src/schemas/doProjectYml.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,MAAM,CAAC;IACN,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;CAC1D,CAAC;KACD,WAAW,EAAE,CAAC"}

package/package.json

@@ -1,13 +1,21 @@
 {
   "name": "do-functions-cli",
-  "version": "1.4.0",
+  "version": "1.5.1",
+  "description": "CLI tool for scaffolding DigitalOcean Serverless Functions with JavaScript and TypeScript templates, automatic dependency installation, and project.yml configuration.",
   "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/grantchatterton/do-functions-cli.git"
   },
+  "homepage": "https://github.com/grantchatterton/do-functions-cli#readme",
+  "bugs": {
+    "url": "https://github.com/grantchatterton/do-functions-cli/issues"
+  },
   "author": "Grant Chatterton",
   "license": "MIT",
+  "engines": {
+    "node": ">=20.12.0"
+  },
   "bin": {
     "do-functions-cli": "dist/cli.js"
   },
@@ -48,13 +56,20 @@
     "templates"
   ],
   "keywords": [
+    "digitalocean",
+    "serverless",
     "functions",
-    "utility",
-    "typescript",
+    "faas",
     "cli",
-    "npm",
-    "do",
-    "digitalocean",
-    "serverless"
+    "scaffold",
+    "generator",
+    "typescript",
+    "javascript",
+    "nodejs",
+    "cloud-functions",
+    "serverless-functions",
+    "do-functions",
+    "function-template",
+    "project-generator"
   ]
 }