danog/sass-site
1
0
Fork 0
mirror of https://github.com/danog/sass-site.git synced 2025-01-21 21:31:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #334 from sass/error-css

Browse Source 
Document Dart Sass's --error-css flag
This commit is contained in:
Natalie Weizenbaum 2019-05-06 13:56:47 -07:00 committed by GitHub
commit ff7970b80e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 62 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
source/documentation/cli/dart-sass.html.md.erb
View File

@ -36,6 +36,8 @@ SCSS unless the [`--indented` flag][] is passed.
### Many-to-many Mode
<% impl_status dart: '1.4.0' %>
```
sass [<input.css>:<output.css>] [<input/>:<output/>]...
```
@ -138,6 +140,8 @@ h1{font-size:40px}
#### `--no-charset`
<% impl_status dart: '1.19.0' %>
This flag tells Sass never to emit a `@charset` declaration or a UTF-8
[byte-order mark][]. By default, or if `--charset` is passed, Sass will insert
either a `@charset` declaration (in expanded output mode) or a byte-order mark
@ -158,8 +162,54 @@ h1::before {
}
```
#### `--error-css`
<% impl_status dart: '1.20.0' %>
This flag tells Sass whether to emit a CSS file when an error occurs during
compilation. This CSS file describes the error in a comment *and* in the
`content` property of `body::before`, so that you can see the error message in
the browser without needing to switch back to the terminal.
By default, error CSS is enabled if you're compiling to at least one file on
disk (as opposed to standard output). You can pass `--error-css` explicitly to
enable it even when you're compiling to standard out, or `--no-error-css` to
disable it everywhere. When it's disabled, the [`--update` flag][] and
[`--watch` flag][] will delete CSS files instead when an error occurs.
[`--watch` flag]: #watch
```shellsession
$ sass --error-css style.scss style.css
/* Error: Incompatible units em and px.
* ,
* 1 | $width: 15px + 2em;
* | ^^^^^^^^^^
* '
* test.scss 1:9 root stylesheet */
body::before {
font-family: "Source Code Pro", "SF Mono", Monaco, Inconsolata, "Fira Mono",
"Droid Sans Mono", monospace, monospace;
white-space: pre;
display: block;
padding: 1em;
margin-bottom: 1em;
border-bottom: 2px solid black;
content: "Error: Incompatible units em and px.\a \2577 \a 1 \2502 $width: 15px + 2em;\a \2502 ^^^^^^^^^^\a \2575 \a test.scss 1:9 root stylesheet";
}
Error: Incompatible units em and px.
╷
1 │ $width: 15px + 2em;
│ ^^^^^^^^^^
╵
test.scss 1:9 root stylesheet
```
#### `--update`
<% impl_status dart: '1.4.0' %>
If the `--update` flag is passed, Sass will only compile stylesheets whose
dependencies have been modified more recently than the corresponding CSS file
was generated. It will also print status messages when updating stylesheets.
@ -171,6 +221,8 @@ Compiled themes/light.scss to public/css/light.css.
### Source Maps
<% impl_status dart: '1.3.0' %>
<%= partial 'documentation/snippets/source-maps' %>
Dart Sass generates source maps by default for every CSS file it emits.
@ -231,6 +283,8 @@ $ sass --embed-source-map sass/style.scss css.style.css
#### `--watch`
<% impl_status dart: '1.6.0' %>
This flag acts like the [`--update` flag][], but after the first round
compilation is done Sass stays open and continues compiling stylesheets whenever
they or their dependencies change.
@ -247,6 +301,8 @@ Compiled themes/dark.scss to public/css/dark.css.
#### `--poll`
<% impl_status dart: '1.8.0' %>
This flag, which may only be passed along with `--watch`, tells Sass to manually
check for changes to the source files every so often instead of relying on the
operating system to notify it when something changes. This may be necessary if
@ -263,6 +319,8 @@ Compiled themes/dark.scss to public/css/dark.css.
#### `--stop-on-error`
<% impl_status dart: '1.8.0' %>
This flag tells Sass to stop compiling immediately when an error is detected,
rather than trying to compile other Sass files that may not contain errors. It's
mostly useful in [many-to-many mode][].
@ -279,6 +337,8 @@ Error: Expected expression.
#### `--interactive`
<% impl_status dart: '1.5.0' %>
This flag (abbreviated `-i`) tells Sass to run in interactive mode, where you
can write [SassScript expressions][] and see their results. Interactive mode
also supports [variables][].
@ -322,6 +382,8 @@ Error: Incompatible units em and px.
#### `--no-unicode`
<% impl_status dart: '1.17.0' %>
This flag tells Sass only to emit ASCII characters to the terminal as part of
error messages. By default, or if `--unicode` is passed, Sass will emit non-ASCII
characters for these messages. This flag does not affect the CSS output.