search

inch-ci / inch_ci-web

Web frontend for Inch CI
http://inch-ci.org/
MIT License
139 stars 20 forks source link

It appears to be inch only picks up files in the root dir #89

Closed Gum-Joe closed 9 years ago

Gum-Joe commented 9 years ago

Re: Gum-Joe/Web-OS In my node-js project,inch failed to evaluate files out the root dir (e.g: it ignored files in my ./libs folder)

rrrene commented 9 years ago

You can configure which files inch should parse: https://inch-ci.org/help/config_file_json

{
  "files": {
    "included": ["libs/"]
  }
}

Please note that an alternative to putting the config in an inch.json is to put the same hash in your package.json under an inch key:

"inch": {
  "files": {
    "included": ["libs/"]
  }
}

Hope this helps!

Gum-Joe commented 9 years ago

Thanks, thought it would automatically parse all the documents By the way, does it ignore functions in the form of exports.NameOfFunction()?

rrrene commented 9 years ago

Effectively, yes, but not intentional.

I'm using JSDoc for parsing JavaScript and if JSDoc does not pick it up, then we're out of luck. So while I would very much like to support more common idioms from the JavaScript and especially Node community, I have to "work with what I got" so to speak :wink:

Gum-Joe commented 9 years ago

Thankyou, will now close issue