Modernised the code base

cleversoap / grunt-esdoc

ES6 Documentation tool ESDoc Grunt Plugin

MIT License

3 stars 3 forks source link

Modernised the code base #8

Closed vanruesc closed 7 years ago

vanruesc commented 7 years ago

With this PR I'd like to propose a revision of the current code base of the project to make it future-proof.

The changes are as follows:

package.json

reformatted (improved readability)
added a description to package.json
added dev dependencies (ESLint, Rollup + Babel, JIT-Grunt + Load-Grunt-Config)
added peer dependency (Grunt >=0.4.0, more information)

Gruntfile

split up into grunt/config and grunt/tasks using jit-grunt and load-grunt-config for improved maintainability and build performance
added ESLint build step
added Rollup build step to generate an ES5 cjs-style task from src/index.js (uses Babel internally)

esdoc.js

moved to src/index.js
minor refactoring, logic is the same as before
the file tasks/grunt-esdoc.js was built using the grunt build task

Please note that these changes are suggestions. I appreciate any feedback and criticism.

cleversoap commented 7 years ago

Will look at this shortly - thanks for all the effort, looks good

vanruesc commented 7 years ago

Thanks for your time!

If you consider merging this, you might want to first take a look at #6 since that PR directly addresses the corresponding open issue #5 while also adding the .gitattributes file.

vanruesc commented 7 years ago

Just added another commit in which I replaced a hard coded path in the rollup config with package.module. I forgot to include this change before, sorry for the inconvenience.

vanruesc commented 7 years ago

A new version of grunt-eslint came out, so I went ahead and updated it.

vanruesc commented 7 years ago

Hi @cleversoap,

although this is starting to get a bit messy because so much time has passed, I'm still hoping for this PR to get merged. I updated ESDoc to 1.x.x and adjusted everything to work with this new major release.

Here's an overview of the changes:

Version requirements for dependencies have been relaxed. Minor patch and fix releases should be safe.
Updated ESDoc to 1.0.1
- Removed publisher argument from esdoc.generate(config).
- Added esdoc-standard-plugin for testing purposes. Works as expected with no further changes.

vanruesc commented 7 years ago

I just realised that ESDoc >= 1.0.1 no longer reports coverage results in the console. Coverage is only available when the esdoc-coverage-plugin or the esdoc-standard-plugin is used.

I fixed the coverage report by reading the coverage output json file if it exists. In case a user decides not to use the esdoc-coverage-plugin, grunt-esdoc won't try to report coverage.

This change partially supersedes #4. (It doesn't include the coverage threshold feature.)

vanruesc commented 7 years ago

Closed in favour of #10.