libmodulor 0.1.0 → 0.3.0

package/dist/esm/utils/ioc/ContainerPrinter.js

@@ -0,0 +1,53 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import { inject, injectable } from 'inversify';
+import { fmtPadEndFor } from '../terminal/fmt.js';
+let ContainerPrinter = class ContainerPrinter {
+    logger;
+    constructor(logger) {
+        this.logger = logger;
+    }
+    async exec({ container }) {
+        const dictionary = container._bindingDictionary._map;
+        const entries = [];
+        const keys = [...dictionary.keys()].map(this.symToString);
+        const keyPadEnd = fmtPadEndFor(keys);
+        const serviceIdentifierPadEnd = fmtPadEndFor([...dictionary.values()].flatMap((bindings) => bindings.map((b) => this.symToString(b.serviceIdentifier))));
+        for (const [key, bindings] of dictionary) {
+            const name = `\x1b[1m${this.symToString(key).padEnd(keyPadEnd)}\x1b[0m`;
+            const implementations = bindings
+                .map((b) => {
+                const serviceIdentifier = this.symToString(b.serviceIdentifier).padEnd(serviceIdentifierPadEnd);
+                const value = b.implementationType?.name ?? '{}';
+                const tags = `[type: ${b.type}] [scope: ${b.scope}]`;
+                return `${serviceIdentifier} <-- ${value} ${tags}`;
+            })
+                .join(' / ');
+            entries.push(`${name} : ${implementations}`);
+        }
+        this.logger.debug('Container bindings');
+        const sorted = entries.sort((a, b) => a.localeCompare(b));
+        for (const e of sorted) {
+            this.logger.debug(e);
+        }
+    }
+    symToString(sym) {
+        return typeof sym === 'string' ? sym : (sym.name ?? 'UnnamedClass');
+    }
+};
+ContainerPrinter = __decorate([
+    injectable(),
+    __param(0, inject('Logger')),
+    __metadata("design:paramtypes", [Object])
+], ContainerPrinter);
+export { ContainerPrinter };

package/dist/esm/utils/ioc/bindCommon.d.ts

@@ -0,0 +1,6 @@
+import type { Container } from 'inversify';
+import { type LoggerSettings, type Settings } from '../../std/index.js';
+import { type UCSettings } from '../../uc/index.js';
+export type CommonSettings = LoggerSettings & UCSettings;
+export type SettingsFunc<S extends Settings> = (commonSettings: CommonSettings) => S & Partial<CommonSettings>;
+export declare function bindCommon<S extends Settings = object>(container: Container, settingsFunc?: SettingsFunc<S>): void;

package/dist/esm/utils/ioc/bindCommon.js

