Merge pull request #403 from cmaster11/ignore-description

Add the `disableDescription` flag, which can be used to NOT print a description for a schema, even if it has been defined previously.

src/__tests__/description/index.ts

@@ -28,6 +28,34 @@ describe('description', () => {
  * Do not modify this file manually
  */
 
+export interface DisableDescription {
+  /**
+   * thing
+   */
+  thing: string;
+}
+
+/**
+ * DisableDescriptionObject
+ */
+export interface DisableDescriptionObject {
+  /**
+   * withDescription
+   */
+  withDescription?: {
+    /**
+     * A simple description
+     */
+    [x: string]: Example;
+  };
+  /**
+   * withoutDescription
+   */
+  withoutDescription?: {
+    [x: string]: Example;
+  };
+}
+
 /**
  * A simple description
  */

src/__tests__/description/schemas/OneSchema.ts

@@ -18,3 +18,14 @@ And more here!
 export const noCommentSchema = Joi.object({
   more: Joi.string().required()
 }).meta({ className: 'NoComment' });
+
+export const disableDescriptionSchema = exampleSchema.meta({
+  className: 'DisableDescription',
+  disableDescription: true
+});
+export const disableDescriptionObjectSchema = Joi.object({
+  withDescription: Joi.object().pattern(Joi.string(), exampleSchema).meta({ unknownType: exampleSchema }),
+  withoutDescription: Joi.object()
+    .pattern(Joi.string(), exampleSchema)
+    .meta({ unknownType: exampleSchema.meta({ disableDescription: true }) })
+}).meta({ className: 'DisableDescriptionObject' });

src/joiUtils.ts

@@ -29,6 +29,16 @@ export function getIsReadonly(details: Describe): boolean | undefined {
   return undefined;
 }
 
+export function getDisableDescription(details: Describe): boolean | undefined {
+  const disableDescriptionItems = getMetadataFromDetails('disableDescription', details);
+  if (disableDescriptionItems.length !== 0) {
+    const disableDescription = disableDescriptionItems.pop();
+    return Boolean(disableDescription);
+  }
+
+  return undefined;
+}
+
 /**
  * Get the interface name from the Joi
  * @returns a string if it can find one

src/parse.ts

@@ -9,7 +9,13 @@ import {
   ObjectDescribe,
   StringDescribe
 } from './joiDescribeTypes';
-import { getAllowValues, getInterfaceOrTypeName, getIsReadonly, getMetadataFromDetails } from './joiUtils';
+import {
+  getAllowValues,
+  getDisableDescription,
+  getInterfaceOrTypeName,
+  getIsReadonly,
+  getMetadataFromDetails
+} from './joiUtils';
 import { getIndentStr, getJsDocString } from './write';
 
 // see __tests__/joiTypes.ts for more information
@@ -30,6 +36,7 @@ function getCommonDetails(
   const value = details.flags?.default;
   const example = details.examples?.[0];
   const isReadonly = getIsReadonly(details);
+  const disableJsDoc = getDisableDescription(details);
 
   let required;
   if (
@@ -42,7 +49,13 @@ function getCommonDetails(
   } else {
     required = settings.defaultToRequired;
   }
-  return { interfaceOrTypeName, jsDoc: { description, example }, required, value, isReadonly };
+  return {
+    interfaceOrTypeName,
+    jsDoc: { description, example, disable: disableJsDoc },
+    required,
+    value,
+    isReadonly
+  };
 }
 
 export function getAllCustomTypes(parsedSchema: TypeContent): string[] {

src/types.ts

@@ -304,4 +304,8 @@ export interface JsDoc {
    * @example example value
    */
   example?: string;
+  /**
+   * If true, completely disables printing JsDoc
+   */
+  disable?: boolean;
 }

src/write.ts

@@ -4,7 +4,7 @@
 import { writeFileSync } from 'fs';
 import Path from 'path';
 
-import { Settings, JsDoc } from './types';
+import { JsDoc, Settings } from './types';
 
 /**
  * Write index.ts file
@@ -23,9 +23,11 @@ export function writeIndexFile(settings: Settings, fileNamesToExport: string[]):
 }
 
 export function getTypeFileNameFromSchema(schemaFileName: string, settings: Settings): string {
-  return (schemaFileName.endsWith(`${settings.schemaFileSuffix}.ts`)
-    ? schemaFileName.substring(0, schemaFileName.length - `${settings.schemaFileSuffix}.ts`.length)
-    : schemaFileName.replace('.ts', '')) + settings.interfaceFileSuffix;
+  return (
+    (schemaFileName.endsWith(`${settings.schemaFileSuffix}.ts`)
+      ? schemaFileName.substring(0, schemaFileName.length - `${settings.schemaFileSuffix}.ts`.length)
+      : schemaFileName.replace('.ts', '')) + settings.interfaceFileSuffix
+  );
 }
 
 /**
@@ -41,6 +43,10 @@ export function getIndentStr(settings: Settings, indentLevel: number): string {
  * Get Interface jsDoc
  */
 export function getJsDocString(settings: Settings, name: string, jsDoc?: JsDoc, indentLevel = 0): string {
+  if (jsDoc?.disable == true) {
+    return '';
+  }
+
   if (!settings.commentEverything && !jsDoc?.description && !jsDoc?.example) {
     return '';
   }