Pr improvements

.github/workflows/publish.yml

@@ -10,21 +10,30 @@ jobs:
     environment:
       name: production
       url: https://www.npmjs.com/package/@benjc/rehype-scroll-to-top
+
+    permissions:
+      id-token: write
+
     steps:
       - uses: actions/checkout@v4
+
       - uses: actions/setup-node@v4
         with:
           node-version: "20.x"
           registry-url: "https://registry.npmjs.org"
-          scope: '@benjc'
+          scope: "@benjc"
+
       - uses: pnpm/action-setup@v2
         with:
           version: 8
+
       - name: Run install
         run: pnpm i
+
       - name: Run build
         run: pnpm run build
+
       - name: Run publish
-        run: npm publish --access=public
+        run: npm publish --provenance --access=public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -12,23 +12,37 @@ jobs:
     strategy:
       matrix:
         node-version: [18.x, 20.x]
+
     steps:
       - uses: actions/checkout@v4
+
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
+
       - uses: pnpm/action-setup@v2
         with:
           version: 8
+
       - name: Run install
         run: pnpm i
+
+      - name: Run lint
+        run: pnpm lint
+
       - name: Run unit tests
         run: pnpm test
+
+      - name: Run type coverage tests
+        run: pnpm type-coverage
+
       - name: Run build
         run: pnpm run build
+
       - name: Generate coverage file
         run: pnpm run coverage
+
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v4
         env:

.prettierrc.json

@@ -0,0 +1,13 @@
+{
+  "bracketSpacing": true,
+  "importOrder": ["^@core/(.*)$", "^@server/(.*)$", "^@ui/(.*)$", "^~/(.*)$", "^[./]"],
+  "importOrderSeparation": true,
+  "importOrderSortSpecifiers": true,
+  "plugins": ["@trivago/prettier-plugin-sort-imports"],
+  "printWidth": 120,
+  "quoteProps": "consistent",
+  "semi": true,
+  "singleQuote": false,
+  "trailingComma": "es5",
+  "useTabs": false
+}

.xo-config.json

@@ -0,0 +1,6 @@
+{
+  "space": true,
+  "rules": {
+    "import/order": "off"
+  }
+}

README.md

@@ -16,27 +16,24 @@ npm i -D @benjc/rehype-scroll-to-top
 ## Usage
 
 ```typescript
-import rehype from "rehype";
-import rehypeParse from 'rehype-parse';
 import rehypeScrollToTop from "@benjc/rehype-scroll-to-top";
-import { unified } from 'unified';
+import rehype from "rehype";
+import rehypeParse from "rehype-parse";
+import { unified } from "unified";
 
-unified()
-  .use(rehypeParse, {fragment: true})
-  .use(rehypeScrollToTop)
-  .process('<h1>Title</h1><p>Content</p>')
+unified().use(rehypeParse, { fragment: true }).use(rehypeScrollToTop).process("<h1>Title</h1><p>Content</p>");
 
 // Or with options:
 unified()
-  .use(rehypeParse, {fragment: true})
+  .use(rehypeParse, { fragment: true })
   .use(rehypeScrollToTop, {
     topLink: { disabled: true },
     bottomLink: {
       text: `Back to top ↑`,
-      classes: 'animated-link-underline',
+      classes: "animated-link-underline",
     },
   })
-  .process('<h1>Title</h1><p>Content</p>')
+  .process("<h1>Title</h1><p>Content</p>");
 ```
 
 ### Input

package.json

@@ -1,18 +1,23 @@
 {
   "name": "@benjc/rehype-scroll-to-top",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "A Rehype plugin that adds a 'scroll to top' & 'scroll to bottom' links to the page.",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "tsc",
     "test": "vitest",
     "coverage": "vitest run --coverage",
+    "coverage:types": "type-coverage --min=100",
     "typecheck": "tsc --noEmit",
+    "lint": "xo --prettier",
+    "lint:fix": "xo --fix --prettier",
     "format": "prettier --write ."
   },
   "repository": {
@@ -30,6 +35,7 @@
   },
   "homepage": "https://github.com/benjamincharity/rehype-scroll-to-top#readme",
   "devDependencies": {
+    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
     "@types/hast": "^3.0.4",
     "@types/node": "^20.11.16",
     "@vitest/coverage-v8": "^1.2.2",
@@ -39,9 +45,12 @@
     "rehype-minify-whitespace": "^6.0.0",
     "rimraf": "^5.0.5",
     "to-vfile": "^8.0.0",
+    "type-coverage": "^2.27.1",
+    "typecov": "~0.2.3",
     "typescript": "^5.3.3",
     "vite": "^5.0.12",
-    "vitest": "^1.2.2"
+    "vitest": "^1.2.2",
+    "xo": "~0.56.0"
   },
   "peerDependencies": {
     "rehype": "^13.0.0",