Close #693 - @ignore comment tag.

If you want to exclude a controller method from SDK library, write `@ignore` comment on the target controller method, then SDK generator will ignore it.

packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestia/core",
-  "version": "2.3.11",
+  "version": "2.3.12",
   "description": "Super-fast validation decorators of NestJS",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -34,7 +34,7 @@
   },
   "homepage": "https://nestia.io",
   "dependencies": {
-    "@nestia/fetcher": "^2.3.11",
+    "@nestia/fetcher": "^2.3.12",
     "@nestjs/common": ">=7.0.1",
     "@nestjs/core": ">=7.0.1",
     "@nestjs/platform-express": ">=7.0.1",
@@ -47,7 +47,7 @@
     "typia": "^5.2.6"
   },
   "peerDependencies": {
-    "@nestia/fetcher": ">=2.3.11",
+    "@nestia/fetcher": ">=2.3.12",
     "@nestjs/common": ">=7.0.1",
     "@nestjs/core": ">=7.0.1",
     "@nestjs/platform-express": ">=7.0.1",

packages/fetcher/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestia/fetcher",
-  "version": "2.3.11",
+  "version": "2.3.12",
   "description": "Fetcher library of Nestia SDK",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",

packages/sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestia/sdk",
-  "version": "2.3.11",
+  "version": "2.3.12",
   "description": "Nestia SDK and Swagger generator",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -35,7 +35,7 @@
   },
   "homepage": "https://nestia.io",
   "dependencies": {
-    "@nestia/fetcher": "^2.3.11",
+    "@nestia/fetcher": "^2.3.12",
     "cli": "^1.0.1",
     "get-function-location": "^2.0.0",
     "glob": "^7.2.0",
@@ -47,7 +47,7 @@
     "typia": "^5.2.6"
   },
   "peerDependencies": {
-    "@nestia/fetcher": ">=2.3.11",
+    "@nestia/fetcher": ">=2.3.12",
     "@nestjs/common": ">=7.0.1",
     "@nestjs/core": ">=7.0.1",
     "reflect-metadata": ">=0.1.12",

packages/sdk/src/analyses/ControllerAnalyzer.ts

@@ -115,6 +115,10 @@ export namespace ControllerAnalyzer {
                 return [];
             }
 
+            // SKIP @IGNORE TAG
+            const jsDocTags = signature.getJsDocTags();
+            if (jsDocTags.some((tag) => tag.name === "ignore")) return [];
+
             // EXPLORE CHILDREN TYPES
             const importDict: ImportAnalyzer.Dictionary = new HashMap();
             const parameters: Array<IRoute.IParameter | null> =
@@ -168,8 +172,7 @@ export namespace ControllerAnalyzer {
                 .toJSON()
                 .map((pair) => [pair.first, pair.second.toJSON()]);
 
-            // PARSE COMMENT TAGS
-            const jsDocTags = signature.getJsDocTags();
+            // CONSIDER SECURITY TAGS
             const security: Record<string, string[]>[] = SecurityAnalyzer.merge(
                 ...controller.security,
                 ...func.security,

test/features/ignore/nestia.config.ts

@@ -0,0 +1,15 @@
+import { INestiaConfig } from "@nestia/sdk";
+
+export const NESTIA_CONFIG: INestiaConfig = {
+    input: ["src/controllers"],
+    output: "src/api",
+    swagger: {
+        output: "swagger.json",
+        security: {
+            bearer: {
+                type: "apiKey",
+            },
+        },
+    },
+};
+export default NESTIA_CONFIG;

test/features/ignore/src/Backend.ts

@@ -0,0 +1,25 @@
+import core from "@nestia/core";
+import { INestApplication } from "@nestjs/common";
+import { NestFactory } from "@nestjs/core";
+import { Singleton } from "tstl";
+
+export class Backend {
+    public readonly application: Singleton<Promise<INestApplication>> =
+        new Singleton(async () =>
+            NestFactory.create(
+                await core.EncryptedModule.dynamic(__dirname + "/controllers", {
+                    key: "A".repeat(32),
+                    iv: "B".repeat(16),
+                }),
+                { logger: false },
+            ),
+        );
+
+    public async open(): Promise<void> {
+        return (await this.application.get()).listen(37_000);
+    }
+
+    public async close(): Promise<void> {
+        return (await this.application.get()).close();
+    }
+}

test/features/ignore/src/api/HttpError.ts

@@ -0,0 +1 @@
+export { HttpError } from "@nestia/fetcher";

test/features/ignore/src/api/IConnection.ts

@@ -0,0 +1 @@
+export type { IConnection } from "@nestia/fetcher";

test/features/ignore/src/api/Primitive.ts

@@ -0,0 +1 @@
+export type { Primitive } from "@nestia/fetcher";

test/features/ignore/src/api/functional/bbs/articles/index.ts

@@ -0,0 +1,114 @@
+/**
+ * @packageDocumentation
+ * @module api.functional.bbs.articles
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia 
+ */
+//================================================================
+import type { IConnection, Primitive } from "@nestia/fetcher";
+import { PlainFetcher } from "@nestia/fetcher/lib/PlainFetcher";
+import type { Format } from "typia/lib/tags/Format";
+
+import type { IBbsArticle } from "../../../structures/IBbsArticle";
+
+/**
+ * Store an article.
+ * 
+ * @param input Content to store
+ * @returns Newly archived article
+ * @deprecated
+ * 
+ * @controller BbsArticlesController.store
+ * @path POST /bbs/articles
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+export async function store(
+    connection: IConnection,
+    input: store.Input,
+): Promise<store.Output> {
+    return PlainFetcher.fetch(
+        {
+            ...connection,
+            headers: {
+                ...(connection.headers ?? {}),
+                "Content-Type": "application/json",
+            },
+        },
+        {
+            ...store.METADATA,
+            path: store.path(),
+        } as const,
+        input,
+    );
+}
+export namespace store {
+    export type Input = Primitive<IBbsArticle.IStore>;
+    export type Output = Primitive<IBbsArticle>;
+
+    export const METADATA = {
+        method: "POST",
+        path: "/bbs/articles",
+        request: {
+            type: "application/json",
+            encrypted: false
+        },
+        response: {
+            type: "application/json",
+            encrypted: false,
+        },
+        status: null,
+    } as const;
+
+    export const path = (): string => {
+        return `/bbs/articles`;
+    }
+}
+
+/**
+ * 
+ * @internal
+ * 
+ * @controller BbsArticlesController.update
+ * @path PUT /bbs/articles/:id
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+export async function update(
+    connection: IConnection,
+    id: string & Format<"uuid">,
+    input: update.Input,
+): Promise<void> {
+    return PlainFetcher.fetch(
+        {
+            ...connection,
+            headers: {
+                ...(connection.headers ?? {}),
+                "Content-Type": "application/json",
+            },
+        },
+        {
+            ...update.METADATA,
+            path: update.path(id),
+        } as const,
+        input,
+    );
+}
+export namespace update {
+    export type Input = Primitive<Partial<IBbsArticle.IStore>>;
+
+    export const METADATA = {
+        method: "PUT",
+        path: "/bbs/articles/:id",
+        request: {
+            type: "application/json",
+            encrypted: false
+        },
+        response: {
+            type: "application/json",
+            encrypted: false,
+        },
+        status: null,
+    } as const;
+
+    export const path = (id: string & Format<"uuid">): string => {
+        return `/bbs/articles/${encodeURIComponent(id ?? "null")}`;
+    }
+}

test/features/ignore/src/api/functional/bbs/index.ts

@@ -0,0 +1,7 @@
+/**
+ * @packageDocumentation
+ * @module api.functional.bbs
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia 
+ */
+//================================================================
+export * as articles from "./articles";

test/features/ignore/src/api/functional/health/index.ts

@@ -0,0 +1,42 @@
+/**
+ * @packageDocumentation
+ * @module api.functional.health
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia 
+ */
+//================================================================
+import type { IConnection } from "@nestia/fetcher";
+import { PlainFetcher } from "@nestia/fetcher/lib/PlainFetcher";
+
+/**
+ * @controller HealthController.get
+ * @path GET /health
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+export async function get(
+    connection: IConnection,
+): Promise<void> {
+    return PlainFetcher.fetch(
+        connection,
+        {
+            ...get.METADATA,
+            path: get.path(),
+        } as const,
+    );
+}
+export namespace get {
+
+    export const METADATA = {
+        method: "GET",
+        path: "/health",
+        request: null,
+        response: {
+            type: "application/json",
+            encrypted: false,
+        },
+        status: null,
+    } as const;
+
+    export const path = (): string => {
+        return `/health`;
+    }
+}

test/features/ignore/src/api/functional/index.ts

@@ -0,0 +1,9 @@
+/**
+ * @packageDocumentation
+ * @module api.functional
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia 
+ */
+//================================================================
+export * as bbs from "./bbs";
+export * as health from "./health";
+export * as performance from "./performance";

test/features/ignore/src/api/functional/performance/index.ts

@@ -0,0 +1,45 @@
+/**
+ * @packageDocumentation
+ * @module api.functional.performance
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia 
+ */
+//================================================================
+import type { IConnection, Primitive } from "@nestia/fetcher";
+import { PlainFetcher } from "@nestia/fetcher/lib/PlainFetcher";
+
+import type { IPerformance } from "../../structures/IPerformance";
+
+/**
+ * @controller PerformanceController.get
+ * @path GET /performance
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+export async function get(
+    connection: IConnection,
+): Promise<get.Output> {
+    return PlainFetcher.fetch(
+        connection,
+        {
+            ...get.METADATA,
+            path: get.path(),
+        } as const,
+    );
+}
+export namespace get {
+    export type Output = Primitive<IPerformance>;
+
+    export const METADATA = {
+        method: "GET",
+        path: "/performance",
+        request: null,
+        response: {
+            type: "application/json",
+            encrypted: false,
+        },
+        status: null,
+    } as const;
+
+    export const path = (): string => {
+        return `/performance`;
+    }
+}

test/features/ignore/src/api/index.ts

@@ -0,0 +1,4 @@
+import * as api from "./module";
+
+export * from "./module";
+export default api;

test/features/ignore/src/api/module.ts

@@ -0,0 +1,5 @@
+export type * from "./IConnection";
+export type * from "./Primitive";
+export * from "./HttpError";
+
+export * as functional from "./functional";