search

coffeedoc / codo

CoffeeScript API documentation generator. It's like YARD but for CoffeeScript!
Other
625 stars 92 forks source link

Fixed Test failing with CoffeeScript >= 1.9.1 #217

Closed dbartholomae closed 8 years ago

dbartholomae commented 8 years ago

Hi there,

in the newer versions of CoffeeScript some of the comment nodes are placed a little bit differently (see #210). I added functionality to look for a comment at the right spot. Furthermore I added functionality for tests to work in Windows, fixed an issue with assignments of the form a = f().b being parsed as variable declarations and added functionality so that comments before new class ClassName are used for that class. I know it's a lot for one pull request, if you are interested in integrating them I can split them up again.

Best, Daniel

inossidabile commented 8 years ago

Thanks!

dbartholomae commented 8 years ago

As mentioned in #218 I realized that there have been some additional commits as I forgot to change the branch when pushing them to my repo:

  1. In tests show colored diffs instead of full JSON (based on #209)
  2. Add two more CLI options:
    • "--min-coverage" allows to check if enough of the code is documented
    • "--test" runs codo without creating files (useful together with min-coverage)
  3. Remove date/time from the default template, so that you can just automatically run codo on each commit without having changes in each file due to the change of time.

Not sure if you saw those, sorry for that. If some of them are not in your interest just tell me and I will split them out of the PR / create a reverting PR. On the other hand, if you do like them, it might make sense to bump to 2.1.0 and publish the added features to npm.

inossidabile commented 8 years ago

Released 2.0.11 since changes don't seem to break BC to me.

dbartholomae commented 8 years ago

Thanks! Didn't know that codo doesn't use semver :)

dbartholomae commented 8 years ago

@inossidabile 2.0.11 seems to be an older version

inossidabile commented 8 years ago

Ah. You actually described the feature in README as well... I bugged. I'm going to pull in some more changes and release 2.1. What you mean by "older version"? Older than what?

dbartholomae commented 8 years ago

Might have been just the readme - when I installed from npm 2.0.11 didn't seem to have the changes :) But 2.1. works fine.