@abide/abide 0.118.0 → 0.119.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @abide/abide
 
+## 0.119.0
+
+### Minor Changes
+
+- a9f8ad1: abide format formats every .abide — its scripts, styles and expressions by bun fmt, its markup by its nesting — and leaves one as written where the template would change (RULEBOOK 38.125-38.130) ([`fb0b837`](https://github.com/briancray/abide/commit/fb0b837b1264a4193371388a61fb64ec81f16638))
+
+### Patch Changes
+
+- a9f8ad1: bun fmt replaces biome, and an unused local or parameter is a type error ([`259f9b1`](https://github.com/briancray/abide/commit/259f9b18b9c2bd12b6ab5c9d9784adb2b8d2edd1))
+- a9f8ad1: format the repo with abide format and bun fmt ([`d7cd46d`](https://github.com/briancray/abide/commit/d7cd46da1e0cd523631d38d923f8bb08d1f0716f))
+
 ## 0.118.0
 
 ### Minor Changes

package/bin/abide.ts

@@ -4,17 +4,19 @@
 
 import { existsSync, realpathSync } from 'node:fs' // bun exposes no sync existence check or realpath of its own
 import { mkdir, rename, rm } from 'node:fs/promises' // bun exposes no directory creation, rename or recursive directory removal of its own
-import { dirname, resolve } from 'node:path' // bun exposes no path helpers of its own
+import { dirname, relative, resolve } from 'node:path' // bun exposes no path helpers of its own
 import { brotliCompress, constants } from 'node:zlib' // bun's brotli is `CompressionStream`, which compresses on the main thread — 1390 ms against this pool's 300 ms over the docs bundle
+
 import { paints } from '#compiler/appLayout.ts'
 import { appMap, mapText } from '#compiler/appMap.ts'
 import { checkApp } from '#compiler/checkApp.ts'
 import {
-    type CompiledApp,
     compilationOf,
     compileApp,
+    type CompiledApp,
 } from '#compiler/compileApp.ts'
 import { compiledEntry } from '#compiler/compiledEntry.ts'
+import { formatAbide } from '#compiler/formatAbide.ts'
 import { formatDiagnosis } from '#compiler/formatDiagnosis.ts'
 import { parseAbide } from '#compiler/parseAbide.ts'
 import { scaffold } from '#compiler/scaffold.ts'
@@ -40,18 +42,23 @@ import { appOnDisk, appRoot, noAppHere } from '#server/createApp.ts'
 import { executableName } from '#server/executableName.ts'
 import { iconAccent } from '#server/iconAccent.ts'
 import { namesUnder } from '#server/namesUnder.ts'
+import { skipped } from '#server/placement.ts'
 import { DEFAULT_DOCUMENT, intoHead } from '#server/render.ts'
 import { runtimeRefusal } from '#server/runtimeRefusal.ts'
 import { pathsUnder, serveBuild } from '#server/serveBuild.ts'
 import { serveDev } from '#server/serveDev.ts'
 import { escapeText } from '#shared/escapeText.ts'
 import { ICON_ADDRESSES, LAUNCHER_PAGE } from '#shared/LAUNCHER_FILES.ts'
+
 import abidePackage from '../package.json' with { type: 'json' }
 
 // 38.123 — the bun this process runs on, held to abide's `engines.bun` before anything is built or
 // booted. A compiled app carries the bun `abide compile` ran on, which this held already.
 const RUNTIME_REFUSAL = runtimeRefusal(Bun.version, abidePackage.engines.bun)
 
+/** How many files `abide format` formats at once, each spawning `bun fmt` for its pieces. */
+const FILES_AT_ONCE = 8
+
 /** Where the app a command builds or serves is, and where its build goes — both absolute. */
 type AppDirectories = { root: string; out: string }
 
@@ -81,6 +88,10 @@ const DISK: Host = {
         dev: inApp(dev),
         build: inApp(build),
         check: inApp(check),
+        format: (given) =>
+            given.positionals.length > 1
+                ? format(namedDirectories(given.positionals), given)
+                : inApp(({ root }) => format([root], given))(given),
         routes: inApp(routes),
         compile: inApp(compile),
         bundle: inApp(bundle),
@@ -699,9 +710,9 @@ async function scaffoldCommand({
         return 1
     }
     const into = resolve(name)
-    const { written, skipped } = await scaffold(name, into)
+    const { written, skipped: kept } = await scaffold(name, into)
     for (const path of written) console.log(`  wrote   ${path}`)
-    for (const path of skipped) console.log(`  kept    ${path}`)
+    for (const path of kept) console.log(`  kept    ${path}`)
     console.log(
         // The starter's own script: `abide` alone is on no PATH until it is installed globally.
         `\nabide scaffold: ${into}\n\n  cd ${name}\n  bun install\n  bun run dev`,
@@ -729,13 +740,7 @@ async function check(
     { root }: AppDirectories,
     { positionals }: Given,
 ): Promise<number> {
-    const within: string[] = []
-    for (const directory of positionals.slice(1))
-        within.push(
-            existsSync(directory)
-                ? realpathSync(resolve(directory))
-                : resolve(directory),
-        )
+    const within = namedDirectories(positionals)
     const found = await checkApp(root)
     let errors = 0
     let warnings = 0
@@ -760,6 +765,64 @@ async function check(
     return errors > 0 ? 1 : 0
 }
 
+/** The directories a command's `[dir…]` names, each as the real path a finding is filed under. */
+function namedDirectories(positionals: string[]): string[] {
+    const named: string[] = []
+    for (const directory of positionals.slice(1))
+        named.push(
+            existsSync(directory)
+                ? realpathSync(resolve(directory))
+                : resolve(directory),
+        )
+    return named
+}
+
+/**
+ * `abide format`: formats every `.abide` under `within` — the directories named, or the app where
+ * none are — and fails where any file was left as written. 38.125, 38.128.
+ *
+ * `--check` writes nothing, and fails where a file would change. 38.129.
+ *
+ * NAMED DIRECTORIES NEED NO APP, unlike `check`'s: a formatter reads one file at a time, so a
+ * monorepo formats every app under it in one run.
+ */
+async function format(within: string[], { values }: Given): Promise<number> {
+    const paths: string[] = []
+    for (const directory of within)
+        for (const name of namesUnder(directory, '**/*.abide'))
+            if (!name.split('/').some(skipped))
+                paths.push(`${directory}/${name}`)
+    let changed = 0
+    let errors = 0
+    // A file's pieces are formatted in parallel already, so files are taken a few at a time.
+    let next = 0
+    const take = async (): Promise<void> => {
+        while (next < paths.length) {
+            const path = paths[next] as string
+            next += 1
+            const text = await Bun.file(path).text()
+            const formatted = await formatAbide(path, text)
+            for (const finding of formatted.findings) {
+                errors += 1
+                console.log(formatDiagnosis(finding, process.cwd()))
+            }
+            if (formatted.text === text) continue
+            changed += 1
+            if (values.check)
+                console.log(
+                    `${relative(process.cwd(), path)} - needs formatting`,
+                )
+            else await Bun.write(path, formatted.text)
+        }
+    }
+    await Promise.all(Array.from({ length: FILES_AT_ONCE }, take))
+    const files = `${changed} file${changed === 1 ? '' : 's'}`
+    console.log(
+        `abide format: ${values.check ? `${files} to format` : `${files} formatted`} of ${paths.length}, ${errors} error${errors === 1 ? '' : 's'}`,
+    )
+    return errors > 0 || (values.check && changed > 0) ? 1 : 0
+}
+
 /**
  * `abide lsp`: the language server over stdio.
  *

package/docs/REGISTRY.md

@@ -861,6 +861,7 @@ rows a runner prints, and an adapter for an abide app.
 | `abide scaffold <name>` | Writes a starter project. | 38.1, 38.42, 38.103, 38.104, 38.106, 38.112, 38.122, 38.124 |
 | `abide run <file> [args…]` | Runs a script under the abide runtime. | 38.2, 38.57 |
 | `abide check [dir…]` | The type-checker over a `.abide` tree. | 38.3, 38.31, 38.32, 38.33, 38.40, 38.105, 38.123 |
+| `abide format [--check] [dir…]` | The formatter over a `.abide` tree. | 38.25, 38.125, 38.126, 38.127, 38.128, 38.129 |
 | `abide routes [--json]` | Every address the app answers, the file answering it, what each matcher takes, and where each hook is filed. | 38.108, 38.123 |
 | `abide dev [--port <n>]` | Watches the project and keeps the app up. | 16.23, 16.56, 37.8, 37.9, 38.4, 38.14, 38.15, 38.16, 38.17, 38.19, 38.24, 38.25, 38.26, 38.28, 38.30, 38.35, 38.36, 38.37, 38.38, 38.41, 38.43, 38.58, 38.63, 38.64, 38.65, 38.94, 38.96, 38.97, 38.123 |
 | `abide build` | Builds the client into content-hashed chunks and a manifest. | 38.43, 38.5, 38.18, 38.25, 38.26, 38.27, 38.30, 38.66, 38.94, 38.123 |
@@ -872,6 +873,6 @@ rows a runner prints, and an adapter for an abide app.
 | `abide watch <address> [args]` | A live subscription to one of the app's followed `GET`s. | 38.69 |
 | `abide compile [--target] [--out] [--platforms]` | One standalone executable. | 37.8, 37.10, 37.11, 37.12, 38.10, 38.25, 38.26, 38.44, 38.45, 38.46, 38.47, 38.48, 38.49, 38.50, 38.51, 38.52, 38.56, 38.93, 38.97, 38.123 |
 | `abide bundle [--out]` | A desktop app for the host platform, with a window on the app. | 38.10, 38.25, 38.26, 38.70, 38.71, 38.72, 38.73, 38.74, 38.75, 38.76, 38.77, 38.78, 38.79, 38.80, 38.81, 38.82, 38.83, 38.84, 38.85, 38.86, 38.87, 38.88, 38.89, 38.90, 38.91, 38.92, 38.101, 38.102, 38.123 |
-| `abide lsp` | The `.abide` language server, over stdio. | 38.11, 38.34, 38.39, 38.98, 38.116, 38.117, 38.118 |
+| `abide lsp` | The `.abide` language server, over stdio. | 38.11, 38.34, 38.39, 38.98, 38.116, 38.117, 38.118, 38.130 |
 | `--help` · `-h` · `abide help` | Usage, generated from the command list. | 38.12, 38.113, 38.114 |
 | `--version` · `-v` | The version of abide, or of the app a compiled executable holds. | 38.115 |

package/docs/RULEBOOK.md

@@ -2825,6 +2825,28 @@ the range.
 
 38.124 The project `abide scaffold` writes MUST carry a `bench` script that runs `harness-bench`.
 
+38.125 `abide format` MUST hand each `<script>` block and each `<style>` of every `.abide` under the
+directories named, or under the app where none are, to `bun fmt` as TypeScript and as CSS, under the
+options `bun fmt` reads for that file, and MUST leave as written a file those options'
+`ignorePatterns` name.
+
+38.126 `abide format` MUST hand each expression a slot, an attribute, a spread, a `{#if}`, a
+`{:else if}` or a `{#for}` holds to `bun fmt` as an expression, and MUST keep one as written where
+the printed expression would end the attribute value it stands in.
+
+38.127 `abide format` MUST indent the markup by its element and block nesting, and MUST NOT change
+the template the file parses to: a run 33.17 drops between two nodes MUST NOT gain indentation, and
+the body of a `<pre>`, a `<textarea>` and a markup `<script>` MUST stay as written.
+
+38.128 `abide format` MUST leave as written a file the parser refuses, a file whose formatted text
+would parse to a different template (38.127), and a piece `bun fmt` refuses, MUST report each on its
+line, MUST go on formatting the rest, and MUST exit non-zero where it reports one.
+
+38.129 `abide format --check` MUST write nothing, and MUST exit non-zero where a file would change.
+
+38.130 `abide lsp` MUST answer a formatting request with what `abide format` makes of the text the
+editor holds.
+
 # 39. Head and view transitions
 
 39.1 A `<head>` element in a `.abide` file MUST contribute its children to the document head.