Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zslucky/freelint
a lint tool using Airbnb standard and based on standard-engine.
https://github.com/zslucky/freelint
Last synced: about 2 months ago
JSON representation
a lint tool using Airbnb standard and based on standard-engine.
- Host: GitHub
- URL: https://github.com/zslucky/freelint
- Owner: zslucky
- License: mit
- Created: 2016-06-14T05:04:36.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-20T01:35:39.000Z (over 6 years ago)
- Last Synced: 2024-10-04T17:09:02.588Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 54.7 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# freelint
[](https://travis-ci.org/zslucky/freelint)
a lint tool based on standard-engine and rules follow the [Airbnb javascript standard](https://github.com/airbnb/javascript).
We are followed [SamVer 2.0](http://semver.org/), this started from version 2.0.0, then we will try our best to avoide the dependency hell.
### Install (Global)
```bash
npm install -g freelint
```
or use `yarn`
```bash
yarn global add freelint
```
### Install (Local)
```bash
npm install freelint --save-dev
```
or use `yarn`
```bash
yarn add freelint --dev
```
```json
# ...
# Add npm task in package.json.
"script": {
"freelint": "freelint",
...
}
```
### Usage (Global)
In your project's directiry.
```bash
freelint
```
### Usage (Local)
```bash
npm run freelint
```
or use `yarn`
```bash
yarn run freelint
```
That's all.
## Know Issues
1. If you are using ES6 import/export feature, and webpack like build tool with a resolve setting, you should extract the resolve settings to a new file named `webpack.resolve.js`, and place it to `config` dir in root dir, we know it's a dirty code, if you have any good solution, don't hesitated to create a pull request.(e.g.[Demo](https://github.com/zslucky/react-redux-freetmp))
### How do I make the output all colorful and *pretty*?
[snazzy](https://www.npmjs.com/package/snazzy) is the default output format for cmd `freelint` now, you can also use any other
format library, just need to use the base cmd `freelint-base`, like:
```bash
$ freelint-base | customFormat
```
### How do I ignore files?
The paths `node_modules/**`, `*.min.js`, `bundle.js`, `coverage/**`, hidden files/folders
(beginning with `.`), and all patterns in a project's root `.gitignore` file are
automatically ignored.
Sometimes you need to ignore additional folders or specific minified files. To do that, add
a `freelint.ignore` property to `package.json`:
```json
"freelint-base": {
"ignore": [
"**/out/",
"/lib/select2/",
"/lib/ckeditor/",
"tmp.js"
]
}
```
### TODO
- [ ] Add reporter function by setting from cli