tshex-cli 1.0.13 → 1.0.14

package/LICENSE

@@ -1,21 +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.
+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

@@ -1,22 +1,15 @@
 #!/usr/bin/env node
 import { program } from 'commander';
-import fs from 'fs';
-import path from 'path';
-var packageJson = JSON.parse(fs.readFileSync(path.join(import.meta.dirname, '..', 'package.json'), 'utf-8'));
-program
-    .name('tshex')
-    .version(packageJson.version)
-    .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);
+import fs from 'node:fs';
+import path from 'node:path';
+function readPackageJson() {
+    return JSON.parse(fs.readFileSync(path.join(import.meta.dirname, '..', 'package.json'), 'utf-8'));
+}
 function executeCreateLib(templatesDir, libraryDir) {
     try {
         fs.cpSync(path.join(templatesDir, 'lib'), libraryDir, {
             recursive: true,
-            filter: function (src) { return (!src.endsWith('.gitkeep')); }
+            filter: (src) => !src.endsWith('.gitkeep')
         });
         console.log('Library created successfully');
     }
@@ -28,7 +21,7 @@ function executeCreateContext(templatesDir, contextDir) {
     try {
         fs.cpSync(path.join(templatesDir, 'ctx'), contextDir, {
             recursive: true,
-            filter: function (src) { return (!src.endsWith('.gitkeep')); }
+            filter: (src) => !src.endsWith('.gitkeep')
         });
         console.log('Context created successfully');
     }
@@ -36,29 +29,10 @@ function executeCreateContext(templatesDir, contextDir) {
         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());
+function main(program) {
+    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;
@@ -74,12 +48,13 @@ function executeCreateReactFunctionalComponent(templatesDir, classDir) {
         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);
-    }
-})();
+}
+const packageJson = readPackageJson();
+program
+    .name('tshex')
+    .version(packageJson.version)
+    .option('--lib <name>', "creates a new library with it's shared directory")
+    .option('--ctx <name>', 'creates a new context')
+    .option('--dir <path>', 'sets the directory to create the new item')
+    .parse(process.argv);
+main(program);

package/package.json

@@ -1,52 +1,50 @@
-{
-  "name": "tshex-cli",
-  "version": "1.0.13",
-  "author": "https://github.com/virtualitems/",
-  "description": "Typescript Hexagonal Architecture CLI",
-  "type": "module",
-  "main": "./build/main.js",
-  "keywords": [
-    "architecture",
-    "clean-architecture",
-    "clean",
-    "cli",
-    "ddd",
-    "design-patterns",
-    "design",
-    "domain-driven-design",
-    "hexagonal",
-    "pattern",
-    "software-architecture",
-    "tshex",
-    "tshex-cli",
-    "typescript",
-    "virtualitems"
-  ],
-  "homepage": "https://github.com/virtualitems/tshex-cli",
-  "bugs": {
-    "url": "https://github.com/virtualitems/tshex-cli/issues"
-  },
-  "files": [
-    "./build",
-    "./source",
-    "./templates"
-  ],
-  "types": "./source/index.d.ts",
-  "scripts": {
-    "examples": "tsc -p examples",
-    "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"
-  }
-}
+{
+  "name": "tshex-cli",
+  "version": "1.0.14",
+  "author": "https://github.com/virtualitems/",
+  "description": "Typescript Hexagonal Architecture CLI",
+  "type": "module",
+  "main": "./build/main.js",
+  "keywords": [
+    "architecture",
+    "clean-architecture",
+    "clean",
+    "cli",
+    "ddd",
+    "design-patterns",
+    "design",
+    "domain-driven-design",
+    "hexagonal",
+    "pattern",
+    "software-architecture",
+    "tshex",
+    "tshex-cli",
+    "typescript",
+    "virtualitems"
+  ],
+  "homepage": "https://github.com/virtualitems/tshex-cli",
+  "bugs": {
+    "url": "https://github.com/virtualitems/tshex-cli/issues"
+  },
+  "files": [
+    "./build",
+    "./source",
+    "./templates"
+  ],
+  "types": "./source/index.d.ts",
+  "devDependencies": {
+    "@types/node": "^22.5.4",
+    "typescript": "^5.4.5"
+  },
+  "dependencies": {
+    "commander": "^12.1.0"
+  },
+  "bin": {
+    "tshex": "./build/main.js"
+  },
+  "scripts": {
+    "examples": "tsc -p examples",
+    "build": "tsc",
+    "dev": "tsc -w"
+  }
+}

