obby-parser 1.0.0 → 1.0.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Caden McArthur
-
-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.
+MIT License
+
+Copyright (c) 2025 Caden McArthur
+
+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

@@ -1,41 +1,41 @@
-# Obby-Parser
-
-A simple TypeScript library for parsing Obsidian-style markdown. It converts `[[wikilinks]]` to HTML anchor tags and collects all unique links.
-
-## Features
-
-- Converts `[[Page Name]]` to `<a href="route/Page-Name">Page Name</a>`
-- Collects all wikilinks in a Set
-- Supports standard markdown formatting via [markdown-it](https://github.com/markdown-it/markdown-it)
-
-## Installation
-
-```bash
-npm install obsi-parser
-```
-
-## Usage
-
-```typescript
-import { parseMarkdown } from 'obsi-parser';
-
-const markdown = "This references [[My Page]] and also **bold** text.";
-const result = parseMarkdown(markdown, "pages/");
-
-console.log(result.html);      // HTML output with anchor tags
-console.log(result.links_set); // Set { "My Page" }
-```
-
-## API
-
-### `parseMarkdown(markdown: string, route: string): ParseResult`
-
-- `markdown`: The markdown string to parse.
-- `route`: The base path for generated links.
-- Returns:  
-  - `html`: The resulting HTML string.
-  - `links_set`: A Set of all unique wikilinks found.
-
-## License
-
+# Obby-Parser
+
+A simple TypeScript library for parsing Obsidian-style markdown. It converts `[[wikilinks]]` to HTML anchor tags and collects all unique links.
+
+## Features
+
+- Converts `[[Page Name]]` to `<a href="route/Page-Name">Page Name</a>`
+- Collects all wikilinks in a Set
+- Supports standard markdown formatting via [markdown-it](https://github.com/markdown-it/markdown-it)
+
+## Installation
+
+```bash
+npm install obsi-parser
+```
+
+## Usage
+
+```typescript
+import { parseMarkdown } from 'obsi-parser';
+
+const markdown = "This references [[My Page]] and also **bold** text.";
+const result = parseMarkdown(markdown, "pages/");
+
+console.log(result.html);      // HTML output with anchor tags
+console.log(result.links_set); // Set { "My Page" }
+```
+
+## API
+
+### `parseMarkdown(markdown: string, route: string): ParseResult`
+
+- `markdown`: The markdown string to parse.
+- `route`: The base path for generated links.
+- Returns:  
+  - `html`: The resulting HTML string.
+  - `links_set`: A Set of all unique wikilinks found.
+
+## License
+
 MIT

package/dist/index.js

@@ -19,7 +19,7 @@ const md = new markdown_it_1.default({ html: true });
  * For now, this is minimal: trim and replace spaces with dashes.
  */
 function normalizeLinkText(text) {
-    return text.trim().replace(/\s+/g, "-");
+    return text.trim().replace(/\s+/g, "").toLowerCase();
 }
 /**
  * Replace [[link]] occurrences with a placeholder anchor and collect links.
@@ -31,6 +31,7 @@ function transformWikilinks(input, route, links) {
         const href = `/${normalizeLinkText(display)}`;
         links.add(display);
         // Return markdown inline HTML anchor; markdown-it will preserve it
+        //for ease of use, this will return a stripped down version of the url
         return `<a href="${href}" target="_blank" rel="noopener noreferrer">${display}</a>`;
     });
 }

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;;;AAsCH,sCAKC;AAzCD,8DAAqC;AAOrC,MAAM,EAAE,GAAG,IAAI,qBAAU,CAAC,EAAC,IAAI,EAAE,IAAI,EAAC,CAAC,CAAC;AAExC;;;GAGG;AACH,SAAS,iBAAiB,CAAC,IAAY;IACrC,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE1C,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CAAC,KAAa,EAAE,KAAa,EAAE,KAAkB;IAC1E,wDAAwD;IACxD,OAAO,KAAK,CAAC,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAC,EAAE,KAAa,EAAE,EAAE;QAC7D,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAC7B,MAAM,IAAI,GAAG,IAAI,iBAAiB,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9C,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACnB,mEAAmE;QACnE,OAAO,YAAY,IAAI,+CAA+C,OAAO,MAAM,CAAC;IACtF,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAgB,aAAa,CAAC,QAAgB,EAAE,KAAa;IAC3D,MAAM,SAAS,GAAgB,IAAI,GAAG,EAAE,CAAC;IACzC,MAAM,WAAW,GAAG,kBAAkB,CAAC,QAAQ,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;IACnE,MAAM,IAAI,GAAG,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACpC,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;AAC7B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;;;AAuCH,sCAKC;AA1CD,8DAAqC;AAOrC,MAAM,EAAE,GAAG,IAAI,qBAAU,CAAC,EAAC,IAAI,EAAE,IAAI,EAAC,CAAC,CAAC;AAExC;;;GAGG;AACH,SAAS,iBAAiB,CAAC,IAAY;IACrC,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;AAEvD,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CAAC,KAAa,EAAE,KAAa,EAAE,KAAkB;IAC1E,wDAAwD;IACxD,OAAO,KAAK,CAAC,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAC,EAAE,KAAa,EAAE,EAAE;QAC7D,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAC7B,MAAM,IAAI,GAAG,IAAI,iBAAiB,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9C,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACnB,mEAAmE;QACnE,sEAAsE;QACtE,OAAO,YAAY,IAAI,+CAA+C,OAAO,MAAM,CAAC;IACtF,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAgB,aAAa,CAAC,QAAgB,EAAE,KAAa;IAC3D,MAAM,SAAS,GAAgB,IAAI,GAAG,EAAE,CAAC;IACzC,MAAM,WAAW,GAAG,kBAAkB,CAAC,QAAQ,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;IACnE,MAAM,IAAI,GAAG,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACpC,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;AAC7B,CAAC"}

package/package.json

@@ -1,38 +1,38 @@
-{
-  "name": "obby-parser",
-  "version": "1.0.0",
-  "description": "Parse Obsidian-style markdown files including ([[links]]) into HTML and extract links",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "clean": "rimraf dist",
-    "build": "tsc -p tsconfig.build.json",
-    "dev": "ts-node src/example.ts",
-    "test": "vitest",
-    "lint": "eslint \"src/**/*.ts\"",
-    "prepare": "npm run build"
-  },
-  "keywords": [
-    "obsidian",
-    "markdown",
-    "parser",
-    "npx",
-    "typescript"
-  ],
-  "author": "cmac2112",
-  "license": "MIT",
-  "dependencies": {
-    "markdown-it": "^13.0.2"
-  },
-  "devDependencies": {
-    "@types/markdown-it": "^14.1.2",
-    "@types/node": "^20.0.0",
-    "@typescript-eslint/eslint-plugin": "^5.0.0",
-    "@typescript-eslint/parser": "^5.0.0",
-    "eslint": "^8.0.0",
-    "rimraf": "^5.0.0",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.0.0",
-    "vitest": "^1.4.0"
-  }
-}
+{
+  "name": "obby-parser",
+  "version": "1.0.1",
+  "description": "Parse Obsidian-style markdown files including ([[links]]) into HTML and extract links",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "tsc -p tsconfig.build.json",
+    "dev": "ts-node src/example.ts",
+    "test": "vitest",
+    "lint": "eslint \"src/**/*.ts\"",
+    "prepare": "npm run build"
+  },
+  "keywords": [
+    "obsidian",
+    "markdown",
+    "parser",
+    "npx",
+    "typescript"
+  ],
+  "author": "cmac2112",
+  "license": "MIT",
+  "dependencies": {
+    "markdown-it": "^13.0.2"
+  },
+  "devDependencies": {
+    "@types/markdown-it": "^14.1.2",
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/parser": "^5.0.0",
+    "eslint": "^8.0.0",
+    "rimraf": "^5.0.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.0",
+    "vitest": "^1.4.0"
+  }
+}

