Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Webstorm Code Quality Setup? #233

Closed
pertrai1 opened this issue Jan 29, 2015 · 12 comments

Comments

@pertrai1
Copy link

commented Jan 29, 2015

Does anyone have a setup in Webstorm - if you use it - that follows these rules? I would like to have these rules setup in my code quality analysis but don't know exactly how to do so and would be great to have some export their settings so I can import - if someone has already done so.

@hshoff

This comment has been minimized.

Copy link
Member

commented Jan 29, 2015

Hi @pertrai1 thanks for checking out the guide!

I'm not too familiar with Webstorm, but I think it's possible:

  1. Using NPM: https://www.jetbrains.com/webstorm/help/installing-and-removing-external-software-using-node-package-manager.html
  2. Install node-jscs http://catatron.com/node-jscs/
  3. use the airbnb style preset: https://github.com/jscs-dev/node-jscs/blob/master/presets/airbnb.json

Hopefully that helps. I'll leave this issue open in case someone else with more knowledge wants to jump in.

@nkbt

This comment has been minimized.

Copy link

commented Jan 30, 2015

@pertrai1 just use .jshhint or whatever other tool you like. They are built-in into Webstorm already

JSHint Config

@nkbt

This comment has been minimized.

Copy link

commented Jan 30, 2015

@pertrai1 I use this config, which is intended to be Airbnb style compatible

{

  // --------------------------------------------------------------------
  // JSHint Configuration, Strict Edition
  // --------------------------------------------------------------------
  //
  // This is a options template for [JSHint][1], using [JSHint example][2]
  // and [Ory Band's example][3] as basis and setting config values to
  // be most strict:
  //
  // * set all enforcing options to true
  // * set all relaxing options to false
  // * set all environment options to false, except the browser value
  // * set all JSLint legacy options to false
  //
  // [1]: http://www.jshint.com/
  // [2]: https://github.com/jshint/node-jshint/blob/master/example/config.json
  // [3]: https://github.com/oryband/dotfiles/blob/master/jshintrc
  //
  // @author http://michael.haschke.biz/
  // @license http://unlicense.org/

  // == Enforcing Options ===============================================
  //
  // These options tell JSHint to be more strict towards your code. Use
  // them if you want to allow only a safe subset of JavaScript, very
  // useful when your codebase is shared with a big number of developers
  // with different skill levels.

  "bitwise": true,        // Prohibit bitwise operators (&, |, ^, etc.).
  "curly": true,          // Require {} for every new block or scope.
  "eqeqeq": true,         // Require triple equals i.e. `===`.
  "forin": true,          // Tolerate `for in` loops without `hasOwnPrototype`.
  "immed": true,          // Require immediate invocations to be wrapped in parens e.g. `( function(){}() );`
  "latedef": true,        // Prohibit variable use before definition.
  "newcap": true,         // Require capitalization of all constructor functions e.g. `new F()`.
  "noarg": true,          // Prohibit use of `arguments.caller` and `arguments.callee`.
  "noempty": true,        // Prohibit use of empty blocks.
  "nonew": true,          // Prohibit use of constructors for side-effects.
  "plusplus": true,       // Prohibit use of `++` & `--`.
  "regexp": true,         // Prohibit `.` and `[^...]` in regular expressions.
  "undef": true,          // Require all non-global variables be declared before they are used.
  "strict": true,         // Require `use strict` pragma in every file.
  "trailing": true,       // Prohibit trailing whitespaces.
  "quotmark": "single",   // Enforce use of single quotation marks for strings.
  "unused": true,         // Warn when variables are defined but never used.
  "maxlen": 100,          // Enforce line length to 100 characters
  "camelcase": true,      // Force all variable names to use either camelCase style or UPPER_CASE with underscores.

  // == Relaxing Options ================================================
  //
  // These options allow you to suppress certain types of warnings. Use
  // them only if you are absolutely positive that you know what you are
  // doing.

  "asi": false,           // Tolerate Automatic Semicolon Insertion (no semicolons).
  "boss": false,          // Tolerate assignments inside if, for & while. Usually conditions & loops are for comparison, not assignments.
  "debug": false,         // Allow debugger statements e.g. browser breakpoints.
  "eqnull": false,        // Tolerate use of `== null`.
  "es5": false,           // Allow EcmaScript 5 syntax.
  "esnext": false,        // Allow ES.next specific features such as `const` and `let`.
  "evil": false,          // Tolerate use of `eval`.
  "expr": false,          // Tolerate `ExpressionStatement` as Programs.
  "funcscope": false,     // Tolerate declarations of variables inside of control structures while accessing them later from the outside.
  "globalstrict": false,   // Allow global "use strict" (also enables 'strict').
  "iterator": false,      // Allow usage of __iterator__ property.
  "lastsemic": false,     // Tolerat missing semicolons when the it is omitted for the last statement in a one-line block.
  "laxbreak": false,      // Tolerate unsafe line breaks e.g. `return [\n] x` without semicolons.
  "laxcomma": false,      // Suppress warnings about comma-first coding style.
  "loopfunc": false,      // Allow functions to be defined within loops.
  "multistr": false,      // Tolerate multi-line strings.
  "onecase": false,       // Tolerate switches with just one case.
  "proto": false,         // Tolerate __proto__ property. This property is deprecated.
  "regexdash": false,     // Tolerate unescaped last dash i.e. `[-...]`.
  "scripturl": false,     // Tolerate script-targeted URLs.
  "smarttabs": false,     // Tolerate mixed tabs and spaces when the latter are used for alignmnent only.
  "shadow": false,        // Allows re-define variables later in code e.g. `var x=1; x=2;`.
  "sub": false,           // Tolerate all forms of subscript notation besides dot notation e.g. `dict['key']` instead of `dict.key`.
  "supernew": false,      // Tolerate `new function () { ... };` and `new Object;`.
  "validthis": false,     // Tolerate strict violations when the code is running in strict mode and you use this in a non-constructor function.

  // == Environments ====================================================
  //
  // These options pre-define global variables that are exposed by
  // popular JavaScript libraries and runtime environments—such as
  // browser or node.js.

  "browser": true,        // Standard browser globals e.g. `window`, `document`.
  "couch": false,         // Enable globals exposed by CouchDB.
  "devel": false,         // Allow development statements e.g. `console.log();`.
  "dojo": false,          // Enable globals exposed by Dojo Toolkit.
  "jquery": false,        // Enable globals exposed by jQuery JavaScript library.
  "mootools": false,      // Enable globals exposed by MooTools JavaScript framework.
  "node": false,          // Enable globals available when code is running inside of the NodeJS runtime environment.
  "nonstandard": false,   // Define non-standard but widely adopted globals such as escape and unescape.
  "prototypejs": false,   // Enable globals exposed by Prototype JavaScript framework.
  "rhino": false,         // Enable globals available when your code is running inside of the Rhino runtime environment.
  "wsh": false,           // Enable globals available when your code is running as a script for the Windows Script Host.

  // == JSLint Legacy ===================================================
  //
  // These options are legacy from JSLint. Aside from bug fixes they will
  // not be improved in any way and might be removed at any point.

  "nomen": false,         // Prohibit use of initial or trailing underbars in names.
  "onevar": false,        // Allow only one `var` statement per function.
  "passfail": false,      // Stop on first error.
  "white": true,          // Check against strict whitespace and indentation rules.

  // == Undocumented Options ============================================
  //
  // While I've found these options in [example1][2] and [example2][3]
  // they are not described in the [JSHint Options documentation][4].
  //
  // [4]: http://www.jshint.com/options/

  "maxerr": 100,          // Maximum errors before stopping.
  "predef": [
  ],
  "indent": 2             // Specify indentation spacing
}
@pertrai1

