orga-build 0.5.2 → 0.5.3

package/lib/__tests__/build.test.js

@@ -12,6 +12,7 @@ const outDir = path.join(__dirname, '.test-output')
 describe('orga-build', () => {
 	before(async () => {
 		await fs.mkdir(fixtureDir, { recursive: true })
+		await fs.mkdir(path.join(fixtureDir, 'docs'), { recursive: true })
 		// Create minimal fixture
 		await fs.writeFile(
 			path.join(fixtureDir, 'index.org'),
@@ -20,8 +21,14 @@ describe('orga-build', () => {
 * Hello World
 
 This is a test page.
+
+Here's [[file:./docs/index.org][index page]].
+
+Here's [[file:more.org][another page]].
 `
 		)
+		await fs.writeFile(path.join(fixtureDir, 'docs', 'index.org'), 'Docs index page.')
+		await fs.writeFile(path.join(fixtureDir, 'more.org'), 'Another page.')
 	})
 
 	after(async () => {
@@ -51,6 +58,8 @@ This is a test page.
 		const html = await fs.readFile(indexPath, 'utf-8')
 		assert.ok(html.includes('<title>Test Page</title>'), 'should have title')
 		assert.ok(html.includes('Hello World'), 'should have heading content')
+		assert.ok(html.includes('href="/docs"'), 'should rewrite docs/index.org to /docs')
+		assert.ok(html.includes('href="/more"'), 'should rewrite more.org to /more')
 	})
 
 	test('generates assets directory', async () => {

package/lib/files.d.ts

@@ -7,11 +7,16 @@ export function setup(dir: string, { outDir }?: {
     outDir?: string | undefined;
 }): {
     pages: () => Promise<Record<string, Page>>;
-    page: (id: string) => Promise<Page>;
+    page: (slug: string) => Promise<Page>;
     components: () => Promise<string | null>;
     layouts: () => Promise<Record<string, string>>;
     contentEntries: () => Promise<ContentEntry[]>;
 };
+/**
+ * Convert a content file path (relative to content root) to the canonical page slug.
+ * @param {string} contentFilePath
+ */
+export function getSlugFromContentFilePath(contentFilePath: string): string;
 export type Page = {
     dataPath: string;
     /**

package/lib/files.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["files.js"],"names":[],"mappings":"AA8EA;;;;GAIG;AACH,2BAJW,MAAM,eAEd;IAAyB,MAAM;CACjC;;eAiIY,MAAM;;;;EAKlB;;cAjNa,MAAM;;;;YACN,MAAM;;;QAMN,MAAM;UACN,MAAM;UACN,MAAM;cACN,MAAM;SACN,KAAK,GAAG,KAAK,GAAG,KAAK;UACrB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC"}
+{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["files.js"],"names":[],"mappings":"AA8EA;;;;GAIG;AACH,2BAJW,MAAM,eAEd;IAAyB,MAAM;CACjC;;iBAiIY,MAAM;;;;EAKlB;AAsBD;;;GAGG;AACH,4DAFW,MAAM,UAoBhB;;cA7Pa,MAAM;;;;YACN,MAAM;;;QAMN,MAAM;UACN,MAAM;UACN,MAAM;cACN,MAAM;SACN,KAAK,GAAG,KAAK,GAAG,KAAK;UACrB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC"}

package/lib/files.js

@@ -106,8 +106,8 @@ export function setup(dir, { outDir } = {}) {
 		/** @type {Record<string, Page>} */
 		const pages = {}
 		for (const file of files) {
-			const pageId = getPagePublicPath(file)
-			pages[pageId] = {
+			const pageSlug = getSlugFromContentFilePath(file)
+			pages[pageSlug] = {
 				dataPath: path.join(dir, file)
 			}
 		}
@@ -131,8 +131,8 @@ export function setup(dir, { outDir } = {}) {
 
 		return layoutFiles.reduce(
 			(/** @type {Record<string, string>} */ result, file) => {
-				const layoutPath = path.dirname(getPagePublicPath(file))
-				result[layoutPath] = path.join(dir, file)
+				const layoutSlug = path.dirname(getSlugFromContentFilePath(file))
+				result[layoutSlug] = path.join(dir, file)
 				return result
 			},
 			/** @type {Record<string, string>} */ {}
@@ -209,10 +209,10 @@ export function setup(dir, { outDir } = {}) {
 
 	return files
 
-	/** @param {string} id */
-	async function page(id) {
+	/** @param {string} slug */
+	async function page(slug) {
 		const all = await pages()
-		return all[id]
+		return all[slug]
 	}
 }
 
@@ -237,16 +237,18 @@ function cache(fn) {
 }
 
 /**
- * @param {string} file
+ * Convert a content file path (relative to content root) to the canonical page slug.
+ * @param {string} contentFilePath
  */
-function getPagePublicPath(file) {
-	let pagePublicPath = file.replace(/\.(org|md|mdx|js|jsx|ts|tsx)$/, '')
-	pagePublicPath = pagePublicPath.replace(/index$/, '')
+export function getSlugFromContentFilePath(contentFilePath) {
+	const normalizedFilePath = contentFilePath.replace(/\\/g, '/')
+	let slug = normalizedFilePath.replace(/\.(org|md|mdx|js|jsx|ts|tsx)$/, '')
+	slug = slug.replace(/index$/, '')
 	// remove trailing slash
-	pagePublicPath = pagePublicPath.replace(/\/$/, '')
+	slug = slug.replace(/\/$/, '')
 	// ensure starting slash
-	pagePublicPath = pagePublicPath.replace(/^\//, '')
-	pagePublicPath = `/${pagePublicPath}`
+	slug = slug.replace(/^\//, '')
+	slug = `/${slug}`
 
 	// turn [id] into :id
 	// so that react-router can recognize it as url params
@@ -255,5 +257,5 @@ function getPagePublicPath(file) {
 	// 	(_, paramName) => `:${paramName}`
 	// )
 
-	return pagePublicPath
+	return slug
 }

package/lib/orga.d.ts

@@ -1,8 +1,10 @@
 /**
  * @param {Object} options
  * @param {string|string[]} options.containerClass - CSS class name(s) to wrap the rendered content
+ * @param {string} options.root - Root directory for content files
  */
-export function setupOrga({ containerClass }: {
+export function setupOrga({ containerClass, root }: {
     containerClass: string | string[];
+    root: string;
 }): import("@orgajs/rollup").Plugin;
 //# sourceMappingURL=orga.d.ts.map

package/lib/orga.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"orga.d.ts","sourceRoot":"","sources":["orga.js"],"names":[],"mappings":"AAMA;;;GAGG;AACH,8CAFG;IAAiC,cAAc,EAAvC,MAAM,GAAC,MAAM,EAAE;CACzB,mCAaA"}
+{"version":3,"file":"orga.d.ts","sourceRoot":"","sources":["orga.js"],"names":[],"mappings":"AAQA;;;;GAIG;AACH,oDAHG;IAAiC,cAAc,EAAvC,MAAM,GAAC,MAAM,EAAE;IACC,IAAI,EAApB,MAAM;CAChB,mCAYA"}

package/lib/orga.js

@@ -1,23 +1,25 @@
 /**
  * @import {Root as HastTree} from 'hast'
  */
+import path from 'node:path'
 import _orga from '@orgajs/rollup'
 import { visitParents } from 'unist-util-visit-parents'
+import { getSlugFromContentFilePath } from './files.js'
 
 /**
  * @param {Object} options
  * @param {string|string[]} options.containerClass - CSS class name(s) to wrap the rendered content
+ * @param {string} options.root - Root directory for content files
  */
-export function setupOrga({ containerClass }) {
+export function setupOrga({ containerClass, root }) {
 	return _orga({
-		rehypePlugins: [[rehypeWrap, { className: containerClass }], image],
+		rehypePlugins: [
+			[rehypeWrap, { className: containerClass }],
+			[rewriteOrgFileLinks, { root }],
+			image
+		],
 		reorgRehypeOptions: {
-			linkHref: (link) => {
-				if (link.path.protocol === 'file') {
-					return link.path.value.replace(/\.org$/, '')
-				}
-				return link.path.value
-			}
+			linkHref: (link) => link.path.value
 		}
 	})
 }
@@ -83,6 +85,56 @@ function image() {
 	}
 }
 
+/**
+ * @param {Object} options
+ * @param {string} options.root
+ */
+function rewriteOrgFileLinks({ root }) {
+	/**
+	 * @param {any} tree
+	 * @param {import('vfile').VFile} [file]
+	 */
+	return function (tree, file) {
+		const filePath = file?.path
+		if (!filePath) return
+
+		visitParents(tree, { tagName: 'a' }, (node) => {
+			const href = node?.properties?.href
+			if (typeof href !== 'string') return
+			if (!href.endsWith('.org')) return
+
+			const targetSlug = resolveOrgHrefToContentSlug({
+				root,
+				filePath,
+				href
+			})
+			if (!targetSlug) return
+			node.properties.href = targetSlug
+		})
+	}
+}
+
+/**
+ * @param {Object} options
+ * @param {string} options.root
+ * @param {string} options.filePath
+ * @param {string} options.href
+ * @returns {string|null}
+ */
+function resolveOrgHrefToContentSlug({ root, filePath, href }) {
+	const decodedHrefPath = decodeURI(href)
+	const absoluteTargetPath = decodedHrefPath.startsWith('/')
+		? path.resolve(root, `.${decodedHrefPath}`)
+		: path.resolve(path.dirname(filePath), decodedHrefPath)
+
+	const relativeTargetPath = path.relative(root, absoluteTargetPath)
+	if (relativeTargetPath.startsWith('..') || path.isAbsolute(relativeTargetPath)) {
+		return null
+	}
+
+	return getSlugFromContentFilePath(relativeTargetPath)
+}
+
 function genId(length = 8) {
 	const array = new Uint8Array(length)
 	crypto.getRandomValues(array)

package/lib/plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["plugin.js"],"names":[],"mappings":"AAoBA;;;;;GAKG;AAEH;;;;;;GAMG;AACH,kEAHW,sBAAsB,GACpB,OAAO,MAAM,EAAE,YAAY,EAAE,CAIzC;AAED;;;;;;GAMG;AACH,uHAHW,sBAAsB,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,OAAO,MAAM,EAAE,YAAY,EAAE,CAAC;IAAC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GAC5I;IAAE,OAAO,EAAE,OAAO,MAAM,EAAE,YAAY,EAAE,CAAC;IAAC,OAAO,EAAE;QAAE,KAAK,EAAE,OAAO,KAAK,CAAA;KAAE,CAAA;CAAE,CAoBxF;AAiBD;;;;;;;;;;;;GAYG;AACH,gDAHW,MAAM,GACJ,OAAO,MAAM,EAAE,MAAM,CA8CjC;AA9HD;;GAEG;AACH;;;;EAIC;;;;;UAIa,MAAM;;;;aACN,MAAM,GAAG,SAAS;;;;qBAClB,MAAM,GAAC,MAAM,EAAE"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["plugin.js"],"names":[],"mappings":"AAoBA;;;;;GAKG;AAEH;;;;;;GAMG;AACH,kEAHW,sBAAsB,GACpB,OAAO,MAAM,EAAE,YAAY,EAAE,CAQzC;AAED;;;;;;GAMG;AACH,uHAHW,sBAAsB,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,OAAO,MAAM,EAAE,YAAY,EAAE,CAAC;IAAC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GAC5I;IAAE,OAAO,EAAE,OAAO,MAAM,EAAE,YAAY,EAAE,CAAC;IAAC,OAAO,EAAE;QAAE,KAAK,EAAE,OAAO,KAAK,CAAA;KAAE,CAAA;CAAE,CAoBxF;AAiBD;;;;;;;;;;;;GAYG;AACH,gDAHW,MAAM,GACJ,OAAO,MAAM,EAAE,MAAM,CA8CjC;AAlID;;GAEG;AACH;;;;EAIC;;;;;UAIa,MAAM;;;;aACN,MAAM,GAAG,SAAS;;;;qBAClB,MAAM,GAAC,MAAM,EAAE"}

package/lib/plugin.js

@@ -33,7 +33,11 @@ export const alias = {
  * @returns {import('vite').PluginOption[]}
  */
 export function orgaBuildPlugin({ root, outDir, containerClass = [] }) {
-	return [setupOrga({ containerClass }), react(), pluginFactory({ dir: root, outDir })]
+	return [
+		setupOrga({ containerClass, root }),
+		react(),
+		pluginFactory({ dir: root, outDir })
+	]
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orga-build",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "description": "A simple tool that builds org-mode files into a website",
   "type": "module",
   "engines": {