SyntaxError: Unexpected end of input about inchjs

[rrrene]

Yeah, I have a suspicion. Will get back to you!

[rrrene]

Should work now with v0.2.0. Could you check again?

If you have any suggestions/questions regarding Inch's evaluation, please do not hesitate to post them here!

[FGRibreau]

@rrrene Indeed, it works now, thanks!
I plan to include inchjs to check-build, that's why I'm currently testing it :)

[rrrene]

Sounds fantastic! If I can be of any help, just let me know.

[FGRibreau]

Hum, just looked at the code, @rrrene could you expose the internal library as a NodeJS API (and document it ?) ?

So I will be able to create an interface for check-build that will allow users to fail a build if at least X files are undocumented or that some files have a C grades.

[rrrene]

@FGRibreau A NodeJS API sounds like a good idea. Unfortunately, I have a lot on my plate right now, so I'm not sure how long this will take.

You could, however, parse the output of inchjs stats --format=json for now. What do you think?

[FGRibreau]

@rrrene yes, I could start with that.

• What would be good defaults for inchjs ? Stop the build if C > 0 ?

From the above output:

{
  "grade_lists": {
    "A": 0,
    "B": 1,
    "C": 0,
    "U": 7
  },
  "scores": {
    "0": 7,
    "50": 1
  },
  "priorities": {
    "1": 8
  }
}

• What does mean priorities ? ... and scores ?
• Could inchjs output file names along each grade as well ?

[rrrene]

I am afraid that is a question only you can answer.

One idea: U should be below 90%, alas 10% of code should be documented. This would not set the bar very high. The question is how good the average project in NodeJS is documented. Maybe I am mistaken, but I got the impression that inline code-documentation is not that high a priority in Node projects.

Re: Scores and priorities -- Scores are points given for the present documentation. They determine the grades. Priorities determine how badly a code object should be documented (> 0 means it should be).