@xsynaptic/satteri-trailing-slash 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Alexander Synaptic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,44 @@
+# @xsynaptic/satteri-trailing-slash
+
+A [Sätteri][] hast plugin that normalizes trailing slashes on internal markdown links to match your
+Astro project's [`trailingSlash`][astro-trailing-slash] setting. Hand-authored links like
+`[text](/path)` emit whatever slash the author typed; when that disagrees with the site's canonical
+form, each link costs a redirect hop. This rewrites them at compile time.
+
+Only internal root-relative `<a href>` links are touched, and any `?query`/`#hash` suffix is
+preserved. External, protocol-relative (`//`), hash-only, `mailto:`/`tel:`, and file-extension links
+are left alone, as are MDX components like `<Link>` (they aren't `<a>` nodes at hast time).
+
+## Install
+
+```sh
+npm install @xsynaptic/satteri-trailing-slash
+```
+
+This package is ESM-only.
+
+## Use
+
+Pass the same value your `astro.config` uses for `trailingSlash`. The one option, `trailingSlash`,
+takes `'always'` (append a slash), `'never'` (strip it), or `'ignore'` (the default: a no-op, matching
+Astro's own default).
+
+```ts
+import { satteri } from '@astrojs/markdown-satteri';
+import { trailingSlash } from '@xsynaptic/satteri-trailing-slash';
+
+export default defineConfig({
+	trailingSlash: 'always',
+	markdown: {
+		processor: satteri({ hastPlugins: [trailingSlash({ trailingSlash: 'always' })] }),
+	},
+});
+```
+
+## License
+
+[MIT][mit-license]
+
+[Sätteri]: https://github.com/bruits/satteri
+[astro-trailing-slash]: https://docs.astro.build/en/reference/configuration-reference/#trailingslash
+[mit-license]: https://opensource.org/licenses/MIT

package/dist/index.d.mts

@@ -0,0 +1,22 @@
+import { z } from "zod";
+
+//#region src/index.d.ts
+declare const optionsSchema: z.ZodObject<{
+  trailingSlash: z.ZodDefault<z.ZodEnum<{
+    always: "always";
+    never: "never";
+    ignore: "ignore";
+  }>>;
+}, z.core.$strip>;
+type TrailingSlashOptions = z.input<typeof optionsSchema>;
+declare function trailingSlash(options?: null | Readonly<TrailingSlashOptions>): {
+  element: {
+    filter: string[];
+    visit(node: Readonly<import("hast").Element>, ctx: import("satteri").HastVisitorContext): void;
+  };
+  name: string;
+};
+declare function normalizeHref(href: string, mode: 'always' | 'never'): string | undefined;
+//#endregion
+export { type TrailingSlashOptions, normalizeHref, trailingSlash };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -0,0 +1,43 @@
+import { defineHastPlugin } from "satteri";
+import { z } from "zod";
+//#region src/index.ts
+const optionsSchema = z.object({ trailingSlash: z.enum([
+	"always",
+	"never",
+	"ignore"
+]).default("ignore") });
+function trailingSlash(options) {
+	const settings = optionsSchema.parse(options ?? {});
+	return defineHastPlugin({
+		element: {
+			filter: ["a"],
+			visit(node, ctx) {
+				if (settings.trailingSlash === "ignore") return;
+				const href = node.properties.href;
+				if (typeof href !== "string") return;
+				const next = normalizeHref(href, settings.trailingSlash);
+				if (next !== void 0) ctx.setProperty(node, "href", next);
+			}
+		},
+		name: "trailing-slash"
+	});
+}
+function normalizeHref(href, mode) {
+	if (!href.startsWith("/") || href.startsWith("//")) return void 0;
+	const suffixMarkers = [href.indexOf("?"), href.indexOf("#")].filter((index) => index !== -1);
+	const cut = suffixMarkers.length === 0 ? -1 : Math.min(...suffixMarkers);
+	const path = cut === -1 ? href : href.slice(0, cut);
+	if (path === "/") return void 0;
+	const suffix = cut === -1 ? "" : href.slice(cut);
+	if (mode === "always") {
+		const lastSegment = path.slice(path.lastIndexOf("/") + 1);
+		if (path.endsWith("/") || lastSegment.includes(".")) return void 0;
+		return `${path}/${suffix}`;
+	}
+	if (!path.endsWith("/")) return void 0;
+	return `${path.slice(0, -1)}${suffix}`;
+}
+//#endregion
+export { normalizeHref, trailingSlash };
+
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { defineHastPlugin } from 'satteri';\nimport { z } from 'zod';\n\nconst optionsSchema = z.object({\n\ttrailingSlash: z.enum(['always', 'never', 'ignore']).default('ignore'),\n});\n\ntype TrailingSlashOptions = z.input<typeof optionsSchema>;\n\nexport function trailingSlash(options?: null | Readonly<TrailingSlashOptions>) {\n\tconst settings = optionsSchema.parse(options ?? {});\n\n\treturn defineHastPlugin({\n\t\telement: {\n\t\t\tfilter: ['a'],\n\t\t\tvisit(node, ctx) {\n\t\t\t\tif (settings.trailingSlash === 'ignore') return;\n\n\t\t\t\tconst href = node.properties.href;\n\t\t\t\tif (typeof href !== 'string') return;\n\n\t\t\t\tconst next = normalizeHref(href, settings.trailingSlash);\n\t\t\t\tif (next !== undefined) ctx.setProperty(node, 'href', next);\n\t\t\t},\n\t\t},\n\t\tname: 'trailing-slash',\n\t});\n}\n\n// Returns undefined when nothing should change, so the visitor skips the write\nfunction normalizeHref(href: string, mode: 'always' | 'never'): string | undefined {\n\tif (!href.startsWith('/') || href.startsWith('//')) return undefined; // internal root-relative only\n\n\tconst suffixMarkers = [href.indexOf('?'), href.indexOf('#')].filter((index) => index !== -1);\n\tconst cut = suffixMarkers.length === 0 ? -1 : Math.min(...suffixMarkers);\n\tconst path = cut === -1 ? href : href.slice(0, cut);\n\n\tif (path === '/') return undefined; // root is canonical in both modes\n\n\tconst suffix = cut === -1 ? '' : href.slice(cut);\n\n\tif (mode === 'always') {\n\t\tconst lastSegment = path.slice(path.lastIndexOf('/') + 1);\n\t\tif (path.endsWith('/') || lastSegment.includes('.')) return undefined; // already slashed, or a file\n\t\treturn `${path}/${suffix}`;\n\t}\n\n\tif (!path.endsWith('/')) return undefined; // 'never': nothing to strip\n\treturn `${path.slice(0, -1)}${suffix}`;\n}\n\nexport { normalizeHref };\nexport type { TrailingSlashOptions };\n"],"mappings":";;;AAGA,MAAM,gBAAgB,EAAE,OAAO,EAC9B,eAAe,EAAE,KAAK;CAAC;CAAU;CAAS;AAAQ,CAAC,CAAC,CAAC,QAAQ,QAAQ,EACtE,CAAC;AAID,SAAgB,cAAc,SAAiD;CAC9E,MAAM,WAAW,cAAc,MAAM,WAAW,CAAC,CAAC;CAElD,OAAO,iBAAiB;EACvB,SAAS;GACR,QAAQ,CAAC,GAAG;GACZ,MAAM,MAAM,KAAK;IAChB,IAAI,SAAS,kBAAkB,UAAU;IAEzC,MAAM,OAAO,KAAK,WAAW;IAC7B,IAAI,OAAO,SAAS,UAAU;IAE9B,MAAM,OAAO,cAAc,MAAM,SAAS,aAAa;IACvD,IAAI,SAAS,KAAA,GAAW,IAAI,YAAY,MAAM,QAAQ,IAAI;GAC3D;EACD;EACA,MAAM;CACP,CAAC;AACF;AAGA,SAAS,cAAc,MAAc,MAA8C;CAClF,IAAI,CAAC,KAAK,WAAW,GAAG,KAAK,KAAK,WAAW,IAAI,GAAG,OAAO,KAAA;CAE3D,MAAM,gBAAgB,CAAC,KAAK,QAAQ,GAAG,GAAG,KAAK,QAAQ,GAAG,CAAC,CAAC,CAAC,QAAQ,UAAU,UAAU,EAAE;CAC3F,MAAM,MAAM,cAAc,WAAW,IAAI,KAAK,KAAK,IAAI,GAAG,aAAa;CACvE,MAAM,OAAO,QAAQ,KAAK,OAAO,KAAK,MAAM,GAAG,GAAG;CAElD,IAAI,SAAS,KAAK,OAAO,KAAA;CAEzB,MAAM,SAAS,QAAQ,KAAK,KAAK,KAAK,MAAM,GAAG;CAE/C,IAAI,SAAS,UAAU;EACtB,MAAM,cAAc,KAAK,MAAM,KAAK,YAAY,GAAG,IAAI,CAAC;EACxD,IAAI,KAAK,SAAS,GAAG,KAAK,YAAY,SAAS,GAAG,GAAG,OAAO,KAAA;EAC5D,OAAO,GAAG,KAAK,GAAG;CACnB;CAEA,IAAI,CAAC,KAAK,SAAS,GAAG,GAAG,OAAO,KAAA;CAChC,OAAO,GAAG,KAAK,MAAM,GAAG,EAAE,IAAI;AAC/B"}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@xsynaptic/satteri-trailing-slash",
+  "version": "0.1.0",
+  "description": "Sätteri hast plugin that normalizes trailing slashes on internal markdown links to match an Astro project's trailingSlash setting.",
+  "type": "module",
+  "license": "MIT",
+  "author": "Alexander Synaptic <x@synapticism.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/xsynaptic/astro-lab.git",
+    "directory": "packages/satteri-trailing-slash"
+  },
+  "homepage": "https://github.com/xsynaptic/astro-lab/tree/main/packages/satteri-trailing-slash#readme",
+  "bugs": {
+    "url": "https://github.com/xsynaptic/astro-lab/issues"
+  },
+  "keywords": [
+    "satteri",
+    "satteri-plugin",
+    "hast",
+    "trailing-slash",
+    "astro",
+    "seo"
+  ],
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "@types/hast": "^3.0.4",
+    "zod": "^4.4.3"
+  },
+  "peerDependencies": {
+    "satteri": "^0.9.0"
+  },
+  "devDependencies": {
+    "satteri": "^0.9.5"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "check-types": "tsc --noEmit"
+  }
+}