@abide/abide 0.102.0 → 0.103.0

package/src/shared/routePattern.ts

@@ -1,5 +1,5 @@
 // A ROUTE LITERAL, PARSED. One grammar for two things that would otherwise drift: the file a
-// page is filed as (`invoices/[id]/page.abide`) and the literal an author writes
+// page is filed as (`invoices/[id].abide`) and the literal an author writes
 // (`'/invoices/[id]'`). The bracket spelling is the file system's, so the address is read off the
 // tree rather than declared beside it and the two cannot disagree.
 //
@@ -10,7 +10,8 @@
 // A LEAF: nothing imported but another leaf, because the compiler, the client router and a server
 // router all read it and a constant crossing a seam lives where nothing pulls a graph in behind it.
 
-import { PUBLIC_DIRECTORY, SERVER_DIRECTORY } from './RESERVED_DIRECTORIES.ts'
+import { LAUNCHER_PAGE } from './LAUNCHER_FILES.ts'
+import { RESERVED_DIRECTORIES } from './RESERVED_DIRECTORIES.ts'
 
 type SegmentKind = 'static' | 'required' | 'optional' | 'rest'
 
@@ -48,9 +49,9 @@ export type FileKind = 'page' | 'layout' | 'error' | 'component'
 /**
  * Whether the `.abide` at `path` is a page, a layout, an error page or a component.
  *
- * AN ADDRESS RATHER THAN A NAME. The file name says which of the three it is, and only a file
- * whose place is an `address` (`placeOf`) is one: a `page.abide` under a `server` directory is a
- * component.
+ * 23.21 — WHERE IT SITS, THEN ITS NAME. Every `.abide` directly in an address directory is a page
+ * but a `layout.abide`, an `error.abide` and the root's `launcher.abide`; one under a fence is a
+ * component whatever it is called.
  * One test for every reader: the build's routes, the checker's `Routes` and the `route.params` a
  * page is typed by.
  *
@@ -58,26 +59,33 @@ export type FileKind = 'page' | 'layout' | 'error' | 'component'
  * read the machine's directories as the app's.
  */
 export function fileKind(path: string): FileKind {
-    if (placeOf(path) !== 'address') return 'component'
-    // The WHOLE basename: `homepage.abide` ends with `page.abide` and is a component.
+    if (placeOf(path) !== 'address' || path === LAUNCHER_PAGE)
+        return 'component'
     const name = path.slice(path.lastIndexOf('/') + 1)
-    if (name === 'page.abide') return 'page'
     if (name === 'layout.abide') return 'layout'
-    return name === 'error.abide' ? 'error' : 'component'
+    if (name === 'error.abide') return 'error'
+    return 'page'
 }
 
 /** Where a file sits in an app, which is what it is to every reader (`placeOf`). */
-export type Place = 'address' | 'server' | 'public' | 'dependency' | 'skipped'
+export type Place =
+    | 'address'
+    | 'server'
+    | 'public'
+    | 'lib'
+    | 'tests'
+    | 'dependency'
+    | 'skipped'
 
 /**
  * Where the file at `path`, relative to the app's root, sits — THE ONE ANSWER every walk, fence and
  * emit reads, so no two of them disagree about a path.
  *
- * - `dependency` — 34.28: a package's, outside the root or under `node_modules`, whose directories
+ * - `dependency` — 34.24: a package's, outside the root or under `node_modules`, whose directories
  *   are its package's layout and none of the app's;
  * - `skipped` — under a dot directory, which no walk of the app enters;
- * - `server` or `public` — 23.15: under that reserved directory, the nearest to the root deciding
- *   (23.16 refuses one inside the other);
+ * - `server`, `public`, `lib` or `tests` — 23.15: under that fence, the nearest to the root deciding
+ *   (23.16 refuses one inside another);
  * - `address` — 23.14: everywhere else, its directories the segments of its route.
  */
 export function placeOf(path: string): Place {
@@ -88,8 +96,8 @@ export function placeOf(path: string): Place {
         const part = parts[index] as string
         if (part === 'node_modules') return 'dependency'
         if (part.startsWith('.')) return 'skipped'
-        if (part === SERVER_DIRECTORY) return 'server'
-        if (part === PUBLIC_DIRECTORY) return 'public'
+        // Each fence's place is its name.
+        if (RESERVED_DIRECTORIES.has(part)) return part as Place
     }
     return 'address'
 }
@@ -100,18 +108,48 @@ export function skipped(name: string): boolean {
 }
 
 /**
- * The route a file answers at — its DIRECTORY's below the root, whatever its name.
+ * The route a file answers at — its path below the root without its extension.
  *
- * 23.14 — `media/[id]/page.abide` is `/media/[id]`, and so is every other file beside it, which is
- * what lets a directory's handlers sit in as many files as an author likes (16.2). `path` is
- * relative to the app's root, as `fileKind`'s is.
+ * 23.14 — `media/[id].abide` and `media/getGrid.ts` are `/media/[id]` and `/media/getGrid`; an
+ * `index.abide`, a `layout.abide` and an `error.abide` are their directory's. `path` is relative to
+ * the app's root, as `fileKind`'s is.
  */
 export function routeOf(path: string): string {
     const parts = path.split('/')
-    parts.pop()
+    const file = parts.pop() as string
+    // The extension alone: `[...rest].abide` carries dots of its own.
+    if (!DIRECTORY_FILES.has(file)) parts.push(file.replace(EXTENSION, ''))
     return `/${parts.filter((part) => part !== '').join('/')}`
 }
 
+const EXTENSION = /\.(?:abide|ts)$/
+
+/** 23.14, 23.18 — the names whose route is their directory's, and so a route's wherever they stand. */
+export const DIRECTORY_FILES = new Set([
+    'index.abide',
+    'layout.abide',
+    'error.abide',
+])
+
+/**
+ * The route the hooks and private handlers of the file at `path` are filed at.
+ *
+ * 37.1 — an address's own route; under a `lib` or a `tests` directory, the route of the directory
+ * holding it, so a component an admin page renders runs under the admin route's rungs; under a
+ * `server` or a `public` directory, and for a dependency's file, the root's.
+ */
+export function scopeOf(path: string): string {
+    // 38.82 — the launcher answers at no route, and files what it calls at the root's.
+    if (path === LAUNCHER_PAGE) return '/'
+    const place = placeOf(path)
+    if (place === 'address') return routeOf(path)
+    if (place !== 'lib' && place !== 'tests') return '/'
+    const parts = path.split('/')
+    // The fence `placeOf` named is the first one, and its name is its place.
+    const fence = parts.indexOf(place)
+    return `/${parts.slice(0, fence).join('/')}`
+}
+
 /**
  * A `sort` comparator over two parsed patterns: negative where `a` is the more specific.
  *

package/src/shared/rpc.ts

@@ -501,7 +501,7 @@ export const DELETE: Declare = declare('DELETE')
 function addressOf(rpc: { address: string | undefined }): string {
     if (rpc.address === undefined)
         throw new Error(
-            'abide: this handler has no address yet. A handler is given one where it is mounted, exported from a <script server> (16.2).',
+            "abide: this handler has no address yet. A handler is given one where it is mounted: a handler file's default (16.2), or a `const` in a <script server> (16.70).",
         )
     return rpc.address
 }

package/src/ui/Router.ts

@@ -12,7 +12,6 @@ import { applyHead, withdrawHead } from './applyHead.ts'
 import { LAYER_MOUNT, LAYER_NAVIGATE } from './LAYER_NAMES.ts'
 import { MOUNTING_LEVEL } from './MOUNTING_LEVEL.ts'
 import { beginLayer, endLayer } from './measureLayer.ts'
-import { menuBridge } from './menuBridge.ts'
 import { fillRegion, pageRegion, type Region } from './regions.ts'
 import type { Scope, Stoppable } from './Scope.ts'
 
@@ -568,11 +567,6 @@ export class Router {
     ): void {
         arrive(target.href, found.route.pattern, found.params)
         this.chain = modules
-        // 38.88 — inside a desktop app, the window shows the menus this chain exports.
-        if (menuBridge() !== undefined)
-            void import('./reportMenu.ts').then((loaded) =>
-                loaded.reportMenu(modules as { menu?: unknown }[]),
-            )
         this.standing = found.route
         this.mounted = target.pathname
         if (into === undefined) return

package/src/compiler/syncTypes.ts

@@ -1,32 +0,0 @@
-// 34.24 — THE TYPES A PLAIN `.ts` READS A `.abide` BY, written with no checker and no build: the
-// files parsed and projected, and nothing else. What `abide sync` runs — and the scaffold's `prepare`
-// with it, so a project is typed as soon as it is installed — and what the language server runs as
-// a file is edited.
-
-import { sourcesUnder } from './compileApp.ts'
-import { parseSources } from './readSources.ts'
-import type { Diagnosis } from './TypeSession.ts'
-import { writeTypes } from './writeTypes.ts'
-
-/**
- * Writes the types of every `.abide` under `appRoot`, `held` standing in for the text on disk of
- * the files an editor has open; answers how many files it typed and what it refused. A file that
- * does not parse, or whose projection is refused, is left as it last was and the rest are typed.
- */
-export async function syncTypes(
-    appRoot: string,
-    held: ReadonlyMap<string, string> = new Map(),
-): Promise<{ typed: number; refused: Diagnosis[] }> {
-    const { root, sources } = await sourcesUnder(appRoot)
-    const read: { path: string; text: string }[] = []
-    for (const source of sources)
-        read.push({
-            path: source.path,
-            text: held.get(source.path) ?? source.text,
-        })
-    const refused: Diagnosis[] = []
-    const parsed = parseSources(read, refused)
-    const unparsed = refused.length
-    await writeTypes(root, parsed, true, refused)
-    return { typed: parsed.length - (refused.length - unparsed), refused }
-}

