nestia 2.0.4 → 2.0.5

package/README.md

@@ -79,15 +79,20 @@ Just type the `nestia sdk <input> --out <output>` command in the console. When t
 Also, when generating a SDK using the cli options, `compilerOptions` would follow the `tsconfig.json`, that is configured for the backend server. If no `tsconfig.json` file exists in your project, the configuration would be default option (`ES5` with `strict` mode). If you want to use different `compilerOptions` with the `tsconfig.json`, you should configure the [nestia.config.ts](#nestiaconfigts).
 
 ### Dependencies
-SDK library generated by the **Nestia** requires the [nestia-fetcher](https://github.com/samchon/nestia-fetcher) module. 
+```bash
+npx nestia install
+```
+
+SDK library generated by the **Nestia** requires the [nestia-fetcher](https://github.com/samchon/nestia-fetcher) and [typescript-is](https://github.com/woutervh-/typescript-is) modules.
 
-Therefore, when you publish an SDK library generated by this **Nestia**, you have to write the [nestia-fetcher](https://github.com/samchon/nestia-fetcher) module into the `dependencies` property of the `package.json` file like below. You also can configure the `dependencies` property of the `package.json` file by typing the `npm install --save nestia-fetcher` command in the console, too.
+The `npx nestia install` command installs those dependencies with `package.json` configuration.
 
 ```json
 {
   "name": "payments-server-api",
   "dependencies": {
-    "nestia-fetcher": "^1.0.2"
+    "nestia-fetcher": "^2.0.0",
+    "typescript-is": "^0.19.0"
   }
 }
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nestia",
-  "version": "2.0.4",
+  "version": "2.0.5",
   "description": "Automatic SDK and Document generator for the NestJS",
   "main": "src/index.ts",
   "bin": {
@@ -33,9 +33,10 @@
     "@types/node": "^17.0.23",
     "@types/reflect-metadata": "^0.1.0",
     "cli": "^1.0.1",
+    "comment-json": "^4.2.2",
     "del": "^6.0.0",
     "glob": "^7.2.0",
-    "ts-node": "^10.7.0",
+    "ts-node": "^9.1.1",
     "tstl": "^2.5.3",
     "ttypescript": "^1.5.13",
     "typescript": "^4.6.3",

package/src/bin/nestia.ts

@@ -1,17 +1,10 @@
 #!/usr/bin/env ts-node
 
 import * as cp from "child_process";
-import * as fs from "fs";
 import * as path from "path";
 import * as process from "process";
 
-import { CompilerOptions } from "../internal/CompilerOptions";
-import { stripJsonComments } from "../utils/stripJsonComments";
-
-interface IConfig
-{
-    compilerOptions?: CompilerOptions;
-}
+import { TsConfig } from "../internal/TsConfig";
 
 function install(): void
 {
@@ -23,11 +16,14 @@ function install(): void
     }
 }
 
-function sdk(file: string): void
+async function sdk(): Promise<void>
 {
-    // PREPARE COMMAND
+    // PREPARE TSCONFIG
+    await TsConfig.fulfill();
+
+    // CONSTRUCT COMMAND
     const parameters: string[] = [
-        `npx ts-node -C ttypescript --project "${file}"`,
+        `npx ts-node`,
         `"${path.relative(process.cwd(), `${__dirname}/../executable/sdk`)}"`,
         ...process.argv.slice(3)
     ];
@@ -41,80 +37,18 @@ function sdk(file: string): void
             stdio: "inherit",
             env: { 
                 ...process.env, 
+                "TS_NODE_COMPILER": "ttypescript",
                 "NODE_NO_WARNINGS": "1" 
             } 
         }
     );
 }
-
-function configure(config: IConfig): boolean
-{
-    if (!config.compilerOptions)
-    {
-        config.compilerOptions = CompilerOptions.DEFAULT;
-        return true;
-    }
-    else
-        return CompilerOptions.emend(config.compilerOptions);
-}
-
-async function tsconfig(task: (file: string) => void): Promise<void>
-{
-    //----
-    // PREPARE ASSETS
-    //----
-    let prepare: null | (() => Promise<[string, () => Promise<void>]>) = null;
-
-    // NO TSCONFIG.JSON?
-    if (fs.existsSync("tsconfig.json") === false)
-    {
-        const config = { compilerOptions: CompilerOptions.DEFAULT };
-        prepare = CompilerOptions.temporary(config);
-    }
-    else
-    {
-        // HAS TSCONFIG.JSON
-        const content: string = await fs.promises.readFile("tsconfig.json", "utf8");
-        const config = JSON.parse(stripJsonComments(content));
-        
-        // NEED TO ADD TRANSFORM PLUGINS
-        const changed: boolean = configure(config);
-        if (changed === true)
-            prepare = CompilerOptions.temporary(config);
-    }
-
-    //----
-    // EXECUTION
-    //----
-    // CREATE TEMPORARY TSCONFIG
-    const [file, erasure] = prepare ? await prepare() : ["tsconfig.json", null];
-
-    // EXECUTE THE TASK
-    let error: Error | null = null;
-    try
-    {
-        task(file);
-    }
-    catch (exp)
-    {
-        error = exp as Error;
-    }
-
-    // REMOVE THE TEMPORARY TSCONFIG
-    if (erasure)
-        await erasure();
-
-    // THROW ERROR IF EXISTS
-    if (error)
-        throw error;
-}
-
 async function main()
 {
     if (process.argv[2] === "install")
         await install();
     else if (process.argv[2] === "sdk")
-        await tsconfig(sdk);
+        await sdk();
     else
         throw new Error(`nestia supports only two commands; install and sdk, however you typed ${process.argv[2]}`);
 }

package/src/internal/TsConfig.ts

@@ -0,0 +1,115 @@
+import * as fs from "fs";
+import * as path from "path";
+import * as process from "process";
+import * as tsc from "typescript";
+import * as CSON from "comment-json"
+
+export interface TsConfig
+{
+    compilerOptions?: tsc.CompilerOptions;
+}
+export namespace TsConfig
+{
+    /* -----------------------------------------------------------
+        DEFAULT VALUES
+    ----------------------------------------------------------- */
+    const DEFAULT_OPTIONS = {
+        target: "es5",
+        module: "commonjs",
+        types: [
+            "node",
+            "reflect-metadata"
+        ],
+        esModuleInterop: true,
+        experimentalDecorators: true,
+        emitDecoratorMetadata: true,
+        plugins: [
+            { transform: "typescript-is/lib/transform-inline/transformer" }, 
+            { transform: "typescript-transform-paths" }
+        ]
+    };
+
+    export async function fulfill(): Promise<void>
+    {
+        if (fs.existsSync("tsconfig.json") === false)
+        {
+            // NO TSCONFIG.JSON EXISTS
+            await fs.promises.copyFile
+            (
+                path.relative(process.cwd(), __dirname + "/tsconfig.default.json"),
+                "tsconfig.json"
+            );
+            return;
+        }
+
+        const content: string = await fs.promises.readFile("tsconfig.json", "utf8");
+        const config: CSON.CommentObject = CSON.parse(content) as CSON.CommentObject;
+        
+        if (!config.compilerOptions)
+        {
+            // NO COMPILER-OPTION EXISTS
+            const defaultConfig: CSON.CommentObject = JSON.parse
+            (
+                await fs.promises.readFile
+                (
+                    path.relative(process.cwd(), __dirname + "/tsconfig.default.json"),
+                    "utf8"
+                )
+            );
+
+            config.compilerOptions = defaultConfig.compilerOptions;
+            await fs.promises.writeFile
+            (
+                "tsconfig.json",
+                CSON.stringify(config, null, 2),
+                "utf8"
+            );
+        }
+        else
+        {
+            // FILL ESSENTIAL PROPS
+            const options: CSON.CommentObject = config.compilerOptions as CSON.CommentObject;
+            for (const [key, value] of Object.entries(DEFAULT_OPTIONS))
+            {
+                if (!options[key])
+                    CSON.assign(config.compilerOptions, { [key]: value });
+                else if (options[key] instanceof Array && value instanceof Array && key !== "plugins")
+                    CSON.assign
+                    (
+                        config.compilerOptions,
+                        { 
+                            [key]: 
+                            [
+                                ...new Set
+                                ([
+                                    ...value, 
+                                    ...options[key] as string[]
+                                ])
+                            ]
+                        }
+                    );
+            }
+
+            if (!options.plugins)
+                CSON.assign(options.plugins, { plugins: DEFAULT_OPTIONS.plugins });
+            else
+            {
+                const optionPlugins: CSON.CommentArray<CSON.CommentObject> = options.plugins as CSON.CommentArray<CSON.CommentObject>;
+                for (const plugin of DEFAULT_OPTIONS.plugins)
+                {
+                    const found = optionPlugins.find(elem => elem.transform === plugin.transform);
+                    if (!found)
+                        optionPlugins.push(plugin);
+                }
+            }
+        }
+
+        // OVERWRITE THE CONTENT
+        await fs.promises.writeFile
+        (
+            "tsconfig.json",
+            CSON.stringify(config, null, 2),
+            "utf8"
+        );
+    }
+}

package/src/internal/tsconfig.default.json

@@ -0,0 +1,81 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
+    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+    "lib": [
+      "DOM",
+      "ES2015"
+    ],                             /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    // "outDir": "./lib",                        /* Redirect output structure to the directory. */
+    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    "noUnusedLocals": true,                /* Report errors on unused locals. */
+    "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+    // "noUncheckedIndexedAccess": true,      /* Include 'undefined' in index signature results */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    "types": [
+      "node",
+      "reflect-metadata"
+    ],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+    "stripInternal": true,
+
+    /* Advanced Options */
+    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
+    "forceConsistentCasingInFileNames": true,  /* Disallow inconsistently-cased references to the same file. */
+    "plugins": [
+      { "transform": "typescript-is/lib/transform-inline/transformer" },
+      { "transform": "typescript-transform-paths" }
+    ]
+  }
+}

package/src/internal/CompilerOptions.ts

@@ -1,142 +0,0 @@
-import * as fs from "fs";
-
-export interface CompilerOptions
-{
-    target: string;
-    module: string;
-    lib: string[];
-    strict: boolean;
-    downlevelIteration: boolean;
-    esModuleInterop?: boolean;
-    plugins?: Array<{ 
-        transform?: string 
-    }>;
-    types?: string[];
-    experimentalDecorators?: boolean;
-    emitDecoratorMetadata?: boolean;
-}
-export namespace CompilerOptions
-{
-    /* -----------------------------------------------------------
-        DEFAULT VALUES
-    ----------------------------------------------------------- */
-    export const DEPENDENCIES: string[] = [
-        "nestia-fetcher", 
-        "typescript-is"
-    ];
-
-    export const TRANSFORMERS: string[] = [
-        "typescript-is/lib/transform-inline/transformer", 
-        "typescript-transform-paths"
-    ];
-
-    export const TYPES: string[] = []
-
-    export const DEFAULT = {
-        target: "es5",
-        module: "commonjs",
-        lib: [
-            "DOM", 
-            "ES2015"
-        ],
-        strict: true,
-        downlevelIteration: true,
-        esModuleInterop: true,
-        plugins: TRANSFORMERS.map(transform => ({ transform })),
-        types: [
-            "node",
-            "reflect-metadata"
-        ],
-        experimentalDecorators: true,
-        emitDecoratorMetadata: true,
-    };
-
-    export function emend(options: CompilerOptions): boolean
-    {
-        // FILL ARRAY DATA
-        if (!options.plugins)
-            options.plugins = [];
-        if (!options.types)
-            options.types = [];
-        
-        // CONSTRUCT CHECKERS
-        const emended: Required<CompilerOptions> = options as Required<CompilerOptions>;
-        const checkers: Array<() => boolean> = [
-            () => 
-            {
-                let changed: boolean = false;
-                for (const transform of CompilerOptions.TRANSFORMERS)
-                {
-                    if (emended.plugins.find(elem => elem.transform === transform) !== undefined)
-                        continue;
-    
-                    changed = true;
-                    emended.plugins.push({ transform });
-                }
-                return changed;
-            },
-            () =>
-            {
-                let changed: boolean = false;
-                for (const type of CompilerOptions.TYPES)
-                {
-                    if (emended.types.find(elem => elem === type) !== undefined)
-                        continue;
-    
-                    changed = true;
-                    emended.types.push(type);
-                }
-                return changed;
-            },
-            () =>
-            {
-                const changed: boolean = emended.experimentalDecorators !== true;
-                if (changed)
-                    emended.experimentalDecorators = true;
-                return changed;
-            },
-            () =>
-            {
-                const changed: boolean = emended.emitDecoratorMetadata !== true;
-                if (changed)
-                    emended.emitDecoratorMetadata = true;
-                return changed;
-            },
-            () =>
-            {
-                const changed: boolean = emended.esModuleInterop !== true;
-                if (changed)
-                    emended.esModuleInterop = true;
-                return changed;
-            }
-        ];
-
-        // DO CHECK IT
-        const checks: boolean[] = checkers.map(func => func());
-        return checks.some(flag => flag);
-    }
-
-    /* -----------------------------------------------------------
-        PROCEDURES
-    ----------------------------------------------------------- */
-    export function temporary(config: IConfig): () => Promise<[string, () => Promise<void>]>
-    {
-        return async () =>
-        {
-            const file: string = `nestia.temporary.tsconfig.${Math.random().toString().substr(2)}.json`;
-            
-            await fs.promises.writeFile
-            (
-                file,
-                JSON.stringify(config, null, 2),
-                "utf8" 
-            );
-            return [file, () => fs.promises.unlink(file)];
-        };
-    }
-}
-
-interface IConfig
-{
-    compilerOptions?: CompilerOptions;
-}