Stylelint-formatter-github NPM

Highlights

Report your stylelint results as annotations using the GitHub Checks API
Only runs in CI environment
Uses stylelint-formatter-pretty as the formatter for displaying the lint results

Example of annotations being included in a pull request

Install

npm install --save-dev stylelint-formatter-github
# or
yarn add -D stylelint-formatter-github

Usage

You will need to install the github app to your repo.

Then just use the formatter and it will report errors and warnings on PRs!

stylelint --custom-formatter=node_modules/stylelint-formatter-github file.js

Using you own GitHub App

You might not want to use our github app for the formatter.

Reasons:

You think they way we exposed the keys is bad
You are on Github Enterprise and cannot use the public app

In these situations all you need to do is create a GitHub app and set a few environment variables.

1. Create a GitHub app

Go to this page to create a new GitHub app. You need to set the following fields:

name - The name that shows for your app in the checks reports
Homepage URL - You can set this to anything. Ours is set to https://github.com
Webhook URL - You can set this to anything. Ours is set to https://github.com

Then hit Save Changes and you're all done setting up your GitHub app.

2. Set `STYLELINT_APP_ID` environment variable

Your GitHub application's ID. This can be found at the top of your GitHub app's edit page.

3. Set `STYLELINT_PRIVATE_KEY` environment variable

The private RSA key for your application. The prompt to generate the RSA key is at the bottom of your GitHub app's edit page.

Once you have generated a key, open the file that is downloaded and copy to text into the PRIVATE_KEY environment variable.

stylelint stylelint-formatter formatter reporter lint validate github annotations checks

create-check stylelint-formatter-pretty

@infinitebrahmanuniverse/nolb-stylelint-f @everything-registry/sub-chunk-2842 @design-systems/lint

1.0.2-canary.100.dc9d506.0

3 years ago

1.0.2-canary.100.f062e0f.0

3 years ago

1.0.2-canary.100.2df33b5.0

3 years ago

1.0.2-canary.94.7faeeec.0

3 years ago

1.0.2-canary.100.3919296.0

3 years ago

1.0.2-canary.94.8156077.0

3 years ago

1.0.2-canary.100.d21e003.0

3 years ago

1.0.2-canary.85.5d03ed5.0

3 years ago

1.0.2-canary.99.f554a08.0

3 years ago

1.0.2-canary.78.02eb957.0

3 years ago

1.0.2-canary.86.322d782.0

3 years ago

1.0.2-canary.92.55fda32.0

3 years ago

1.0.2-canary.86.306621c.0

4 years ago

1.0.2-canary.76.980d0cd.0

4 years ago

1.0.2-canary.100.c8e7377.0

4 years ago

1.0.2-canary.99.91cf4bd.0

4 years ago

1.0.2-canary.78.14155d6.0

4 years ago

1.0.2-canary.77.33348d2.0

4 years ago

1.0.2-canary.80.2c14af6.0

4 years ago

1.0.2-canary.96.16fc723.0

4 years ago

1.0.2-canary.101.1b84333.0

4 years ago

1.0.2-canary.85.3cd662e.0

4 years ago

1.0.2-canary.60.a347f0f.0

4 years ago

1.0.2-canary.86.2fc6c99.0

4 years ago

1.0.2-canary.99.9e4959c.0

4 years ago

1.0.2-canary.85.d7bf83b.0

4 years ago

1.0.2-canary.100.121adbf.0

4 years ago

1.0.2-canary.77.c671404.0

4 years ago

1.0.2-canary.80.f93a1b1.0

4 years ago

1.0.2-canary.89.a303cc0.0

4 years ago

1.0.2-canary.99.7389fe0.0

4 years ago

1.0.2-canary.85.f814fce.0

4 years ago

1.0.2-canary.86.ef20d56.0

4 years ago

1.0.2-canary.94.d43d832.0

4 years ago

1.0.2-canary.80.d448de6.0

4 years ago

1.0.2-canary.80.9a50e6e.0

4 years ago

1.0.2-canary.80.c0d2e79.0

4 years ago

1.0.2-canary.98.6682dce.0

4 years ago

1.0.2-canary.98.109b2e1.0

4 years ago

1.0.2-canary.98.84559f8.0

