@cloud-cli/dc 1.1.5 → 1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloud-cli/dc",
-  "version": "1.1.5",
+  "version": "1.2.0",
   "main": "./dist/index.js",
   "description": "Run services with docker compose",
   "type": "module",

package/src/index.ts

@@ -1,14 +1,14 @@
-import { getConfig, init } from "@cloud-cli/cli";
-import { exec } from "@cloud-cli/exec";
-import { existsSync, mkdirSync } from "node:fs";
-import { readFile, readdir, rm, writeFile } from "node:fs/promises";
-import { join } from "node:path";
+import { getConfig, init } from '@cloud-cli/cli';
+import { exec } from '@cloud-cli/exec';
+import { existsSync, mkdirSync } from 'node:fs';
+import { readFile, readdir, rm, writeFile } from 'node:fs/promises';
+import { join } from 'node:path';
 
-const config = getConfig("dc", { storagePath: "docker-compose" });
+const config = getConfig('dc', { storagePath: 'docker-compose' });
 const storagePath = join(process.cwd(), config.storagePath);
-const notFoundError = new Error("Service not found");
+const notFoundError = new Error('Service not found');
 const binaryAndArgs = {
-  binary: "",
+  binary: '',
   args: [],
 };
 
@@ -17,10 +17,10 @@ interface CliOptions {
   content?: string;
 }
 
