# prettier-plugin-ini

> prettier plugin for INI files

Latest version **1.3.0** (published 2024-09-20) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.0 |
| Published | 2024-09-20 |
| First published | 2020-04-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 17.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Kevin Newton |
| Maintainers | kddeisz |

## Links

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

## Dependencies (1)

- [prettier](https://npm.io/package/prettier.md) >=3.0.0-alpha.3

## Recent versions

- 1.3.0 (latest) — 2024-09-20
- 1.2.0 — 2024-05-21
- 1.1.0 — 2022-08-12
- 1.0.0 — 2022-03-22
- 0.3.1 — 2020-09-02
- 0.3.0 — 2020-07-10
- 0.2.0 — 2020-07-06
- 0.1.0 — 2020-04-11

## README

<h1 align="center">Prettier for INI files</h1>

<p align="center">
  <a href="https://gitter.im/jlongster/prettier">
    <img alt="Gitter" src="https://img.shields.io/gitter/room/jlongster/prettier.svg?style=flat-square">
  </a>
  <a href="https://github.com/kddnewton/prettier-plugin-ini/actions">
    <img alt="GitHub Actions" src="https://img.shields.io/github/actions/workflow/status/kddnewton/prettier-plugin-ini/main.yml?branch=main&style=flat-square">
  </a>
  <a href="https://www.npmjs.com/package/prettier-plugin-ini">
    <img alt="NPM Version" src="https://img.shields.io/npm/v/prettier-plugin-ini.svg?style=flat-square">
  </a>
  <a href="#badge">
    <img alt="code style: prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square">
  </a>
  <a href="https://twitter.com/PrettierCode">
    <img alt="Follow+Prettier+on+Twitter" src="https://img.shields.io/twitter/follow/prettiercode.svg?label=follow+prettier&style=flat-square">
  </a>
</p>

`prettier-plugin-ini` is a [prettier](https://prettier.io/) plugin for INI files. `prettier` is an opinionated code formatter that supports multiple languages and integrates with most editors. The idea is to eliminate discussions of style in code review and allow developers to get back to thinking about code design instead.

## Getting started

To run `prettier` with the INI plugin, you're going to need [`node`](https://nodejs.org/en/download/) (version `8.3` or newer).

If you're using the `npm` CLI, then add the plugin by:

```bash
npm install --save-dev prettier prettier-plugin-ini
```

Or if you're using `yarn`, then add the plugin by:

```bash
yarn add --dev prettier prettier-plugin-ini
```

The `prettier` executable is now installed and ready for use:

```bash
./node_modules/.bin/prettier --write '**/*.ini'
```

## Configuration

Below are the options (from [`src/plugin.js`](src/plugin.js)) that `prettier-plugin-ini` currently supports:

| API Option             | CLI Option                  | Default | Description                                                                                      |
| ---------------------- | --------------------------- | :-----: | ------------------------------------------------------------------------------------------------ |
| `iniSpaceAroundEquals` | `--ini-space-around-equals` | `false` | Adds a space around the equals sign when specifying params.                                      |
| `printWidth`           | `--print-width`             |  `80`   | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#print-width)). |
| `tabWidth`             | `--tab-width`               |   `2`   | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#tab-width)).   |

Any of these can be added to your existing [prettier configuration
file](https://prettier.io/docs/en/configuration.html). For example:

```json
{
  "tabWidth": 4
}
```

Or, they can be passed to `prettier` as arguments:

```bash
prettier --tab-width 4 --write '**/*.ini'
```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kddnewton/prettier-plugin-ini.

## License

The package is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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