@@ -0,0 +1,71 @@
+import { APP_NAME_PLACEHOLDER, PRODUCT_NAME_PLACEHOLDER, } from '../../convention.js';
+import { ConsoleLogger } from '../../std/impl/ConsoleLogger.js';
+import { FetchHTTPAPICallExecutor } from '../../std/impl/FetchHTTPAPICallExecutor.js';
+import { NoopHTTPAPICallExecutorAgentBuilder } from '../../std/impl/NoopHTTPAPICallExecutorAgentBuilder.js';
+import { NoopXMLManager } from '../../std/impl/NoopXMLManager.js';
+import { SettingsServerClientManager } from '../../std/impl/SettingsServerClientManager.js';
+import { SimpleFormDataBuilder } from '../../std/impl/SimpleFormDataBuilder.js';
+import { SimpleHTTPAPICaller } from '../../std/impl/SimpleHTTPAPICaller.js';
+import { SimpleMapI18nManager } from '../../std/impl/SimpleMapI18nManager.js';
+import { StaticSettingsManager } from '../../std/impl/StaticSettingsManager.js';
+import { StdDateClockManager } from '../../std/impl/StdDateClockManager.js';
+import { STD_DEFAULT_LOGGER_SETTINGS, } from '../../std/index.js';
+import { HTTPUCTransporter } from '../../uc/impl/HTTPUCTransporter.js';
+import { InMemoryUCDataStore } from '../../uc/impl/InMemoryUCDataStore.js';
+import { SimpleUCManager } from '../../uc/impl/SimpleUCManager.js';
+import { StaticUCClientConfirmManager } from '../../uc/impl/StaticUCClientConfirmManager.js';
+import { UC_DEFAULT_SETTINGS, } from '../../uc/index.js';
+import { bindProvider } from './bindProvider.js';
+export function bindCommon(container, settingsFunc) {
+    const commonSettings = {
+        ...STD_DEFAULT_LOGGER_SETTINGS,
+        ...UC_DEFAULT_SETTINGS,
+    };
+    const settings = {
+        ...commonSettings,
+        ...settingsFunc?.(commonSettings),
+    };
+    if (!container.isBound('ProductManifest')) {
+        container.bind('ProductManifest').toConstantValue({
+            appReg: [{ name: APP_NAME_PLACEHOLDER }],
+            name: PRODUCT_NAME_PLACEHOLDER,
+        });
+    }
+    container.bind('ClockManager').to(StdDateClockManager);
+    container
+        .bind('FormDataBuilder')
+        .to(SimpleFormDataBuilder);
+    container.bind('HTTPAPICaller').to(SimpleHTTPAPICaller);
+    container
+        .bind('HTTPAPICallExecutor')
+        .to(FetchHTTPAPICallExecutor);
+    container
+        .bind('HTTPAPICallExecutorAgentBuilder')
+        .to(NoopHTTPAPICallExecutorAgentBuilder);
+    container
+        .bind('I18nManager')
+        .to(SimpleMapI18nManager)
+        .inSingletonScope();
+    container.bind('I18n').toConstantValue({});
+    container.bind('Logger').to(ConsoleLogger);
+    container.bind('Settings').toConstantValue(settings);
+    container
+        .bind('SettingsManager')
+        .to(StaticSettingsManager);
+    container
+        .bind('ServerClientManager')
+        .to(SettingsServerClientManager);
+    container.bind('XMLManager').to(NoopXMLManager);
+    bindProvider(container, 'UCInit');
+    bindProvider(container, 'UCMain');
+    bindProvider(container, 'UCPolicy');
+    container
+        .bind('UCClientConfirmManager')
+        .to(StaticUCClientConfirmManager);
+    container
+        .bind('UCDataStore')
+        .to(InMemoryUCDataStore)
+        .inSingletonScope();
+    container.bind('UCManager').to(SimpleUCManager).inRequestScope();
+    container.bind('UCTransporter').to(HTTPUCTransporter);
+}

package/dist/esm/utils/ioc/bindNodeCLI.d.ts

@@ -0,0 +1,2 @@
+import type { Container } from 'inversify';
+export declare function bindNodeCLI(container: Container): void;

package/dist/esm/utils/ioc/bindNodeCLI.js

@@ -0,0 +1,8 @@
+import { NodePromptManager } from '../../std/impl/NodePromptManager.js';
+import { PromptUCClientConfirmManager } from '../../uc/impl/PromptUCClientConfirmManager.js';
+export function bindNodeCLI(container) {
+    container.bind('PromptManager').to(NodePromptManager);
+    container
+        .rebind('UCClientConfirmManager')
+        .to(PromptUCClientConfirmManager);
+}

package/dist/esm/utils/ioc/bindNodeCore.d.ts

@@ -0,0 +1,2 @@
+import type { Container } from 'inversify';
+export declare function bindNodeCore(container: Container): void;

package/dist/esm/utils/ioc/bindNodeCore.js

@@ -0,0 +1,16 @@
+import { NodeBufferManager } from '../../std/impl/NodeBufferManager.js';
+import { NodeCryptoManager } from '../../std/impl/NodeCryptoManager.js';
+import { NodeEnvironmentManager } from '../../std/impl/NodeEnvironmentManager.js';
+import { NodeFSManager } from '../../std/impl/NodeFSManager.js';
+import { NodeFormDataBuilder } from '../../std/impl/NodeFormDataBuilder.js';
+export function bindNodeCore(container) {
+    container.bind('BufferManager').to(NodeBufferManager);
+    container.bind('CryptoManager').to(NodeCryptoManager);
+    container
+        .bind('EnvironmentManager')
+        .to(NodeEnvironmentManager);
+    container.bind('FSManager').to(NodeFSManager);
+    container
+        .rebind('FormDataBuilder')
+        .to(NodeFormDataBuilder);
+}

