@wocker/core 1.0.4 → 1.0.5

package/README.md

@@ -1 +1,29 @@
 # @wocker/core
+
+###### Docker workspace for web projects
+
+## Installation
+
+**Note:** It is recommended to install Wocker globally to ensure accessibility from any directory in your terminal.
+
+```shell
+npm i -g @wocker/ws
+```
+
+
+### Completion
+
+Wocker comes with shell completion support to enhance your development workflow. To enable shell completion, run the following command:
+
+```bash
+source <(ws completion script)
+```
+
+This will enable tab completion for `ws` commands, providing a more convenient and efficient way to interact with the tool.
+
+
+## Documentation
+
+Wocker is a powerful tool for managing your web project's Docker workspace. It provides a convenient and efficient way to set up and manage your Docker containers.
+
+For more information and detailed usage, please refer to the [documentation](https://kearisp.github.io/wocker).

package/lib/index.d.ts

@@ -3,6 +3,7 @@ export * from "./decorators/Inject";
 export * from "./decorators/Injectable";
 export * from "./makes/Controller";
 export * from "./makes/DI";
+export * from "./makes/FS";
 export * from "./makes/FSManager";
 export * from "./makes/Logger";
 export * from "./makes/Plugin";

package/lib/index.js

@@ -21,6 +21,7 @@ __exportStar(require("./decorators/Inject"), exports);
 __exportStar(require("./decorators/Injectable"), exports);
 __exportStar(require("./makes/Controller"), exports);
 __exportStar(require("./makes/DI"), exports);
+__exportStar(require("./makes/FS"), exports);
 __exportStar(require("./makes/FSManager"), exports);
 __exportStar(require("./makes/Logger"), exports);
 __exportStar(require("./makes/Plugin"), exports);

package/lib/makes/FS.d.ts

@@ -1,7 +1,19 @@
 /// <reference types="node" />
-import { PathOrFileDescriptor } from "fs";
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import { Abortable } from "node:events";
+import { PathLike, PathOrFileDescriptor, WriteFileOptions, RmOptions, MakeDirectoryOptions } from "fs";
+type ReadFileOptions = Abortable & {
+    encoding?: BufferEncoding;
+    flag?: string;
+};
 declare class FS {
-    static readJSON(filePath: PathOrFileDescriptor): Promise<any>;
-    static writeJSON(filePath: PathOrFileDescriptor, data: any): Promise<void>;
+    static mkdir(path: PathLike, options?: MakeDirectoryOptions): Promise<unknown>;
+    static readFile(filePath: PathOrFileDescriptor, options?: ReadFileOptions): Promise<string | Buffer>;
+    static writeFile(filePath: PathOrFileDescriptor, data: string | NodeJS.ArrayBufferView, options?: WriteFileOptions): Promise<unknown>;
+    static readJSON(...paths: string[]): Promise<any>;
+    static writeJSON(filePath: PathOrFileDescriptor, data: any, options?: WriteFileOptions): Promise<void>;
+    static rm(path: PathLike, options?: RmOptions): Promise<void>;
 }
 export { FS };

package/lib/makes/FS.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -11,10 +34,57 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FS = void 0;
 const fs_1 = require("fs");
+const Path = __importStar(require("path"));
 class FS {
-    static readJSON(filePath) {
+    static mkdir(path, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                (0, fs_1.mkdir)(path, options, (err) => {
+                    if (err) {
+                        reject(err);
+                        return;
+                    }
+                    resolve(undefined);
+                });
+            });
+        });
+    }
+    static readFile(filePath, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                (0, fs_1.readFile)(filePath, options, (err, res) => {
+                    if (err) {
+                        reject(err);
+                        return;
+                    }
+                    resolve(res);
+                });
+            });
+        });
+    }
+    static writeFile(filePath, data, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                const callback = (err) => {
+                    if (err) {
+                        reject(err);
+                        return;
+                    }
+                    resolve(undefined);
+                };
+                if (options) {
+                    (0, fs_1.writeFile)(filePath, data, options, callback);
+                }
+                else {
+                    (0, fs_1.writeFile)(filePath, data, callback);
+                }
+            });
+        });
+    }
+    static readJSON(...paths) {
         return __awaiter(this, void 0, void 0, function* () {
             const res = yield new Promise((resolve, reject) => {
+                const filePath = Path.join(...paths);
                 (0, fs_1.readFile)(filePath, (err, data) => {
                     if (err) {
                         reject(err);
@@ -26,17 +96,42 @@ class FS {
             return JSON.parse(res.toString());
         });
     }
-    static writeJSON(filePath, data) {
+    static writeJSON(filePath, data, options) {
         return __awaiter(this, void 0, void 0, function* () {
             const json = JSON.stringify(data, null, 4);
             return new Promise((resolve, reject) => {
-                (0, fs_1.writeFile)(filePath, json, (err) => {
+                const callback = (err) => {
                     if (err) {
                         reject(err);
                         return;
                     }
                     resolve(undefined);
-                });
+                };
+                if (options) {
+                    (0, fs_1.writeFile)(filePath, json, options, callback);
+                }
+                else {
+                    (0, fs_1.writeFile)(filePath, json, callback);
+                }
+            });
+        });
+    }
+    static rm(path, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                const callback = (err) => {
+                    if (err) {
+                        reject(err);
+                        return;
+                    }
+                    resolve(undefined);
+                };
+                if (options) {
+                    (0, fs_1.rm)(path, options, callback);
+                }
+                else {
+                    (0, fs_1.rm)(path, callback);
+                }
             });
         });
     }

package/lib/makes/Logger.d.ts

@@ -3,7 +3,7 @@ declare class Logger {
     static install(di: DI): void;
     static log(...data: any[]): void;
     static info(...data: any[]): void;
-    static warning(...data: any[]): void;
+    static warn(...data: any[]): void;
     static error(...data: any[]): void;
 }
 export { Logger };

package/lib/makes/Logger.js

@@ -13,8 +13,8 @@ class Logger {
     static info(...data) {
         _di.resolveService(LogService_1.LogService).info(...data);
     }
-    static warning(...data) {
-        _di.resolveService(LogService_1.LogService).warning(...data);
+    static warn(...data) {
+        _di.resolveService(LogService_1.LogService).warn(...data);
     }
     static error(...data) {
         _di.resolveService(LogService_1.LogService).error(...data);

package/lib/models/Project.d.ts

@@ -17,14 +17,20 @@ declare class Project {
     scripts?: string[];
     buildArgs?: EnvConfig;
     env: EnvConfig;
-    volumes?: string[];
     ports?: string[];
+    volumes?: string[];
+    metadata?: EnvConfig;
     static di?: DI;
     constructor(data: any);
+    get containerName(): string;
     hasEnv(name: string): boolean;
     getEnv(name: string, defaultValue?: string): string | undefined;
     setEnv(name: string, value: string | boolean): void;
     unsetEnv(name: string): void;
+    hasMeta(name: string): boolean;
+    getMeta<D = string | undefined>(name: string, defaultValue?: D): D;
+    setMeta(name: string, value: string | boolean): void;
+    unsetMeta(name: string): void;
     volumeMount(...volumes: string[]): void;
     getVolumeBySource(source: string): string | undefined;
     getVolumeByDestination(destination: string): string | undefined;

package/lib/models/Project.js

@@ -30,6 +30,10 @@ class Project {
         this.env = data.env || {};
         this.ports = data.ports;
         this.volumes = data.volumes;
+        this.metadata = data.metadata;
+    }
+    get containerName() {
+        return `${this.name}.workspace`;
     }
     hasEnv(name) {
         if (!this.env) {
@@ -51,6 +55,29 @@ class Project {
             delete this.env[name];
         }
     }
+    hasMeta(name) {
+        return !!this.metadata && this.metadata.hasOwnProperty(name);
+    }
+    getMeta(name, defaultValue) {
+        const { [name]: value = defaultValue } = this.metadata || {};
+        return value;
+    }
+    setMeta(name, value) {
+        if (!this.metadata) {
+            this.metadata = {};
+        }
+        this.metadata[name] = typeof value === "boolean"
+            ? (value ? "true" : "false")
+            : value;
+    }
+    unsetMeta(name) {
+        if (this.metadata && name in this.metadata) {
+            delete this.metadata[name];
+        }
+        if (this.metadata && Object.keys(this.metadata).length === 0) {
+            delete this.metadata;
+        }
+    }
     volumeMount(...volumes) {
         if (volumes.length === 0) {
             return;

package/lib/services/LogService.d.ts

@@ -1,7 +1,7 @@
 declare abstract class LogService {
     abstract log(...data: any[]): void;
     abstract info(...data: any[]): void;
-    abstract warning(...data: any[]): void;
+    abstract warn(...data: any[]): void;
     abstract error(...data: any[]): void;
 }
 export { LogService };

package/lib/services/ProjectService.d.ts

@@ -1,3 +1,4 @@
+import { Container } from "dockerode";
 import { Project } from "../models/Project";
 type SearchParams = Partial<{
     id: string;
@@ -7,6 +8,7 @@ type SearchParams = Partial<{
 declare abstract class ProjectService {
     abstract cdProject(name: string): Promise<void>;
     abstract get(): Promise<Project>;
+    abstract getContainer(): Promise<Container | null>;
     abstract start(project: Project): Promise<void>;
     abstract stop(project: Project): Promise<void>;
     abstract save(project: Project): Promise<void>;

package/package.json

@@ -1,11 +1,22 @@
 {
     "name": "@wocker/core",
-    "version": "1.0.4",
+    "version": "1.0.5",
     "author": "Kris Papercut <krispcut@gmail.com>",
-    "description": "Wocker Core",
+    "description": "Core of wocker",
     "license": "MIT",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
+    "keywords": [
+        "wocker"
+    ],
+    "homepage": "https://kearisp.github.io/wocker",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/kearisp/wocker-core.git"
+    },
+    "bugs": {
+        "url": "https://github.com/kearisp/wocker-core/issues"
+    },
     "scripts": {
         "prepare": "npm run build",
         "watch": "tsc -w",
@@ -13,14 +24,14 @@
         "test": "echo \"Error: no test specified\" && exit 1"
     },
     "dependencies": {
-        "@kearisp/cli": "^1.0.3",
+        "@kearisp/cli": "^1.0.5",
         "fs": "^0.0.1-security",
         "path": "^0.12.7",
-        "reflect-metadata": "^0.1.13"
+        "reflect-metadata": "^0.2.1"
     },
     "devDependencies": {
         "@types/dockerode": "^3.3.23",
-        "@types/node": "^20.8.9",
-        "typescript": "^5.2.2"
+        "@types/node": "^20.11.7",
+        "typescript": "^5.3.3"
     }
 }