{"bin":{"coffeelint":"./bin/coffeelint"},"bugs":{"url":"https://github.com/clutchski/coffeelint/issues"},"dist":{"shasum":"8b6e76e82fb1aa27eebd91b80a2b18822d72727d","tarball":"https://registry.npmjs.org/coffeelint/-/coffeelint-1.16.2.tgz","fileCount":23,"integrity":"sha512-6mzgOo4zb17WfdrSui/cSUEgQ0AQkW3gXDht+6lHkfkqGUtSYKwGdGcXsDfAyuScVzTlTtKdfwkAlJWfqul7zg==","signatures":[{"sig":"MEQCICRnsxB7WpgIFgowxU2vbOfqQzHo+nxVxeNwi/UPIRqXAiA+CUOLKOZLHVJ5Tb4LkN9sSSKsLR+PRe3qByBZPjFhvQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":154566},"main":"./lib/coffeelint.js","name":"coffeelint","author":{"name":"Matthew Perpick","email":"clutchski@gmail.com"},"readme":"CoffeeLint\n==========\n\nCoffeeLint is a style checker that helps keep CoffeeScript code\nclean and consistent.\n\nFor guides on installing, using and configuring CoffeeLint, head over\n[here](http://www.coffeelint.org).\n\nTo suggest a feature, report a bug, or general discussion, head over\n[here](http://github.com/clutchski/coffeelint/issues/).\n\n## Team\n\nCurrent:\n\n- [Shuan Wang](https://github.com/swang)\n\nPast:\n\n- [Asa Ayers](https://github.com/AsaAyers)\n- [Matt Perpick](https://github.com/clutchski)\n\n## Contributing\n\n* New rules should be set to a `warn` level. Developers will expect new changes to NOT break their existing workflow, so unless your change is extremely usefull, default to `warn`. Expect discussion if you choose to use `error`.\n\n* Look at existing rules and test structures when deciding how to name your rule. `no_foo.coffee` is used for many tests designed to catch specific errors, whereas `foo.coffee` is used for tests that are designed to enforce formatting and syntax.\n\n### Steps\n\n1. Fork the repo locally.\n2. Run `npm install` to get dependencies.\n3. Create your rule in a single file as `src/rules/your_rule_here.coffee`, using the existing\n   rules as a guide.\n   You may examine the AST and tokens using\n   [http://asaayers.github.io/clfiddle/](http://asaayers.github.io/clfiddle/).\n4. Add your test file `my_test.coffee` to the `test` directory.\n5. Register your rule in `src/coffeelint.coffee`.\n6. Run your test using `npm run testrule test/your_test_here.coffee`.\n7. Run the whole tests suite using `npm test`.\n8. Check that your rule's documentation is generated properly (see _Updating documentation when\nadding a new rule_ below).\n9. Squash all commits into a single commit when done.\n10. Submit a pull request.\n\n[![Build Status](https://secure.travis-ci.org/clutchski/coffeelint.svg)](http://travis-ci.org/clutchski/coffeelint)\n\n### Updating documentation when adding a new rule\n\nWhen adding a new rule, its documentation is specified by setting a\n`description` property within its `rule` property:\n```coffeescript\nmodule.exports = class NoComment\n\n    rule:\n        name: 'no_comment'\n        level: 'ignore'\n        message: 'No comment'\n        description: '''\n            Disallows any comment in the code\n            '''\n\n    tokens: ['#', '###']\n\n    lintToken : (token, tokenApi) ->\n\t\treturn {context: \"Found '#{token[0]}'\"}\n```\n\nThe description property is a string that can embed HTML code:\n```html\ndescription: '''\n\tDisallows any comment in the code. This code would not pass:\n\t<pre>\n\t<code>### Some code with comments\n\tfoo = ->\n\t\t# some other comments\n\t\tbar()\n\t</code>\n\t</pre>\n\t'''\n```\n[Coffeelint's website](http://www.coffeelint.org/) generates each\nrule's documentation based on this `description` property.\n\nWhen adding a new rule, it is suggested that you check that the documentation\nfor your new rule is generated correctly. In order to do that, you should\nfollow these steps:\n* Checkout the branch that contains the changes adding the new rule.\n* Run `npm run compile`.\n* Checkout the `gh-pages` branch: `git checkout origin/gh-pages`.\n* Run `cp lib/coffeelint.js js/coffeelint.js`.\n* Regenerate the HTML documentation: `rake updatehtml`. Note that you will\nprobably need to install rake.\n* Open the `index.html` file with your favorite browser and make sure that your\nrule's documentation is generated properly.\n","engines":{"npm":">=1.3.7","node":">=0.8.0"},"gitHead":"6d9ca0eca492a4dbfbf701f6a9ca2e630a121519","license":"MIT","scripts":{"lint":"cake compile && ./bin/coffeelint .","test":"./vowsrunner.js --spec test/*.coffee test/*.litcoffee","compile":"cake compile","pretest":"cake compile","publish":"cake publish","lint-csv":"cake compile && ./bin/coffeelint --csv .","posttest":"npm run lint","testrule":"npm run compile && ./vowsrunner.js --spec","prepublish":"cake prepublish","lint-jslint":"cake compile && ./bin/coffeelint --jslint .","postpublish":"cake postpublish"},"_npmUser":{"name":"swang","email":"shuanwang@gmail.com"},"homepage":"http://www.coffeelint.org","keywords":["lint","coffeescript","coffee-script"],"repository":{"url":"git://github.com/clutchski/coffeelint.git","type":"git"},"_npmVersion":"5.4.2","description":"Lint your CoffeeScript","directories":{},"maintainers":[{"name":"swang","email":"shuanwang@gmail.com"}],"_nodeVersion":"8.8.1","dependencies":{"glob":"^7.0.6","ignore":"^3.0.9","resolve":"^0.6.3","optimist":"^0.6.1","coffee-script":"~1.11.0","strip-json-comments":"^1.0.2"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"vows":">=0.8.1","underscore":">=1.4.4"},"_npmOperationalInternal":{"tmp":"tmp/coffeelint_1.16.2_1518909338339_0.4685556090895613","host":"s3://npm-registry-packages"},"_id":"coffeelint@1.16.2","version":"1.16.2"}