@utilfirst/prettier-plugin 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ayan Yenbekbay
+
+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,38 @@
+# @utilfirst/prettier-plugin
+
+Shared Prettier plugin for utilfirst projects. Targets markdown, Prettier 3.
+
+## What it does
+
+- Keeps bare URLs with trailing or intra-word underscores literal (e.g. `https://instagram.com/highnote_____` doesn't get rewritten as `**\_**`).
+- Suppresses the blank line Prettier inserts between a paragraph and an immediately following list (lets you write `Intro:\n- item\n` and have it stay flush).
+
+## Install
+
+```sh
+pnpm add -D @utilfirst/prettier-plugin
+```
+
+## Use
+
+```js
+// prettier.config.mjs
+/** @type {import("prettier").Config} */
+export default {
+  plugins: ["@utilfirst/prettier-plugin"],
+};
+```
+
+## Develop
+
+```sh
+pnpm install
+pnpm run setup-hooks # one-time: wire pre-commit via simple-git-hooks
+pnpm test            # vitest with inline snapshots
+pnpm run build       # tsdown → dist/
+pnpm run lint        # eslint + prettier + publint + tsc
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import { Root } from "mdast";
+import { Plugin } from "prettier";
+
+//#region src/index.d.ts
+declare const plugin: Plugin<Root>;
+//#endregion
+export { plugin as default };

package/dist/index.js

@@ -0,0 +1,48 @@
+import * as md from "prettier/plugins/markdown";
+
+//#region src/index.ts
+const SCAN_RE = /(```[\s\S]*?```|~~~[\s\S]*?~~~|`[^`\n]*`|\[[^\]\n]*\]\([^)\n]*\)|<[^>\n]+>)|https?:\/\/[^\s<>)]+/g;
+function wrapBareUrls(src) {
+	return src.replace(SCAN_RE, (match, keep) => keep ? match : `<${match}>`);
+}
+function collapseAutolinks(node) {
+	if (node?.type === "link" && node.children?.length === 1 && node.url === node.children[0]?.value) {
+		node.type = "html";
+		node.value = node.url;
+		delete node.children;
+		delete node.url;
+		delete node.title;
+	}
+	node?.children?.forEach(collapseAutolinks);
+}
+function suppressIntroListGap(rootDoc, children) {
+	if (!Array.isArray(rootDoc)) return;
+	const inner = rootDoc[0];
+	if (!Array.isArray(inner)) return;
+	for (let i = 0; i < children.length - 1; i++) if (children[i]?.type === "paragraph" && children[i + 1]?.type === "list") inner[3 * i + 2] = "";
+}
+const plugin = {
+	parsers: { markdown: {
+		...md.parsers.markdown,
+		async parse(text, options) {
+			const wrapped = wrapBareUrls(text);
+			options.originalText = wrapped;
+			const ast = await md.parsers.markdown.parse(wrapped, options);
+			collapseAutolinks(ast);
+			return ast;
+		}
+	} },
+	printers: { mdast: {
+		...md.printers.mdast,
+		print(path, options, print) {
+			const doc = md.printers.mdast.print(path, options, print);
+			const node = path.node;
+			if (node.type === "root") suppressIntroListGap(doc, node.children ?? []);
+			return doc;
+		}
+	} }
+};
+var src_default = plugin;
+
+//#endregion
+export { src_default as default };

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@utilfirst/prettier-plugin",
+  "version": "0.1.0",
+  "description": "Shared Prettier plugin for utilfirst projects",
+  "keywords": [
+    "prettier",
+    "prettier-plugin",
+    "markdown"
+  ],
+  "homepage": "https://github.com/utilfirst/utilfirst-prettier-plugin#readme",
+  "bugs": "https://github.com/utilfirst/utilfirst-prettier-plugin/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/utilfirst/utilfirst-prettier-plugin.git"
+  },
+  "license": "MIT",
+  "author": "Ayan Yenbekbay <ayan.yenb@gmail.com>",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsdown",
+    "fix": "pnpm run --sequential '/^fix:[^:]+$/'",
+    "fix:eslint": "pnpm run lint:eslint --fix",
+    "fix:prettier": "pnpm run lint:prettier --write",
+    "lint": "pnpm run --sequential '/^lint:[^:]+$/'",
+    "lint:eslint": "eslint .",
+    "lint:prettier": "prettier --check .",
+    "lint:publint": "publint",
+    "lint:typecheck": "tsc --pretty --noEmit",
+    "prepack": "pnpm run build",
+    "setup-hooks": "simple-git-hooks",
+    "test": "vitest run"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "pnpm exec lint-staged && pnpm run lint:typecheck"
+  },
+  "lint-staged": {
+    "*": "prettier --ignore-unknown --write",
+    "*.{js,cjs,mjs,ts,tsx}": "eslint --fix"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@types/mdast": "^4.0.4",
+    "@types/node": "^25.9.1",
+    "@vitest/coverage-v8": "^4.1.7",
+    "eslint": "^10.3.0",
+    "lint-staged": "^17.0.4",
+    "prettier": "^3.8.3",
+    "prettier-plugin-organize-imports": "^4.3.0",
+    "prettier-plugin-packagejson": "^3.0.2",
+    "prettier-plugin-sh": "^0.18.1",
+    "prettier-plugin-sort-json": "^4.2.0",
+    "publint": "^0.3.16",
+    "simple-git-hooks": "^2.13.1",
+    "tsdown": "^0.18.4",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.59.3",
+    "vitest": "^4.0.7"
+  },
+  "peerDependencies": {
+    "prettier": "^3.0.0"
+  },
+  "packageManager": "pnpm@11.0.9",
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
+}