tshex-cli 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 virtualitems
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/build/main.js

@@ -0,0 +1,84 @@
+#!/usr/bin/env node
+import { program } from 'commander';
+import fs from 'fs';
+import path from 'path';
+program
+    .name('tshex')
+    .version('1.0.0')
+    .option('--lib <name>', 'creates a new library with it\'s shared directory')
+    .option('--ctx <name>', 'creates a new context')
+    .option('--cls <name>', 'creates a new class')
+    .option('--rfc <name>', 'creates a new react functional component')
+    .option('--dir <path>', 'sets the directory to create the new item')
+    .parse(process.argv);
+function executeCreateLib(templatesDir, libraryDir) {
+    try {
+        fs.cpSync(path.join(templatesDir, 'lib'), libraryDir, {
+            recursive: true,
+            filter: function (src) { return (!src.endsWith('.gitkeep')); }
+        });
+        console.log('Library created successfully');
+    }
+    catch (err) {
+        console.error(err);
+    }
+}
+function executeCreateContext(templatesDir, contextDir) {
+    try {
+        fs.cpSync(path.join(templatesDir, 'ctx'), contextDir, {
+            recursive: true,
+            filter: function (src) { return (!src.endsWith('.gitkeep')); }
+        });
+        console.log('Context created successfully');
+    }
+    catch (err) {
+        console.error(err);
+    }
+}
+function executeCreateClass(templatesDir, classDir) {
+    try {
+        fs.cpSync(path.join(templatesDir, 'cls.example'), classDir, {});
+        console.log('Class created successfully');
+    }
+    catch (err) {
+        console.error(err);
+    }
+}
+function executeCreateReactFunctionalComponent(templatesDir, classDir) {
+    try {
+        fs.cpSync(path.join(templatesDir, 'rfc.example'), classDir, {});
+        console.log('React component created successfully');
+    }
+    catch (err) {
+        console.error(err);
+    }
+}
+(function () {
+    var _a;
+    var templatesDir = path.join(import.meta.dirname, '..', 'templates');
+    var options = program.opts();
+    var targetDir = path.resolve((_a = options.dir) !== null && _a !== void 0 ? _a : process.cwd());
+    if (Object.keys(options).length === 0) {
+        program.help();
+        return;
+    }
+    if (!fs.existsSync(targetDir)) {
+        fs.mkdirSync(targetDir, { recursive: true });
+    }
+    if (options.lib !== undefined) {
+        targetDir = path.join(targetDir, options.lib);
+        executeCreateLib(templatesDir, targetDir);
+    }
+    if (options.ctx !== undefined) {
+        targetDir = path.join(targetDir, options.ctx);
+        executeCreateContext(templatesDir, targetDir);
+    }
+    if (options.cls !== undefined) {
+        var target = path.join(targetDir, options.cls + '.ts');
+        executeCreateClass(templatesDir, target);
+    }
+    if (options.rfc !== undefined) {
+        var target = path.join(targetDir, options.rfc + '.tsx');
+        executeCreateReactFunctionalComponent(templatesDir, target);
+    }
+})();

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "tshex-cli",
+  "version": "1.0.2",
+  "author": "https://github.com/virtualitems/",
+  "description": "Typescript Hexagonal Architecture CLI",
+  "type": "module",
+  "main": "./build/main.js",
+  "files": [
+    "./build",
+    "./source",
+    "./templates"
+  ],
+  "types": "./source/index.d.ts",
+  "scripts": {
+    "build": "tsc && tsc-alias",
+    "dev": "tsc -w"
+  },
+  "devDependencies": {
+    "@types/commander": "^2.12.0",
+    "@types/node": "^22.5.4",
+    "tsc-alias": "^1.8.10",
+    "typescript": "^5.4.5"
+  },
+  "dependencies": {
+    "commander": "^12.1.0"
+  },
+  "bin": {
+    "tshex": "./build/main.js"
+  }
+}

package/readme.md

@@ -0,0 +1,53 @@
+# Hexagonal Architecture CLI
+
+This CLI will help you to generate a hexagonal architecture structure.
+
+# Installation
+
+```bash
+npm install -g tshex-cli
+```
+
+# Usage
+
+## Help
+
+```bash
+tshex -h
+
+tshex --help
+```
+
+## Create a new library
+
+```bash
+tshex --lib <name>
+```
+
+## Create a new context
+
+```bash
+tshex --ctx <name>
+```
+
+## Create a new class
+
+```bash
+tshex --cls <name>
+```
+
+## Create a new react functional component
+
+```bash
+tshex --rfc <name>
+```
+
+## Set the directory to create the new items
+
+```bash
+tshex --lib <name> --ctx <name> --dir <path>
+```
+
+# example
+
+https://github.com/virtualitems/typescript-codebase/tree/hexagonal-example

