Skip to content
This repository has been archived by the owner on Mar 23, 2024. It is now read-only.

Added config formats #675

Closed
wants to merge 3 commits into from
Closed

Added config formats #675

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d70eb78
Added config formats
maximal Oct 8, 2014
c647617
Typo fix
maximal Oct 8, 2014
e5a91b9
Improving config docs
maximal Oct 10, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,15 @@ Allows to define path to the config file.
jscs path[ path[...]] --config=./.config.json
```

If there is no `--config` option specified, `jscs` it will consequentially search for `jscsConfig` option in `package.json` file then for `.jscsrc` and `.jscs.json` files in the current working directory then in nearest ancestor until it hits the system root.
If there is no `--config` option specified, `jscs` it will consequentially search for `jscsConfig` option in `package.json` file then for `.jscsrc` (which is a just JSON with comments) and `.jscs.json` files in the current working directory then in nearest ancestor until it hits the system root.

You can also write your config in plain `.js`. In this case config object must be prepended with `module.exports = `:

```js
module.exports = {
// JSCS options go here
}
```

### `--preset`
If defined will use predefined rules for specific code style.
Expand Down