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

[FEATURE] Git hook + documentation coverage #546

Closed
manekinekko opened this issue Apr 25, 2018 · 2 comments
Closed

[FEATURE] Git hook + documentation coverage #546

manekinekko opened this issue Apr 25, 2018 · 2 comments

Comments

@manekinekko
Copy link
Member

Add the ability to run compodoc as a linting tool to report documentation coverage issues. This is similar to what the lintstagged tool does.

Having this feature would allow compodoc to run as a git hook, for instance.

@manekinekko manekinekko changed the title [FEATURE] Use static data-target ids [FEATURE] linting capabilities Apr 25, 2018
@vogloblinsky vogloblinsky added this to the 1.2.0 milestone Apr 25, 2018
@vogloblinsky vogloblinsky changed the title [FEATURE] linting capabilities [FEATURE] Git hook + documentation coverage Apr 25, 2018
@vogloblinsky
Copy link
Contributor

@manekinekko
From what i have read, a package like https://github.com/typicode/husky does the job ?
After installation, add the corresponding npm script :

...
	"precommit": "compodoc -p src/tsconfig.app.json --coverageTest 65"
...

@lock
Copy link

lock bot commented Sep 30, 2019

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem. Why locking ? Having issues with the most up-to-date context.

@lock lock bot locked as resolved and limited conversation to collaborators Sep 30, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants