99 lines
3.2 KiB
Markdown
99 lines
3.2 KiB
Markdown
### Sass Formatter
|
|
|
|
<span id="BADGE_GENERATION_MARKER_0"></span>
|
|
[](https://github.com/facebook/jest) [](https://www.codefactor.io/repository/github/therealsyler/sass-formatter) [](https://github.com/TheRealSyler/sass-formatter/actions/workflows/main.yml) [](https://codecov.io/gh/TheRealSyler/sass-formatter) [](https://www.npmjs.com/package/sass-formatter) [](https://bundlephobia.com/result?p=sass-formatter) [](https://packagephobia.now.sh/result?p=sass-formatter) [](https://github.com/TheRealSyler/sass-formatter)
|
|
<span id="BADGE_GENERATION_MARKER_1"></span>
|
|
|
|
### Website [sass-formatter.syler.de](https://sass-formatter.syler.de/)
|
|
## Used in
|
|
* [Vscode sass extension](https://github.com/TheRealSyler/vscode-sass-indented)
|
|
## Usage
|
|
|
|
```typescript
|
|
import { SassFormatter } from 'sass-formatter';
|
|
|
|
const result = SassFormatter.Format(
|
|
`
|
|
span
|
|
color: none
|
|
|
|
@for $i from 0 through 2
|
|
|
|
&:nth-child(#{$i})
|
|
color: none
|
|
@each $author in $list
|
|
.photo-#{$author}
|
|
background: image-url("avatars/#{$author}.png") no-repeat
|
|
|
|
@while $types > 0
|
|
.while-#{$types}
|
|
width: $type-width + $types`
|
|
);
|
|
```
|
|
|
|
#### Result
|
|
|
|
```sass
|
|
span
|
|
color: none
|
|
|
|
@for $i from 0 through 2
|
|
|
|
&:nth-child(#{$i})
|
|
color: none
|
|
@each $author in $list
|
|
.photo-#{$author}
|
|
background: image-url("avatars/#{$author}.png") no-repeat
|
|
|
|
@while $types > 0
|
|
.while-#{$types}
|
|
width: $type-width + $types
|
|
```
|
|
|
|
<span id="DOC_GENERATION_MARKER_0"></span>
|
|
|
|
# Docs
|
|
|
|
- **[config](#config)**
|
|
|
|
- [SassFormatterConfig](#sassformatterconfig)
|
|
- [defaultSassFormatterConfig](#defaultsassformatterconfig)
|
|
|
|
### config
|
|
|
|
##### SassFormatterConfig
|
|
|
|
```ts
|
|
interface SassFormatterConfig {
|
|
/**Enable debug messages */
|
|
debug: boolean;
|
|
/**delete rows that are empty. */
|
|
deleteEmptyRows: boolean;
|
|
/**@deprecated*/
|
|
deleteWhitespace: boolean;
|
|
/**Convert css or scss to sass */
|
|
convert: boolean;
|
|
/**set the space after the colon of a property to one.*/
|
|
setPropertySpace: boolean;
|
|
tabSize: number;
|
|
/**insert spaces or tabs. */
|
|
insertSpaces: boolean;
|
|
/**Defaults to LF*/
|
|
lineEnding: 'LF' | 'CRLF';
|
|
}
|
|
```
|
|
|
|
##### defaultSassFormatterConfig
|
|
|
|
```ts
|
|
const defaultSassFormatterConfig: SassFormatterConfig;
|
|
```
|
|
|
|
_Generated with_ **[suf-cli](https://www.npmjs.com/package/suf-cli)**
|
|
<span id="DOC_GENERATION_MARKER_1"></span>
|
|
|
|
## License
|
|
|
|
<span id="LICENSE_GENERATION_MARKER_0"></span>
|
|
Copyright (c) 2019 Leonard Grosoli Licensed under the MIT license.
|
|
<span id="LICENSE_GENERATION_MARKER_1"></span>
|