-const getPath = (name) => join(storagePath, name + ".yml");
+const getPath = (name) => join(storagePath, name + '.yml');
 const checkName = (name) => {
   if (!name) {
-    throw new Error("Name is required");
+    throw new Error('Name is required');
   }
 
   // TODO sanitize file name
@@ -35,10 +35,7 @@ async function stop(options: CliOptions) {
     throw notFoundError;
   }
 
-  const out = await exec(
-    binaryAndArgs.binary,
-    [...binaryAndArgs.args, "-f", path, "down"].filter(Boolean)
-  );
+  const out = await exec(binaryAndArgs.binary, [...binaryAndArgs.args, '-f', path, 'down'].filter(Boolean));
 
   if (out.ok) {
     return true;
@@ -55,10 +52,7 @@ async function start(options: CliOptions) {
     throw notFoundError;
   }
 
-  const out = await exec(
-    binaryAndArgs.binary,
-    [...binaryAndArgs.args, "-f", path, "up", "-d"].filter(Boolean)
-  );
+  const out = await exec(binaryAndArgs.binary, [...binaryAndArgs.args, '-f', path, 'up', '-d'].filter(Boolean));
 
   if (out.ok) {
     return true;
@@ -72,7 +66,7 @@ async function update(options: CliOptions) {
   const { content } = options;
 
   if (!content) {
-    throw new Error("docker compose content is required");
+    throw new Error('docker compose content is required');
   }
 
   const path = getPath(name);
@@ -93,7 +87,7 @@ async function remove(options: CliOptions) {
 
 async function list() {
   const files = await readdir(storagePath, { withFileTypes: true });
-  return files.filter((f) => f.isFile()).map((f) => f.name.replace(".yml", ""));
+  return files.filter((f) => f.isFile()).map((f) => f.name.replace('.yml', ''));
 }
 
 async function show(options: CliOptions) {
@@ -101,7 +95,7 @@ async function show(options: CliOptions) {
   const path = getPath(name);
 
   if (existsSync(path)) {
-    const content = await readFile(path, "utf-8");
+    const content = await readFile(path, 'utf-8');
     return { name, content };
   }
 
@@ -112,22 +106,37 @@ export default {
   async [init]() {
     mkdirSync(storagePath, { recursive: true });
 
-    const docker = await exec("docker", ["compose"]);
+    const docker = await exec('docker', ['compose']);
     if (docker.ok) {
-      binaryAndArgs.binary = "docker";
-      binaryAndArgs.args.push("compose");
+      binaryAndArgs.binary = 'docker';
+      binaryAndArgs.args.push('compose');
       return;
     }
 
-    const dockerCompose = await exec("docker-compose", ["--help"]);
+    const dockerCompose = await exec('docker-compose', ['--help']);
     if (dockerCompose.ok) {
-      binaryAndArgs.binary = "docker-compose";
+      binaryAndArgs.binary = 'docker-compose';
       return;
     }
 
-    binaryAndArgs.binary = "exit";
-    binaryAndArgs.args.push("1");
+    binaryAndArgs.binary = 'exit';
+    binaryAndArgs.args.push('1');
   },
+  help: () => ({
+    description: 'Manage Docker Compose services',
+    commands: {
+      'dc up [name]': 'Start services (optional name to start specific service)',
+      'dc down [name]': 'Stop services (optional name to stop specific service)',
+      'dc list': 'List Compose files/services',
+      'dc show [name]': 'Show content of a Compose file',
+      'dc set [name]': 'Update content of a Compose file',
+      'dc remove [name]': 'Remove a Compose file',
+    },
+    options: {
+      name: 'Service/Compose file name',
+      content: 'Docker Compose YAML content (for set command)',
+    },
+  }),
   start,
   stop,
   update,

package/dist/index.d.ts

@@ -1,24 +0,0 @@
-import { init } from "@cloud-cli/cli";
-interface CliOptions {
-    name: string;
-    content?: string;
-}
-declare function stop(options: CliOptions): Promise<boolean>;
-declare function start(options: CliOptions): Promise<boolean>;
-declare function update(options: CliOptions): Promise<boolean>;
-declare function remove(options: CliOptions): Promise<boolean>;
-declare function list(): Promise<string[]>;
-declare function show(options: CliOptions): Promise<{
-    name: any;
-    content: string;
-}>;
-declare const _default: {
-    [init](): Promise<void>;
-    start: typeof start;
-    stop: typeof stop;
-    update: typeof update;
-    remove: typeof remove;
-    show: typeof show;
-    list: typeof list;
-};
-export default _default;

package/dist/index.js

@@ -1,99 +0,0 @@
-import { getConfig, init } from "@cloud-cli/cli";
-import { exec } from "@cloud-cli/exec";
-import { existsSync, mkdirSync } from "node:fs";
-import { readFile, readdir, rm, writeFile } from "node:fs/promises";
-import { join } from "node:path";
-const config = getConfig("dc", { storagePath: "docker-compose" });
-const storagePath = join(process.cwd(), config.storagePath);
-const notFoundError = new Error("Service not found");
-const binaryAndArgs = {
-    binary: "",
-    args: [],
-};
-const getPath = (name) => join(storagePath, name + ".yml");
-const checkName = (name) => {
-    if (!name) {
-        throw new Error("Name is required");
-    }
-    // TODO sanitize file name
-    return name;
-};
-async function stop(options) {
-    const name = checkName(options.name);
-    const path = getPath(name);
-    if (!existsSync(path)) {
-        throw notFoundError;
-    }
-    const out = await exec(binaryAndArgs.binary, [...binaryAndArgs.args, "-f", path, "down"].filter(Boolean));
-    if (out.ok) {
-        return true;
-    }
-    throw new Error(out.stderr);
-}
-async function start(options) {
-    const name = checkName(options.name);
-    const path = getPath(name);
-    if (!existsSync(path)) {
-        throw notFoundError;
-    }
-    const out = await exec(binaryAndArgs.binary, [...binaryAndArgs.args, "-f", path, "up", "-d"].filter(Boolean));
-    if (out.ok) {
-        return true;
-    }
-    throw new Error(out.stderr);
-}
-async function update(options) {
-    const name = checkName(options.name);
-    const { content } = options;
-    if (!content) {
-        throw new Error("docker compose content is required");
-    }
-    const path = getPath(name);
-    await writeFile(path, String(options.content));
-    return true;
-}
-async function remove(options) {
-    const name = checkName(options.name);
-    const path = getPath(name);
-    if (existsSync(path)) {
-        await rm(path);
-    }
-    return true;
-}
-async function list() {
-    const files = await readdir(storagePath, { withFileTypes: true });
-    return files.filter((f) => f.isFile()).map((f) => f.name.replace(".yml", ""));
-}
-async function show(options) {
-    const name = checkName(options.name);
-    const path = getPath(name);
-    if (existsSync(path)) {
-        const content = await readFile(path, "utf-8");
-        return { name, content };
-    }
-    throw notFoundError;
-}
-export default {
-    async [init]() {
-        mkdirSync(storagePath, { recursive: true });
-        const docker = await exec("docker", ["compose"]);
-        if (docker.ok) {
-            binaryAndArgs.binary = "docker";
-            binaryAndArgs.args.push("compose");
-            return;
-        }
-        const dockerCompose = await exec("docker-compose", ["--help"]);
-        if (dockerCompose.ok) {
-            binaryAndArgs.binary = "docker-compose";
-            return;
-        }
-        binaryAndArgs.binary = "exit";
-        binaryAndArgs.args.push("1");
-    },
-    start,
-    stop,
-    update,
-    remove,
-    show,
-    list,
-};