Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fsouza/prettierd
prettier, as a daemon, for improved formatting speed.
https://github.com/fsouza/prettierd
efm-langserver emacs formatter hacktoberfest javascript neovim prettier typescript vim
Last synced: 3 days ago
JSON representation
prettier, as a daemon, for improved formatting speed.
- Host: GitHub
- URL: https://github.com/fsouza/prettierd
- Owner: fsouza
- License: isc
- Created: 2020-06-23T14:41:56.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T03:16:41.000Z (about 2 months ago)
- Last Synced: 2024-10-29T15:19:33.117Z (about 1 month ago)
- Topics: efm-langserver, emacs, formatter, hacktoberfest, javascript, neovim, prettier, typescript, vim
- Language: TypeScript
- Homepage:
- Size: 1.29 MB
- Stars: 797
- Watchers: 4
- Forks: 24
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-x - prettierd
README
# prettierd
[](https://github.com/fsouza/prettierd/actions?query=branch:main+workflow:Build)
- [Installation guide](#installation-guide)
- [Using in the command line with node.js](#using-in-the-command-line-with-nodejs)
- [Supported languages / plugins](#supported-languages--plugins)
- [Additional plugins](#additional-plugins)
- [Provide Default Configuration](#provide-default-configuration)
- [Local Instance](#local-instance)
- [Editor integration](#editor-integration)
Wanna run prettier in your editor, but fast? Welcome to prettierd!
This is built on top of [core_d.js](https://github.com/mantoni/core_d.js) and
integrates with prettier.
## Installation guide
```
$ npm install -g @fsouza/prettierd
```
**NOTE**: `npm` comes builtin to [`node`](https://nodejs.org).
Alternatively, users may also use homebrew:
```
$ brew install fsouza/prettierd/prettierd
```
## Using in the command line with node.js
The prettierd script always takes the file in the standard input and the
positional parameter with the name of the file:
```
$ cat file.ts | prettierd file.ts
```
## Supported languages / plugins
Many parsers ship with prettierd, including JavaScript, TypeScript, GraphQL,
CSS, HTML and YAML.
Please notice that starting with version 0.12.0, prettierd now supports
invoking the local version of prettier, so instead of adding new languages to
prettierd, you should rely on that feature to use it locally with your custom
version of prettier and enabled plugins.
## Additional plugins
Additional plugins can be supported by installing them and adding them to the
prettier configuration. For example, to use the Ruby plugin, install
[`@prettier/plugin-ruby`](https://www.npmjs.com/package/@prettier/plugin-ruby)
and add it to your configuration:
```json
{
// ... other settings
"plugins": ["@prettier/plugin-ruby"]
}
```
Then formatting Ruby files should be possible.
## Provide Default Configuration
You can provide a default configuration for the prettier via setting the
environment variable `PRETTIERD_DEFAULT_CONFIG` to the exact path of the
`prettier` configuration file.
## Local Instance
If you have locally installed `prettier` in your package, it will use that.
Otherwise, it will use the one bundled with the package itself.
If you want to use prettierd exclusively with the locally installed prettier
package, you can set the environment variable `PRETTIERD_LOCAL_PRETTIER_ONLY`
(any truthy value will do, good examples are `true` or `1`).
## Editor integration
### Vim / Neovim
I use this directly with neovim's LSP client, via
[efm-langserver](https://github.com/mattn/efm-langserver):
```lua
local prettier = {
formatCommand = 'prettierd "${INPUT}"',
formatStdin = true,
env = {
string.format('PRETTIERD_DEFAULT_CONFIG=%s', vim.fn.expand('~/.config/nvim/utils/linter-config/.prettierrc.json')),
},
}
```
Alternatively, you can use
[prettierme](https://github.com/ruyadorno/prettierme) to integrate directly
with other editors.
Or, as a third option for users of Vim/Neovim plugins such as
[formatter.nvim](https://github.com/mhartington/formatter.nvim) or
[vim-codefmt](https://github.com/google/vim-codefmt), you can configure
prettierd in the stdin mode. Below is an example with `formatter.nvim`:
```lua
require('formatter').setup({
logging = false,
filetype = {
javascript = {
-- prettierd
function()
return {
exe = "prettierd",
args = {vim.api.nvim_buf_get_name(0)},
stdin = true
}
end
},
-- other formatters ...
}
})
```
### Sublime Text
#### Prettierd Format
You can use [Prettierd Format](https://packagecontrol.io/packages/Prettierd%20Format) to format your files with prettierd. After installation, it enables format-on-save for any file supported by Prettier by default.
#### Fmt
Alternatively, if you're looking for something more advanced that supports multiple formatters, you can use [Fmt](https://packagecontrol.io/packages/Fmt) and configure prettierd for each language scope you wish to format:
```json
{
"rules": [
{
"selector": "source.ts",
"cmd": ["prettierd", "--stdin-filepath", "$file"],
"format_on_save": true
},
{
"selector": "source.json"
// ...
}
// ...
]
}
```
### Zed
To use Prettierd with Zed, you need to configure the `language_overrides` adding a `format_on_save` command for each of the languages you wish to be handling.
> [!NOTE]
> Configuration below assumes you have installed `prettierd` and gives an example of its path from Homebrew installation. You can check path on your system by running `which prettierd`.
Example configuration:
```json
{
"language_overrides": {
"TypeScript": {
"format_on_save": {
"external": {
"command": "/opt/homebrew/bin/prettierd",
"arguments": ["--stdin-filepath", "{buffer_path}"]
}
}
}
}
}
```
Save your configuration file, and provided you've installed and set the correct path to `prettierd` program, Zed will start formatting your files on save action.
### Other editors
I don't know much about other editors, but feel free to send a pull requests on
instructions.