package/dist/esm/utils/ioc/bindProduct.d.ts

@@ -0,0 +1,4 @@
+import type { Container } from 'inversify';
+import type { ProductI18n } from '../../product/i18n.js';
+import type { ProductManifest } from '../../product/index.js';
+export declare function bindProduct(container: Container, productManifest: ProductManifest, productI18n: ProductI18n): void;

package/dist/esm/utils/ioc/bindProduct.js

@@ -0,0 +1,6 @@
+export function bindProduct(container, productManifest, productI18n) {
+    container.rebind('I18n').toConstantValue(productI18n);
+    container
+        .rebind('ProductManifest')
+        .toConstantValue(productManifest);
+}

package/dist/esm/utils/ioc/bindProvider.d.ts

@@ -0,0 +1,2 @@
+import type { Container } from 'inversify';
+export declare function bindProvider<T>(container: Container, identifier: string): void;

package/dist/esm/utils/ioc/bindProvider.js

@@ -0,0 +1,9 @@
+export function bindProvider(container, identifier) {
+    container
+        .bind(`Provider<${identifier}>`)
+        .toProvider((context) => {
+        return async (clazz) => {
+            return context.container.resolve(clazz);
+        };
+    });
+}

package/dist/esm/utils/ioc/bindRN.d.ts

@@ -0,0 +1,2 @@
+import type { Container } from 'inversify';
+export declare function bindRN(container: Container): void;

package/dist/esm/utils/ioc/bindRN.js

@@ -0,0 +1,4 @@
+import { BufferLibBufferManager } from '../../std/impl/BufferLibBufferManager.js';
+export function bindRN(container) {
+    container.bind('BufferManager').to(BufferLibBufferManager);
+}

package/dist/esm/utils/ioc/bindServer.d.ts

@@ -0,0 +1,2 @@
+import type { Container } from 'inversify';
+export declare function bindServer(container: Container): void;

package/dist/esm/utils/ioc/bindServer.js

@@ -0,0 +1,8 @@
+import { JoseJWTManager } from '../../index.std-jwt-manager-jose.js';
+import { FakeEmailManager } from '../../std/impl/FakeEmailManager.js';
+import { FakeJobManager } from '../../std/impl/FakeJobManager.js';
+export function bindServer(container) {
+    container.bind('EmailManager').to(FakeEmailManager);
+    container.bind('JWTManager').to(JoseJWTManager);
+    container.bind('JobManager').to(FakeJobManager);
+}

package/dist/esm/utils/ioc/bindWeb.d.ts

@@ -0,0 +1,2 @@
+import type { Container } from 'inversify';
+export declare function bindWeb(container: Container): void;

package/dist/esm/utils/ioc/bindWeb.js

@@ -0,0 +1,12 @@
+import { BufferLibBufferManager } from '../../std/impl/BufferLibBufferManager.js';
+import { WebCryptoManager } from '../../std/impl/WebCryptoManager.js';
+import { WebFSManager } from '../../std/impl/WebFSManager.js';
+import { WebUCClientConfirmManager } from '../../uc/impl/WebUCClientConfirmManager.js';
+export function bindWeb(container) {
+    container.bind('BufferManager').to(BufferLibBufferManager);
+    container.bind('CryptoManager').to(WebCryptoManager);
+    container.bind('FSManager').to(WebFSManager);
+    container
+        .rebind('UCClientConfirmManager')
+        .to(WebUCClientConfirmManager);
+}

package/dist/esm/utils/ioc/container.d.ts

@@ -0,0 +1,2 @@
+import type { interfaces } from 'inversify';
+export declare const CONTAINER_OPTS: interfaces.ContainerOptions;

package/dist/esm/utils/ioc/container.js

@@ -0,0 +1,3 @@
+export const CONTAINER_OPTS = {
+    autoBindInjectable: true,
+};

package/dist/esm/utils/ioc/types.d.ts

@@ -0,0 +1,2 @@
+import type { interfaces } from 'inversify';
+export type Class<T> = interfaces.Newable<T>;

package/dist/esm/utils/ioc/types.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/utils/numbers/fmt.d.ts

