More notes.

Author: sdegutis

main.ts

@@ -24,7 +24,7 @@ if (isDev) {
   })
 }
 else {
-  generateFiles(await processSite())
+  generateFiles(await processSite(), { parent: import.meta.dirname })
 }
 
 async function processSite() {

package-lock.json

@@ -12,7 +12,7 @@
     "@types/markdown-it-attrs": "^4.1.3",
     "@types/markdown-it-container": "^2.0.10",
     "@types/node": "^22.15.9",
-    "immaculata": "^2.0.1",
+    "immaculata": "^2.2.1",
     "typescript": "^5.8.2"
   },
   "dependencies": {

package.json

@@ -1,5 +1,9 @@
 # Change log
 
+## 2.1.1
+
+Fix type error.
+
 ## 2.2.0
 
 * Changed [new FileTree()](filetree.md#constructor) to take `meta.import.dirname` instead of `meta.import.url`

site/public/api/changelog.md

@@ -7,7 +7,7 @@
 ```ts
 constructor(
   path: string, // e.g. "site" or "."
-  importMetaUrl: string,
+  parentDir: string, // usually import.meta.dirname
   opts?: {
     exclude?: (path: string, stat: fs.Stats) => any,
   }
@@ -17,7 +17,7 @@ constructor(
 Loads the tree from disk into memory immediately.
 
 ```ts
-const tree = new FileTree('site', import.meta.url)
+const tree = new FileTree('site', import.meta.dirname)
 ```
 
 
@@ -27,7 +27,7 @@ const tree = new FileTree('site', import.meta.url)
 public root: string
 ```
 
-The full file URL of the tree's root based on constructor's `path` and `importMetaUrl`.
+The full file URL of the tree's root, being constructor's `parentDir` + `path`
 
 Never includes a trailing `'/'`
 
@@ -51,7 +51,7 @@ type TreeFile = {
 A list of all files (recursively) at the given path.
 
 ```ts
-const tree = new FileTree('site', import.meta.url)
+const tree = new FileTree('site', import.meta.dirname)
 
 // if cwd contains:
 //   ./site/index.html
@@ -92,7 +92,7 @@ May be called more than once, which are no-ops that just return the same `EventE
 Uses `fs.watch` internally; groups multiple fs events into one via `debounce` (default `100` ms).
 
 ```ts
-const tree = new FileTree('site', import.meta.url)
+const tree = new FileTree('site', import.meta.dirname)
 tree.watch()
 ```
 

site/public/api/filetree.md

@@ -3,8 +3,11 @@
 ```typescript
 function generateFiles(
   out: Map<string, Buffer | string>,
-  dry = false,
-  outDir = 'docs'
+  opts: {
+    parent: string,
+    dry?: boolean, // default false
+    dir?: string,  // default 'docs'
+  }
 ): void
 ```
 
@@ -20,7 +23,7 @@ generateFiles(new Map([
   ['/index.html', 'hello world'],
   ['/about.html', 'about my site'],
   ['/css/main.css', 'body{...}'],
-]))
+]), { parent: import.meta.dirname })
 
 // writefile: docs/index.html
 // writefile: docs/about.html

site/public/api/generate-files.md

@@ -72,7 +72,7 @@ are never stale modules.
 ```ts
 import module from 'node:module'
 
-const tree = new FileTree('site', import.meta.url)
+const tree = new FileTree('site', import.meta.dirname)
 
 module.registerHooks(hooks.useTree(tree))
 

site/public/api/module-hooks.md

@@ -12,7 +12,7 @@ a `FileTree.files` into a map compatible with `DevServer`
 and `generateFiles`. You can just do this:
 
 ```ts
-const tree = new FileTree('site', import.meta.url)
+const tree = new FileTree('site', import.meta.dirname)
 
 let files = tree.files.values().toArray()
 
@@ -23,7 +23,7 @@ await Promise.all(files.forEach(async f => /* ... */))
 
 const fileMap = new Map(files.map(f => [f.path, f.content]))
 server.files = fileMap
-generateFiles(fileMap)
+generateFiles(fileMap, { parent: import.meta.dirname })
 ```
 
 But that gets very inconvenient very quickly:
@@ -42,7 +42,7 @@ So the `Pipeline` class was created as a convenience.
 Here's the same code above with `Pipeline`:
 
 ```ts
-const tree = new FileTree('site', import.meta.url)
+const tree = new FileTree('site', import.meta.dirname)
 
 const pipeline = Pipeline.from(tree.files)
 
@@ -53,7 +53,7 @@ await pipeline.with(/.../).doAsync(f => /* ... */)
 
 const fileMap = pipeline.results()
 server.files = fileMap
-generateFiles(fileMap)
+generateFiles(fileMap, { parent: import.meta.dirname })
 ```
 
 ## API

site/public/api/pipeline.md

@@ -20,7 +20,7 @@ an out tree, transpiling and renaming as needed:
 ```ts
 import { FileTree, generateFiles } from "immaculata"
 
-const tree = new FileTree('site', import.meta.url)
+const tree = new FileTree('site', import.meta.dirname)
 
 tree.watch().on('filesUpdated', process)
 process()
