Remove keyof resolution option

Author: socsieng

src/convert/keyof-comment-resolver.ts

@@ -1,6 +1,5 @@
 import {
   Comment,
-  CommentTag,
   DeclarationReflection,
   ProjectReflection,
   ReferenceType,
@@ -16,35 +15,6 @@ import join from '../util/join';
 import { propertySorter } from '../util/sort';
 
 export default class KeyOfCommentResolver {
-  public resolveKeys(project: ProjectReflection, reflection: Reflection, override: boolean = false) {
-    const node = reflection as DeclarationReflection;
-    const type = node.type as TypeOperatorType;
-    const reference = this.getDeclaration(project, type.target);
-
-    let keys = this.getKeys(reference)
-      .sort(propertySorter(r => r.id))
-      .map(r => type.target?.type === 'reference' ? `[[${(type.target as ReferenceType)?.name}.${r.name}|\`${r.name}\`]]` : `\`${r.name}\``)
-      .join(', ');
-
-    if (!node.comment) {
-      node.comment = new Comment();
-    }
-
-    if (!node.comment.tags) {
-      node.comment.tags = [];
-    }
-
-    let tag = node.comment.getTag('keys');
-    if (tag) {
-      if (override) {
-        tag.text = keys;
-      }
-    } else {
-      tag = new CommentTag('keys', undefined, keys);
-      node.comment.tags.push(tag);
-    }
-  }
-
   public shouldResolveKeys(project: ProjectReflection, reflection: Reflection) {
     const node = reflection as DeclarationReflection;
 

src/keyof-plugin.ts

@@ -1,37 +1,11 @@
 import { Context, Converter } from 'typedoc/dist/lib/converter';
-import { DeclarationOption, ParameterType } from 'typedoc/dist/lib/utils/options/declaration';
-import { BindOption } from 'typedoc/dist/lib/utils';
 import { ConverterComponent } from 'typedoc/dist/lib/converter/components';
 import KeyOfCommentResolver from './convert/keyof-comment-resolver';
 
-export enum AddKeysTagOption {
-  off = 0,
-  add = 1,
-  update = 2,
-}
-
-export const addKeysOptionMapping: { [key: string]: AddKeysTagOption } = {
-  off: AddKeysTagOption.off,
-  add: AddKeysTagOption.add,
-  update: AddKeysTagOption.update,
-};
-
-const keyofCommentsOption = {
-  name: 'keyofComments',
-  type: ParameterType.Map,
-  help: 'Expands the values of the keyof operator and adds a tag, default is set to off',
-  defaultValue: AddKeysTagOption.off,
-  map: addKeysOptionMapping,
-} as DeclarationOption;
-
 export class KeyOfPlugin extends ConverterComponent {
   static options = [
-    keyofCommentsOption,
   ];
 
-  @BindOption(keyofCommentsOption.name)
-  _mode!: AddKeysTagOption;
-
   protected initialize() {
     this.listenTo(this.owner, {
       [Converter.EVENT_RESOLVE_BEGIN]: this.onBeginResolve,
@@ -40,14 +14,6 @@ export class KeyOfPlugin extends ConverterComponent {
 
   private onBeginResolve(context: Context) {
     const resolver = KeyOfCommentResolver.instance();
-    if (this._mode !== AddKeysTagOption.off) {
-      const override = this._mode === AddKeysTagOption.update;
-
-      Object.values(context.project.reflections)
-        .filter(item => resolver.shouldResolveKeys(context.project, item))
-        .forEach(item => resolver.resolveKeys(context.project, item, override));
-    }
-
     Object.values(context.project.reflections)
       .filter(item => resolver.shouldInlineKeys(context.project, item))
       .forEach(item => resolver.inlineKeys(context.project, item));

tests/dynamic-tests.ts

@@ -83,11 +83,9 @@ describe('Dynamic test suite', () => {
       const keyOfResolver = KeyOfCommentResolver.instance();
 
       const reflectionsToRemove = filter.filterReflections(Object.values(project.reflections), Version.parse('1.0'));
-      const reflectionsWithKeys = Object.values(project.reflections).filter(r => keyOfResolver.shouldResolveKeys(project, r));
       const reflectionsToInline = Object.values(project.reflections).filter(r => keyOfResolver.shouldInlineKeys(project, r));
 
       filter.removeReflections(project, reflectionsToRemove);
-      reflectionsWithKeys.forEach(r => keyOfResolver.resolveKeys(project, r));
       reflectionsToInline.forEach(r => keyOfResolver.inlineKeys(project, r));
 
       OmitTagsPlugin.removeTags(Object.values(project.reflections), ['stuff']);

tests/test-data/type/operator-expected.d.ts

@@ -1,7 +1,4 @@
 declare module test {
-  /**
-   * @keys [[StatusTypes.success|`success`]], [[StatusTypes.failure|`failure`]]
-   */
   type StatusType = keyof StatusTypes;
 
   type StatusTypes = {
@@ -33,27 +30,8 @@ declare module test {
    *
    *   - switch
    *   - television
-   *
-   * @keys `on`, `off`
    */
   type DynamicType = "on" | "off";
 
-  /**
-   * Should leave these keys tag alone
-   *
-   * @keys on | off
-   * | ON | OFF
-   */
-  type LeaveThisAlone = keyof {
-    /**
-     * Turns stuff on
-     */
-    on: string,
-    /**
-     * Turns stuff off
-     */
-    off: string,
-  };
-
   type Reference = "on" | "off";
 }

tests/test-data/type/operator-input.ts

@@ -35,22 +35,5 @@ export module test {
     off: string,
   };
 
-  /**
-   * Should leave these keys tag alone
-   *
-   * @keys on | off
-   * | ON | OFF
-   */
-  export type LeaveThisAlone = keyof {
-    /**
-     * Turns stuff on
-     */
-    on: string,
-    /**
-     * Turns stuff off
-     */
-    off: string,
-  };
-
   export type Reference = "on" | "off";
 }