# perfectionist-dfd

> Beautify and/or normalize CSS files. Fork and update of a fork and update of an archived project.

Latest version **3.0.3** (published 2023-10-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install perfectionist-dfd
pnpm add perfectionist-dfd
yarn add perfectionist-dfd
bun add perfectionist-dfd
```

Provides the command `perfectionist-dfd`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.3 |
| Published | 2023-10-22 |
| First published | 2022-04-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 64.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Daniel F. Dickinson |
| Maintainers | danielfdickinson |
| Keywords | beautify, css, format, normalize, postcss, postcss-plugin, pretty |

## Links

- npm: https://www.npmjs.com/package/perfectionist-dfd
- Repository: https://github.com/danielfdickinson/perfectionist-dfd
- Issues: https://github.com/danielfdickinson/perfectionist-dfd/issues
- npm.io page: https://npm.io/package/perfectionist-dfd

## Dependencies (8)

- [semver](https://npm.io/package/semver.md) ^7.5.4
- [defined](https://npm.io/package/defined.md) ^1.0.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.6
- [postcss-scss](https://npm.io/package/postcss-scss.md) ^4.0.3
- [read-file-stdin](https://npm.io/package/read-file-stdin.md) ^0.2.1
- [write-file-stdout](https://npm.io/package/write-file-stdout.md) ^0.0.2
- [postcss-value-parser](https://npm.io/package/postcss-value-parser.md) ^4.2.0
- [string.prototype.repeat](https://npm.io/package/string.prototype.repeat.md) ^1.0.0

## Alternatives

- [style-dictionary](https://npm.io/package/style-dictionary.md) — 2.0M weekly downloads
- [postcss-merge-idents](https://npm.io/package/postcss-merge-idents.md) — 1.7M weekly downloads
- [@fontsource/noto-sans](https://npm.io/package/@fontsource/noto-sans.md) — 93.0K weekly downloads
- [uglifycss](https://npm.io/package/uglifycss.md) — 71.6K weekly downloads
- [mat4-interpolate](https://npm.io/package/mat4-interpolate.md) — 23.3K weekly downloads

## Recent versions

- 3.0.3 (latest) — 2023-10-22
- 3.0.1 (stable) — 2022-07-22
- 3.0.2 — 2023-07-16
- 3.0.1-beta.4 — 2022-07-21
- 3.0.1-beta.2 — 2022-07-21
- 3.0.1-beta.1 — 2022-05-01
- 3.0.0 — 2022-04-04
- 3.0.0-alpha.3-dev.1 — 2022-04-03
- 3.0.0-alpha.2 — 2022-04-03
- 2.4.2 — 2022-04-03
- 2.4.2-beta.2 — 2022-04-02
- 2.4.2-beta.1 — 2022-04-02

## README

# perfectionist-dfd

Beautify and/or normalize CSS files. Fork and update of a fork and update of an archived project. DEPRECATED.

## Status

DEPRECATED: The codebase is old and other alternatives exist (prettier for formatting, normalize-css for CSS normalization, and others)

[![perfectionist-dfd CI](https://github.com/danielfdickinson/perfectionist-dfd/actions/workflows/ci.yml/badge.svg)](https://github.com/danielfdickinson/perfectionist-dfd/actions/workflows/ci.yml) [![Coverage](https://coveralls.io/repos/github/danielfdickinson/perfectionist-dfd/badge.svg?branch=main)](https://coveralls.io/github/danielfdickinson/perfectionist-dfd?branch=main) [![NPM version](https://img.shields.io/npm/v/perfectionist-dfd)](https://www.npmjs.com/package/perfectionist-dfd?activeTab=versions)

## Example runs

### Input

```css
h1   {
         color   :  red }
```

### Expanded output

```css
h1 {
    color: red;
}
```

### Compact output

```css
h1 { color: red; }
```

### Compressed output

```css
h1{color:red}
```

## Supported Environments

* Currently [Node.js](https://nodejs.org) 12+ are supported.
* REVIEW: May add browser support in the future.

## Install

With [npm](https://npmjs.org/package/perfectionist-dfd) do:

```sh
npm install postcss perfectionist-dfd --save
```

## Import (ES6+) or require (CommonJS) in your source file

### ES6+

```javascript
import perfectionistDFD from 'perfectionist-dfd';
```

### CommonJS

```javascript
const perfectionistDFD = require('perfectionist-dfd');
```

## API

### perfectionistDFD.process(css, [options])

#### css

Type: `string`
_Required option._

Pass a CSS string to beautify it.

#### options

Type: `object`
_optional_

##### cascade

Type: `boolean`
Default: `true`

Set this to `false` to disable visual cascading of vendor prefixed properties.
Note that this transform only applies to the `expanded` format.

```css
/* true */
h1 {
    -webkit-border-radius: 12px;
            border-radius: 12px;
}

/* false */
h1 {
    -webkit-border-radius: 12px;
    border-radius: 12px;
}
```

##### colorCase

Type: `string`
Default: `lower`

Set either `lower` or `upper` to transform hexadecimal colors to the according case.

```css
/* upper */
p { color: #C8C8C8 }

/* lower */
p { color: #c8c8c8 }
```

##### colorShorthand

Type: `boolean`
Default: `true`

Set this to `true` to shorten hexadecimal colors.

```css
/* true */
p { color: #fff }

/* false */
p { color: #ffffff }
```

##### format

Type: `string`
Default: `expanded`

Pass either `expanded`, `compact` or `compressed`. Note that the `compressed`
format only facilitates simple whitespace compression around selectors &
declarations. For more powerful compression, see [cssnano](https://cssnano.co).

##### indentChar

Type: `string`
Default: ' ' (space)

Specify `\t` here instead if you would like to use tabs for indentation.

##### indentSize

Type: `number`
Default: `4`

This number will be used as a basis for all indent levels, using the `expanded`
format.

##### trimLeadingZero

Type: `boolean`
Default: `true`

Set this to `true` to trim leading zero for fractional numbers less than 1.

```css
/* true */
p { line-height: .8 }

/* false */
p { line-height: 0.8 }
```

##### trimTrailingZeros

Type: `boolean`
Default: `true`

Set this to `true` to trim trailing zeros in numbers.

```css
/* true */
div { top: 50px }

/* false */
div { top: 50.000px }
```

##### maxAtRuleLength

Type: `boolean|number`
Default: `80`

If set to a positive integer, set a maximum width for at-rule parameters; if
they exceed this, they will be split up over multiple lines. If false, this
behaviour will not be performed. Note that this transform only applies to
the `expanded` format.

##### maxSelectorLength

Type: `boolean|number`
Default: `80`

If set to a positive integer, set a maximum width for a selector string; if
it exceeds this, it will be split up over multiple lines. If false, this
behaviour will not be performed. Note that this transform is excluded from the
`compressed` format.

##### maxValueLength

Type: `boolean|number`
Default: `80`

If set to a positive integer, set a maximum width for a property value; if
it exceeds this, it will be split up over multiple lines. If false, this
behaviour will not be performed. Note that this transform only applies to
the `expanded` format.

##### sourcemap

Type: `boolean`
Default: `false`

Generate a sourcemap with the transformed CSS.

##### syntax

Type: `string`

Specify `scss` if you would like to also format SCSS-style single line comments.
This loads the [postcss-scss](https://github.com/postcss/postcss-scss) plugin.

##### zeroLengthNoUnit

Type: `boolean`
Default: `true`

Set this to `true` to trim units after zero length.

```css
/* true */
div { padding: 0 }

/* false */
div { padding: 0px }
```

#### Example using perfectionistDFD.process

```javascript
import perfectionistDFD from 'perfectionist-dfd'

const pftDFDOpts = {
    indentSize: 2,
    trimLeadingZero: false
}

const outCSS = perfectionistDFD.process(css, pftDFDOpts).css
```

### `postcss([ perfectionistDFD(opts) ])`

perfectionist-dfd can also be consumed as a PostCSS plugin. See the
[PostCSS documentation](https://github.com/postcss/postcss#usage) for examples for
your environment.

### CLI

perfectionist-dfd also ships with a CLI app. To see the available options, just run:

```sh
perfectionist-dfd --help
```

### PostCSS usage

See the [PostCSS documentation](https://github.com/postcss/postcss#usage) for
examples for your environment.

## Future

1. TODO: #11 Update easy pieces of [perfectionist-dfd](https://github.com/danielfdickinson/perfectionist-dfd) to 8.x API.
2. TODO: #12 Update main logic of [perfectionist-dfd](https://github.com/danielfdickinson/perfectionist-dfd) to 8.x API.
3. TODO: #13 Update rest of [perfectionist-dfd](https://github.com/danielfdickinson/perfectionist-dfd) to 8.x API.
4. TODO: #14 Improve and enhance [perfectionist-dfd](https://github.com/danielfdickinson/perfectionist-dfd) as a [PostCSS](https://github.com/postcss/postcss#readme) plugin.
5. TODO: #15 Improve and enhance as a standalone tool.
6. REVIEW: #24 Add support for use in browser environments.

## Contributing

Pull requests are welcome. If you add functionality, then please add unit tests
to cover it.

## License

MIT © 2015 [Ben Briggs](https://beneb.info) \
MIT © 2022 [Daniel F. Dickinson](https://www.wildtechgarden.ca/danielfdickinson/)

---
_Source: https://npm.io/package/perfectionist-dfd · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._