Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jgierer12/prettier-github
Format code in GitHub comments with Prettier
https://github.com/jgierer12/prettier-github
bot github javascript prettier
Last synced: 11 days ago
JSON representation
Format code in GitHub comments with Prettier
- Host: GitHub
- URL: https://github.com/jgierer12/prettier-github
- Owner: jgierer12
- License: mit
- Archived: true
- Created: 2017-06-11T07:20:25.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-07-03T20:14:08.000Z (over 7 years ago)
- Last Synced: 2025-01-22T05:30:51.742Z (11 days ago)
- Topics: bot, github, javascript, prettier
- Language: JavaScript
- Homepage:
- Size: 90.8 KB
- Stars: 242
- Watchers: 4
- Forks: 22
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# Prettier GitHub [](https://travis-ci.org/jgierer12/prettier-github)
> Format code in GitHub comments with [Prettier](https://github.com/prettier/prettier)
## Installation
### GitHub app
This is the recommended and easiest installation method. Install the [Prettier GitHub app](https://github.com/apps/prettier-github) to some or all of your repos.
### Self-hosted
1. [](https://deploy.now.sh/?repo=https://github.com/jgierer12/prettier-github&env=GITHUB_KEY&env=GITHUB_ID&env=GITHUB_WEBHOOK_SECRET) or [](https://heroku.com/deploy?template=https://github.com/jgierer12/prettier-github)
1. Setup
1. Register a [GitHub app](https://github.com/settings/apps/new)
1. Use whatever makes sense for you for **App name**, **Description**, **Homepage URL** and **User authorization callback URL**; leave **Setup URL** empty
1. Set **Webhook URL** to your deployment URL, for example `https://prettier-github.herokuapp.com/`
1. Set a **Webhook secret** and note it down
1. Select **Read & write** access for **Issues**, **Pull requests** and **Repository contents**
1. For **Issues** and **Pull requests**, check **all** Webhook checkboxes; for **Repository contents**, check only **Commit comment**
1. Click on **Create GitHub app**
1. Click on **Generate private key** and save the downloaded file
1. Note down the app **ID** (displayed under your username in the right column)
1. Configure environment variables of your deployment
1. Set `GITHUB_KEY` to the downloaded private key
1. Set `GITHUB_ID` to the app ID
1. Set `GITHUB_WEBHOOK_SECRET` to the Webhook secret you configured
## Usage
Whenever someone includes a JavaScript code block in a comment, it will be formatted using Prettier.
Before: 
After: 
You can disable formatting per-comment by writing `` anywhere in the comment (except code blocks)
### Limitations
Due to lacking GitHub APIs, Prettier GitHub currently doesn't format reviews, review comments and commit comments. See [#11](https://github.com/jgierer12/prettier-github/issues/11)
## Configuration
Prettier GitHub will use the `prettier` field in the `package.json` of the respective repository for configuration. See [Prettier's readme](https://github.com/prettier/prettier#options) for available options. Additionally, you can set `langs` to an array specifying which languages should be formatted.
### Example
`package.json`:
```json
{
...
"prettier": {
"singleQuote": true,
"useTabs": true,
"langs": [
"js",
"javascript"
]
}
...
}
```
This will enforce single quotes and tabs, and will only format code blocks marked as `js` or `javascript`.
## Development
1. Generate [personal access token](https://github.com/settings/tokens/new) with the **repo** scope for your GitHub account
1. Install [ngrok](https://ngrok.com/) for localhost tunnelling
1. Run `ngrok http 3000` and note down the URL, for example `http://2ab92a92.ngrok.io`
1. Set up a [webhook](https://developer.github.com/webhooks/creating/#setting-up-a-webhook) for your testing repo
1. Set **Payload URL** to the ngrok URL
1. Set **Content type** to `application/json`
1. Set a **Secret** and note it down
1. Select **Let me select individual events**; then check **Commit comment**, **Issue comment**, **Issues**, **Pull request**, **Pull request review** and **Pull request review comment** and uncheck **Push**
1. Copy `.env.example`
1. Set `GITHUB_TOKEN` to the personal access token generated earlier
1. Set `GITHUB_WEBHOOK_SECRET` to the Webhook secret you configured
1. Run `npm install` and then `npm start`
## License
MIT