@jrc03c/gt-cli 0.1.5 → 0.1.6

package/README.md

@@ -89,16 +89,39 @@ gt request <path> -H "X-Custom:value"         # Add custom headers
 
 ```json
 {
+  "email": "you@example.com",
+  "password": "your-password",
   "programs": {
-    "my-program": {
-      "id": 12345,
-      "key": "abc1234"
+    "abc1234": {
+      "file": "my-program.gt",
+      "id": 12345
     }
   }
 }
 ```
 
-This file is gitignored. It maps local program file names to their server-side IDs and keys.
+Programs are keyed by their 7-character program key, and each entry maps to a local `.gt` file and its server-side numeric ID.
+
+The `email` and `password` fields are optional — they provide an alternative to environment variables for authentication (see [Authentication](#authentication) above).
+
+> **NOTE:** 🚨 If storing `email` and `password` values in `gt.config.json`, then **DO NOT** commit that file to the repository history! Instead, add `gt.config.json` to your `.gitignore` file.
+
+### Separate push and pull files
+
+If you use a build step to transform your `.gt` files before pushing, you can specify separate source and dist paths:
+
+```json
+{
+  "programs": {
+    "abc1234": {
+      "file": { "src": "src/program.gt", "dist": "dist/program.gt" },
+      "id": 12345
+    }
+  }
+}
+```
+
+With this configuration, `gt pull` writes to `src/program.gt` and `gt push` reads from `dist/program.gt`.
 
 ## Development
 

package/dist/index.js

@@ -9,6 +9,12 @@ var ENVIRONMENT_HOSTS = {
   stage: "https://guidedtrack-stage.herokuapp.com",
   production: "https://www.guidedtrack.com"
 };
+function getPullFile(ref) {
+  return typeof ref.file === "string" ? ref.file : ref.file.src;
+}
+function getPushFile(ref) {
+  return typeof ref.file === "string" ? ref.file : ref.file.dist;
+}
 
 // src/lib/api.ts
 function buildAuthHeader(credentials) {
@@ -300,7 +306,7 @@ function registerBuild(program2) {
       process.exit(1);
     }
     for (const [key, ref] of entries) {
-      await buildProgram(ref.file, key, credentials, environment);
+      await buildProgram(getPushFile(ref), key, credentials, environment);
     }
   });
 }
@@ -433,7 +439,7 @@ function registerInit(program2) {
       console.log("No .gt files found.");
       return;
     }
-    const linkedFiles = new Set(Object.values(programs).map((p) => p.file));
+    const linkedFiles = new Set(Object.values(programs).map((p) => getPullFile(p)));
     for (const file of files) {
       if (linkedFiles.has(file)) {
         console.log(`
@@ -487,7 +493,7 @@ Found "${file}"`);
       console.log(`found! ("${found.name}")`);
       if (programs[found.key]) {
         console.log(
-          `Program "${found.name}" is already linked to "${programs[found.key].file}", skipping.`
+          `Program "${found.name}" is already linked to "${getPullFile(programs[found.key])}", skipping.`
         );
         continue;
       }
@@ -722,15 +728,16 @@ function registerPull(program2) {
     }
     console.log(`Pulling from ${environment}...`);
     for (const [, ref] of entries) {
+      const pullFile = getPullFile(ref);
       process.stdout.write(
-        `>> Downloading "${ref.file}" (id: ${ref.id})... `
+        `>> Downloading "${pullFile}" (id: ${ref.id})... `
       );
       const source = await fetchProgramSource(
         ref.id,
         credentials,
         environment
       );
-      await writeFile3(resolve3(process.cwd(), ref.file), source);
+      await writeFile3(resolve3(process.cwd(), pullFile), source);
       console.log("done");
     }
   });
@@ -765,11 +772,12 @@ function registerPush(program2) {
     console.log(`Pushing to ${environment}...`);
     const pushed = [];
     for (const [key, ref] of entries) {
+      const pushFile = getPushFile(ref);
       process.stdout.write(
-        `>> Updating "${ref.file}" (id: ${ref.id})... `
+        `>> Updating "${pushFile}" (id: ${ref.id})... `
       );
       const contents = await readFile2(
-        resolve4(process.cwd(), ref.file),
+        resolve4(process.cwd(), pushFile),
         "utf-8"
       );
       await apiRequest(`/programs/${ref.id}.json`, {
@@ -779,7 +787,7 @@ function registerPush(program2) {
         body: { contents, program: { description: "" } }
       });
       console.log("done");
-      pushed.push({ file: ref.file, key });
+      pushed.push({ file: pushFile, key });
     }
     if (options.build && pushed.length > 0) {
       console.log("\nBuilding pushed programs...");

package/package.json

@@ -39,5 +39,5 @@
     "test:watch": "vitest"
   },
   "type": "module",
-  "version": "0.1.5"
+  "version": "0.1.6"
 }