tshex-cli 1.0.13 → 1.0.15

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');

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

@@ -0,0 +1,81 @@
+// Libraries
+
+// Same Layer
+
+// Lower Layers
+
+// Types
+
+// Constants
+
+/**
+ * @description
+ */
+export 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
+
+/**
+ * @description Represents a data source.
+ */
+export abstract class Repository<Manager extends DataManager> {
+    [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 manager: Manager) {}
+
+    // Public Methods
+
+    // Protected Methods
+
+    // Private Methods
+
+    // Public Static Methods
+
+    // Protected Static Methods
+
+    // Private Static Methods
+} //:: class

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

@@ -0,0 +1,121 @@
+// Libraries
+
+// Same Layer
+
+// Lower Layers
+
+// Types
+
+// Constants
+
+/**
+ * @description
+ */
+export abstract class Event {
+    [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 timestamp: number = Date.now(),
+        public readonly details: Record<string, unknown> = {}
+    ) {}
+
+    // public METHODS
+
+    // protected METHODS
+
+    // private METHODS
+
+    // public static METHODS
+
+    // protected static METHODS
+
+    // private static METHODS
+} //:: class
+
+/**
+ * @description
+ */
+export abstract class EventHandler {
+    [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 handle(event: Event): Promise<void>
+
+    // protected METHODS
+
+    // private METHODS
+
+    // public static METHODS
+
+    // protected static METHODS
+
+    // private static METHODS
+} //:: class
+
+/**
+ * @description
+ */
+export abstract class EventDispatcher {
+    [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 subscribe(key: unknown, handler: EventHandler): void
+
+    public abstract unsubscribe(key: unknown, handler: EventHandler): void
+
+    public abstract dispatch(event: Event): void
+
+    // protected METHODS
+
+    // private METHODS
+
+    // public static METHODS
+
+    // protected static METHODS
+
+    // private static METHODS
+} //:: class

package/templates/lib/shared/application/{Response.ts → http.ts}

@@ -1,52 +1,48 @@
-// 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
+// Libraries
+
+// Same Layer
+
+// Lower Layers
+
+// Types
+
+// Constants
+
+/**
+ * @description
+ */
+export class HttpResponseBody {
+    [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: Record<string, unknown> | null = null,
+        public readonly errors: string[] | null = null,
+        public readonly links: Record<string, URL> | null = null
+    ) {}
+
+    // public METHODS
+
+    // protected METHODS
+
+    // private METHODS
+
+    // public static METHODS
+
+    // protected static METHODS
+
+    // private static METHODS
+} //:: class

package/templates/{cls.example → lib/shared/application/loggers.ts}

@@ -1,50 +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
+// Libraries
+
+// Same Layer
+
+// Lower Layers
+
+// Types
+
+// Constants
+
+/**
+ * @description
+ */
+export 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(data: unknown): void
+
+    public abstract info(data: unknown): void
+
+    public abstract warning(data: unknown): void
+
+    public abstract error(data: unknown): void
+
+    // protected METHODS
+
+    // private METHODS
+
+    // public static METHODS
+
+    // protected static METHODS
+
+    // private static METHODS
+} //:: class