-
Notifications
You must be signed in to change notification settings - Fork 710
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add option to warn on undocumented items (#1819)
* Add option to warn on undocumented items * Fix skip node_modules * fix off by one error Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix off by one error on reporting * Fix changelog, change ignore node_modules check Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix formatting Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix circular dep Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix circular reference * Actually fix circular dep * Improve errors for invalid requiredToBeDocumented values Co-authored-by: Gerrit Birkeland <gerrit@gerritbirkeland.com>
- Loading branch information
Showing
19 changed files
with
190 additions
and
97 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
/** | ||
* Defines the available reflection kinds. | ||
*/ | ||
export enum ReflectionKind { | ||
Project = 0x1, | ||
Module = 0x2, | ||
Namespace = 0x4, | ||
Enum = 0x8, | ||
EnumMember = 0x10, | ||
Variable = 0x20, | ||
Function = 0x40, | ||
Class = 0x80, | ||
Interface = 0x100, | ||
Constructor = 0x200, | ||
Property = 0x400, | ||
Method = 0x800, | ||
CallSignature = 0x1000, | ||
IndexSignature = 0x2000, | ||
ConstructorSignature = 0x4000, | ||
Parameter = 0x8000, | ||
TypeLiteral = 0x10000, | ||
TypeParameter = 0x20000, | ||
Accessor = 0x40000, | ||
GetSignature = 0x80000, | ||
SetSignature = 0x100000, | ||
ObjectLiteral = 0x200000, | ||
TypeAlias = 0x400000, | ||
Event = 0x800000, | ||
Reference = 0x1000000, | ||
} | ||
|
||
/** @hidden */ | ||
export namespace ReflectionKind { | ||
export const All = ReflectionKind.Reference * 2 - 1; | ||
|
||
export const ClassOrInterface = | ||
ReflectionKind.Class | ReflectionKind.Interface; | ||
export const VariableOrProperty = | ||
ReflectionKind.Variable | ReflectionKind.Property; | ||
export const FunctionOrMethod = | ||
ReflectionKind.Function | ReflectionKind.Method; | ||
export const ClassMember = | ||
ReflectionKind.Accessor | | ||
ReflectionKind.Constructor | | ||
ReflectionKind.Method | | ||
ReflectionKind.Property | | ||
ReflectionKind.Event; | ||
export const SomeSignature = | ||
ReflectionKind.CallSignature | | ||
ReflectionKind.IndexSignature | | ||
ReflectionKind.ConstructorSignature | | ||
ReflectionKind.GetSignature | | ||
ReflectionKind.SetSignature; | ||
export const SomeModule = ReflectionKind.Namespace | ReflectionKind.Module; | ||
export const SomeType = | ||
ReflectionKind.Interface | | ||
ReflectionKind.TypeLiteral | | ||
ReflectionKind.TypeParameter | | ||
ReflectionKind.TypeAlias; | ||
export const SomeValue = | ||
ReflectionKind.Variable | | ||
ReflectionKind.Function | | ||
ReflectionKind.ObjectLiteral; | ||
|
||
/** @internal */ | ||
export const Inheritable = | ||
ReflectionKind.Accessor | | ||
ReflectionKind.IndexSignature | | ||
ReflectionKind.Property | | ||
ReflectionKind.Method | | ||
ReflectionKind.Constructor; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.