package/source/main.ts

@@ -0,0 +1,137 @@
+#!/usr/bin/env node
+
+// NPM LIBRARIES
+
+import { program } from 'commander';
+
+
+// NODE LIBRARIES
+
+import fs from 'fs';
+import path from 'path';
+
+
+// COMMANDER SETUP
+
+program
+    .name('tshex')
+    .version('1.0.0')
+    .option('--lib <name>', 'creates a new library with it\'s shared directory')
+    .option('--ctx <name>', 'creates a new context')
+    .option('--cls <name>', 'creates a new class')
+    .option('--rfc <name>', 'creates a new react functional component')
+    .option('--dir <path>', 'sets the directory to create the new item')
+    .parse(process.argv);
+
+
+// FUNCTIONS
+
+function executeCreateLib(templatesDir: string, libraryDir: string)
+{
+    try {
+        fs.cpSync(
+            path.join(templatesDir, 'lib'),
+            libraryDir,
+            {
+                recursive: true,
+                filter: (src) => (!src.endsWith('.gitkeep'))
+            },
+        );
+        console.log('Library created successfully');
+    }
+    catch (err) {
+        console.error(err);
+    }
+}
+
+
+function executeCreateContext(templatesDir: string, contextDir: string)
+{
+    try {
+        fs.cpSync(
+            path.join(templatesDir, 'ctx'),
+            contextDir,
+            {
+                recursive: true,
+                filter: (src) => (!src.endsWith('.gitkeep'))
+            },
+        );
+        console.log('Context created successfully');
+    }
+    catch (err) {
+        console.error(err);
+    }
+}
+
+
+function executeCreateClass(templatesDir: string, classDir: string)
+{
+    try {
+        fs.cpSync(
+            path.join(templatesDir, 'cls.example'),
+            classDir,
+            {},
+        );
+        console.log('Class created successfully');
+    } catch (err) {
+        console.error(err);
+    }
+}
+
+
+function executeCreateReactFunctionalComponent(templatesDir: string, classDir: string)
+{
+    try {
+        fs.cpSync(
+            path.join(templatesDir, 'rfc.example'),
+            classDir,
+            {},
+        );
+        console.log('React component created successfully');
+    } catch (err) {
+        console.error(err);
+    }
+}
+
+
+// CLIENT CODE
+
+(function ()
+{
+
+    const templatesDir = path.join(import.meta.dirname, '..', 'templates');
+
+    const options = program.opts();
+
+    let targetDir = path.resolve(options.dir ?? process.cwd());
+
+    if (Object.keys(options).length === 0) {
+        program.help();
+        return;
+    }
+
+    if (!fs.existsSync(targetDir)) {
+        fs.mkdirSync(targetDir, { recursive: true });
+    }
+
+    if (options.lib !== undefined) {
+        targetDir = path.join(targetDir, options.lib);
+        executeCreateLib(templatesDir, targetDir);
+    }
+
+    if (options.ctx !== undefined) {
+        targetDir = path.join(targetDir, options.ctx);
+        executeCreateContext(templatesDir, targetDir);
+    }
+
+    if (options.cls !== undefined) {
+        const target = path.join(targetDir, options.cls + '.ts');
+        executeCreateClass(templatesDir, target);
+    }
+
+    if (options.rfc !== undefined) {
+        const target = path.join(targetDir, options.rfc + '.tsx');
+        executeCreateReactFunctionalComponent(templatesDir, target);
+    }
+
+})();

package/templates/cls.example

@@ -0,0 +1,50 @@
+// Libraries
+
+// Shared Module
+
+// Other Modules
+
+// Same Layer
+
+// Lower Layers
+
+// Types
+
+// Constants
+
+
+/**
+ * @description 
+ */
+export default class __CLASS__ extends __DECLARE_FIRST__OVERRIDE_SECOND__ABSTRACT_LAST__
+{
+
+    [property: string]: unknown;
+
+    // public ATTRIBUTES
+
+    // protected ATTRIBUTES
+
+    // private ATTRIBUTES
+
+    // public static ATTRIBUTES
+
+    // protected static ATTRIBUTES
+
+    // private static ATTRIBUTES
+
+    // Constructor, Getters, Setters
+
+    // public METHODS
+
+    // protected METHODS
+
+    // private METHODS
+
+    // public static METHODS
+
+    // protected static METHODS
+
+    // private static METHODS
+
+} //:: class

package/templates/ctx/index.ts

@@ -0,0 +1,9 @@
+// Ports layer
+
+// Adapters layer
+
+// Application layer
+
+// Domain layer
+
+// Constants

package/templates/lib/index.d.ts

@@ -0,0 +1 @@
+type Generic<T=unknown> = Record<string, T>;