@@ -0,0 +1,3 @@
+import type { UIntQuantity } from '../../dt/index.js';
+import { type Unit } from './units.js';
+export declare function fmt(value: number, unit?: Unit | undefined, decimalsCount?: UIntQuantity | undefined): string;

package/dist/esm/utils/numbers/fmt.js

@@ -0,0 +1,24 @@
+import { baseFromSquareUnit, isSquareUnit } from './units.js';
+export function fmt(value, unit, decimalsCount) {
+    if (!unit) {
+        return new Intl.NumberFormat(undefined, {
+            maximumFractionDigits: decimalsCount,
+        }).format(value);
+    }
+    let formatterUnit = undefined;
+    let unitSuffix = '';
+    if (isSquareUnit(unit)) {
+        formatterUnit = baseFromSquareUnit(unit);
+        unitSuffix = '²';
+    }
+    else {
+        formatterUnit = unit;
+    }
+    const formatted = new Intl.NumberFormat(undefined, {
+        maximumFractionDigits: decimalsCount,
+        style: 'unit',
+        unit: formatterUnit,
+        unitDisplay: 'short',
+    }).format(value);
+    return `${formatted}${unitSuffix}`;
+}

package/dist/esm/utils/numbers/units.d.ts

@@ -0,0 +1,9 @@
+import type { ExtractStrict } from '../types/utility-types.js';
+declare const CORE_UNITS: readonly ["acre", "bit", "byte", "celsius", "centimeter", "day", "degree", "fahrenheit", "fluid-ounce", "foot", "gallon", "gigabit", "gigabyte", "gram", "hectare", "hour", "inch", "kilobit", "kilobyte", "kilogram", "kilometer", "liter", "megabit", "megabyte", "meter", "microsecond", "mile", "mile-scandinavian", "milliliter", "millimeter", "millisecond", "minute", "month", "nanosecond", "ounce", "percent", "petabyte", "pound", "second", "stone", "terabit", "terabyte", "week", "yard", "year"];
+export type CoreUnit = (typeof CORE_UNITS)[number];
+export type SquareableUnit = ExtractStrict<CoreUnit, 'acre' | 'foot' | 'inch' | 'hectare' | 'kilometer' | 'meter' | 'mile' | 'mile-scandinavian' | 'millimeter' | 'yard'>;
+export type SquareUnit = `square-${SquareableUnit}`;
+export type Unit = CoreUnit | SquareUnit;
+export declare function isSquareUnit(unit: string): unit is SquareUnit;
+export declare function baseFromSquareUnit(unit: SquareUnit): CoreUnit;
+export {};

package/dist/esm/utils/numbers/units.js

@@ -0,0 +1,53 @@
+const CORE_UNITS = [
+    'acre',
+    'bit',
+    'byte',
+    'celsius',
+    'centimeter',
+    'day',
+    'degree',
+    'fahrenheit',
+    'fluid-ounce',
+    'foot',
+    'gallon',
+    'gigabit',
+    'gigabyte',
+    'gram',
+    'hectare',
+    'hour',
+    'inch',
+    'kilobit',
+    'kilobyte',
+    'kilogram',
+    'kilometer',
+    'liter',
+    'megabit',
+    'megabyte',
+    'meter',
+    'microsecond',
+    'mile',
+    'mile-scandinavian',
+    'milliliter',
+    'millimeter',
+    'millisecond',
+    'minute',
+    'month',
+    'nanosecond',
+    'ounce',
+    'percent',
+    'petabyte',
+    'pound',
+    'second',
+    'stone',
+    'terabit',
+    'terabyte',
+    'week',
+    'yard',
+    'year',
+];
+export function isSquareUnit(unit) {
+    return unit.startsWith('square-');
+}
+export function baseFromSquareUnit(unit) {
+    return unit.replace('square-', '');
+}

package/dist/esm/utils/strings/capitalize.d.ts

@@ -0,0 +1,2 @@
+export declare function capitalize<T extends string>(value: T): Capitalize<T>;
+export declare function isCapitalized(value: string): value is Capitalize<string>;

package/dist/esm/utils/strings/capitalize.js

@@ -0,0 +1,14 @@
+export function capitalize(value) {
+    const firstChar = value[0];
+    if (!firstChar) {
+        return '';
+    }
+    return (firstChar.toUpperCase() + value.slice(1));
+}
+export function isCapitalized(value) {
+    const firstChar = value[0];
+    if (!firstChar) {
+        return true;
+    }
+    return firstChar === firstChar.toUpperCase();
+}

