Skip to content

--requiredToBeDocumented options not validated correctly #1872

Closed
@williamkbentley

Description

@williamkbentley

Search terms

require
docs
warning
requiredToBeDocumented

Expected Behavior

Validate provided types array

Actual Behavior

Incorrect error reported

Steps to reproduce the bug

Attempt to run TypeDoc with --validation.notDocumented and --requiredToBeDocumented Enum

Results in:
Error: 'Enum' is an invalid value for 'requiredToBeDocumented'. Must be one of: Project, Module, Namespace, Enum, EnumMember, Variable, Function, Class, Interface, Constructor, Property, Method, CallSignature, IndexSignature, ConstructorSignature, Parameter, TypeLiteral, TypeParameter, Accessor, GetSignature, SetSignature, ObjectLiteral, TypeAlias, Event, Reference

See: #1819
src/lib/utils/options/sources/typedoc.ts

Environment

  • Typedoc version: 0.22.12
  • TypeScript version: ~4.4.0
  • Node.js version: 14.15.4
  • OS: Win10

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueEasier issue for first time contributorshelp wantedContributions are especially encouraged

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions