Skip to content

Commit 50e8bfd

Browse files
committed
chore: add Prettier for Markdown in lint-staged; format existing md files
1 parent 8778807 commit 50e8bfd

6 files changed

Lines changed: 32 additions & 14 deletions

File tree

AGENTS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ After modifying code, ensure to run the following commands to maintain code qual
99
- `npm run all` - Full build for release (ci + build Chrome & Firefox)
1010

1111
Or run individually:
12+
1213
- `npm test` - Run tests (Vitest)
1314
- `npm run lint` - Lint code
1415
- `npm run format` - Format code with Prettier
1516

16-
Refer to [DEVELOPMENT.md](DEVELOPMENT.md) for more details on available scripts and project setup.
17+
Refer to [DEVELOPMENT.md](DEVELOPMENT.md) for more details on available scripts and project setup.

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,36 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
77
## [1.0.4] - 2026-06-10
88

99
### Fixed
10+
1011
- Replace all `innerHTML` assignments with safe DOM API construction (createElement, textContent, replaceChildren, createContextualFragment) to satisfy Firefox AMO linter requirements
1112
- Add `getIconSVGElement()` utility using `createContextualFragment` for safe SVG injection without innerHTML
1213
- Add `data_collection_permissions` to Firefox manifest as required by AMO
1314

1415
## [1.0.3] - 2026-03-10
1516

1617
### Fixed
18+
1719
- Race condition where a 60-second auto-refresh could restore notifications already dismissed via mark-as-read, mark-all-as-read, mark-repo-as-read, or desktop notification click
1820
- In-progress detail fetches now abort if a user action invalidates their snapshot, preventing stale data from being written back to storage
1921
- Badge "+" indicator now only updates when a fetch actually commits to storage
2022

2123
## [1.0.2] - 2026-03-04
2224

2325
### Improved
26+
2427
- Unified stagger animation for all mark-as-read flows
2528
- Eliminated redundant GET_STATE round-trip after mark-repo-as-read
2629

2730
## [1.0.1] - 2026-03-03
2831

2932
### Fixed
33+
3034
- Mark-as-read animation reworked to use overlay approach, fixing dark band artifact in scroll containers
3135
- Reduced right-side jump when adjusting popup width
3236
- CSS variables standardized across device-flow and popup styles
3337

3438
### Improved
39+
3540
- DOM removal now deferred until API confirms success for all mark-as-read flows
3641
- Stagger timeouts properly tracked and cancellable on rollback
3742
- Notification cache cleared on mark-all-as-read to prevent stale data

DEVELOPMENT.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,19 @@
1919

2020
## Scripts
2121

22-
| Command | Description |
23-
| ---------------------- | --------------------------------------------- |
24-
| `npm run ci` | Run all checks (test + lint:fix + format) |
25-
| `npm run dev` | Run CI then prepare Firefox dev environment |
26-
| `npm run all` | Run CI then build Chrome & Firefox packages |
27-
| `npm test` | Run tests (Vitest) |
28-
| `npm run prepare` | Setup Husky git hooks |
29-
| `npm run lint` | Lint code |
30-
| `npm run lint:fix` | Lint and auto-fix |
31-
| `npm run format` | Format code with Prettier |
32-
| `npm run format:check` | Check code formatting |
33-
| `npm run build` | Build Chrome and Firefox packages |
34-
| `npm run dev:firefox` | Create Firefox dev environment |
22+
| Command | Description |
23+
| ---------------------- | ------------------------------------------- |
24+
| `npm run ci` | Run all checks (test + lint:fix + format) |
25+
| `npm run dev` | Run CI then prepare Firefox dev environment |
26+
| `npm run all` | Run CI then build Chrome & Firefox packages |
27+
| `npm test` | Run tests (Vitest) |
28+
| `npm run prepare` | Setup Husky git hooks |
29+
| `npm run lint` | Lint code |
30+
| `npm run lint:fix` | Lint and auto-fix |
31+
| `npm run format` | Format code with Prettier |
32+
| `npm run format:check` | Check code formatting |
33+
| `npm run build` | Build Chrome and Firefox packages |
34+
| `npm run dev:firefox` | Create Firefox dev environment |
3535

3636
## Project Structure
3737

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
- ✨ Clean, minimal UI — feature-rich without the clutter
1919
- 🎨 Light / Dark / System theme with adjustable popup width
2020

21+
<!-- prettier-ignore -->
2122
| | |
2223
|---|---|
2324
| <img src=".github/assets/notifications.png" alt="Notifications" width="400"> | <img src=".github/assets/actions.gif" alt="Actions" width="400"> |

RELEASE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,41 @@
66
- Add version entry: `## [X.Y.Z] - YYYY-MM-DD` with changes
77

88
2. Update version in `package.json`, `manifest.json`, and `manifest-firefox.json`:
9+
910
```sh
1011
# Edit all three files to set "version": "X.Y.Z"
1112
```
13+
1214
Then run `npm install` to sync `package-lock.json`:
15+
1316
```sh
1417
npm install
1518
```
1619

1720
3. Commit changes:
21+
1822
```sh
1923
git add CHANGELOG.md package.json package-lock.json manifest.json manifest-firefox.json
2024
git commit -m "chore: update version to vX.Y.Z"
2125
git push origin main
2226
```
2327

2428
4. Run the release workflow:
29+
2530
```sh
2631
gh workflow run release.yml
2732
```
33+
2834
This will run tests, build Chrome & Firefox packages, and create a GitHub Release with the zip files.
2935

3036
5. Verify the release was created successfully:
37+
3138
```sh
3239
gh release view vX.Y.Z
3340
```
3441

3542
6. Update the release notes on GitHub to match CHANGELOG.md:
43+
3644
```sh
3745
gh release edit vX.Y.Z --notes "## Improved
3846
- Change 1

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@
2323
],
2424
"*.{html,css}": [
2525
"prettier --write"
26+
],
27+
"*.md": [
28+
"prettier --write --prose-wrap preserve"
2629
]
2730
},
2831
"keywords": [

0 commit comments

Comments
 (0)