package/dist/esm/utils/strings/humanize.d.ts

@@ -0,0 +1 @@
+export declare function humanize(value: string): string;

package/dist/esm/utils/strings/humanize.js

@@ -0,0 +1,5 @@
+export function humanize(value) {
+    let res = value.replace(/([a-z])([A-Z])/g, '$1 $2').trim();
+    res = res.charAt(0).toUpperCase() + res.slice(1);
+    return res;
+}

package/dist/esm/utils/strings/truncate.d.ts

@@ -0,0 +1,2 @@
+import type { UIntQuantity } from '../../dt/index.js';
+export declare function truncate(value: string, length: UIntQuantity, ellipsis?: string): string;

package/dist/esm/utils/strings/truncate.js

@@ -0,0 +1,3 @@
+export function truncate(value, length, ellipsis = '...') {
+    return value.length > length ? value.slice(0, length) + ellipsis : value;
+}

package/dist/esm/utils/terminal/fmt.d.ts

@@ -0,0 +1,4 @@
+export declare function fmtBold(s: string): string;
+export declare function fmtCommand(cmd: string, details: string | undefined, padEnd: number): string;
+export declare function fmtPadEndFor(s: string[]): number;
+export declare function fmtSection(s: string): string;

package/dist/esm/utils/terminal/fmt.js

@@ -0,0 +1,13 @@
+export function fmtBold(s) {
+    return `\x1b[1m${s}\x1b[0m`;
+}
+export function fmtCommand(cmd, details, padEnd) {
+    return `  ${cmd.padEnd(padEnd)}${details ?? ''}`;
+}
+export function fmtPadEndFor(s) {
+    const longest = s.sort((a, b) => a.length - b.length).reverse()[0];
+    return (longest?.length ?? 1) + 10;
+}
+export function fmtSection(s) {
+    return fmtBold(`\n[${s}]\n`);
+}

package/dist/esm/utils/types/funcs.d.ts

@@ -0,0 +1,6 @@
+import type { NumIndex, UIntQuantity } from '../../dt/index.js';
+export declare function assertIsDefined<T>(value: T, key: string): asserts value is NonNullable<T>;
+export declare function isBlank<T>(value: T | T[] | undefined | null): value is undefined | null;
+export declare function range(n: UIntQuantity): NumIndex[];
+export declare function sample<T>(items: T[]): T | null;
+export declare function tupleOf<T>(val: T, n: UIntQuantity): T[];

package/dist/esm/utils/types/funcs.js

@@ -0,0 +1,32 @@
+import { IllegalArgumentError } from '../../error/index.js';
+export function assertIsDefined(value, key) {
+    if (isBlank(value)) {
+        throw new IllegalArgumentError(`${key} is required`);
+    }
+}
+export function isBlank(value) {
+    return (value === undefined ||
+        value === null ||
+        (typeof value === 'string' && value.trim().length === 0) ||
+        (Array.isArray(value) && value.length === 0));
+}
+export function range(n) {
+    const items = [];
+    for (let i = 0; i < n; i++) {
+        items.push(i);
+    }
+    return items;
+}
+export function sample(items) {
+    if (items.length === 0) {
+        return null;
+    }
+    return items[Math.floor(Math.random() * items.length)] ?? null;
+}
+export function tupleOf(val, n) {
+    const items = [];
+    for (let i = 0; i < n; i++) {
+        items.push(val);
+    }
+    return items;
+}

package/dist/esm/utils/types/utility-types.d.ts

@@ -0,0 +1,5 @@
+export type ExtractStrict<T, U extends T> = Extract<T, U>;
+export type RecursiveNonNullable<T> = {
+    [K in keyof T]-?: RecursiveNonNullable<NonNullable<T[K]>>;
+};
+export type StringKeys<T extends object> = Extract<keyof T, string>;

package/dist/esm/utils/types/utility-types.js

@@ -0,0 +1 @@
+export {};

package/docs/getting-started/001_Create_the_project.md