4 years ago

1.0.2-canary.98.62bdfc1.0

4 years ago

1.0.2-canary.98.b736c99.0

4 years ago

1.0.2-canary.97.c55a928.0

4 years ago

1.0.2-canary.80.82778e8.0

4 years ago

1.0.2-canary.80.55d8b38.0

4 years ago

1.0.2-canary.80.48464d0.0

4 years ago

1.0.2-canary.80.96bf3c7.0

4 years ago

1.0.2-canary.85.1036112.0

4 years ago

1.0.2-canary.80.838e8f1.0

4 years ago

1.0.2-canary.86.e168559.0

4 years ago

1.0.2-canary.80.5389b01.0

4 years ago

1.0.2-canary.94.90f4399.0

4 years ago

1.0.2-canary.97.84a497a.0

4 years ago

1.0.2-canary.97.226dee1.0

4 years ago

1.0.2-canary.89.5986841.0

4 years ago

1.0.2-canary.85.6036b2d.0

4 years ago

1.0.2-canary.60.7b271fa.0

4 years ago

1.0.2-canary.80.c1408bb.0

4 years ago

1.0.2-canary.80.a5bea50.0

4 years ago

1.0.2-canary.80.936e908.0

4 years ago

1.0.2-canary.80.2f66cdf.0

4 years ago

1.0.2-canary.80.1955197.0

4 years ago

1.0.2-canary.80.1ffa32d.0

4 years ago

1.0.2-canary.97.cfc2cce.0

4 years ago

1.0.2-canary.97.e37f585.0

4 years ago

1.0.2-canary.97.3769c19.0

4 years ago

1.0.2-canary.97.4f431a4.0

4 years ago

1.0.2-canary.97.2f5db19.0

4 years ago

1.0.2-canary.85.ce27e0c.0

4 years ago

1.0.2-canary.97.3f0f111.0

4 years ago

1.0.2-canary.86.552be7e.0

4 years ago

1.0.2-canary.97.ff78470.0

4 years ago

1.0.2-canary.96.6b0d027.0

4 years ago

1.0.2-canary.96.24a57b6.0

4 years ago

1.0.2-canary.86.8b5c390.0

4 years ago

1.0.2-canary.95.871a78e.0

4 years ago

1.0.2-canary.78.33f2c58.0

4 years ago

1.0.2-canary.95.025c535.0

4 years ago

1.0.2-canary.94.158d408.0

4 years ago

1.0.2-canary.92.e6ac18c.0

4 years ago

1.0.2-canary.76.1f455b3.0

4 years ago

1.0.2-canary.93.b91ca53.0

4 years ago

1.0.2-canary.88.ca79534.0

4 years ago

1.0.2-canary.85.a326fa1.0

4 years ago

1.0.2-canary.88.6164a6f.0

4 years ago

1.0.2-canary.91.3ac6430.0

4 years ago

1.0.2-canary.76.24b64fb.0

4 years ago

1.0.2-canary.86.f01c896.0

4 years ago

1.0.2-canary.90.5e04fc2.0

4 years ago

1.0.2-canary.88.c16fcc6.0

4 years ago

1.0.2-canary.89.8c2498c.0

4 years ago

1.0.2-canary.60.2b748a8.0

4 years ago

1.0.2-canary.85.9650f56.0

4 years ago

1.0.2-canary.60.aeb1048.0

4 years ago

1.0.2-canary.88.0799f6c.0

4 years ago

1.0.2-canary.60.9e112dd.0

4 years ago

1.0.2-canary.85.dfa2708.0

4 years ago

1.0.2-canary.80.03caf83.0

4 years ago

1.0.2-canary.88.f54e792.0

4 years ago

1.0.2-canary.82.07cd7dc.0

4 years ago

1.0.2-canary.76.c19e154.0

4 years ago

1.0.2-canary.78.254746f.0

4 years ago

1.0.2-canary.88.c6b8f75.0

4 years ago

1.0.2-canary.80.7e7a5ab.0

4 years ago

1.0.2-canary.80.a5eb107.0

4 years ago

1.0.2-canary.76.11b651e.0

4 years ago

1.0.2-canary.88.2282c55.0

4 years ago

1.0.2-canary.88.415803e.0

