@darksheep/eslint-formatter-github 2.2.0 → 2.2.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [2.2.1](https://github.com/DarkSheepSoftware/node-packages/compare/eslint-formatter-github-v2.2.0...eslint-formatter-github-v2.2.1) (2026-04-17)
+
+
+### 📚 Documentation
+
+* Update the READMEs ([#824](https://github.com/DarkSheepSoftware/node-packages/issues/824)) ([9d282b7](https://github.com/DarkSheepSoftware/node-packages/commit/9d282b724fe056ec275578088bf495985e22c25f))
+
 ## [2.2.0](https://github.com/DarkSheepSoftware/node-packages/compare/eslint-formatter-github-v2.1.0...eslint-formatter-github-v2.2.0) (2025-10-09)
 
 

package/README.md

@@ -1,6 +1,44 @@
 # @darksheep/eslint-formatter-github
+An ESLint formatter that outputs [GitHub Actions workflow commands](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-a-warning-message), turning lint results into inline annotations on pull requests.
 
+Severity is mapped as follows:
+- `0` (off) → `notice`
+- `1` (warn) → `warning`
+- `2` (error) → `error`
+
+## Installation
+```sh
+yarn add --dev @darksheep/eslint-formatter-github
+```
+
+## Usage
+
+Pass it to ESLint via the `--format` flag:
+
+```sh
+npx eslint . --format @darksheep/eslint-formatter-github
+```
+
+Or add it to your ESLint config:
+
+```json
+{
+  "scripts": {
+    "lint": "eslint . --format @darksheep/eslint-formatter-github"
+  }
+}
 ```
-npm install --save-dev eslint @darksheep/eslint-formatter-github
-npx eslint . --format @darksheep/github
+
+This is most useful in a GitHub Actions workflow:
+
+```yaml
+- name: Lint
+  run: yarn lint
 ```
+
+When run in Actions, errors and warnings will appear as annotations directly on the relevant lines of the PR diff.
+
+## Notes
+- Outside of GitHub Actions, the output still works but the annotations won't render as inline comments
+- The formatter uses the nearest `package.json` to label the group heading in the Actions log
+- Exit code is incremented by the number of errors, so your CI step will fail on lint errors as expected

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@darksheep/eslint-formatter-github",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "ESLint + Github actions",
   "license": "UNLICENCED",
   "type": "commonjs",

package/src/index.js

@@ -1,3 +1,7 @@
+/**
+ * @import { LineAnnotation } from '@darksheep/github-actions';
+ */
+
 const path = require('node:path');
 const { setNotice, setWarning, setError, startGroup, endGroup } = require('@darksheep/github-actions');
 const { getPackageJson } = require('@darksheep/package.json/sync');
@@ -73,7 +77,7 @@ function formatFileResult(fileResult) {
       ? `[${result.ruleId}] ${result.message}`
       : result.message;
 
-    /** @type {import('@darksheep/github-actions').LineAnnotation} */
+    /** @type {LineAnnotation} */
     const context = {
       file: filePath,
       line: result.line,