appwrite-utils-cli 0.10.5 → 0.10.61

package/README.md

@@ -147,6 +147,8 @@ This updated CLI ensures that developers have robust tools at their fingertips t
 
 ## Changelog
 
+- 0.10.61: Fixed ignore haha, also added `ignore` to the `Functions` config, to specify what to ignore when creating the `.tar.gz` file
+- 0.10.051: Added `node_modules` and a few others to the ignore
 - 0.10.05: Made deploy function into deploy function(s) -- so you can do more than one at a time
 - 0.10.04: Fixed stupid progress bar not updating -- also fixed double text
 - 0.10.03: Fixed `syncDb` to push the configurations properly, accidentally hurt it during `synchronizeConfigurations`

package/dist/functions/deployments.d.ts

@@ -1,4 +1,4 @@
 import { Client } from "node-appwrite";
 import { type AppwriteFunction } from "appwrite-utils";
-export declare const deployFunction: (client: Client, functionId: string, codePath: string, activate?: boolean, entrypoint?: string, commands?: string) => Promise<import("node-appwrite").Models.Deployment>;
+export declare const deployFunction: (client: Client, functionId: string, codePath: string, activate?: boolean, entrypoint?: string, commands?: string, ignored?: string[]) => Promise<import("node-appwrite").Models.Deployment>;
 export declare const deployLocalFunction: (client: Client, functionName: string, functionConfig: AppwriteFunction, functionPath?: string) => Promise<import("node-appwrite").Models.Deployment>;

package/dist/functions/deployments.js

@@ -1,7 +1,7 @@
 import { Client, Functions, Runtime } from "node-appwrite";
 import { InputFile } from "node-appwrite/file";
 import { create as createTarball } from "tar";
-import { join } from "node:path";
+import { join, relative } from "node:path";
 import fs from "node:fs";
 import { platform } from "node:os";
 import {} from "appwrite-utils";
@@ -9,6 +9,7 @@ import chalk from "chalk";
 import cliProgress from "cli-progress";
 import { execSync } from "child_process";
 import { createFunction, getFunction, updateFunctionSpecifications, } from "./methods.js";
+import ignore from "ignore";
 const findFunctionDirectory = (basePath, functionName) => {
     const normalizedName = functionName.toLowerCase().replace(/\s+/g, "-");
     const dirs = fs.readdirSync(basePath, { withFileTypes: true });
@@ -26,9 +27,12 @@ const findFunctionDirectory = (basePath, functionName) => {
     }
     return undefined;
 };
