@wocker/ws 1.0.1 → 1.0.3

package/README.md

@@ -1,155 +1,29 @@
-# Wocker
+# @wocker/ws
 
 ###### Docker workspace for web projects
 
-## Requirements
+## Installation
 
-- [node.js](https://nodejs.org)
-- [docker](https://www.docker.com)
-
-
-## Usage
-
-### Installation
+**Note:** It is recommended to install Wocker globally to ensure accessibility from any directory in your terminal.
 
 ```shell
 npm i -g @wocker/ws
 ```
 
-### Project initialization
-
-```text
-127.0.0.1 <domain>
-```
-
-```shell
-cd /project-dir
-ws init
-ws domain:add <domain>
-```
-
-### Starting project container
-
-```shell
-ws start -d
-```
-
-Options:
-- --detach, -d -
-
-[//]: # (TODO)
-
-
-### Proxy
-
-```shell
-ws proxy:start
-```
-
-#### Logs
-
-```shell
-ws proxy:logs
-```
-
-
-### Mariadb
-
-#### Installation
-
-To access the following services within the workspace, please add the following entries to your hosts file:
-
-```text
-127.0.0.1 maildev.workspace
-127.0.0.1 dbadmin-mariadb.workspace
-```
-
-
-#### Start Mariadb
-
-```shell
-ws maridb:start
-```
-
-### Backup db
-
-The `mariadb:backup` command is used to create a backup of a MariaDB database.
-
-```shell
-ws mariadb:backup [database]
-```
-
-#### Backup Location
-
-The backup file will be saved in the following directory:
-
-> $WS_DIR/plugins/mariadb/dump/**\[dbname]**/yyyy-MM-dd HH-mm.sql
-
-
-### Delete backup
-
-The `mariadb:delete-backup` command will remove file from `$WS_DIR` directory.
-
-```shell
-ws mariadb:delete-backup [database] [filename]
-```
-
-### Dump
-
-The `mariadb:dump` command is used to dump a MariaDB database to a file.
-
-```shell
-ws mairadb:dump [database] > dump.sql
-```
-
-
-## Technologies
-
-- [typescript](https://www.typescriptlang.org)
-- [dockerode](https://npmjs.org/package/dockerode)
-
-
-## Environments
-
-You can add `WS_DIR` into `.bashrc` for changing ws data path.
-
-```shell
-export WS_DIR="$HOME/.workspace"
-```
-
 
 ### 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.
 
-## Folders structure
 
-```text
-├── bin/
-├── plugins/
-│   ├── localtunnel/
-│   ├── maildev/
-│   ├── mariadb/
-│   └── ngrok/
-├── presets/
-│   ├── apache/
-│   ├── go/
-│   ├── node/
-│   └── shopify/
-├── plugins/
-└── src/
-    ├── makes/
-    │   └── index.ts
-    ├── models/
-    │   └── index.ts
-    ├── types/
-    │   └── index.ts
-    ├── utils/
-    │   └── index.ts
-    ├── App.ts
-    ├── env.ts
-    └── index.ts 
-```
+## 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/bin/ws.js

@@ -4,10 +4,14 @@ const chalk = require("chalk");
 const {app} = require("../lib/index.js");
 
 
-app.run().then((res) => {
-    if(res) {
-        process.stdout.write(res);
+app.run(process.argv).then((res) => {
+    if(!res) {
+        return;
     }
+
+    process.stdout.write(res);
 }).catch((err) => {
     console.error(chalk.red(err.message));
+
+    // throw err;
 });

package/lib/App.d.ts

@@ -1,13 +1,16 @@
+import { Controller } from "@wocker/core";
 import { Cli } from "@kearisp/cli";
-import { Controller, Plugin } from "src/makes";
-import { AppConfigService } from "src/services";
+import { DI } from "./makes";
+import { AppConfigService } from "./services";
 export declare class App {
-    protected config: AppConfigService;
+    protected di: DI;
     protected cli: Cli;
-    constructor(config: AppConfigService);
+    protected appConfigService: AppConfigService;
+    constructor();
     install(): void;
-    useController(controller: Controller): void;
-    usePlugin(plugin: Plugin): void;
-    setDebug(status: string): Promise<void>;
+    use(Constructor: {
+        new (...params: any[]): Controller;
+    }): void;
+    setDebug(status: string): Promise<string>;
     run(): Promise<string>;
 }

package/lib/App.js

@@ -1,52 +1,107 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
+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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.App = void 0;
-var Path = _interopRequireWildcard(require("path"));
-var _cli = require("@kearisp/cli");
-var _env = require("./env");
-var _utils = require("./utils");
-var _makes = require("./makes");
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+const cli_1 = require("@kearisp/cli");
+const Path = __importStar(require("path"));
+const env_1 = require("./env");
+const utils_1 = require("./utils");
+const makes_1 = require("./makes");
+const services_1 = require("./services");
+const controllers_1 = require("./controllers");
 class App {
-  constructor(config) {
-    this.config = config;
-    this.cli = new _cli.Cli(_makes.Logger);
-    this.install();
-  }
-  install() {
-    this.cli.command("completion script").help(false).action(() => this.cli.completionScript());
-    this.cli.command("debug <status>").completion("status", () => ["on", "off"]).action(async (options, status) => this.setDebug(status));
-  }
-  useController(controller) {
-    controller.install(this.cli);
-  }
-  usePlugin(plugin) {
-    plugin.install(this.cli);
-  }
-  async setDebug(status) {
-    _makes.Logger.info(`Set debug ${status}`);
-    await (0, _utils.setConfig)({
-      debug: status === "on"
-    });
-  }
-  async run() {
-    const mapDir = Path.dirname(_env.MAP_PATH);
-    if (!_makes.FS.existsSync(mapDir)) {
-      await _makes.FS.mkdir(mapDir);
+    constructor() {
+        this.di = new makes_1.DI();
+        this.appConfigService = new services_1.AppConfigService();
+        this.di.registerService(services_1.AppConfigService, this.appConfigService);
+        this.di.registerService(services_1.AppEventsService, new services_1.AppEventsService());
+        this.di.registerService(services_1.DockerService, new services_1.DockerService(this.di));
+        this.di.registerService(services_1.PresetService, new services_1.PresetService(this.di));
+        this.di.registerService(services_1.PluginService, new services_1.PluginService(this.di));
+        this.di.registerService(services_1.ProjectService, new services_1.ProjectService(this.di));
+        this.di.registerService(services_1.LogService, new services_1.LogService(this.di));
+        this.di.registerService(cli_1.Cli, this.cli);
+        this.cli = new cli_1.Cli(makes_1.Logger);
+        makes_1.Preset.install(this.di);
+        makes_1.Project.install(this.di);
+        makes_1.Logger.install(this.di);
+        this.install();
+        this.use(controllers_1.ImageController);
+        this.use(controllers_1.PluginController);
+        this.use(controllers_1.PresetController);
+        this.use(controllers_1.ProjectController);
+        this.use(controllers_1.ProxyController);
+    }
+    install() {
+        this.cli.command("completion script")
+            .help(false)
+            .action(() => this.cli.completionScript());
+        this.cli.command("log [...items]")
+            .action((options, items) => {
+            makes_1.Logger.log(...items);
+            return "";
+        });
+        this.cli.command("debug <status>")
+            .completion("status", () => ["on", "off"])
+            .action(async (options, status) => this.setDebug(status));
+    }
+    use(Constructor) {
+        const controller = new Constructor(this.di);
+        controller.install(this.cli);
     }
-    if (!_makes.FS.existsSync(_env.MAP_PATH)) {
-      await _makes.FS.writeJSON(_env.MAP_PATH, {
-        projects: []
-      });
+    async setDebug(status) {
+        makes_1.Logger.info(`Set debug ${status}`);
+        await (0, utils_1.setConfig)({
+            debug: status === "on"
+        });
+        return "";
     }
-    if (!_makes.FS.existsSync(`${_env.DATA_DIR}/projects`)) {
-      await _makes.FS.mkdir(`${_env.DATA_DIR}/projects`);
+    async run() {
+        const mapDir = Path.dirname(env_1.MAP_PATH);
+        if (!makes_1.FS.existsSync(mapDir)) {
+            await makes_1.FS.mkdir(mapDir);
+        }
+        if (!makes_1.FS.existsSync(env_1.MAP_PATH)) {
+            await makes_1.FS.writeJSON(env_1.MAP_PATH, {
+                projects: []
+            });
+        }
+        if (!makes_1.FS.existsSync(`${env_1.DATA_DIR}/projects`)) {
+            await makes_1.FS.mkdir(`${env_1.DATA_DIR}/projects`);
+        }
+        const { plugins = [] } = await this.appConfigService.getAppConfig();
+        for (const plugin of plugins) {
+            try {
+                const { default: Plugin } = await Promise.resolve(`${plugin}`).then(s => __importStar(require(s)));
+                this.use(Plugin);
+            }
+            catch (err) {
+                makes_1.Logger.error(err.message);
+            }
+        }
+        return this.cli.run(process.argv);
     }
-    return this.cli.run(process.argv);
-  }
 }
-exports.App = App;
+exports.App = App;

package/lib/controllers/ImageController.d.ts

@@ -1,7 +1,9 @@
 import { Cli } from "@kearisp/cli";
-import { Controller } from "src/makes";
+import { DI, Controller } from "../makes";
+import { AppConfigService } from "../services";
 declare class ImageController extends Controller {
-    constructor();
+    protected appConfigService: AppConfigService;
+    constructor(di: DI);
     install(cli: Cli): void;
     list(): Promise<string>;
 }

package/lib/controllers/ImageController.js

@@ -1,29 +1,31 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.ImageController = void 0;
-var _cliTable = _interopRequireDefault(require("cli-table3"));
-var _makes = require("../makes");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-class ImageController extends _makes.Controller {
-  constructor() {
-    super();
-  }
-  install(cli) {
-    super.install(cli);
-    cli.command("images").action(() => this.list());
-  }
-  async list() {
-    const images = await _makes.Docker.imageLs({});
-    const table = new _cliTable.default({
-      head: ["Name"]
-    });
-    for (const image of images) {
-      table.push([image.Id]);
+const cli_table3_1 = __importDefault(require("cli-table3"));
+const makes_1 = require("../makes");
+const services_1 = require("../services");
+class ImageController extends makes_1.Controller {
+    constructor(di) {
+        super();
+        this.appConfigService = di.resolveService(services_1.AppConfigService);
+    }
+    install(cli) {
+        super.install(cli);
+        cli.command("images")
+            .action(() => this.list());
+    }
+    async list() {
+        const images = await makes_1.Docker.imageLs({});
+        const table = new cli_table3_1.default({
+            head: ["Name"]
+        });
+        for (const image of images) {
+            table.push([image.Id]);
+        }
+        return table.toString() + "\n";
     }
-    return table.toString() + "\n";
-  }
 }
-exports.ImageController = ImageController;
+exports.ImageController = ImageController;

package/lib/controllers/PluginController.d.ts

@@ -0,0 +1,14 @@
+import { Cli } from "@kearisp/cli";
+import { DI, Controller } from "../makes";
+import { AppConfigService, PluginService } from "../services";
+type AddOptions = {};
+type RemoveOptions = {};
+declare class PluginController extends Controller {
+    protected appConfigService: AppConfigService;
+    protected pluginService: PluginService;
+    constructor(di: DI);
+    install(cli: Cli): void;
+    add(options: AddOptions, addName: string): Promise<void>;
+    remove(options: RemoveOptions, removeName: string): Promise<void>;
+}
+export { PluginController };

package/lib/controllers/PluginController.js

@@ -0,0 +1,84 @@
+"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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PluginController = void 0;
+const axios_1 = __importDefault(require("axios"));
+const chalk_1 = __importDefault(require("chalk"));
+const makes_1 = require("../makes");
+const services_1 = require("../services");
+const utils_1 = require("../utils");
+class PluginController extends makes_1.Controller {
+    constructor(di) {
+        super();
+        this.appConfigService = di.resolveService(services_1.AppConfigService);
+        this.pluginService = di.resolveService(services_1.PluginService);
+    }
+    install(cli) {
+        super.install(cli);
+        cli.command("plugin:add <name>")
+            .action((options, name) => this.add(options, name));
+        cli.command("plugin:remove <name>")
+            .action((options, name) => this.remove(options, name));
+    }
+    async add(options, addName) {
+        const [, prefix = "@wocker/", name, suffix = "-plugin"] = /^(@wocker\/)?(\w+)(-plugin)?$/.exec(addName) || [];
+        const fullName = `${prefix}${name}${suffix}`;
+        try {
+            const { default: Plugin } = await Promise.resolve(`${fullName}`).then(s => __importStar(require(s)));
+            this.pluginService.use(Plugin);
+            await this.appConfigService.activatePlugin(fullName);
+            console.info(`Plugin ${fullName} activated`);
+            return;
+        }
+        catch (err) {
+            makes_1.Logger.error(err.message);
+        }
+        try {
+            const res = await axios_1.default.get(`https://registry.npmjs.org/${encodeURIComponent(fullName)}`, {
+                validateStatus: () => true
+            });
+            if (res.status !== 200) {
+                console.error(chalk_1.default.red(`Plugin ${fullName} not found`));
+                return;
+            }
+            console.info(`Installing ${fullName}`);
+            await (0, utils_1.exec)(`npm install -g ${fullName}`);
+            await this.appConfigService.activatePlugin(fullName);
+        }
+        catch (err) {
+            makes_1.Logger.error(err.message);
+        }
+    }
+    async remove(options, removeName) {
+        const [, prefix = "@wocker/", name, suffix = "-plugin"] = /^(@wocker\/)?(\w+)(-plugin)?$/.exec(removeName) || [];
+        const fullName = `${prefix}${name}${suffix}`;
+        await this.appConfigService.deactivatePlugin(fullName);
+        console.info(`Plugin ${fullName} deactivated`);
+    }
+}
+exports.PluginController = PluginController;

package/lib/controllers/PresetController.d.ts

@@ -0,0 +1,21 @@
+import { Cli } from "@wocker/core";
+import { DI, Controller, Project } from "../makes";
+import { AppConfigService, AppEventsService, ProjectService, PresetService, DockerService } from "../services";
+type BuildParams = {
+    rebuild?: boolean;
+};
+declare class PresetController extends Controller {
+    protected appConfigService: AppConfigService;
+    protected appEventsService: AppEventsService;
+    protected projectService: ProjectService;
+    protected presetService: PresetService;
+    protected dockerService: DockerService;
+    constructor(di: DI);
+    install(cli: Cli): void;
+    presets(): Promise<string[]>;
+    protected onInit(project: Project): Promise<void>;
+    protected onRebuild(project: Project): Promise<void>;
+    protected onBeforeStart(project: Project): Promise<void>;
+    build(options: BuildParams, presetName: string): Promise<void>;
+}
+export { PresetController };