tshex-cli 1.0.15 → 1.0.17

package/build/main.js

@@ -3,13 +3,15 @@ import { program } from 'commander';
 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'));
+    const filePath = path.join(import.meta.dirname, '..', 'package.json');
+    const fileContents = fs.readFileSync(filePath, 'utf-8');
+    return JSON.parse(fileContents);
 }
 function executeCreateLib(templatesDir, libraryDir) {
     try {
         fs.cpSync(path.join(templatesDir, 'lib'), libraryDir, {
             recursive: true,
-            filter: (src) => !src.endsWith('.gitkeep')
+            filter: (src) => src.endsWith('.gitkeep') === false
         });
         console.log('Library created successfully');
     }
@@ -21,7 +23,7 @@ function executeCreateContext(templatesDir, contextDir) {
     try {
         fs.cpSync(path.join(templatesDir, 'ctx'), contextDir, {
             recursive: true,
-            filter: (src) => !src.endsWith('.gitkeep')
+            filter: (src) => src.endsWith('.gitkeep') === false
         });
         console.log('Context created successfully');
     }
@@ -29,24 +31,43 @@ function executeCreateContext(templatesDir, contextDir) {
         console.error(err);
     }
 }
+function executeCreateReactContext(templatesDir, contextDir) {
+    try {
+        fs.cpSync(path.join(templatesDir, 'ctx-react'), contextDir, {
+            recursive: true,
+            filter: (src) => src.endsWith('.gitkeep') === false
+        });
+        console.log('React context created successfully');
+    }
+    catch (err) {
+        console.error(err);
+    }
+}
 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;
     }
-    if (!fs.existsSync(targetDir)) {
+    if (fs.existsSync(targetDir) === false) {
         fs.mkdirSync(targetDir, { recursive: true });
     }
     if (options.lib !== undefined) {
         targetDir = path.join(targetDir, options.lib);
         executeCreateLib(templatesDir, targetDir);
     }
+    if (options.react === true && options.ctx === undefined) {
+        program.error('Option --react requires --ctx <name>');
+    }
     if (options.ctx !== undefined) {
         targetDir = path.join(targetDir, options.ctx);
-        executeCreateContext(templatesDir, targetDir);
+        if (options.react === true) {
+            executeCreateReactContext(templatesDir, targetDir);
+        }
+        else {
+            executeCreateContext(templatesDir, targetDir);
+        }
     }
 }
 const packageJson = readPackageJson();
@@ -55,6 +76,7 @@ program
     .version(packageJson.version)
     .option('--lib <name>', "creates a new library with it's shared directory")
     .option('--ctx <name>', 'creates a new context')
+    .option('-R, --react', 'creates a React context with --ctx')
     .option('--dir <path>', 'sets the directory to create the new item')
     .parse(process.argv);
 main(program);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tshex-cli",
-  "version": "1.0.15",
+  "version": "1.0.17",
   "author": "https://github.com/virtualitems/",
   "description": "Typescript Hexagonal Architecture CLI",
   "type": "module",

package/readme.md

@@ -20,10 +20,11 @@ https://github.com/virtualitems/tshex-cli/issues
 
 `tshex` scaffolds folders and files for a hexagonal architecture project. It does not write business logic for you; it only generates the structure, so you can fill it in with your own code.
 
-There are two things you can generate:
+There are four things you can generate:
 
 - A **library** (`--lib`): the shared foundation of a project. It contains the domain and application contracts (entities, value objects, services, etc.) that the rest of the code depends on.
 - A **context** (`--ctx`): a specific business area (e.g. `users`, `billing`, `orders`). It contains the `domain/`, `application/`, and `adapters/` folders where you implement that area's logic.
+- A **React context** (`--react-context`): a React-ready context scaffold.
 
 A typical project has one library and one or more contexts inside it.
 
@@ -50,18 +51,19 @@ tshex --help
 ## Usage
 
 ```bash
-tshex [--lib <name>] [--ctx <name>] [--dir <path>]
+tshex [--lib <name>] [--ctx <name>] [--react-context <name>] [--dir <path>]
 ```
 
 | Option         | Purpose                                                            |
 | -------------- | ------------------------------------------------------------------- |
 | `--lib <name>` | Generate a library called `<name>`, based on `templates/lib`.       |
 | `--ctx <name>` | Generate a context called `<name>`, based on `templates/ctx`.       |
