Skip to content
This repository has been archived by the owner on Nov 7, 2022. It is now read-only.
/ hashdard Public archive

๐ŸŒŸ Hash Labs JavaScript Style Guide

License

Notifications You must be signed in to change notification settings

hashlabs/hashdard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

7 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

JavaScript Hash Labs Style

npm downloads bitHound Dependencies

Based on the goodness of feross/standard, with some small changes.

Install

npm install hashdard

Rules

Importantly:

  • semicolons
  • no space-after-function-name
  • no space-after-function-name
  • always object-curly-spacing
  • Check feross/standard for the rest of the rules.

Usage

Install globally.

npm install hashdard -g

Or locally, depending what you need globally

npm install hashdard --save-dev

After you've done that you should be able to use the hashdard program. The simplest use case would be checking the style of all JavaScript files in the current working directory:

$ hashdard
Error: Use JavaScript Hash Labs Style
  lib/torrent.js:950:11: Expected '===' and instead saw '=='.

You can autofix errors using the --fix parameter

$ hashdard --fix

Custom Parser

To use a custom parser, install it from npm (example: npm install babel-eslint) and add this to your package.json:

{
  "hashdard": {
    "parser": "babel-eslint"
  }
}

Install Syntastic and add these lines to .vimrc:

let g:syntastic_javascript_checkers=['hashdard']
let g:syntastic_javascript_standard_exec = 'hashdard'

For automatic formatting on save, add these two lines to .vimrc:

Ignoring files

Just like in standard, The paths node_modules/**, *.min.js, bundle.js, coverage/**, hidden files/folders (beginning with .), and all patterns in a project's root .gitignore file are automatically excluded when looking for .js files to check.

Sometimes you need to ignore additional folders or specific minfied files. To do that, add a hashdard.ignore property to package.json:

"hashdard": {
  "ignore": [
    "**/out/",
    "/lib/select2/",
    "/lib/ckeditor/",
    "tmp.js"
  ]
}

See feross/standard for more information.

About Hash Labs

hash labs logo

hashdard is maintained and funded by Hash Labs LLC

About

๐ŸŒŸ Hash Labs JavaScript Style Guide

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published