node package manager

jsw

JavaScript Whatever Style

npm downloads

One Style to Rule Them All

No decisions to make. No .eslintrc, .jshintrc, or .jscsrc files to manage. It just works.

This is a fork from JavaScript Standard by Feross, et al, except it totally doesn't care whether you use semicolons or not - just like the JavaScript language spec. This module will track any changes made upstream.

This module saves you (and others!) time in two ways:

  • No configuration. The easiest way to enforce consistent style in your project. Just drop it in.
  • Catch style errors before they're submitted in PRs. Saves precious code review time by eliminating back-and-forth between maintainer and contributor.

Install

npm install jsw

Rules

  • Semicolons? Use 'em or not. Whatever. It literally doesn't matter.It's fine. Really!
  • 2 spaces – for indentation
  • Single quotes for strings – except to avoid escaping
  • No unused variables – this one catches tons of bugs!
  • Never start a line with ( or [
    • This is the only gotcha with omitting semicolons – automatically checked for you!
    • More details
  • Space after keywords if (condition) { ... }
  • Space after function name function name (arg) { ... }
  • Name the context variable selfvar self = this
    • Accidental window.self usage is dissallowed (happens when var self = this is omitted)
  • Always use === instead of == – but obj == null is allowed to check null || undefined.
  • Always handle the node.js err function parameter
  • Always prefix browser globals with window – except document and navigator are okay
    • Prevents accidental use of poorly-named browser globals like open, length, event, and name.
  • And more goodnessgive jsw a try today!

To get a better idea, take a look at a sample file written in JavaScript Whatever Style, or check out some of the repositories that use whatever.

Badge

Use this in one of your projects? Include one of these badges in your readme to let people know that your code is using the whatever style.

js-whatever-style

[![js-whatever-style](https://cdn.rawgit.com/jden/jsw/master/badge.png)](https://github.com/jden/jsw)

Usage

The easiest way to use JavaScript Whatever Style to check your code is to install it globally as a Node command line program. To do so, simply run the following command in your terminal (flag -g installs jsw globally on your system, omit it if you want to install in the current working directory):

npm install jsw -g

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

$ jsw
Error: Use JavaScript Standard Style
  lib/torrent.js:950:11: Expected '===' and instead saw '=='.

You can optionally pass in a directory using the glob pattern:

$ standard src/util/**/*.js

Editor plugins

First, install jsw. Then, install the appropriate plugin for your editor:

What you might do if you're clever

  1. Add it to package.json
{
  "name": "my-cool-package",
  "devDependencies": {
    "standard": "^3.0.0"
  },
  "scripts": {
    "test": "jsw && node my-tests.js"
  }
}
  1. Check style automatically when you run npm test
$ npm test
Error: Use JavaScript Whatever Style
  lib/torrent.js:950:11: Expected '===' and instead saw '=='.
  1. Never give style feedback on a pull request again!

FAQ

Why would I use JavaScript Whatever Style?

The beauty of JavaScript Whatever Style is that it's simple. No one wants to maintain multiple hundred-line style configuration files for every module/project they work on. Enough of this madness!

This module saves you time in two ways:

  • No configuration. The easiest way to enforce consistent style in your project. Just drop it in.
  • Catch style errors before they're submitted in PRs. Saves precious code review time by eliminating back-and-forth between maintainer and contributor.

Adopting jsw style means ranking the importance of code clarity and community conventions higher than personal style. This might not make sense for 100% of projects and development cultures, however open source can be a hostile place for newbies. Setting up clear, automated contributor expectations makes a project healthier.

I disagree with rule X, can you change it?

No. The the whole point of jsw is to avoid bikeshedding about style. There are lots of debates online about tabs vs. spaces, etc. that will never be resolved. These debates just distract from getting stuff done. At the end of the day you have to 'just pick something', and that's the whole philosophy of jsw -- its a bunch of sensible 'just pick something' opinions. Hopefully, users see the value in that over defending their own opinions.

But this isn't a real web standard!

Of course it's not! The style laid out here is not affiliated with any official web standards groups, which is why this repo is called jden/jsw and not ECMA/standard.

The word "standard" has more meanings than just "web standard" :-) For example:

  • This module helps hold our code to a high standard of quality.
  • This module ensures that new contributors follow some basic style standards.

Is there an automatic formatter?

Yes! Just run standard --format filename.js. This uses Max Ogden's automatic formatter standard-format, which can automatically fix most code issues. It'll strip out all of your semicolons, though, since it conforms to the stricter subset that jsw is forked from, standard.

While most issues can be fixed, some, like not handling errors in node-style callbacks, must be fixed manually.

How do I ignore files?

The paths node_modules/**, *.min.js, bundle.js, coverage/**, and hidden files/folders (beginning with .) are automatically excluded when looking for .js files to style check.

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

"standard"{
  "ignore": [
    "**/out/**",
    "**/lib/select2/**",
    "**/lib/ckeditor/**"
  ]
}

How do I hide a certain warning?

In rare cases, you'll need to break a rule and hide the warning generated by jsw.

JavaScript Whatever Style uses eslint under-the-hood and you can hide warnings as you normally would if you used eslint directly.

To get verbose output (so you can find the particular rule name to ignore), run:

$ jsw --verbose
Error: Use JavaScript Whatever Style
  routes/error.js:20:36: 'file' was used before it was defined. (no-use-before-define)

Disable all rules on a specific line:

file = 'I know what I am doing' // eslint-disable-line 

Or, disable only the "no-use-before-define" rule:

file = 'I know what I am doing' // eslint-disable-line no-use-before-define 

Or, disable the "no-use-before-define" rule for multiple lines:

/*eslint-disable no-use-before-define */
// offending code here... 
// offending code here... 
// offending code here... 
/*eslint-enable no-use-before-define */

Can you make rule X configurable?

No. Use eslint and this shareable config if you want to configure hundreds of options individually.

Pro tip: Just use jsw and move on. There are actual real problems that you could spend your time solving! :P

What about Web Workers?

Web workers have a magic global variable called self. In regular JS files, standard won't let you use self directly, as it wants to prevent accidental use of window.self. But standard has no way of knowing when you are in a worker and therefore does not know when to allow usage of self directly.

Until we figure out a better solution, we recommend adding this to the top of workers:

/* global self */

This lets jsw (as well as humans reading your code) know that self is a global in web worker code.

Is there a Git pre-commit hook for jsw?

Funny you should ask!

#!/bin/sh 
# Ensure all javascript files staged for commit pass standard code style 
git diff --name-only --cached --relative | grep '\.js$' | xargs jsw
exit $?

Alternatively, overcommit is a Git hook manager that includes support for running standard as a Git pre-commit hook. To enable this, add the following to your .overcommit.yml file:

PreCommit:
  Standard:
    enabled: true

License

MIT. Copyright (c) Feross Aboukhadijeh. Additonal trivial contributions by jden.