luizalabs / gandalf-lint

Bad Code Shall Not Pass

gandalf-lint

Bad Code Shall Not Pass

Install

NPM:

npm install --save-dev eslint @softboxlab/eslint-config-gandalf-lint

Yarn:

yarn add --dev eslint @softboxlab/eslint-config-gandalf-lint

Requirements

• npm ^5.0.0
• ESLint ^5.12.0

Configure

Call the white wizard by creating a .eslintrc file on your root project and writing in it:

{
  "extends": "@softboxlab/eslint-config-gandalf-lint"
}

Remember to add the eslint plugin on your favorite IDE, like this one: ESLint for VSCode

Usage

You can create a script on your package.json file like so:

"scripts": {
  "glint": "eslint --ext .js PROJECT_FOLDER"
}

And use your magic script for shall not pass any bad code:

npm run glint

And with fireworks you can automagically fix some errors:

npm run glint --fix

or using yarn:

yarn glint
yarn glint --fix

Autorun it?

If you don't fell like creating any scripts, feel free to have your files linted on the fly by your IDE (did you remember to install the eslint plugin on your IDE?)

---

Gandalf approves

Contributors

• View Contributors

License

The MIT License (MIT)

Copyright (c) Feross Aboukhadijeh

Copyright (c) 2012 Airbnb

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---

This project licence is also MIT.

gandalf-lint's Issues

Add rule comma-dangle

"comma-dangle": [ "error", "always-multiline" ],

I'd like to have back this rule, because in git projects, it points a modification on a specific line, just because of the insertion of the comma.

Rule lines-between-class-members

lines-between-class-members

I think this rule was working on this project, but doesn't work anymore.
Could this be re-added (or added)?

Add semicolon rule

some companies use this rule.

Airbnb: https://airbnb.io/javascript/#semicolons

Please clarify license for this repo

Hi SofBoxLab team, this is a great code, thats for sharing.

Can you please clarify license for this repo? Hopefully MIT?

Verificar rules

• Control Statements
• Comments
• Naming Conventions
• Accessors

Documentação das regras utilizadas

No projeto Juggernaut nós sentimos a falta de uma documentação com as regras que são utilizadas no gandalf-lint, para decidirmos se ele realmente funcionaria para nós.

É possível criar uma documentação assim?

Regras eslint para retornar / adicionar

• "max-params": ["error", 3],
  Limita o máximo de parâmetros na função, forçando funções que tiverem mais parâmetros a serem tratadas como objects.

• Voltar com o "comma-dangle": [ "error", "always-multiline" ],

Remove eslint-plugin-node

Now that we have gandalf-lint-node I've been thinking in moving eslint-plugin-node from here to gandalf-lint-node.

What do you think?

ESLint warning

Last ESLint updates changed some settings and now we have this warning related to Standard config:

(node:5933) [ESLINT_LEGACY_OBJECT_REST_SPREAD] DeprecationWarning: The 'parserOptions.ecmaFeatures.experimentalObjectRestSpread' option is deprecated. Use 'parserOptions.ecmaVersion' instead. (found in "node_modules/eslint-config-standard/index.js")

Maybe a dependencies update will solve it, community is already tracking this warning status:

standard/eslint-config-standard-react#48

Add rule max-params

"max-params": ["error", 3],
Limits the maximum number of parameter of a function, forcing functions that have more than 3 parameters, to be treated as a json object.

Regra conflitua com o i18n

A regra abaixo está conflituando com o react-i18next.
Ele possui um HOC que injeta uma propriedade chamada t(). E com isso, a linha dá erro no id-length do eslint.

https://github.com/SoftboxLab/gandalf-lint/blob/26d391e89fc553fbbb0394b094a33058d353c583/rules/gandalf.js#L327

Separation of concerns

I strongly recommend separating gandalf-lint in three projects:

• gandalf-lint-base: gandalf-lint for all JS projects independent of any framework;
• gandalf-lint-react: gandalf-lint-base + linting for react;
• gandalf-lint-vue: gandalf-lint-base + linting for vue;

Update eslint-config-standard