+| `--react-context <name>` | Generate a React context called `<name>`, based on `templates/react-context`. |
 | `--dir <path>` | Parent directory where the library/context will be created. Defaults to the current directory. |
 | `--help`       | Show the command options.                                           |
 | `--version`    | Show the installed version.                                         |
 
-`--lib` and `--ctx` can be used together in a single command (see [Create a library and a context together](#create-a-library-and-a-context-together)). Running `tshex` without any options just prints the help text — it does not generate anything.
+`--lib`, `--ctx`, and `--react-context` can be used together in a single command. Running `tshex` without any options just prints the help text — it does not generate anything.
 
 ## Create a library
 
@@ -203,3 +205,13 @@ src/
         ├── domain/
         └── index.ts
 ```
+
+    ## Create a React context
+
+    Use this when you want only the React context scaffold:
+
+    ```bash
+    tshex --react-context users
+    ```
+
+    This generates a `users/` folder in the current directory.

package/source/main.ts

@@ -12,19 +12,16 @@ import path from 'node:path'
 // FUNCTIONS
 
 function readPackageJson() {
-    return JSON.parse(
-        fs.readFileSync(
-            path.join(import.meta.dirname, '..', 'package.json'),
-            'utf-8'
-        )
-    )
+    const filePath = path.join(import.meta.dirname, '..', 'package.json')
+    const fileContents = fs.readFileSync(filePath, 'utf-8')
+    return JSON.parse(fileContents)
 }
 
 function executeCreateLib(templatesDir: string, libraryDir: string) {
     try {
         fs.cpSync(path.join(templatesDir, 'lib'), libraryDir, {
             recursive: true,
-            filter: (src) => !src.endsWith('.gitkeep')
+            filter: (src) => src.endsWith('.gitkeep') === false
         })
         console.log('Library created successfully')
     } catch (err) {
@@ -36,7 +33,7 @@ function executeCreateContext(templatesDir: string, contextDir: string) {
     try {
         fs.cpSync(path.join(templatesDir, 'ctx'), contextDir, {
             recursive: true,
-            filter: (src) => !src.endsWith('.gitkeep')
+            filter: (src) => src.endsWith('.gitkeep') === false
         })
         console.log('Context created successfully')
     } catch (err) {
@@ -44,6 +41,18 @@ function executeCreateContext(templatesDir: string, contextDir: string) {
     }
 }
 
+function executeCreateReactContext(templatesDir: string, contextDir: string) {
+    try {
+        fs.cpSync(path.join(templatesDir, 'ctx-react'), contextDir, {
+            recursive: true,
+            filter: (src) => src.endsWith('.gitkeep') === false
+        })
+        console.log('React context created successfully')
+    } catch (err) {
+        console.error(err)
+    }
+}
+
 function main(program: typeof import('commander').program) {
     const templatesDir = path.join(import.meta.dirname, '..', 'templates')
 
@@ -53,10 +62,9 @@ function main(program: typeof import('commander').program) {
 
     if (Object.keys(options).length === 0) {
         program.help()
-        return
     }
 
-    if (!fs.existsSync(targetDir)) {
+    if (fs.existsSync(targetDir) === false) {
         fs.mkdirSync(targetDir, { recursive: true })
     }
 
@@ -65,9 +73,18 @@ function main(program: typeof import('commander').program) {
         executeCreateLib(templatesDir, targetDir)
     }
 
+    if (options.react === true && options.ctx === undefined) {
+        program.error('Option --react requires --ctx <name>')
+    }
+
     if (options.ctx !== undefined) {
         targetDir = path.join(targetDir, options.ctx)
-        executeCreateContext(templatesDir, targetDir)
+
+        if (options.react === true) {
+            executeCreateReactContext(templatesDir, targetDir)
+        } else {
+            executeCreateContext(templatesDir, targetDir)
+        }
     }
 }
 
@@ -78,6 +95,7 @@ program
     .version(packageJson.version)
     .option('--lib <name>', "creates a new library with it's shared directory")
     .option('--ctx <name>', 'creates a new context')
+    .option('-R, --react', 'creates a React context with --ctx')
     .option('--dir <path>', 'sets the directory to create the new item')
     .parse(process.argv)
 

package/templates/ctx/example-ports.ts

@@ -0,0 +1,5 @@
+// Ports are exports from the context root level
+
+export function example(): void {
+    // ...
+}

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

@@ -1,81 +1,102 @@
-// Libraries
+type Generic<T = unknown> = Record<string, T>
 
-// Same Layer
+/**
+ * @description
+ */
+export interface Filterable<S = Generic> {
+    filter(selector: S): Promise<Array<S>>
+}
 
-// Lower Layers
+/**
+ * @description
+ */
+export interface Sortable<S = Generic> {
+    sort(selector: S): Promise<Array<S>>
+}
 
-// Types
+/**
+ * @description
+ */
+export interface Creatable<D = Generic> {
+    create(data: D): Promise<unknown>
+}
 
-// Constants
+/**
+ * @description
+ */
+export interface Updatable<S = Generic, D = Generic> {
+    update(selector: S, data: D): Promise<unknown>
+}
 
 /**
  * @description
  */
-export abstract class DataManager {
-    [property: string]: unknown
+export interface Deletable<S = Generic> {
+    delete(selector: S): Promise<unknown>
+}
 
-    // Public Attributes
+/**
+ * @description
+ */
+export interface Aggregatable<S = Generic> {
+    aggregate(selector: S): Promise<S>
+}
 
-    // Protected Attributes
+/**
+ * @description
+ */
+export interface Relatable {
+    selectRelated(...args: unknown[]): unknown
 
-    // Private Attributes
+    prefetchRelated(...args: unknown[]): unknown
+}
 
-    // Public Static Attributes
+/**
+ * @description
+ */
+export abstract class DataManager<T = Generic> {
+    [property: string]: unknown
 
-    // Protected Static Attributes
+    public abstract all(): Promise<Array<T>>
 
-    // Private Static Attributes
+    public abstract none(): Array<T>
+} //:: class
 
-    // Constructor, Getters, Setters
+/**
+ * @description
+ */
+export abstract class DatasetManager<T = Generic> extends DataManager<T> {
+    [property: string]: unknown
 
-    // Public Methods
+    public abstract union(other: Array<T>): Promise<Array<T>>
 
-    public abstract connect(...args: unknown[]): Promise<unknown>
+    public abstract intersection(other: Array<T>): Promise<Array<T>>
 
-    public abstract disconnect(): Promise<unknown>
+    public abstract difference(other: Array<T>): Promise<Array<T>>
 
-    // Protected Methods
+    public abstract symmetric_difference(other: Array<T>): Promise<Array<T>>
 
-    // Private Methods
+    public abstract complement(other: Array<T>): Promise<Array<T>>
+} //:: class
 
-    // Public Static Methods
+/**
+ * @description
+ */
+export abstract class DriverManager<M extends DataManager = DataManager> {
+    [property: string]: unknown
 
-    // Protected Static Methods
+    public abstract connect(...args: unknown[]): Promise<M>
 
-    // Private Static Methods
+    public abstract disconnect(): Promise<unknown>
 } //:: class
 
 /**
  * @description Represents a data source.
  */
-export abstract class Repository<Manager extends DataManager> {
+export abstract class Repository<M extends DriverManager = DriverManager> {
     [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
+    public constructor(public readonly manager: M) {}
 
-    // Private Static Methods
+    protected abstract transform<T = Generic>(data: Generic): T
 } //:: class

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

@@ -1,12 +1,12 @@
-// Libraries
+export const DEBUG = 10
 
-// Same Layer
+export const INFO = 20
 
-// Lower Layers
+export const WARNING = 30
 
-// Types
+export const ERROR = 40
 
-// Constants
+export const CRITICAL = 50
 
 /**
  * @description
@@ -14,22 +14,6 @@
 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
@@ -38,13 +22,5 @@ export abstract class Logger {
 
     public abstract error(data: unknown): void
 
-    // protected METHODS
-
-    // private METHODS
-
-    // public static METHODS
-
-    // protected static METHODS
-
-    // private static METHODS
+    public abstract critical(data: unknown): void
 } //:: class

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

@@ -0,0 +1,10 @@
+/**
+ * @description
+ */
+export interface Validatable {
+    [property: string]: unknown
+
+    isValid(): boolean
+
+    validate(): unknown
+}

package/templates/ctx/index.ts

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