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

possible to exclude dependencies/requires in documentation lint #956

Closed
insipx opened this issue Nov 21, 2017 · 2 comments
Closed

possible to exclude dependencies/requires in documentation lint #956

insipx opened this issue Nov 21, 2017 · 2 comments

Comments

@insipx
Copy link

insipx commented Nov 21, 2017

  • What version of documentation.js are you using?: 5.3.3
  • How are you running documentation.js (on the CLI, Node.js API, Grunt, other?): Node.js npm:
    ./node_modules/.bin/documentation lint lib/**.js

running documentation.js like I am currently, it lints files outside of ./lib, presumably because they are local and required by a file inside of lib/. These local dependencies are 3rd-party deps in the form of git submodules.

Is there a way to run 'shallow' on documentation lint to exclude any dependencies?

@tmcw
Copy link
Member

tmcw commented Nov 21, 2017

Have you tried the --shallow flag? I'm seeing that it's not correctly documented in lint --help but it should work nonetheless.

@bubenkoff
Copy link
Contributor

bubenkoff commented Jan 15, 2018

@tmcw no, --shallow is not an allowed argument, any other ways of working this around?

bubenkoff added a commit to quriobot/documentation that referenced this issue Jan 15, 2018
bubenkoff added a commit to quriobot/documentation that referenced this issue Jan 15, 2018
@tmcw tmcw closed this as completed in 64f660d Mar 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants