Socket
Book a DemoInstallSign in
Socket

coffeelint

Package Overview
Dependencies
Maintainers
1
Versions
80
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

coffeelint

Lint your CoffeeScript

2.1.0
latest
Source
npmnpm
Version published
Maintainers
1
Created
Source

CoffeeLint

CoffeeLint is a style checker that helps keep CoffeeScript code clean and consistent.

For guides on installing, using and configuring CoffeeLint, head over here.

To suggest a feature, report a bug, or general discussion, head over here.

Team

Current:

  • Shuan Wang

Past:

Contributing

  • 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.

  • 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.

Steps

  • Fork the repo locally.
  • Run npm install to get dependencies.
  • Create your rule in a single file as src/rules/your_rule_here.coffee, using the existing rules as a guide. You may examine the AST and tokens using http://asaayers.github.io/clfiddle/.
  • Add your test file my_test.coffee to the test directory.
  • Register your rule in src/coffeelint.coffee.
  • Run your test using npm run testrule test/your_test_here.coffee.
  • Run the whole tests suite using npm test.
  • Check that your rule's documentation is generated properly (see Updating documentation when adding a new rule below).
  • Squash all commits into a single commit when done.
  • Submit a pull request.

Build Status

Updating documentation when adding a new rule

When adding a new rule, its documentation is specified by setting a description property within its rule property:

module.exports = class NoComment

    rule:
        name: 'no_comment'
        level: 'ignore'
        message: 'No comment'
        description: '''
            Disallows any comment in the code
            '''

    tokens: ['#', '###']

    lintToken : (token, tokenApi) ->
		return {context: "Found '#{token[0]}'"}

The description property is a string that can embed HTML code:

description: '''
	Disallows any comment in the code. This code would not pass:
	<pre>
	<code>### Some code with comments
	foo = ->
		# some other comments
		bar()
	</code>
	</pre>
	'''

Coffeelint's website generates each rule's documentation based on this description property.

When adding a new rule, it is suggested that you check that the documentation for your new rule is generated correctly. In order to do that, you should follow these steps:

  • Checkout the branch that contains the changes adding the new rule.
  • Run npm run compile.
  • Checkout the gh-pages branch: git checkout origin/gh-pages.
  • Run cp lib/coffeelint.js js/coffeelint.js.
  • Regenerate the HTML documentation: rake updatehtml. Note that you will probably need to install rake.
  • Open the index.html file with your favorite browser and make sure that your rule's documentation is generated properly.

Keywords

lint

FAQs

Package last updated on 16 Feb 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.