From 1272e2ec742e0b357c4e5858e5324b4b428aebe3 Mon Sep 17 00:00:00 2001 From: Aaron Date: Tue, 10 Jun 2025 16:14:58 -0500 Subject: [PATCH] chore: Fix markdown lint errors and add upgrade `@aklinker1/check` to include markdownlint --- .github/workflows/validate.yml | 3 --- docs/guide/resources/upgrading.md | 3 +++ package.json | 3 +-- pnpm-lock.yaml | 14 ++++++++++++-- 4 files changed, 16 insertions(+), 7 deletions(-) diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml index 02e88476..48eb0aa9 100644 --- a/.github/workflows/validate.yml +++ b/.github/workflows/validate.yml @@ -23,9 +23,6 @@ jobs: - name: Basic Checks run: pnpm check - - name: Markdownlint - run: pnpm check:md - builds: name: Builds runs-on: ubuntu-22.04 diff --git a/docs/guide/resources/upgrading.md b/docs/guide/resources/upgrading.md index f32a8fca..6c4f10ea 100644 --- a/docs/guide/resources/upgrading.md +++ b/docs/guide/resources/upgrading.md @@ -54,8 +54,10 @@ See To upgrade, you have two options: 1. **Stop using the polyfill** + - If you're already using `extensionApi: "chrome"`, then you're not using the polyfill and there is nothing to change! - Otherwise there is only one change: `browser.runtime.onMessage` no longer supports using promises to return a response: + ```ts browser.runtime.onMessage.addListener(async () => { // [!code --] const res = await someAsyncWork(); // [!code --] @@ -67,6 +69,7 @@ To upgrade, you have two options: return true; // [!code ++] }); ``` + 2. **Continue using the polyfill** - If you want to keep using the polyfill, you can! One less thing to worry about during this upgrade. - Install `webextension-polyfill` and WXT's [new polyfill module](https://www.npmjs.com/package/@wxt-dev/webextension-polyfill): diff --git a/package.json b/package.json index 3cc58e40..665ef856 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,6 @@ "packageManager": "pnpm@10.10.0", "scripts": { "check": "check && pnpm -r --sequential run check", - "check:md": "markdownlint .", "test": "pnpm -r --sequential run test run", "test:coverage": "pnpm -r --sequential run test:coverage", "prepare": "simple-git-hooks", @@ -19,7 +18,7 @@ }, "devDependencies": { "@aklinker1/buildc": "^1.1.4", - "@aklinker1/check": "2.0.0", + "@aklinker1/check": "^2.1.0", "@commitlint/config-conventional": "^19.8.0", "@commitlint/types": "^19.8.0", "@types/fs-extra": "^11.0.4", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index c20f79a4..7551d361 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -17,8 +17,8 @@ importers: specifier: ^1.1.4 version: 1.1.4 '@aklinker1/check': - specifier: 2.0.0 - version: 2.0.0 + specifier: ^2.1.0 + version: 2.1.0 '@commitlint/config-conventional': specifier: ^19.8.0 version: 19.8.0 @@ -693,6 +693,10 @@ packages: resolution: {integrity: sha512-itoIc3WlLCtoVEwTIi/f6E4UKXJQJhYyMzbBqbQ73uvIsChgXKfmZHjaUwz4PyBtmkvlO4yhkh1JSQUzy2x5jA==} hasBin: true + '@aklinker1/check@2.1.0': + resolution: {integrity: sha512-x+0vxb0vHV+6ZskcLYobI6FCAFG1jwVGgKuH9pTfHLW3vlzbGSGUKcxbCuMI3Q51WZS8oE4UfB+4v5M2+0uz1g==} + hasBin: true + '@aklinker1/rollup-plugin-visualizer@5.12.0': resolution: {integrity: sha512-X24LvEGw6UFmy0lpGJDmXsMyBD58XmX1bbwsaMLhNoM+UMQfQ3b2RtC+nz4b/NoRK5r6QJSKJHBNVeUdwqybaQ==} engines: {node: '>=14'} @@ -5245,6 +5249,12 @@ snapshots: ci-info: 4.2.0 citty: 0.1.6 + '@aklinker1/check@2.1.0': + dependencies: + '@antfu/utils': 0.7.10 + ci-info: 4.2.0 + citty: 0.1.6 + '@aklinker1/rollup-plugin-visualizer@5.12.0(rollup@4.34.9)': dependencies: open: 8.4.2