https://github.com/kddnewton/prettier-plugin-ini

A prettier plugin for INI files
https://github.com/kddnewton/prettier-plugin-ini

Last synced: 3 months ago
JSON representation

A prettier plugin for INI files

• Host: GitHub
• URL: https://github.com/kddnewton/prettier-plugin-ini
• Owner: kddnewton
• License: mit
• Created: 2020-02-11T17:28:23.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-11-04T07:24:50.000Z (3 months ago)
• Last Synced: 2024-11-04T08:26:33.865Z (3 months ago)
• Language: JavaScript
• Size: 2.86 MB
• Stars: 11
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Prettier for INI files




  

    

  

  

    

  

  

    

  

  

    

  

  

    

  



`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).