https://github.com/nice-move/prettier-plugin-ssh-config
A prettier plugin for ssh config.
https://github.com/nice-move/prettier-plugin-ssh-config
config prettier prettier-plugin ssh ssh-config
Last synced: 2 months ago
JSON representation
A prettier plugin for ssh config.
- Host: GitHub
- URL: https://github.com/nice-move/prettier-plugin-ssh-config
- Owner: nice-move
- License: mit
- Created: 2021-07-18T06:40:20.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-06-20T03:32:07.000Z (10 months ago)
- Last Synced: 2026-02-11T04:24:00.454Z (3 months ago)
- Topics: config, prettier, prettier-plugin, ssh, ssh-config
- Language: JavaScript
- Homepage:
- Size: 491 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# prettier-plugin-ssh-config
A [prettier] plugin for ssh config.
[prettier]: https://prettier.io/
[![npm][npm-badge]][npm-url]
[![github][github-badge]][github-url]
![node][node-badge]
[npm-url]: https://www.npmjs.com/package/prettier-plugin-ssh-config
[npm-badge]: https://img.shields.io/npm/v/prettier-plugin-ssh-config.svg?style=flat-square&logo=npm
[github-url]: https://github.com/nice-move/prettier-plugin-ssh-config
[github-badge]: https://img.shields.io/npm/l/prettier-plugin-ssh-config.svg?style=flat-square&colorB=blue&logo=github
[node-badge]: https://img.shields.io/node/v/prettier-plugin-ssh-config.svg?style=flat-square&colorB=green&logo=node.js
## Examples
```ssh-config
Host *
HostName localhost
User root
Host abc
HostName 127.0.0.1
User nginx
```
## Installation
```sh
npm install prettier prettier-plugin-ssh-config --save-dev
```
## Usage
```sh
prettier --write ssh_config
```
### Support Filenames
- ssh.config
- ssh_config
- ssh-config
- sshconfig
- \*.ssh_config
- \*.ssh-config
- \*.sshconfig
To support custom config name:
```jsonc
// .prettierrc.json
{
"overrides": [
{
"files": ".ssh/config",
"options": {
"parser": "ssh-config"
}
}
]
}
```
## Options
This plugin took [options](https://prettier.io/docs/en/options.html) from prettier. Support `useTabs/tabWidth/endOfLine` , not support `printWidth/requirePragma/insertPragma` .
## Related
- [@nice-move/prettier-config](https://github.com/nice-move/nice-move/tree/master/packages/prettier-config)
- [@bring-it/cli](https://github.com/airkro/bring-it)