@@ -34,7 +34,8 @@ function process() {
   const out = new Map(files.map(f => [f.path, f.content]))
 
   server.files = out // update dev server
-  generateFiles(out) // or write to disk
+                     // or write to disk:
+  generateFiles(out, { parent: import.meta.dirname })
 }
 ```
 
@@ -73,11 +74,11 @@ import { Head, Html, Main, Navbar, Sidebar } from "../template/core.tsx"
 import { md, type Env } from "./markdown.ts"
 import { tocToHtml } from './toc.ts'
 
-const tree = new FileTree('site', import.meta.url)
+const tree = new FileTree('site', import.meta.dirname)
 
-const martel = new FileTree('node_modules/@fontsource/martel', import.meta.url)
-const exo2 = new FileTree('node_modules/@fontsource-variable/exo-2', import.meta.url)
-const monda = new FileTree('node_modules/@fontsource-variable/monda', import.meta.url)
+const martel = new FileTree('node_modules/@fontsource/martel', import.meta.dirname)
+const exo2 = new FileTree('node_modules/@fontsource-variable/exo-2', import.meta.dirname)
+const monda = new FileTree('node_modules/@fontsource-variable/monda', import.meta.dirname)
 
 export function processSite() {
   const files = Pipeline.from(tree.files)

site/public/blog/a-new-way-to-vendor.md

@@ -15,7 +15,7 @@ import { FileTree, hooks } from 'immaculata'
 import { registerHooks } from 'module'
 
 // keep an in-memory version of file tree under "./site"
-const tree = new FileTree('site', import.meta.url)
+const tree = new FileTree('site', import.meta.dirname)
 
 // keep it up to date
 tree.watch().on('filesUpdated', reload)
@@ -141,7 +141,7 @@ registerHooks(hooks.mapImport('react/jsx-runtime', 'immaculata/dist/jsx-strings.
 registerHooks(hooks.mapImport('react/jsx-runtime', 'another-jsx-lib/jsx.js'))
 
 // or bring your own impl
-export const tree = new FileTree('site', import.meta.url)
+export const tree = new FileTree('site', import.meta.dirname)
 registerHooks(hooks.mapImport('react/jsx-runtime', tree.root + '/myjsx.js'))
 ```
 

site/public/blog/announcing-immaculata.md

@@ -16,7 +16,7 @@ and optionally keep it updated with [tree.watch](../api/filetree.md#watch).
 ```ts
 import { FileTree } from 'immaculata'
 
-export const tree = new FileTree('site', import.meta.url)
+export const tree = new FileTree('site', import.meta.dirname)
 
 // can now load files from memory rather than fs.readFileSync('site/style.css')
 tree.files.get('/style.css')
@@ -36,7 +36,7 @@ So I created the [useTree](../api/module-hooks.md#usetree) module hook that inva
 import { FileTree, hooks } from 'immaculata'
 import { registerHooks } from 'module'
 
-export const tree = new FileTree('site', import.meta.url)
+export const tree = new FileTree('site', import.meta.dirname)
 registerHooks(hooks.useTree(tree))
 
 tree.watch().on('filesUpdated', dostuff)

site/public/blog/hacking-nodejs-modules.md

@@ -23,7 +23,7 @@ import { FileTree } from "immaculata"
 import { useTree } from "immaculata/hooks.js"
 import { registerHooks } from 'module'
 
-const tree = new FileTree('site', import.meta.url)
+const tree = new FileTree('site', import.meta.dirname)
 registerHooks(useTree(tree))
 
 const myModule = await import('site/myModule.js')

site/public/guides/enabling-hmr.md

@@ -73,7 +73,7 @@ To use a JSX implementatoin within a [FileTree](../api/filetree.md#filetree), pr
 import { FileTree, hooks } from "immaculata"
 import { registerHooks } from "module"
 
-const tree = new FileTree('site', import.meta.url)
+const tree = new FileTree('site', import.meta.dirname)
 
 registerHooks(hooks.mapImport('react/jsx-runtime', tree.root + '/my-jsx.ts'))
 ~~~

site/public/guides/enabling-jsx.md

@@ -19,7 +19,7 @@ import { registerHooks } from 'module'
 import ts from 'typescript'
 import { fileURLToPath } from 'url'
 
-const tree = new immaculata.FileTree('site', import.meta.url)
+const tree = new immaculata.FileTree('site', import.meta.dirname)
 registerHooks(hooks.useTree(tree))
 registerHooks(hooks.mapImport('react/jsx-runtime', 'immaculata/jsx-strings.js'))
 registerHooks(hooks.compileJsx(compileViaTypescript))
@@ -35,7 +35,7 @@ if (process.argv[2] === 'dev') {
   })
 }
 else {
-  immaculata.generateFiles(await processSite())
+  immaculata.generateFiles(await processSite(), { parent: import.meta.dirname })
 }
 
 async function processSite() {

site/public/guides/simple-build-tool.md

@@ -29,7 +29,7 @@ import { FileTree, hooks } from 'immaculata'
 import { registerHooks } from 'module'
 
 // keep an in-memory version of file tree under "./src"
-const tree = new FileTree('src', import.meta.url)
+const tree = new FileTree('src', import.meta.dirname)
 
 // invalidate modules under "src" when they change
 registerHooks(hooks.useTree(tree))