npm

Need private packages and team management tools?Check out npm Orgs. »

@s-ui/lint

2.5.0 • Public • Published

sui-lint

CLI to lint your code and make it compliant.

It provides:

  • Same js and sass style of code accross all company
  • Linting rules a reference package, not every project
  • Implemented as a reusable CLI

Installation

$ npm install @s-ui/lint --save-dev

CLI

When installed, a new CLI sui-lint is automatically available to lint your files according to SUI conventions.

Lint JS files:

$ sui-lint js [options]

Puedes pasarle más misma opciones que acepta eslint. Con la única diferencia que no puedes pasar una nueva configuración ya que está fijada a la nuestra. Por defecto va a buscar todos los ficheros js|jsx desde el root de tu proyecto excluyendo las carpetas lib|dist

Lint SASS files:

$ sui-lint sass [options]

Al igual que en el caso anterior no puedes pasar una nueva configuración, y las carpetas ignoradas son también lib|dist

Como hago funcionar mi editor con estas reglas:

1.- Instala el plugin de eslint/sassLint adecuado para tu editor.

2.- Agregar a tu package json estas lineas:

{
  "eslintConfig": {
     "extends": ["./node_modules/@s-ui/lint/eslintrc.js"]},
  "sasslintConfig": "./node_modules/@s-ui/lint/sass-lint.yml"
}

Example package.json

{
  "name": "test-project",
  "version": "1.0.0",
  "scripts": {
    "lint": "npm run lint:js && npm run lint:sass",
    "lint:js": "sui-lint js",
    "lint:sass": "sui-lint sass"
  },
  "devDependencies": {
    "@s-ui/lint": "1.0.0-beta.1"
  },
  "eslintConfig": { "extends": ["./node_modules/@s-ui/lint/eslintrc.js"]},
  "sasslintConfig": "./node_modules/@s-ui/lint/sass-lint.yml"
}

Keywords

none

install

npm i @s-ui/lint

Downloadsweekly downloads

924

version

2.5.0

license

MIT

last publish

collaborators

  • avatar
  • avatar
  • avatar
Report a vulnerability