Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smastrom/sublime-prettierd-format
Sublime Text plugin to format files faster using prettierd
https://github.com/smastrom/sublime-prettierd-format
prettier prettierd sublime-text sublime-text-4 sublime-text-plugin
Last synced: 3 months ago
JSON representation
Sublime Text plugin to format files faster using prettierd
- Host: GitHub
- URL: https://github.com/smastrom/sublime-prettierd-format
- Owner: smastrom
- License: 0bsd
- Created: 2023-09-15T10:17:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-18T02:07:55.000Z (9 months ago)
- Last Synced: 2024-04-19T02:51:12.321Z (9 months ago)
- Topics: prettier, prettierd, sublime-text, sublime-text-4, sublime-text-plugin
- Language: Python
- Homepage: https://packagecontrol.io/packages/Prettierd%20Format
- Size: 5.86 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Prettierd Format
Sublime Text plugin to format files faster using [prettierd](https://github.com/fsouza/prettierd).
## Installation
1. Install [prettierd](https://github.com/fsouza/prettierd) globally with npm/yarn/pnpm:
```sh
npm i -g @fsouza/prettierd
```
2. Install this plugin with [Package Control](https://packagecontrol.io/packages/Prettierd%20Formatter):
`Package Control: Install Package` → `Prettierd Format`
3. Restart Sublime Text
## Usage
By default it formats on save any file supported by [Prettier](https://prettier.io/docs/en/) out-of-the-box.
### Commands
To format a file:
- `Prettierd: Format`
To save a file without formatting:
- `Prettierd: Save without formatting`
### Options
Enable/disable format on save:
```json
"format_on_save": true
```
Add additional extensions (enabled via prettier plugins) to be formatted either on save or commands:
```json
"additional_extensions": ["php"]
```
Exclude extensions from being formatted on save:
```json
"disabled_extensions_on_save": ["md"]
```
Exclude directories from being formatted on save:
```json
"disabled_directories_on_save": ["*/node_modules/*"]
```
Optional, path to `prettierd` executable. If not specified, it will be searched for in the system:
```json
"prettierd_path": null
```
## Notes
This plugin does nothing else than piping the input to `prettierd` and replacing the view contents with the output.
It is basically just like executing `cat file.js | prettierd file.js` with the command line.
For this reason, any issue with prettier plugins or configuration should be investigated on the [prettierd](https://github.com/fsouza/prettierd) repo as it is the underlying tool actually interacting with Prettier.
### Astro / Svelte
As of September 2023, there are some upstream issues with Astro and Svelte files.
You can format them with the command `LSP: format` after installing their LSPs and enabling format on save for each language in the LSP settings.
Using the above command not only respects the `.prettierrc` configuration but is also very fast.
## License
0BSD