package/src/example.ts

@@ -1,15 +1,15 @@
-import fs from "fs";
-import path from "path";
-import { parseMarkdown } from "./index";
-
-const input = process.argv[2] || path.join(process.cwd(), "example.md");
-if (!fs.existsSync(input)) {
-  console.error("No input file found:", input);
-  process.exit(1);
-}
-const content = fs.readFileSync(input, "utf8");
-const result = parseMarkdown(content, "www.personalwebsite.com/test/");
-console.log("HTML output:\n", result.html);
-console.log("\nLinks found:", result.links_set);
-
-console.log("json parsed", JSON.stringify(result.html))
+import fs from "fs";
+import path from "path";
+import { parseMarkdown } from "./index";
+
+const input = process.argv[2] || path.join(process.cwd(), "example.md");
+if (!fs.existsSync(input)) {
+  console.error("No input file found:", input);
+  process.exit(1);
+}
+const content = fs.readFileSync(input, "utf8");
+const result = parseMarkdown(content, "www.personalwebsite.com/test/");
+console.log("HTML output:\n", result.html);
+console.log("\nLinks found:", result.links_set);
+
+console.log("json parsed", JSON.stringify(result.html))

package/src/index.ts

@@ -1,51 +1,52 @@
-/**
- * parseMarkdown
- * - Accepts an Obsidian-style markdown string.
- * - Finds all [[wikilinks]] and collects them into links[].
- * - Replaces [[Name]] with an <a href="Name.html">Name</a> (simple default transform).
- * - Returns the HTML (via markdown-it) and the array of links found.
- * - This is a one way operation meant to just translate markdown files for the web
- */
-
-import MarkdownIt from "markdown-it";
-
-export type ParseResult = {
-  html: string;
-  links_set: Set<string>;
-};
-
-const md = new MarkdownIt({html: true});
-
-/**
- * Normalize link text to a safe file name or slug.
- * For now, this is minimal: trim and replace spaces with dashes.
- */
-function normalizeLinkText(text: string): string {
-  return text.trim().replace(/\s+/g, "-");
-  
-}
-
-/**
- * Replace [[link]] occurrences with a placeholder anchor and collect links.
- */
-function transformWikilinks(input: string, route: string, links: Set<string>): string {
-  // Use a replacer so we can capture multiple occurrences
-  return input.replace(/\[\[([^\]]+)\]\]/g, (_, inner: string) => {
-    const display = inner.trim();
-    const href = `/${normalizeLinkText(display)}`;
-    links.add(display);
-    // Return markdown inline HTML anchor; markdown-it will preserve it
-    return `<a href="${href}" target="_blank" rel="noopener noreferrer">${display}</a>`;
-  });
-}
-
-/**
- * Main exported function.
- * route should be setup in a way for you to handle params easily
- */
-export function parseMarkdown(markdown: string, route: string): ParseResult {
-  const links_set: Set<string> = new Set();
-  const withAnchors = transformWikilinks(markdown, route, links_set);
-  const html = md.render(withAnchors);
-  return { html, links_set };
+/**
+ * parseMarkdown
+ * - Accepts an Obsidian-style markdown string.
+ * - Finds all [[wikilinks]] and collects them into links[].
+ * - Replaces [[Name]] with an <a href="Name.html">Name</a> (simple default transform).
+ * - Returns the HTML (via markdown-it) and the array of links found.
+ * - This is a one way operation meant to just translate markdown files for the web
+ */
+
+import MarkdownIt from "markdown-it";
+
+export type ParseResult = {
+  html: string;
+  links_set: Set<string>;
+};
+
+const md = new MarkdownIt({html: true});
+
+/**
+ * Normalize link text to a safe file name or slug.
+ * For now, this is minimal: trim and replace spaces with dashes.
+ */
+function normalizeLinkText(text: string): string {
+  return text.trim().replace(/\s+/g, "").toLowerCase();
+  
+}
+
+/**
+ * Replace [[link]] occurrences with a placeholder anchor and collect links.
+ */
+function transformWikilinks(input: string, route: string, links: Set<string>): string {
+  // Use a replacer so we can capture multiple occurrences
+  return input.replace(/\[\[([^\]]+)\]\]/g, (_, inner: string) => {
+    const display = inner.trim();
+    const href = `/${normalizeLinkText(display)}`;
+    links.add(display);
+    // Return markdown inline HTML anchor; markdown-it will preserve it
+    //for ease of use, this will return a stripped down version of the url
+    return `<a href="${href}" target="_blank" rel="noopener noreferrer">${display}</a>`;
+  });
+}
+
+/**
+ * Main exported function.
+ * route should be setup in a way for you to handle params easily
+ */
+export function parseMarkdown(markdown: string, route: string): ParseResult {
+  const links_set: Set<string> = new Set();
+  const withAnchors = transformWikilinks(markdown, route, links_set);
+  const html = md.render(withAnchors);
+  return { html, links_set };
 }