4 years ago

1.0.2-canary.89.baa6715.0

4 years ago

1.0.2-canary.88.2437e58.0

4 years ago

1.0.2-canary.87.125e12f.0

4 years ago

1.0.2-canary.85.0c54932.0

4 years ago

1.0.2-canary.85.ffdfa2d.0

4 years ago

1.0.2-canary.80.f44d01a.0

4 years ago

1.0.2-canary.87.9580a9f.0

4 years ago

1.0.2-canary.80.6ea7fa1.0

4 years ago

1.0.2-canary.76.e41632f.0

4 years ago

1.0.2-canary.80.6ffa3b0.0

4 years ago

1.0.2-canary.80.0deb3b7.0

4 years ago

1.0.2-canary.87.89ceecf.0

4 years ago

1.0.2-canary.85.8d94e1f.0

4 years ago

1.0.2-canary.81.670e4ee.0

4 years ago

1.0.2-canary.85.cf21469.0

4 years ago

1.0.2-canary.80.0d69e2b.0

4 years ago

1.0.2-canary.80.3a7d3d8.0

4 years ago

1.0.2-canary.86.20fdf4c.0

4 years ago

1.0.2-canary.80.5535189.0

4 years ago

1.0.2-canary.80.a008ee8.0

4 years ago

1.0.2-canary.76.be3bbf2.0

4 years ago

1.0.2-canary.76.fabe3c2.0

4 years ago

1.0.2-canary.80.2ebc860.0

4 years ago

1.0.2-canary.85.73649c4.0

4 years ago

1.0.2-canary.84.ebce678.0

4 years ago

1.0.2-canary.82.ee82f8a.0

4 years ago

1.0.2-canary.80.6b5c711.0

4 years ago

1.0.2-canary.80.7d56713.0

4 years ago

1.0.2-canary.78.2f300ea.0

4 years ago

1.0.2-canary.80.9a4b1bd.0

4 years ago

1.0.2-canary.80.72ffbd7.0

4 years ago

1.0.2-canary.49.7e9385b.0

4 years ago

1.0.2-canary.78.948a37f.0

4 years ago

1.0.2-canary.76.5941589.0

4 years ago

1.0.2-canary.76.cf6b5cd.0

4 years ago

1.0.2-canary.80.769d22d.0

4 years ago

1.0.2-canary.81.5dfdbbf.0

4 years ago

1.0.2-canary.78.1cbe87d.0

4 years ago

1.0.2-canary.80.38a24b9.0

4 years ago

1.0.2-canary.80.3bb2239.0

4 years ago

1.0.2-canary.80.9350622.0

4 years ago

1.0.2-canary.83.10c9878.0

4 years ago

1.0.2-canary.81.32a802f.0

4 years ago

1.0.2-canary.81.0c5509e.0

4 years ago

1.0.2-canary.49.c4f01ac.0

4 years ago

1.0.2-canary.81.41bac3e.0

4 years ago

1.0.2-canary.82.bd5c742.0

4 years ago

1.0.2-canary.81.6337949.0

4 years ago

1.0.2-canary.81.1105cb9.0

4 years ago

1.0.2-canary.49.5765ab5.0

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

1.0.2-canary.79.737a79e.0

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

1.0.2-canary.76.8149716.0

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

1.0.2-canary.77.fe170b8.0

4 years ago

1.0.1-canary.14d410e

4 years ago

1.0.1-canary.89805ef

4 years ago

1.0.2-canary.80.1085ff2.0

4 years ago

1.0.1-canary.95eaeae

4 years ago

1.0.1-canary.724903e

4 years ago

1.0.1-canary.64.0069b43.0

4 years ago

1.0.1-canary.e7dab4d

4 years ago

1.0.2-canary.78.c985b51.0

4 years ago

1.0.1-canary.252669b

4 years ago

1.0.1-canary.64.cb5a6ae.0

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

Highlights

Install

Usage

Using you own GitHub App

1. Create a GitHub app

2. Set STYLELINT_APP_ID environment variable

3. Set STYLELINT_PRIVATE_KEY environment variable

2. Set `STYLELINT_APP_ID` environment variable

3. Set `STYLELINT_PRIVATE_KEY` environment variable