package/templates/lib/main.ts

@@ -0,0 +1,5 @@
+/**
+ * @fileoverview This file is used only for exporting the main components of the library.
+ */
+
+throw new Error('Not implemented yet');

package/templates/lib/shared/application/DataTransferObject.ts

@@ -0,0 +1,46 @@
+// Libraries
+
+// Same Layer
+
+// Lower Layers
+
+// Types
+
+// Constants
+
+
+/**
+* @description 
+*/
+export default abstract class DataTransferObject
+{
+
+    [property: string]: unknown;
+
+    // public ATTRIBUTES
+
+    // protected ATTRIBUTES
+
+    // private ATTRIBUTES
+
+    // public static ATTRIBUTES
+
+    // protected static ATTRIBUTES
+
+    // private static ATTRIBUTES
+
+    // Constructor, Getters, Setters
+
+    // public METHODS
+
+    // protected METHODS
+
+    // private METHODS
+
+    // public static METHODS
+
+    // protected static METHODS
+
+    // private static METHODS
+
+} //:: class

package/templates/lib/shared/application/Facade.ts

@@ -0,0 +1,47 @@
+// Libraries
+
+// Same Layer
+
+// Lower Layers
+
+// Types
+
+// Constants
+
+
+/**
+ * @description 
+ * function arguments are Entity
+ */
+export default abstract class Facade
+{
+
+    [property: string]: unknown;
+
+    // public ATTRIBUTES
+
+    // protected ATTRIBUTES
+
+    // private ATTRIBUTES
+
+    // public static ATTRIBUTES
+
+    // protected static ATTRIBUTES
+
+    // private static ATTRIBUTES
+
+    // Constructor, Getters, Setters
+
+    // public METHODS
+
+    // protected METHODS
+
+    // private METHODS
+
+    // public static METHODS
+
+    // protected static METHODS
+
+    // private static METHODS
+
+} //:: class

package/templates/lib/shared/application/Logger.ts

@@ -0,0 +1,54 @@
+// Libraries
+
+// Same Layer
+
+// Lower Layers
+
+// Types
+
+// Constants
+
+
+/**
+* @description 
+*/
+export default abstract class Logger
+{
+
+    [property: string]: unknown;
+
+    // public ATTRIBUTES
+
+    // protected ATTRIBUTES
+
+    // private ATTRIBUTES
+
+    // public static ATTRIBUTES
+
+    // protected static ATTRIBUTES
+
+    // private static ATTRIBUTES
+
+    // Constructor, Getters, Setters
+
+    // public METHODS
+
+    public abstract debug(message: string): void;
+
+    public abstract info(message: string): void;
+
+    public abstract warning(message: string): void;
+
+    public abstract error(message: string): void;
+
+    // protected METHODS
+
+    // private METHODS
+
+    // public static METHODS
+
+    // protected static METHODS
+
+    // private static METHODS
+
+} //:: class

package/templates/lib/shared/application/Response.ts

@@ -0,0 +1,52 @@
+// Libraries
+
+// Same Layer
+
+// Lower Layers
+
+// Types
+
+// Constants
+
+
+/**
+* @description 
+*/
+export default class Response
+{
+
+    [property: string]: unknown;
+
+    // public ATTRIBUTES
+
+    // protected ATTRIBUTES
+
+    // private ATTRIBUTES
+
+    // public static ATTRIBUTES
+
+    // protected static ATTRIBUTES
+
+    // private static ATTRIBUTES
+
+    // Constructor, Getters, Setters
+
+    public constructor(
+        public readonly data: unknown,
+        public readonly error: unknown,
+        public readonly message: unknown,
+    ) { }
+
+    // public METHODS
+
+    // protected METHODS
+
+    // private METHODS
+
+    // public static METHODS
+
+    // protected static METHODS
+
+    // private static METHODS
+
+} //:: class

package/templates/lib/shared/application/data/DataManager.ts

@@ -0,0 +1,50 @@
+// Libraries
+
+// Same Layer
+
+// Lower Layers
+
+// Types
+
+// Constants
+
+
+/**
+ * @description 
+ */
+export default abstract class DataManager
+{
+
+    [property: string]: unknown;
+
+    // Public Attributes
+
+    // Protected Attributes
+
+    // Private Attributes
+
+    // Public Static Attributes
+
+    // Protected Static Attributes
+
+    // Private Static Attributes
+
+    // Constructor, Getters, Setters
+
+    // Public Methods
+
+    public abstract connect(...args: unknown[]): Promise<unknown>;
+
+    public abstract disconnect(): Promise<unknown>;
+
+    // Protected Methods
+
+    // Private Methods
+
+    // Public Static Methods
+
+    // Protected Static Methods
+
+    // Private Static Methods
+
+} //:: class