Add eslint tasks and README

Closes #47
This commit is contained in:
Kirill Glebov 2018-09-27 13:40:08 +02:00 committed by Martin Pitt
parent 1da6473420
commit d73a91232e
2 changed files with 20 additions and 1 deletions

View file

@ -33,6 +33,23 @@ ln -s `pwd`/dist ~/.local/share/cockpit/starter-kit
After changing the code and running `make` again, reload the Cockpit page in After changing the code and running `make` again, reload the Cockpit page in
your browser. your browser.
# Running eslint
Cockpit Starter Kit uses [ESLint](https://eslint.org/) to automatically check
JavaScript code style in `.jsx` and `.es6` files.
The linter is executed within every build as a webpack preloader.
For developer convenience, the ESLint can be started explicitly by:
$ npm run eslint
Violations of some rules can be fixed automatically by:
$ npm run eslint:fix
Rules configuration can be found in the `.eslintrc.json` file.
# Automated Testing # Automated Testing
Run `make check` to build an RPM, install it into a standard Cockpit test VM Run `make check` to build an RPM, install it into a standard Cockpit test VM

View file

@ -7,7 +7,9 @@
"author": "", "author": "",
"license": "LGPL-2.1", "license": "LGPL-2.1",
"scripts": { "scripts": {
"build": "webpack" "build": "webpack",
"eslint": "eslint --ext .jsx --ext .es6 src/",
"eslint:fix": "eslint --fix --ext .jsx --ext .es6 src/"
}, },
"devDependencies": { "devDependencies": {
"@babel/core": "^7.0.0", "@babel/core": "^7.0.0",