package/readme.md

@@ -1,76 +1,76 @@
-# Hexagonal Architecture CLI
-
-This CLI will help you to generate a hexagonal architecture structure.
-
-# Why?
-
-Hexagonal architecture is a software design pattern that separates the internal domain of the application from the external dependencies.. This separation is achieved by dividing the application into layers. Each layer has a specific responsibility and interacts with the other layers in a specific way.
-
-Because what we are trying to achieve is a separation between the domain code and the installed dependencies, a Hexagonal Architecture Framework is a step in the opposite direction, as it couples the domain code with the framework. This is why we need a tool to help us to create the structure with our own codebase.
-
-# Usage example
-
-https://github.com/virtualitems/tshex-cli
-
-# Note!!!
-
-This tool and its templates are in constant development, so be aware that some changes may occur and be careful when updating the tool.
-
-If you have any suggestions or improvements, please let me know.
-
-https://github.com/virtualitems/tshex-cli/issues
-
-# Installation
-
-```bash
-npm install -g tshex-cli
-```
-
-# Usage
-
-> Remember to replace placeholders `<...>` with the actual data.
->
-
-## Getting started
-
-```bash
-tshex --lib <library-name> --ctx <context-name>
-```
-
-## 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 <lib-name> --ctx <ctx-name> --dir <path>
+# Hexagonal Architecture CLI
+
+This CLI will help you to generate a hexagonal architecture structure.
+
+# Why?
+
+Hexagonal architecture is a software design pattern that separates the internal domain of the application from the external dependencies.. This separation is achieved by dividing the application into layers. Each layer has a specific responsibility and interacts with the other layers in a specific way.
+
+Because what we are trying to achieve is a separation between the domain code and the installed dependencies, a Hexagonal Architecture Framework is a step in the opposite direction, as it couples the domain code with the framework. This is why we need a tool to help us to create the structure with our own codebase.
+
+# Usage example
+
+https://github.com/virtualitems/tshex-cli
+
+# Note!!!
+
+This tool and its templates are in constant development, so be aware that some changes may occur and be careful when updating the tool.
+
+If you have any suggestions or improvements, please let me know.
+
+https://github.com/virtualitems/tshex-cli/issues
+
+# Installation
+
+```bash
+npm install -g tshex-cli
+```
+
+# Usage
+
+> Remember to replace placeholders `<...>` with the actual data.
+>
+
+## Getting started
+
+```bash
+tshex --lib <library-name> --ctx <context-name>
+```
+
+## 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 <lib-name> --ctx <ctx-name> --dir <path>
 ```

package/source/main.ts

@@ -1,145 +1,84 @@
-#!/usr/bin/env node
-
-// NPM LIBRARIES
-
-import { program } from 'commander';
-
-
-// NODE LIBRARIES
-
-import fs from 'fs';
-import path from 'path';
-
-// Read package.json
-const packageJson = JSON.parse(
-    fs.readFileSync(
-        path.join(import.meta.dirname, '..', 'package.json'),
-        'utf-8'
-    )
-);
-
-
-// COMMANDER SETUP
-
-program
-    .name('tshex')
-    .version(packageJson.version)
-    .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);
-    }
-
-})();
+#!/usr/bin/env node
+
+// NPM LIBRARIES
+
+import { program } from 'commander'
+
+// NODE LIBRARIES
+
+import fs from 'node:fs'
+import path from 'node:path'
+
+// FUNCTIONS
+
+function readPackageJson() {
+    return JSON.parse(
+        fs.readFileSync(
+            path.join(import.meta.dirname, '..', 'package.json'),
+            'utf-8'
+        )
+    )
+}
+
+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 main(program: typeof import('commander').program) {
+    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)
+    }
+}
+
+const packageJson = readPackageJson()
+
+program
+    .name('tshex')
+    .version(packageJson.version)
+    .option('--lib <name>', "creates a new library with it's shared directory")
+    .option('--ctx <name>', 'creates a new context')
+    .option('--dir <path>', 'sets the directory to create the new item')
+    .parse(process.argv)
+
+main(program)

package/templates/ctx/index.ts

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

package/templates/lib/index.d.ts

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

package/templates/lib/main.ts

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