Keyword convention for custom rules on npm, e.g. »coffeelintrule«

[janraasch]

There should be a conventional keyword to identify an npm module as a custom rule for CoffeeLint.

I looked at https://github.com/fragphace/coffeelint-variable-scope/blob/master/package.json and https://github.com/Dreamscapes/coffeelint-newline-at-eof/blob/master/package.json.

Going with the flow of grunt and gulp (i.e. gruntplugin, gulpplugin) I'd suggest using coffeelintrule (which I did here). This should also be documented in the Custom Rules section.

[AsaAyers]

I agree. Sounds great. I want to have a place on the site that links out to known rules, but I haven't had time for that recently. It could also link to https://npmjs.org/search?q=coffeelintrule. Do you have time to put together some pull requests? I recommend linking back to here from PRs to coffeelint-variable-scope and coffeelint-newline-at-aof

CoffeeLint's website is in the gh-pages branch. It has two files, index-top.html and index-bottom.html. The command rake updatehtml will combine them.

[janraasch]

Sent pull requests to coffeelint-variable-scope and coffeelint-newline-at-aof.

[AsaAyers]

Thanks :-) On Jan 21, 2014 8:02 AM, "Jan Raasch" notifications@github.com wrote:

Sent pull requests to coffeelint-variable-scope and coffeelint-newline-at-aof.

— Reply to this email directly or view it on GitHubhttps://github.com/clutchski/coffeelint/issues/217#issuecomment-32882267 .

[janraasch]

I'm having problems running rake updatehtml locally, but I would add something like

<h2 class="section_title" id="api">Custom Rules on npm</h2>
          <p>
              Rule authors should add the coffeelintrule keyword to their npm package so
              custom rules can be found easily. Click <a href="https://npmjs.org/search?q=coffeelintrule">here</a> to list all currently available custome rules on npm.
          </p>

above the Building Custom Rules (NEW 0.6) section.

[janraasch]

Got rake updatehtml working. Had to npm install coffee underscore first :)