# prettier-plugin-properties

> Prettier plugin for .properties files

Latest version **0.3.1** (published 2025-12-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install prettier-plugin-properties
pnpm add prettier-plugin-properties
yarn add prettier-plugin-properties
bun add prettier-plugin-properties
```

## Health

**Score 45/100 (D)** — status: stable.

Positive: no vulnerabilities.

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

## Facts

| | |
|---|---|
| Version | 0.3.1 |
| Published | 2025-12-28 |
| First published | 2020-04-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Eemeli Aro |
| Maintainers | eemeli |
| Keywords | prettier, properties, plugin |

## Links

- npm: https://www.npmjs.com/package/prettier-plugin-properties
- Repository: https://github.com/eemeli/prettier-plugin-properties
- Homepage: https://github.com/eemeli/prettier-plugin-properties#readme
- Issues: https://github.com/eemeli/prettier-plugin-properties/issues
- npm.io page: https://npm.io/package/prettier-plugin-properties

## Dependencies (1)

- [dot-properties](https://npm.io/package/dot-properties.md) ^1.1.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 0.3.1 (latest) — 2025-12-28
- 0.3.0 — 2023-10-13
- 0.2.0 — 2022-08-05
- 0.1.0 — 2020-04-08

## README

# Prettier for .properties Files

Adds support to Prettier (v2.3 and later) for [`.properties`](https://en.wikipedia.org/wiki/.properties) files.
To use, install it:

```
npm install --save-dev prettier-plugin-properties
```

and then add it to your [Prettier plugin configuration](https://prettier.io/docs/plugins).

## Configuration

In addition to the default options, two additional options are available:

### Escape Non-Latin-1 Characters

Escape with `\u` all non-Latin-1 characters, to allow safely encoding output as ISO-8859-1.

| Default | CLI Override          | API Override              |
| ------- | --------------------- | ------------------------- |
| `false` | `--escape-non-latin1` | `escapeNonLatin1: <bool>` |

### Key Separator

Set the separator to use between a property key and its value.

Valid options:<br>
`" " | ":" | "=" | ": " | "= " | " : " | " = "`

| Default | CLI Override              | API Override            |
| ------- | ------------------------- | ----------------------- |
| `" = "` | `--key-separator "<sep>"` | `keySeparator: "<sep>"` |

### Using Overrides

To apply separate Prettier configuration for different file types,
you may use [configuration overrides](https://prettier.io/docs/configuration.html#configuration-overrides).
For example:

```json
{
  "overrides": [
    {
      "files": "*.properties",
      "options": {
        "printWidth": 0
      }
    }
  ]
}
```

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