8000 fix an example CLI use in Readme by alxndr · Pull Request #650 · sasstools/sass-lint · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix an example CLI use in Readme #650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 27, 2016
Merged

fix an example CLI use in Readme #650

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0d6ac5d
fix example CLI usage in readme
alxndr Apr 26, 2016
8550e0c
small punctuation tweaks
alxndr Apr 26, 2016
46d39fd
Merge branch 'develop' into doc-tweak
alxndr Apr 26, 2016
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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A Node-only Sass linter for both `sass` and `scss` syntax!
---

## Install
You can get `sass-lint` from [NPM](https://www.npmjs.com/package/sass-lint)
You can get `sass-lint` from [NPM](https://www.npmjs.com/package/sass-lint):

```
npm install sass-lint --save-dev
Expand All @@ -15,7 +15,7 @@ npm install sass-lint --save-dev

## Configuring

Sass-lint can be configured from a `.sass-lint.yml` file in your project. If you don't have one in the root of your project or you would like all your projects to follow a standard config file then you can specify the path to one in your projects `package.json` file.
Sass-lint can be configured from a `.sass-lint.yml` file in your project. If you don't have one in the root of your project or you would like all your projects to follow a standard config file then you can specify the path to one in your project's `package.json` file.

For example:
```javascript
Expand Down Expand Up @@ -90,7 +90,7 @@ With this in mind if you would like to have the CLI show both warnings and error

#### Specify a config

Below is an example of the command being used to load a config `-c app/config/.sass-lint.yml` file show errors and warnings on the command line and target a glob pattern `**/*.scss` being used.
Below is an example of the command being used to load a config `-c app/config/.sass-lint.yml` file, show errors and warnings on the command line, and target a glob pattern `**/*.scss`:

```
sass-lint -c app/config/.sass-lint.yml '**/*.scss' -v -q
Expand All @@ -105,17 +105,17 @@ sass-lint --config app/config/.sass-lint.yml '**/*.scss' --verbose --no-exit
#### Ignore files/patterns
To add a list of files to ignore `tests/**/*.scss, dist/other.scss` into the mix you could do the following:
```
sass-lint -c app/config/.sass-lint.yml '**/*.scss' -v -q -i 'tests/**/*.scss'
sass-lint -c app/config/.sass-lint.yml '**/*.scss' -v -q -i 'tests/**/*.scss, dist/other.scss'
```
or with long form flags
```
sass-lint --config app/config/.sass-lint.yml '**/*.scss' --verbose --no-exit --ignore 'tests/**/*.scss, dist/other.scss'
```


> Notice that glob patterns need to be wrapped in quotation or single quote marks in order to be passed to sass-lint correctly and if you want to ignore multiple paths you also need to wrap it in quotation marks and seperate each pattern/fil with a comma and a space `, `.
> Notice that glob patterns need to be wrapped in quotation or single quote marks in order to be passed to sass-lint correctly and if you want to ignore multiple paths you also need to wrap it in quotation marks and seperate each pattern/file with a comma and a space `, `.

This will be revisited and updated in `sass-lint` v2.0.0
This will be revisited and updated in `sass-lint` v2.0.0.

For further information you can visit our CLI documentation linked below.

Expand Down
0