This comment has been minimized.

Copy link
Author

commented Jan 30, 2015

AWESOME, just what I was looking for. Thank you so much

@pertrai1 pertrai1 closed this Jan 30, 2015
@airbnb airbnb deleted a comment from doasync Jun 29, 2017
@airbnb airbnb deleted a comment from doasync Jun 30, 2017
@englishextra

This comment has been minimized.

Copy link

commented Nov 8, 2017

@pertrai1 In webstorm if you use code / inspect code - apart from you personal inspections setup (you would use jshint) you will get tons of internal errors, So it wont help. You will see internal report + your .jshintrc-ed jshint report in one report. So you can't get just only a jshint setup and not any other. That's a said thing and it was discussed, but very poorly on SO. So I jshint with ST3 or use gruntfile but in that case you would install node modules in project folder, which I avoid by all means.

@nkbt

just use .jshhint or whatever other tool you like. They are built-in into Webstorm already

isnt it a .jshintrc and not .jshhint

@ljharb

This comment has been minimized.

Copy link
Collaborator

commented Nov 8, 2017

Use eslint; not jshint.

@englishextra

This comment has been minimized.

Copy link

commented Nov 8, 2017

@ljharb

Use eslint; not jshint.

In that case you would need to install eslint with npm in project folder for Webstorm to work and you should enable it in settings/languages.../javascript...

The other thing I see no good reason to switch to eslint. I dont lint code for production in webstorm for the reasons I said above. Just see the built in warnings and highlitings.

As for linting for production I lint in ST3 and where I use jshint AND eslint
Then travis-ci also lints using grunt.

Please avoid such stuff like use that and not that, because You can't know my setup.

@ljharb

This comment has been minimized.

Copy link
Collaborator

commented Nov 8, 2017

This is Airbnb's style guide; the entire repo is "use this and not that". eslint has every rule jshint has and more, and importantly, it supports modern syntax more thoroughly than jshint does. Using both no longer serves any purpose.

No setup still exists where using jshint makes sense; only eslint should be used at this point.

@englishextra

This comment has been minimized.

Copy link

commented Nov 8, 2017

@ljharb This is webstorm setup issue

@ljharb

This comment has been minimized.

Copy link
Collaborator

commented Nov 8, 2017

Yes, it's a webstorm issue - on our style guide repo. The issue is asking how to set up webstorm to follow airbnb's rules - which are "use eslint".

@englishextra

This comment has been minimized.

Copy link

commented Nov 8, 2017

@ljharb In that case it's clear.

Still the webstorm will not help the author to follow the repo guides because they would see warnings that have nothing to do with airbnb

@ljharb

This comment has been minimized.

Copy link
Collaborator

commented Nov 8, 2017

The last comment prior to yours is 3 years ago; I think it's clear that the author isn't still trying to set up WebStorm.

I'm going to lock this issue; no further comment on it is required.

@airbnb airbnb locked and limited conversation to collaborators Nov 8, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
5 participants
You can’t perform that action at this time.