-export const deployFunction = async (client, functionId, codePath, activate = true, entrypoint = "index.js", commands = "npm install") => {
+export const deployFunction = async (client, functionId, codePath, activate = true, entrypoint = "index.js", commands = "npm install", ignored = ["node_modules", ".git", ".vscode", ".DS_Store"]) => {
     const functions = new Functions(client);
-    console.log(chalk.blue("📦 Preparing function deployment..."));
+    console.log(chalk.blue("Preparing function deployment..."));
+    // Convert ignored patterns to lowercase for case-insensitive comparison
+    const ignoredLower = ignored.map((pattern) => pattern.toLowerCase());
+    const tarPath = join(process.cwd(), `function-${functionId}.tar.gz`);
     const progressBar = new cliProgress.SingleBar({
         format: "Uploading |" +
             chalk.cyan("{bar}") +
@@ -37,11 +41,15 @@ export const deployFunction = async (client, functionId, codePath, activate = tr
         barIncompleteChar: "░",
         hideCursor: true,
     });
-    const tarPath = join(process.cwd(), `function-${functionId}.tar.gz`);
     await createTarball({
         gzip: true,
         file: tarPath,
         cwd: codePath,
+        filter: (path, stat) => {
+            const relativePath = relative(codePath, join(codePath, path)).toLowerCase();
+            return !ignoredLower.some((pattern) => relativePath.startsWith(pattern) ||
+                relativePath.includes(`/${pattern}`));
+        },
     }, ["."]);
     const fileBuffer = await fs.promises.readFile(tarPath);
     const fileObject = InputFile.fromBuffer(new Uint8Array(fileBuffer), `function-${functionId}.tar.gz`);
@@ -126,5 +134,5 @@ export const deployLocalFunction = async (client, functionName, functionConfig,
     const deployPath = functionConfig.deployDir
         ? join(resolvedPath, functionConfig.deployDir)
         : resolvedPath;
-    return deployFunction(client, functionConfig.$id, deployPath, true, functionConfig.entrypoint, functionConfig.commands);
+    return deployFunction(client, functionConfig.$id, deployPath, true, functionConfig.entrypoint, functionConfig.commands, functionConfig.ignore);
 };

package/package.json

@@ -1,57 +1,58 @@
-{
-  "name": "appwrite-utils-cli",
-  "description": "Appwrite Utility Functions to help with database management, data conversion, data import, migrations, and much more. Meant to be used as a CLI tool, I do not recommend installing this in frontend environments.",
-  "version": "0.10.05",
-  "main": "src/main.ts",
-  "type": "module",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/zachhandley/AppwriteUtils"
-  },
-  "author": "Zach Handley <zach@blackleafdigital.com> (https://zachhandley.com)",
-  "keywords": [
-    "appwrite",
-    "cli",
-    "utils",
-    "migrations",
-    "data",
-    "database",
-    "import",
-    "migration",
-    "utility"
-  ],
-  "bin": {
-    "appwrite-migrate": "./dist/main.js"
-  },
-  "scripts": {
-    "build": "bun run tsc",
-    "start": "tsx --no-cache src/main.ts",
-    "deploy": "bun run build && npm publish --access public",
-    "postinstall": "echo 'This package is intended for CLI use only and should not be added as a dependency in other projects.'"
-  },
-  "dependencies": {
-    "@types/inquirer": "^9.0.7",
-    "appwrite-utils": "^0.3.97",
-    "chalk": "^5.3.0",
-    "cli-progress": "^3.12.0",
-    "commander": "^12.1.0",
-    "inquirer": "^9.3.6",
-    "js-yaml": "^4.1.0",
-    "lodash": "^4.17.21",
-    "luxon": "^3.5.0",
-    "nanostores": "^0.10.3",
-    "node-appwrite": "^14.1.0",
-    "tar": "^7.4.3",
-    "tsx": "^4.17.0",
-    "ulidx": "^2.4.0",
-    "winston": "^3.14.2",
-    "zod": "^3.23.8"
-  },
-  "devDependencies": {
-    "@types/cli-progress": "^3.11.6",
-    "@types/js-yaml": "^4.0.9",
-    "@types/lodash": "^4.17.7",
-    "@types/luxon": "^3.4.2",
-    "typescript": "^5.5.4"
-  }
-}
+{
+  "name": "appwrite-utils-cli",
+  "description": "Appwrite Utility Functions to help with database management, data conversion, data import, migrations, and much more. Meant to be used as a CLI tool, I do not recommend installing this in frontend environments.",
+  "version": "0.10.61",
+  "main": "src/main.ts",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zachhandley/AppwriteUtils"
+  },
+  "author": "Zach Handley <zach@blackleafdigital.com> (https://zachhandley.com)",
+  "keywords": [
+    "appwrite",
+    "cli",
+    "utils",
+    "migrations",
+    "data",
+    "database",
+    "import",
+    "migration",
+    "utility"
+  ],
+  "bin": {
+    "appwrite-migrate": "./dist/main.js"
+  },
+  "scripts": {
+    "build": "bun run tsc",
+    "start": "tsx --no-cache src/main.ts",
+    "deploy": "bun run build && npm publish --access public",
+    "postinstall": "echo 'This package is intended for CLI use only and should not be added as a dependency in other projects.'"
+  },
+  "dependencies": {
+    "@types/inquirer": "^9.0.7",
+    "appwrite-utils": "^0.3.98",
+    "chalk": "^5.3.0",
+    "cli-progress": "^3.12.0",
+    "commander": "^12.1.0",
+    "ignore": "^6.0.2",
+    "inquirer": "^9.3.6",
+    "js-yaml": "^4.1.0",
+    "lodash": "^4.17.21",
+    "luxon": "^3.5.0",
+    "nanostores": "^0.10.3",
+    "node-appwrite": "^14.1.0",
+    "tar": "^7.4.3",
+    "tsx": "^4.17.0",
+    "ulidx": "^2.4.0",
+    "winston": "^3.14.2",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@types/cli-progress": "^3.11.6",
+    "@types/js-yaml": "^4.0.9",
+    "@types/lodash": "^4.17.7",
+    "@types/luxon": "^3.4.2",
+    "typescript": "^5.5.4"
+  }
+}

package/src/functions/deployments.ts

@@ -1,7 +1,7 @@
 import { Client, Functions, Runtime } from "node-appwrite";
 import { InputFile } from "node-appwrite/file";
 import { create as createTarball } from "tar";
-import { join } from "node:path";
+import { join, relative } from "node:path";
 import fs from "node:fs";
 import { platform } from "node:os";
 import { type AppwriteFunction, type Specification } from "appwrite-utils";
@@ -13,6 +13,7 @@ import {
   getFunction,
   updateFunctionSpecifications,
 } from "./methods.js";
+import ignore from "ignore";
 
 const findFunctionDirectory = (
   basePath: string,
@@ -44,10 +45,16 @@ export const deployFunction = async (
   codePath: string,
   activate: boolean = true,
   entrypoint: string = "index.js",
-  commands: string = "npm install"
+  commands: string = "npm install",
+  ignored: string[] = ["node_modules", ".git", ".vscode", ".DS_Store"]
 ) => {
   const functions = new Functions(client);
-  console.log(chalk.blue("📦 Preparing function deployment..."));
+  console.log(chalk.blue("Preparing function deployment..."));
+
+  // Convert ignored patterns to lowercase for case-insensitive comparison
+  const ignoredLower = ignored.map((pattern) => pattern.toLowerCase());
+
+  const tarPath = join(process.cwd(), `function-${functionId}.tar.gz`);
 
   const progressBar = new cliProgress.SingleBar({
     format:
@@ -59,12 +66,22 @@ export const deployFunction = async (
     hideCursor: true,
   });
 
-  const tarPath = join(process.cwd(), `function-${functionId}.tar.gz`);
   await createTarball(
     {
       gzip: true,
       file: tarPath,
       cwd: codePath,
+      filter: (path, stat) => {
+        const relativePath = relative(
+          codePath,
+          join(codePath, path)
+        ).toLowerCase();
+        return !ignoredLower.some(
+          (pattern) =>
+            relativePath.startsWith(pattern) ||
+            relativePath.includes(`/${pattern}`)
+        );
+      },
     },
     ["."]
   );
@@ -209,6 +226,7 @@ export const deployLocalFunction = async (
     deployPath,
     true,
     functionConfig.entrypoint,
-    functionConfig.commands
+    functionConfig.commands,
+    functionConfig.ignore
   );
 };