package/src/compiler/writeTypes.ts

@@ -1,82 +0,0 @@
-// 34.24 — WHAT A `.abide` EXPORTS, AS A PLAIN `.ts` IMPORTING IT IS TYPED. TypeScript reads no
-// `.abide`, and a wildcard declaration can name a default alone, so the names a `<script module>` or
-// a `<script server>` exports were untyped to every `.ts` outside abide's own checker. Each file's
-// projection — its module and server blocks, exactly what that checker answers a `.abide` import
-// with (`TypeSession.standIn`) — is written to `.abide/types`, mirroring the tree, where the app's
-// `tsconfig` reaches it: `rootDirs` for a relative import, `paths` for `#src/*`.
-//
-// THE CHECKER IS NOT ASKED, because the API it answers over emits no declarations, and the
-// projection is a module TypeScript infers the same types from. `@ts-nocheck` because the blocks are
-// read as written — a reactive read by name is the checker's to answer (31.3) and `abide check`'s to
-// report, and reported here too it would be one finding twice, at a path nobody wrote.
-
-import { rmSync } from 'node:fs' // bun has no file removal of its own
-import { dirname, relative } from 'node:path' // bun exposes no path helpers of its own
-import { buildDirectory } from '#server/buildDirectory.ts'
-import { namesUnder } from '#server/namesUnder.ts'
-import { COMPONENT_MODULE } from './checkedShadow.ts'
-import { formatDiagnosis } from './formatDiagnosis.ts'
-import { projectShadow } from './projectShadow.ts'
-import { type ParsedSource, refusal } from './readSources.ts'
-import type { Diagnosis } from './TypeSession.ts'
-
-/**
- * Writes each source's types beside the build, and removes the ones whose `.abide` is gone.
- *
- * A file is written only where its text moved, so an editor watching the directory re-reads what
- * changed rather than everything. WITH `refused`, A SOURCE WHOSE PROJECTION IS REFUSED (34.3, …) is a
- * finding at its first line and keeps the types it last had, as `parseSources` treats one that does
- * not parse; without it the refusal is thrown, naming the file.
- */
-export async function writeTypes(
-    root: string,
-    sources: readonly Pick<ParsedSource, 'path' | 'file'>[],
-    /** Whether `sources` is every file, so the types of one not among them are stale. */
-    whole = true,
-    refused?: Diagnosis[],
-): Promise<void> {
-    const above = dirname(root)
-    // Mirrored below the directory above `root`, as the scaffold's `tsconfig` names it.
-    const types = `${buildDirectory(root)}/types`
-    const written = new Set<string>()
-    const writes: Promise<unknown>[] = []
-    for (const source of sources) {
-        const path = `${types}/${relative(above, source.path)}.ts`
-        written.add(path)
-        let projected: string
-        try {
-            projected = projectShadow(source.file).text
-        } catch (thrown) {
-            const found = refusal(source.path, thrown)
-            if (refused === undefined)
-                throw new Error(formatDiagnosis(found, process.cwd()))
-            refused.push(found)
-            continue
-        }
-        // The checker's own stand-in for the default: a component taking anything (`COMPONENT_MODULE`).
-        const text = `// @ts-nocheck\n${projected}\n${COMPONENT_MODULE}`
-        if (WRITTEN.get(path) === text) continue
-        writes.push(
-            Bun.file(path)
-                .text()
-                .catch(() => undefined)
-                .then((standing) => {
-                    WRITTEN.set(path, text)
-                    return standing === text ? undefined : Bun.write(path, text)
-                }),
-        )
-    }
-    await Promise.all(writes)
-    if (!whole) return
-    // Only below this root's own mirror: two apps beside one another share the directory above.
-    const mirror = `${types}/${relative(above, root)}`
-    for (const name of namesUnder(mirror))
-        if (!written.has(`${mirror}/${name}`)) {
-            rmSync(`${mirror}/${name}`)
-            WRITTEN.delete(`${mirror}/${name}`)
-        }
-}
-
-// What this process last left at each path, so a compile run again (`abide dev`, the language
-// server) reads back only the files whose text moved since.
-const WRITTEN = new Map<string, string>()

package/src/server/LAUNCHER_FILES.ts

@@ -1,9 +0,0 @@
-// THE DESKTOP LAUNCHER'S FILES. Its page and the `launcher` options it exports sit at the app's root
-// beside the root layout, a name the framework finds rather than an address (23.14); the icon is a
-// public file, so it is wherever the address it answers at says (36.11).
-
-/** The launcher's page and options. 38.80, 38.82. */
-export const LAUNCHER_PAGE = 'launcher.abide'
-
-/** The addresses of the desktop app's icon, the `.icns` first. 38.79. */
-export const ICON_ADDRESSES = { icns: '/icon.icns', png: '/icon.png' } as const