Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

--requiredToBeDocumented options not validated correctly #1872

Closed
williamkbentley opened this issue Feb 22, 2022 · 1 comment
Closed

--requiredToBeDocumented options not validated correctly #1872

williamkbentley opened this issue Feb 22, 2022 · 1 comment
Labels
bug Functionality does not match expectation good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged

Comments

@williamkbentley
Copy link

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
@williamkbentley williamkbentley added the bug Functionality does not match expectation label Feb 22, 2022
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Feb 24, 2022

D'oh, that's a problem...

@Gerrit0 Gerrit0 added good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged labels Feb 24, 2022
@Gerrit0 Gerrit0 closed this as completed in 4350d47 Mar 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged
Projects
None yet
Development

No branches or pull requests

2 participants