package/test/parser.spec.ts

@@ -1,25 +1,25 @@
-import { describe, it, expect } from "vitest";
-import { parseMarkdown } from "../src/index";
-
-let pageTest: Set<string> = new Set<string>();
-let linkTest: Set<string> = new Set<string>();
-describe("parseMarkdown", () => {
-  it("converts [[wikilink]] to an anchor and collects link", () => {
-    const input = "This references [[My Page]] and also inline **bold** text.";
-    const { html, links_set } = parseMarkdown(input, "test/");
-    pageTest.add("My Page")
-
-    expect(links_set).toEqual(pageTest);
-    expect(html).toContain('&lt;a href=&quot; test/My-Page&quot; target=&quot;_blank&quot; rel=&quot;noopener noreferrer&quot;&gt;My Page&lt;/a&gt;');
-    expect(html).toContain("<strong>bold</strong>");
-  });
-
-  it("handles multiple wikilinks", () => {
-    const input = "[[One]] and [[Two]] and again [[One]]";
-    const { links_set } = parseMarkdown(input, "test/");
-    linkTest.add("One")
-    linkTest.add("Two")
-    expect(links_set).toEqual(linkTest);
-  });
-});
+import { describe, it, expect } from "vitest";
+import { parseMarkdown } from "../src/index";
+
+let pageTest: Set<string> = new Set<string>();
+let linkTest: Set<string> = new Set<string>();
+describe("parseMarkdown", () => {
+  it("converts [[wikilink]] to an anchor and collects link", () => {
+    const input = "This references [[My Page]] and also inline **bold** text.";
+    const { html, links_set } = parseMarkdown(input, "test/");
+    pageTest.add("My Page")
+
+    expect(links_set).toEqual(pageTest);
+    expect(html).toContain('<p>This references <a href="/mypage" target="_blank" rel="noopener noreferrer">My Page</a> and also inline <strong>bold</strong> text.</p>');
+    expect(html).toContain("<strong>bold</strong>");
+  });
+
+  it("handles multiple wikilinks", () => {
+    const input = "[[One]] and [[Two]] and again [[One]]";
+    const { links_set } = parseMarkdown(input, "test/");
+    linkTest.add("One")
+    linkTest.add("Two")
+    expect(links_set).toEqual(linkTest);
+  });
+});
 // more robust tests are needed

package/tsconfig.build.json

@@ -1,9 +1,9 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "declaration": true,
-    "outDir": "dist",
-    "composite": false
-  },
-  "include": ["src/**/*"]
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "dist",
+    "composite": false
+  },
+  "include": ["src/**/*"]
 }

package/tsconfig.json

@@ -1,18 +1,18 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "CommonJS",
-    "outDir": "./dist",
-    "rootDir": "./src",
-    "moduleResolution": "Node",
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "strict": true,
-    "forceConsistentCasingInFileNames": true,
-    "sourceMap": true,
-    "baseUrl": ".",
-    "resolveJsonModule": true
-  },
-  "include": ["src/index.ts"],
-  "exclude": ["node_modules", "dist","test"]
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "CommonJS",
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "moduleResolution": "Node",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "sourceMap": true,
+    "baseUrl": ".",
+    "resolveJsonModule": true
+  },
+  "include": ["src/index.ts"],
+  "exclude": ["node_modules", "dist","test"]
 }