@@ -0,0 +1,168 @@
+# Create the project
+
+Assuming you have the following installed (otherwise, install them or adapt the commands) :
+
+- `node` >= 22
+- `yarn` >= 1.x
+- `wget` and `curl`
+
+If you're on macOS, for the `sed` commands, add a `''` after `-i` ([Explanation](https://stackoverflow.com/a/4247319/1259118)).
+
+```sh
+# Create the directory
+mkdir libmodulor-tuto && cd libmodulor-tuto # Note how the repository is generic to contain multiple apps and products
+
+# Initialize git
+git init
+
+# Initialize config files
+touch .gitignore biome.json package.json README.md tsconfig.json vitest.config.ts
+```
+
+## .gitignore
+
+```.gitignore
+coverage
+dist
+node_modules
+src/apps/**/test/reports
+.env
+```
+
+## biome.json
+
+```json
+{
+    "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+    "files": {
+        "ignore": ["coverage", "dist", "node_modules"],
+        "ignoreUnknown": true
+    },
+    "formatter": {
+        "indentStyle": "space",
+        "indentWidth": 4
+    },
+    "javascript": {
+        "formatter": {
+            "quoteStyle": "single"
+        },
+        "parser": {
+            "unsafeParameterDecoratorsEnabled": true
+        }
+    }
+}
+```
+
+## package.json
+
+```json
+{
+    "name": "libmodulor-tuto",
+    "version": "0.1.0",
+    "author": "Chafik H'nini <chafik.hnini@gmail.com>",
+    "type": "module",
+    "private": true,
+    "scripts": {
+        "helper": "node ./node_modules/libmodulor/dist/esm/products/Helper/index.js",
+        "lint": "biome check --write .",
+        "test": "tsc && vitest run"
+    },
+    "dependencies": {
+        "inversify": "^6.2.1",
+        "libmodulor": "^0.3.0",
+        "reflect-metadata": "^0.2.2"
+    },
+    "devDependencies": {
+        "@biomejs/biome": "^1.9.4",
+        "@types/node": "^22.10.7",
+        "@vitest/coverage-v8": "^3.0.2",
+        "buffer": "^6.0.3",
+        "cookie-parser": "^1.4.7",
+        "express": "^4.21.2",
+        "express-fileupload": "^1.5.1",
+        "fast-check": "^3.23.2",
+        "helmet": "^8.0.0",
+        "jose": "^5.9.6",
+        "typescript": "^5.7.3",
+        "vite": "^6.0.11",
+        "vitest": "^3.0.3"
+    }
+}
+```
+
+## README.md
+
+```md
+# libmodulor-tuto
+
+🚀🚀🚀
+```
+
+## tsconfig.json
+
+```json
+{
+    "compilerOptions": {
+        "allowSyntheticDefaultImports": true,
+        "declaration": true,
+        "lib": ["dom", "esnext"],
+        "module": "NodeNext",
+        "moduleResolution": "NodeNext",
+        "noEmit": true,
+        "removeComments": true,
+        "skipLibCheck": true,
+        "sourceMap": true,
+        "target": "ESNext",
+
+        "strict": true,
+        "allowUnreachableCode": false,
+        "allowUnusedLabels": false,
+        "exactOptionalPropertyTypes": true,
+        "noFallthroughCasesInSwitch": true,
+        "noPropertyAccessFromIndexSignature": true,
+        "noImplicitOverride": true,
+        "noImplicitReturns": true,
+        "noUncheckedIndexedAccess": true,
+        "noUnusedLocals": true,
+        "noUnusedParameters": true,
+        "verbatimModuleSyntax": true,
+
+        "emitDecoratorMetadata": true,
+        "experimentalDecorators": true,
+
+        "jsx": "react"
+    }
+}
+```
+
+## vitest.config.ts
+
+```typescript
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+    test: {
+        coverage: {
+            enabled: true,
+            exclude: ['src/apps/**/test', 'src/**/*.test.ts'],
+            include: ['src'],
+            reporter: ['html', 'lcov', 'text'],
+        },
+        reporters: ['verbose'],
+    },
+});
+```
+
+## Install
+
+```sh
+yarn install
+```
+
+```sh
+yarn lint && git add . && git commit -m "chore: init source code"
+```
+
+Optionally, you can create a remote repository (e.g. on GitHub) and push it.
+
+Now that's done, let's [Create the App](./002_Create_the_App.md).