typedoc 0.22.11 → 0.22.12

package/dist/lib/application.js

@@ -22,6 +22,7 @@ const assert_1 = require("assert");
 const entry_point_1 = require("./utils/entry-point");
 const paths_1 = require("./utils/paths");
 const general_1 = require("./utils/general");
+const documentation_1 = require("./validation/documentation");
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const packageInfo = require("../../package.json");
 const supportedVersionMajorMinor = packageInfo.peerDependencies.typescript
@@ -248,6 +249,9 @@ let Application = Application_1 = class Application extends component_1.Childabl
         if (checks.notExported) {
             (0, exports_1.validateExports)(project, this.logger, this.options.getValue("intentionallyNotExported"));
         }
+        if (checks.notDocumented) {
+            (0, documentation_1.validateDocumentation)(project, this.logger, this.options.getValue("requiredToBeDocumented"));
+        }
         // checks.invalidLink is currently handled when rendering by the MarkedLinksPlugin.
         // It should really move here, but I'm putting that off until done refactoring the comment
         // parsing so that we don't have duplicate parse logic all over the place.

package/dist/lib/converter/symbols.js

@@ -492,11 +492,6 @@ function convertVariableAsFunction(context, symbol, exportSymbol) {
         : context.checker.getDeclaredTypeOfSymbol(symbol);
     const reflection = context.createDeclarationReflection(models_1.ReflectionKind.Function, symbol, exportSymbol);
     setModifiers(symbol, accessDeclaration, reflection);
-    // Does anyone care about this? I doubt it...
-    if (declaration &&
-        (0, enum_1.hasAllFlags)(symbol.flags, ts.SymbolFlags.BlockScopedVariable)) {
-        reflection.setFlag(models_1.ReflectionFlag.Const, (0, enum_1.hasAllFlags)((declaration || symbol.valueDeclaration).parent.flags, ts.NodeFlags.Const));
-    }
     context.finalizeDeclarationReflection(reflection, symbol, exportSymbol);
     const reflectionContext = context.withScope(reflection);
     (_b = reflection.signatures) !== null && _b !== void 0 ? _b : (reflection.signatures = []);
@@ -561,6 +556,10 @@ function setModifiers(symbol, declaration, reflection) {
     reflection.setFlag(models_1.ReflectionFlag.Readonly, (0, enum_1.hasAllFlags)((_a = symbol.checkFlags) !== null && _a !== void 0 ? _a : 0, ts.CheckFlags.Readonly) ||
         (0, enum_1.hasAllFlags)(modifiers, ts.ModifierFlags.Readonly));
     reflection.setFlag(models_1.ReflectionFlag.Abstract, (0, enum_1.hasAllFlags)(modifiers, ts.ModifierFlags.Abstract));
+    if (reflection.kindOf(models_1.ReflectionKind.Variable) &&
+        (0, enum_1.hasAllFlags)(symbol.flags, ts.SymbolFlags.BlockScopedVariable)) {
+        reflection.setFlag(models_1.ReflectionFlag.Const, (0, enum_1.hasAllFlags)(declaration.parent.flags, ts.NodeFlags.Const));
+    }
     // ReflectionFlag.Static happens when constructing the reflection.
     // We don't have sufficient information here to determine if it ought to be static.
 }

package/dist/lib/models/ReflectionGroup.d.ts

@@ -1,4 +1,4 @@
-import type { ReflectionKind } from "./reflections/abstract";
+import type { ReflectionKind } from "./reflections/kind";
 import type { ReflectionCategory } from "./ReflectionCategory";
 import type { DeclarationReflection } from ".";
 /**

package/dist/lib/models/reflections/abstract.d.ts

@@ -3,56 +3,13 @@ import type { Type } from "../types";
 import type { Comment } from "../comments/comment";
 import type { ProjectReflection } from "./project";
 import type { NeverIfInternal } from "../../utils";
+import { ReflectionKind } from "./kind";
 /**
  * Reset the reflection id.
  *
  * Used by the test cases to ensure the reflection ids won't change between runs.
  */
 export declare function resetReflectionID(): void;
-/**
- * Defines the available reflection kinds.
- */
-export declare enum ReflectionKind {
-    Project = 1,
-    Module = 2,
-    Namespace = 4,
-    Enum = 8,
-    EnumMember = 16,
-    Variable = 32,
-    Function = 64,
-    Class = 128,
-    Interface = 256,
-    Constructor = 512,
-    Property = 1024,
-    Method = 2048,
-    CallSignature = 4096,
-    IndexSignature = 8192,
-    ConstructorSignature = 16384,
-    Parameter = 32768,
-    TypeLiteral = 65536,
-    TypeParameter = 131072,
-    Accessor = 262144,
-    GetSignature = 524288,
-    SetSignature = 1048576,
-    ObjectLiteral = 2097152,
-    TypeAlias = 4194304,
-    Event = 8388608,
-    Reference = 16777216
-}
-/** @hidden */
-export declare namespace ReflectionKind {
-    const All: number;
-    const ClassOrInterface: number;
-    const VariableOrProperty: number;
-    const FunctionOrMethod: number;
-    const ClassMember: number;
-    const SomeSignature: number;
-    const SomeModule: number;
-    const SomeType: number;
-    const SomeValue: number;
-    /** @internal */
-    const Inheritable: number;
-}
 export declare enum ReflectionFlag {
     None = 0,
     Private = 1,

package/dist/lib/models/reflections/abstract.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Reflection = exports.TraverseProperty = exports.ReflectionFlags = exports.ReflectionFlag = exports.ReflectionKind = exports.resetReflectionID = void 0;
+exports.Reflection = exports.TraverseProperty = exports.ReflectionFlags = exports.ReflectionFlag = exports.resetReflectionID = void 0;
 const assert_1 = require("assert");
 const utils_1 = require("./utils");
+const kind_1 = require("./kind");
 /**
  * Holds all data models used by TypeDoc.
  *
@@ -27,68 +28,6 @@ function resetReflectionID() {
     REFLECTION_ID = 0;
 }
 exports.resetReflectionID = resetReflectionID;
-/**
- * Defines the available reflection kinds.
- */
-var ReflectionKind;
-(function (ReflectionKind) {
-    ReflectionKind[ReflectionKind["Project"] = 1] = "Project";
-    ReflectionKind[ReflectionKind["Module"] = 2] = "Module";
-    ReflectionKind[ReflectionKind["Namespace"] = 4] = "Namespace";
-    ReflectionKind[ReflectionKind["Enum"] = 8] = "Enum";
-    ReflectionKind[ReflectionKind["EnumMember"] = 16] = "EnumMember";
-    ReflectionKind[ReflectionKind["Variable"] = 32] = "Variable";
-    ReflectionKind[ReflectionKind["Function"] = 64] = "Function";
-    ReflectionKind[ReflectionKind["Class"] = 128] = "Class";
-    ReflectionKind[ReflectionKind["Interface"] = 256] = "Interface";
-    ReflectionKind[ReflectionKind["Constructor"] = 512] = "Constructor";
-    ReflectionKind[ReflectionKind["Property"] = 1024] = "Property";
-    ReflectionKind[ReflectionKind["Method"] = 2048] = "Method";
-    ReflectionKind[ReflectionKind["CallSignature"] = 4096] = "CallSignature";
-    ReflectionKind[ReflectionKind["IndexSignature"] = 8192] = "IndexSignature";
-    ReflectionKind[ReflectionKind["ConstructorSignature"] = 16384] = "ConstructorSignature";
-    ReflectionKind[ReflectionKind["Parameter"] = 32768] = "Parameter";
-    ReflectionKind[ReflectionKind["TypeLiteral"] = 65536] = "TypeLiteral";
-    ReflectionKind[ReflectionKind["TypeParameter"] = 131072] = "TypeParameter";
-    ReflectionKind[ReflectionKind["Accessor"] = 262144] = "Accessor";
-    ReflectionKind[ReflectionKind["GetSignature"] = 524288] = "GetSignature";
-    ReflectionKind[ReflectionKind["SetSignature"] = 1048576] = "SetSignature";
-    ReflectionKind[ReflectionKind["ObjectLiteral"] = 2097152] = "ObjectLiteral";
-    ReflectionKind[ReflectionKind["TypeAlias"] = 4194304] = "TypeAlias";
-    ReflectionKind[ReflectionKind["Event"] = 8388608] = "Event";
-    ReflectionKind[ReflectionKind["Reference"] = 16777216] = "Reference";
-})(ReflectionKind = exports.ReflectionKind || (exports.ReflectionKind = {}));
-/** @hidden */
-(function (ReflectionKind) {
-    ReflectionKind.All = ReflectionKind.Reference * 2 - 1;
-    ReflectionKind.ClassOrInterface = ReflectionKind.Class | ReflectionKind.Interface;
-    ReflectionKind.VariableOrProperty = ReflectionKind.Variable | ReflectionKind.Property;
-    ReflectionKind.FunctionOrMethod = ReflectionKind.Function | ReflectionKind.Method;
-    ReflectionKind.ClassMember = ReflectionKind.Accessor |
-        ReflectionKind.Constructor |
-        ReflectionKind.Method |
-        ReflectionKind.Property |
-        ReflectionKind.Event;
-    ReflectionKind.SomeSignature = ReflectionKind.CallSignature |
-        ReflectionKind.IndexSignature |
-        ReflectionKind.ConstructorSignature |
-        ReflectionKind.GetSignature |
-        ReflectionKind.SetSignature;
-    ReflectionKind.SomeModule = ReflectionKind.Namespace | ReflectionKind.Module;
-    ReflectionKind.SomeType = ReflectionKind.Interface |
-        ReflectionKind.TypeLiteral |
-        ReflectionKind.TypeParameter |
-        ReflectionKind.TypeAlias;
-    ReflectionKind.SomeValue = ReflectionKind.Variable |
-        ReflectionKind.Function |
-        ReflectionKind.ObjectLiteral;
-    /** @internal */
-    ReflectionKind.Inheritable = ReflectionKind.Accessor |
-        ReflectionKind.IndexSignature |
-        ReflectionKind.Property |
-        ReflectionKind.Method |
-        ReflectionKind.Constructor;
-})(ReflectionKind = exports.ReflectionKind || (exports.ReflectionKind = {}));
 var ReflectionFlag;
 (function (ReflectionFlag) {
     ReflectionFlag[ReflectionFlag["None"] = 0] = "None";
@@ -409,7 +348,7 @@ class Reflection {
      * Return a string representation of this reflection.
      */
     toString() {
-        return ReflectionKind[this.kind] + " " + this.name;
+        return kind_1.ReflectionKind[this.kind] + " " + this.name;
     }
     /**
      * Return a string representation of this reflection and all of its children.

package/dist/lib/models/reflections/container.d.ts

@@ -1,7 +1,8 @@
-import { Reflection, ReflectionKind, TraverseCallback } from "./abstract";
+import { Reflection, TraverseCallback } from "./abstract";
 import type { ReflectionCategory } from "../ReflectionCategory";
 import type { ReflectionGroup } from "../ReflectionGroup";
 import type { DeclarationReflection } from "./declaration";
+import type { ReflectionKind } from "./kind";
 export declare class ContainerReflection extends Reflection {
     /**
      * The children of this reflection.

package/dist/lib/models/reflections/index.d.ts

@@ -1,8 +1,9 @@
-export { Reflection, ReflectionKind, ReflectionFlag, TraverseProperty, ReflectionFlags, } from "./abstract";
+export { Reflection, ReflectionFlag, ReflectionFlags, TraverseProperty, } from "./abstract";
 export type { Decorator, TraverseCallback } from "./abstract";
 export { ContainerReflection } from "./container";
 export { DeclarationReflection } from "./declaration";
 export type { DeclarationHierarchy } from "./declaration";
+export { ReflectionKind } from "./kind";
 export { ParameterReflection } from "./parameter";
 export { ProjectReflection } from "./project";
 export { ReferenceReflection } from "./reference";

package/dist/lib/models/reflections/index.js

@@ -1,16 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.splitUnquotedString = exports.TypeParameterReflection = exports.SignatureReflection = exports.ReferenceReflection = exports.ProjectReflection = exports.ParameterReflection = exports.DeclarationReflection = exports.ContainerReflection = exports.ReflectionFlags = exports.TraverseProperty = exports.ReflectionFlag = exports.ReflectionKind = exports.Reflection = void 0;
+exports.splitUnquotedString = exports.TypeParameterReflection = exports.SignatureReflection = exports.ReferenceReflection = exports.ProjectReflection = exports.ParameterReflection = exports.ReflectionKind = exports.DeclarationReflection = exports.ContainerReflection = exports.TraverseProperty = exports.ReflectionFlags = exports.ReflectionFlag = exports.Reflection = void 0;
 var abstract_1 = require("./abstract");
 Object.defineProperty(exports, "Reflection", { enumerable: true, get: function () { return abstract_1.Reflection; } });
-Object.defineProperty(exports, "ReflectionKind", { enumerable: true, get: function () { return abstract_1.ReflectionKind; } });
 Object.defineProperty(exports, "ReflectionFlag", { enumerable: true, get: function () { return abstract_1.ReflectionFlag; } });
-Object.defineProperty(exports, "TraverseProperty", { enumerable: true, get: function () { return abstract_1.TraverseProperty; } });
 Object.defineProperty(exports, "ReflectionFlags", { enumerable: true, get: function () { return abstract_1.ReflectionFlags; } });
+Object.defineProperty(exports, "TraverseProperty", { enumerable: true, get: function () { return abstract_1.TraverseProperty; } });
 var container_1 = require("./container");
 Object.defineProperty(exports, "ContainerReflection", { enumerable: true, get: function () { return container_1.ContainerReflection; } });
 var declaration_1 = require("./declaration");
 Object.defineProperty(exports, "DeclarationReflection", { enumerable: true, get: function () { return declaration_1.DeclarationReflection; } });
+var kind_1 = require("./kind");
+Object.defineProperty(exports, "ReflectionKind", { enumerable: true, get: function () { return kind_1.ReflectionKind; } });
 var parameter_1 = require("./parameter");
 Object.defineProperty(exports, "ParameterReflection", { enumerable: true, get: function () { return parameter_1.ParameterReflection; } });
 var project_1 = require("./project");

package/dist/lib/models/reflections/kind.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Defines the available reflection kinds.
+ */
+export declare enum ReflectionKind {
+    Project = 1,
+    Module = 2,
+    Namespace = 4,
+    Enum = 8,
+    EnumMember = 16,
+    Variable = 32,
+    Function = 64,
+    Class = 128,
+    Interface = 256,
+    Constructor = 512,
+    Property = 1024,
+    Method = 2048,
+    CallSignature = 4096,
+    IndexSignature = 8192,
+    ConstructorSignature = 16384,
+    Parameter = 32768,
+    TypeLiteral = 65536,
+    TypeParameter = 131072,
+    Accessor = 262144,
+    GetSignature = 524288,
+    SetSignature = 1048576,
+    ObjectLiteral = 2097152,
+    TypeAlias = 4194304,
+    Event = 8388608,
+    Reference = 16777216
+}
+/** @hidden */
+export declare namespace ReflectionKind {
+    const All: number;
+    const ClassOrInterface: number;
+    const VariableOrProperty: number;
+    const FunctionOrMethod: number;
+    const ClassMember: number;
+    const SomeSignature: number;
+    const SomeModule: number;
+    const SomeType: number;
+    const SomeValue: number;
+    /** @internal */
+    const Inheritable: number;
+}

package/dist/lib/models/reflections/kind.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReflectionKind = void 0;
+/**
+ * Defines the available reflection kinds.
+ */
+var ReflectionKind;
+(function (ReflectionKind) {
+    ReflectionKind[ReflectionKind["Project"] = 1] = "Project";
+    ReflectionKind[ReflectionKind["Module"] = 2] = "Module";
+    ReflectionKind[ReflectionKind["Namespace"] = 4] = "Namespace";
+    ReflectionKind[ReflectionKind["Enum"] = 8] = "Enum";
+    ReflectionKind[ReflectionKind["EnumMember"] = 16] = "EnumMember";
+    ReflectionKind[ReflectionKind["Variable"] = 32] = "Variable";
+    ReflectionKind[ReflectionKind["Function"] = 64] = "Function";
+    ReflectionKind[ReflectionKind["Class"] = 128] = "Class";
+    ReflectionKind[ReflectionKind["Interface"] = 256] = "Interface";
+    ReflectionKind[ReflectionKind["Constructor"] = 512] = "Constructor";
+    ReflectionKind[ReflectionKind["Property"] = 1024] = "Property";
+    ReflectionKind[ReflectionKind["Method"] = 2048] = "Method";
+    ReflectionKind[ReflectionKind["CallSignature"] = 4096] = "CallSignature";
+    ReflectionKind[ReflectionKind["IndexSignature"] = 8192] = "IndexSignature";
+    ReflectionKind[ReflectionKind["ConstructorSignature"] = 16384] = "ConstructorSignature";
+    ReflectionKind[ReflectionKind["Parameter"] = 32768] = "Parameter";
+    ReflectionKind[ReflectionKind["TypeLiteral"] = 65536] = "TypeLiteral";
+    ReflectionKind[ReflectionKind["TypeParameter"] = 131072] = "TypeParameter";
+    ReflectionKind[ReflectionKind["Accessor"] = 262144] = "Accessor";
+    ReflectionKind[ReflectionKind["GetSignature"] = 524288] = "GetSignature";
+    ReflectionKind[ReflectionKind["SetSignature"] = 1048576] = "SetSignature";
+    ReflectionKind[ReflectionKind["ObjectLiteral"] = 2097152] = "ObjectLiteral";
+    ReflectionKind[ReflectionKind["TypeAlias"] = 4194304] = "TypeAlias";
+    ReflectionKind[ReflectionKind["Event"] = 8388608] = "Event";
+    ReflectionKind[ReflectionKind["Reference"] = 16777216] = "Reference";
+})(ReflectionKind = exports.ReflectionKind || (exports.ReflectionKind = {}));
+/** @hidden */
+(function (ReflectionKind) {
+    ReflectionKind.All = ReflectionKind.Reference * 2 - 1;
+    ReflectionKind.ClassOrInterface = ReflectionKind.Class | ReflectionKind.Interface;
+    ReflectionKind.VariableOrProperty = ReflectionKind.Variable | ReflectionKind.Property;
+    ReflectionKind.FunctionOrMethod = ReflectionKind.Function | ReflectionKind.Method;
+    ReflectionKind.ClassMember = ReflectionKind.Accessor |
+        ReflectionKind.Constructor |
+        ReflectionKind.Method |
+        ReflectionKind.Property |
+        ReflectionKind.Event;
+    ReflectionKind.SomeSignature = ReflectionKind.CallSignature |
+        ReflectionKind.IndexSignature |
+        ReflectionKind.ConstructorSignature |
+        ReflectionKind.GetSignature |
+        ReflectionKind.SetSignature;
+    ReflectionKind.SomeModule = ReflectionKind.Namespace | ReflectionKind.Module;
+    ReflectionKind.SomeType = ReflectionKind.Interface |
+        ReflectionKind.TypeLiteral |
+        ReflectionKind.TypeParameter |
+        ReflectionKind.TypeAlias;
+    ReflectionKind.SomeValue = ReflectionKind.Variable |
+        ReflectionKind.Function |
+        ReflectionKind.ObjectLiteral;
+    /** @internal */
+    ReflectionKind.Inheritable = ReflectionKind.Accessor |
+        ReflectionKind.IndexSignature |
+        ReflectionKind.Property |
+        ReflectionKind.Method |
+        ReflectionKind.Constructor;
+})(ReflectionKind = exports.ReflectionKind || (exports.ReflectionKind = {}));

package/dist/lib/models/reflections/project.d.ts

@@ -1,7 +1,8 @@
 import { SourceFile, SourceDirectory } from "../sources/index";
-import { Reflection, ReflectionKind } from "./abstract";
+import { Reflection } from "./abstract";
 import { ContainerReflection } from "./container";
 import type * as ts from "typescript";
+import { ReflectionKind } from "./kind";
 /**
  * A reflection that represents the root of the project.
  *

package/dist/lib/models/reflections/project.js

@@ -8,6 +8,7 @@ const utils_1 = require("./utils");
 const reference_1 = require("./reference");
 const types_1 = require("../types");
 const utils_2 = require("../../utils");
+const kind_1 = require("./kind");
 /**
  * A reflection that represents the root of the project.
  *
@@ -21,7 +22,7 @@ class ProjectReflection extends container_1.ContainerReflection {
      * @param name  The name of the project.
      */
     constructor(name) {
-        super(name, abstract_1.ReflectionKind.Project);
+        super(name, kind_1.ReflectionKind.Project);
         // Used to resolve references.
         this.symbolToReflectionIdMap = new Map();
         this.reflectionIdToSymbolMap = new Map();

package/dist/lib/models/reflections/reference.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReferenceReflection = void 0;
 const abstract_1 = require("./abstract");
 const declaration_1 = require("./declaration");
+const kind_1 = require("./kind");
 /**
  * Describes a reflection which does not exist at this location, but is referenced. Used for imported reflections.
  *
@@ -26,7 +27,7 @@ class ReferenceReflection extends declaration_1.DeclarationReflection {
      * @internal
      */
     constructor(name, state, parent) {
-        super(name, abstract_1.ReflectionKind.Reference, parent);
+        super(name, kind_1.ReflectionKind.Reference, parent);
         this._target = state;
     }
     /**

package/dist/lib/models/reflections/signature.d.ts

@@ -1,8 +1,9 @@
 import { Type, ReferenceType } from "../types";
-import { Reflection, TraverseCallback, ReflectionKind } from "./abstract";
+import { Reflection, TraverseCallback } from "./abstract";
 import type { ParameterReflection } from "./parameter";
 import type { TypeParameterReflection } from "./type-parameter";
 import type { DeclarationReflection } from "./declaration";
+import type { ReflectionKind } from "./kind";
 export declare class SignatureReflection extends Reflection {
     /**
      * Create a new SignatureReflection to contain a specific type of signature.

package/dist/lib/models/reflections/type-parameter.js

@@ -2,12 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TypeParameterReflection = void 0;
 const abstract_1 = require("./abstract");
+const kind_1 = require("./kind");
 class TypeParameterReflection extends abstract_1.Reflection {
     /**
      * Create a new TypeParameterReflection instance.
      */
     constructor(name, constraint, defaultType, parent) {
-        super(name, abstract_1.ReflectionKind.TypeParameter, parent);
+        super(name, kind_1.ReflectionKind.TypeParameter, parent);
         this.type = constraint;
         this.default = defaultType;
     }

package/dist/lib/utils/options/declaration.d.ts

@@ -2,6 +2,7 @@ import type { Theme as ShikiTheme } from "shiki";
 import type { LogLevel } from "../loggers";
 import type { SortStrategy } from "../sort";
 import type { EntryPointStrategy } from "../entry-point";
+import type { ReflectionKind } from "../../models/reflections/kind";
 export declare const EmitStrategy: {
     readonly true: true;
     readonly false: false;
@@ -85,6 +86,7 @@ export interface TypeDocOptionMap {
     /** @deprecated use validation.invalidLink */
     listInvalidSymbolLinks: boolean;
     validation: ValidationOptions;
+    requiredToBeDocumented: (keyof typeof ReflectionKind)[];
 }
 export declare type ValidationOptions = {
     /**
@@ -96,6 +98,10 @@ export declare type ValidationOptions = {
      * If set, TypeDoc will produce warnings about \{&link\} tags which will produce broken links.
      */
     invalidLink: boolean;
+    /**
+     * If set, TypeDoc will produce warnings about declarations that do not have doc comments
+     */
+    notDocumented: boolean;
 };
 /**
  * Converts a given TypeDoc option key to the type of the declaration expected.

package/dist/lib/utils/options/sources/typedoc.js

@@ -6,6 +6,7 @@ const declaration_1 = require("../declaration");
 const shiki_1 = require("shiki");
 const sort_1 = require("../../sort");
 const entry_point_1 = require("../../entry-point");
+const kind_1 = require("../../../models/reflections/kind");
 function addTypeDocOptions(options) {
     options.addDeclaration({
         type: declaration_1.ParameterType.Path,
@@ -311,6 +312,33 @@ function addTypeDocOptions(options) {
         help: "A list of types which should not produce 'referenced but not documented' warnings.",
         type: declaration_1.ParameterType.Array,
     });
+    options.addDeclaration({
+        name: "requiredToBeDocumented",
+        help: "A list of reflection kinds that must be documented",
+        type: declaration_1.ParameterType.Array,
+        validate(values) {
+            // this is good enough because the values of the ReflectionKind enum are all numbers
+            const validValues = Object.values(kind_1.ReflectionKind).filter((v) => typeof v === "string");
+            for (const kind of values) {
+                if (validValues.includes(kind)) {
+                    throw new Error(`'${kind}' is an invalid value for 'requiredToBeDocumented'. Must be one of: ${validValues.join(", ")}`);
+                }
+            }
+        },
+        defaultValue: [
+            "Enum",
+            "EnumMember",
+            "Variable",
+            "Function",
+            "Class",
+            "Interface",
+            "Property",
+            "Method",
+            "GetSignature",
+            "SetSignature",
+            "TypeAlias",
+        ],
+    });
     options.addDeclaration({
         name: "validation",
         help: "Specify which validation steps TypeDoc should perform on your generated documentation.",
@@ -318,6 +346,7 @@ function addTypeDocOptions(options) {
         defaults: {
             notExported: true,
             invalidLink: false,
+            notDocumented: false,
         },
     });
 }

package/dist/lib/utils/sort.js

@@ -5,7 +5,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sortReflections = exports.SORT_STRATEGIES = void 0;
-const abstract_1 = require("../models/reflections/abstract");
+const kind_1 = require("../models/reflections/kind");
 exports.SORT_STRATEGIES = [
     "source-order",
     "alphabetical",
@@ -47,8 +47,8 @@ const sorts = {
     },
     "enum-value-ascending"(a, b) {
         var _a, _b;
-        if (a.kind == abstract_1.ReflectionKind.EnumMember &&
-            b.kind == abstract_1.ReflectionKind.EnumMember) {
+        if (a.kind == kind_1.ReflectionKind.EnumMember &&
+            b.kind == kind_1.ReflectionKind.EnumMember) {
             return (parseFloat((_a = a.defaultValue) !== null && _a !== void 0 ? _a : "0") <
                 parseFloat((_b = b.defaultValue) !== null && _b !== void 0 ? _b : "0"));
         }
@@ -56,8 +56,8 @@ const sorts = {
     },
     "enum-value-descending"(a, b) {
         var _a, _b;
-        if (a.kind == abstract_1.ReflectionKind.EnumMember &&
-            b.kind == abstract_1.ReflectionKind.EnumMember) {
+        if (a.kind == kind_1.ReflectionKind.EnumMember &&
+            b.kind == kind_1.ReflectionKind.EnumMember) {
             return (parseFloat((_a = b.defaultValue) !== null && _a !== void 0 ? _a : "0") <
                 parseFloat((_b = a.defaultValue) !== null && _b !== void 0 ? _b : "0"));
         }
@@ -89,31 +89,31 @@ const sorts = {
     },
     kind(a, b) {
         const weights = [
-            abstract_1.ReflectionKind.Reference,
-            abstract_1.ReflectionKind.Project,
-            abstract_1.ReflectionKind.Module,
-            abstract_1.ReflectionKind.Namespace,
-            abstract_1.ReflectionKind.Enum,
-            abstract_1.ReflectionKind.EnumMember,
-            abstract_1.ReflectionKind.Class,
-            abstract_1.ReflectionKind.Interface,
-            abstract_1.ReflectionKind.TypeAlias,
-            abstract_1.ReflectionKind.Constructor,
-            abstract_1.ReflectionKind.Event,
-            abstract_1.ReflectionKind.Property,
-            abstract_1.ReflectionKind.Variable,
-            abstract_1.ReflectionKind.Function,
-            abstract_1.ReflectionKind.Accessor,
-            abstract_1.ReflectionKind.Method,
-            abstract_1.ReflectionKind.ObjectLiteral,
-            abstract_1.ReflectionKind.Parameter,
-            abstract_1.ReflectionKind.TypeParameter,
-            abstract_1.ReflectionKind.TypeLiteral,
-            abstract_1.ReflectionKind.CallSignature,
-            abstract_1.ReflectionKind.ConstructorSignature,
-            abstract_1.ReflectionKind.IndexSignature,
-            abstract_1.ReflectionKind.GetSignature,
-            abstract_1.ReflectionKind.SetSignature,
+            kind_1.ReflectionKind.Reference,
+            kind_1.ReflectionKind.Project,
+            kind_1.ReflectionKind.Module,
+            kind_1.ReflectionKind.Namespace,
+            kind_1.ReflectionKind.Enum,
+            kind_1.ReflectionKind.EnumMember,
+            kind_1.ReflectionKind.Class,
+            kind_1.ReflectionKind.Interface,
+            kind_1.ReflectionKind.TypeAlias,
+            kind_1.ReflectionKind.Constructor,
+            kind_1.ReflectionKind.Event,
+            kind_1.ReflectionKind.Property,
+            kind_1.ReflectionKind.Variable,
+            kind_1.ReflectionKind.Function,
+            kind_1.ReflectionKind.Accessor,
+            kind_1.ReflectionKind.Method,
+            kind_1.ReflectionKind.ObjectLiteral,
+            kind_1.ReflectionKind.Parameter,
+            kind_1.ReflectionKind.TypeParameter,
+            kind_1.ReflectionKind.TypeLiteral,
+            kind_1.ReflectionKind.CallSignature,
+            kind_1.ReflectionKind.ConstructorSignature,
+            kind_1.ReflectionKind.IndexSignature,
+            kind_1.ReflectionKind.GetSignature,
+            kind_1.ReflectionKind.SetSignature,
         ];
         return weights.indexOf(a.kind) < weights.indexOf(b.kind);
     },

package/dist/lib/validation/documentation.d.ts

@@ -0,0 +1,3 @@
+import { ProjectReflection, ReflectionKind } from "../models";
+import { Logger } from "../utils";
+export declare function validateDocumentation(project: ProjectReflection, logger: Logger, requiredToBeDocumented: readonly (keyof typeof ReflectionKind)[]): void;

package/dist/lib/validation/documentation.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateDocumentation = void 0;
+const path = require("path");
+const ts = require("typescript");
+const models_1 = require("../models");
+const utils_1 = require("../utils");
+function validateDocumentation(project, logger, requiredToBeDocumented) {
+    const kinds = requiredToBeDocumented.reduce((prev, cur) => (prev |= models_1.ReflectionKind[cur]), 0);
+    for (const ref of project.getReflectionsByKind(kinds)) {
+        const symbol = project.getSymbolFromReflection(ref);
+        if (!ref.comment && (symbol === null || symbol === void 0 ? void 0 : symbol.declarations)) {
+            const decl = symbol.declarations[0];
+            const sourceFile = decl.getSourceFile();
+            const { line } = ts.getLineAndCharacterOfPosition(sourceFile, decl.getStart());
+            const file = (0, utils_1.normalizePath)(path.relative(process.cwd(), sourceFile.fileName));
+            if (file.includes("node_modules")) {
+                continue;
+            }
+            const loc = `${file}:${line + 1}`;
+            logger.warn(`${ref.name}, defined at ${loc}, does not have any documentation.`);
+        }
+    }
+}
+exports.validateDocumentation = validateDocumentation;

package/dist/lib/validation/exports.js

@@ -65,7 +65,7 @@ function validateExports(project, logger, intentionallyNotExported) {
                     const decl = symbol.declarations[0];
                     const { line } = ts.getLineAndCharacterOfPosition(decl.getSourceFile(), decl.getStart());
                     const file = (0, utils_1.normalizePath)((0, path_1.relative)(process.cwd(), decl.getSourceFile().fileName));
-                    logger.warn(`${type.name}, defined at ${file}:${line}, is referenced by ${current.getFullName()} but not included in the documentation.`);
+                    logger.warn(`${type.name}, defined at ${file}:${line + 1}, is referenced by ${current.getFullName()} but not included in the documentation.`);
                 }
             }
         },

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.22.11",
+  "version": "0.22.12",
   "homepage": "https://typedoc.org",
   "main": "./dist/index.js",
   "exports": "./dist/index.js",
@@ -50,6 +50,7 @@
     "reg-suit": "^0.11.1",
     "reg-suit-core": "^0.11.1",
     "reg-suit-interface": "^0.11.0",
+    "ts-node": "^10.4.0",
     "typescript": "^4.5.4"
   },
   "files": [
@@ -63,9 +64,9 @@
   ],
   "scripts": {
     "pretest": "node scripts/copy_test_files.js",
-    "test": "mocha --config .config/mocha.fast.json",
+    "test": "mocha -r ts-node/register --config .config/mocha.fast.json",
     "pretest:full": "npm run pretest",
-    "test:full": "nyc mocha --config .config/mocha.full.json",
+    "test:full": "nyc mocha -r ts-node/register --config .config/mocha.full.json",
     "test:visual": "node ./dist/test/capture-screenshots.js && reg-suit -c .config/regconfig.json compare",
     "test:visual:accept": "node scripts/accept_visual_regression.js",
     "prerebuild_specs": "npm run pretest",

package/dist/lib/ts-internal.d.ts

@@ -1,43 +0,0 @@
-import type * as ts from "typescript";
-/**
- * Expose the internal TypeScript APIs that are used by TypeDoc
- */
-declare module "typescript" {
-    interface Node {
-        symbol?: ts.Symbol;
-    }
-    interface Symbol {
-        checkFlags?: CheckFlags;
-    }
-    interface TypeChecker {
-        getTypePredicateOfSignature(signature: ts.Signature): ts.TypePredicate | undefined;
-    }
-    interface UnionType {
-        origin?: ts.Type;
-    }
-    enum CheckFlags {
-        Instantiated = 1,
-        SyntheticProperty = 2,
-        SyntheticMethod = 4,
-        Readonly = 8,
-        ReadPartial = 16,
-        WritePartial = 32,
-        HasNonUniformType = 64,
-        HasLiteralType = 128,
-        ContainsPublic = 256,
-        ContainsProtected = 512,
-        ContainsPrivate = 1024,
-        ContainsStatic = 2048,
-        Late = 4096,
-        ReverseMapped = 8192,
-        OptionalParameter = 16384,
-        RestParameter = 32768,
-        DeferredType = 65536,
-        HasNeverType = 131072,
-        Mapped = 262144,
-        StripOptional = 524288,
-        Synthetic = 6,
-        Discriminant = 192,
-        Partial = 48
-    }
-}

package/dist/lib/ts-internal.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });