Docs: wrap.

Author: bjones1

builder/Cargo.toml

@@ -17,7 +17,7 @@
 # [http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).
 #
 # `Cargo.toml` -- Rust build/package management config for the builder
-# ====================================================================
+# ==============================================================================
 [package]
 name = "builder"
 version = "0.1.0"

builder/src/main.rs

@@ -14,19 +14,19 @@
 // the CodeChat Editor. If not, see
 // [http://www.gnu.org/licenses](http://www.gnu.org/licenses).
 /// `main.rs` -- Entrypoint for the CodeChat Editor Builder
-/// =======================================================
+/// ============================================================================
 ///
 /// This code uses [dist](https://opensource.axo.dev/cargo-dist/book/) as a part
 /// of the release process. To update the `./release.yaml` file this tool
 /// creates:
 ///
-/// 1.  Edit `server/dist-workspace.toml`: change `allow-dirty` to `[]`.
-/// 2.  Run `dist init` and accept the defaults, then run `dist generate`.
-/// 3.  Review changes to `./release.yaml`, reapplying hand edits.
-/// 4.  Revert the changes to `server/dist-workspace.toml`.
-/// 5.  Test
+/// 1. Edit `server/dist-workspace.toml`: change `allow-dirty` to `[]`.
+/// 2. Run `dist init` and accept the defaults, then run `dist generate`.
+/// 3. Review changes to `./release.yaml`, reapplying hand edits.
+/// 4. Revert the changes to `server/dist-workspace.toml`.
+/// 5. Test
 // Imports
-// -------
+// -----------------------------------------------------------------------------
 //
 // ### Standard library
 use std::{
@@ -50,7 +50,7 @@ use regex::Regex;
 // None
 //
 // Data structures
-// ---------------
+// -----------------------------------------------------------------------------
 //
 // The following defines the command-line interface for the CodeChat Editor.
 #[derive(Parser)]
@@ -117,15 +117,15 @@ struct TypeScriptBuildOptions {
 }
 
 // Constants
-// ---------
+// -----------------------------------------------------------------------------
 static VSCODE_PATH: &str = "../extensions/VSCode";
 static CLIENT_PATH: &str = "../client";
 static BUILDER_PATH: &str = "../builder";
 static TEST_UTILS_PATH: &str = "../test_utils";
 static NAPI_TARGET: &str = "NAPI_TARGET";
 
 // Code
-// ----
+// -----------------------------------------------------------------------------
 //
 // ### Utilities
 //
@@ -242,8 +242,8 @@ fn quick_copy_dir<P: AsRef<Path>>(src: P, dest: P, files: Option<P>) -> io::Resu
         .status()?
         .code()
         .expect("Copy process terminated by signal");
-    // Per [these
-    // docs](https://learn.microsoft.com/en-us/troubleshoot/windows-server/backup-and-storage/return-codes-used-robocopy-utility),
+    // Per
+    // [these docs](https://learn.microsoft.com/en-us/troubleshoot/windows-server/backup-and-storage/return-codes-used-robocopy-utility),
     // check the return code.
     if cfg!(windows) && exit_code >= 8 || !cfg!(windows) && exit_code != 0 {
         Err(io::Error::other(format!(
@@ -288,7 +288,7 @@ fn search_and_replace_file<
 }
 
 // Core routines
-// -------------
+// -----------------------------------------------------------------------------
 //
 // These functions simplify common build-focused development tasks and support
 // CI builds.
@@ -312,17 +312,17 @@ fn patch_file(patch: &str, before_patch: &str, file_path: &str) -> io::Result<()
 }
 /// After updating files in the client's Node files, perform some fix-ups.
 fn patch_client_libs() -> io::Result<()> {
-    // Apply a the fixes described in [issue
-    // 27](https://github.com/bjones1/CodeChat_Editor/issues/27).
+    // Apply a the fixes described in
+    // [issue 27](https://github.com/bjones1/CodeChat_Editor/issues/27).
     patch_file(
         "
         selectionNotFocus = this.view.state.facet(editable) ? focused : hasSelection(this.dom, this.view.observer.selectionRange)",
         "        let selectionNotFocus = !focused && !(this.view.state.facet(editable) || this.dom.tabIndex > -1) &&
             hasSelection(this.dom, this.view.observer.selectionRange) && !(activeElt && this.dom.contains(activeElt));",
         &format!("{CLIENT_PATH}/node_modules/@codemirror/view/dist/index.js")
     )?;
-    // In [older
-    // releases](https://www.tiny.cloud/docs/tinymce/5/6.0-upcoming-changes/#options),
+    // In
+    // [older releases](https://www.tiny.cloud/docs/tinymce/5/6.0-upcoming-changes/#options),
     // TinyMCE allowed users to change `whitespace_elements`; the whitespace
     // inside these isn't removed by TinyMCE. However, this was removed in v6.0.
     // Therefore, manually patch TinyMCE instead.
@@ -385,8 +385,8 @@ fn run_install(dev: bool) -> io::Result<()> {
         #[cfg(not(windows))]
         // The original command had `'=https'`, but single quotes confused
         // `cmd_lib` and aren't needed to quote this. Note that `//` in the URL
-        // is a comment in Rust, so it must be [enclosed in
-        // quotes](https://github.com/rust-shell-script/rust_cmd_lib/issues/88).
+        // is a comment in Rust, so it must be
+        // [enclosed in quotes](https://github.com/rust-shell-script/rust_cmd_lib/issues/88).
         run_cmd! {
             curl -L --proto =https --tlsv1.2 -sSf "https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh" | bash;
         }?;
@@ -560,7 +560,7 @@ fn run_client_build(
         true,
     )?;
 
-    // <a id="#pdf.js>The PDF viewer for use with VSCode. Built it separately,
+    // \<a id="#pdf.js>The PDF viewer for use with VSCode. Built it separately,
     // since it's loaded apart from the rest of the Client.
     run_script(
         &esbuild,
@@ -643,7 +643,8 @@ fn run_extensions_build(
     if dist {
         napi_args.push("--release");
     }
-    // See if this is a cross-platform build -- if so, add in the specified target.
+    // See if this is a cross-platform build -- if so, add in the specified
+    // target.
     let target;
     if let Ok(tmp) = env::var(NAPI_TARGET) {
         target = tmp;
@@ -739,7 +740,9 @@ fn run_postrelease(target: &str) -> io::Result<()> {
         "aarch64-apple-darwin" => "darwin-arm64",
         _ => panic!("Unsupported platform {target}."),
     };
-    // `vsce` will invoke this program's `ext_build`; however, it doesn't provide a way to pass the target when cross-compiling. Use an environment variable instead.
+    // `vsce` will invoke this program's `ext_build`; however, it doesn't
+    // provide a way to pass the target when cross-compiling. Use an environment
+    // variable instead.
     unsafe {
         env::set_var(NAPI_TARGET, target);
     }
@@ -763,7 +766,7 @@ fn run_postrelease(target: &str) -> io::Result<()> {
 }
 
 // CLI implementation
-// ------------------
+// -----------------------------------------------------------------------------
 //
 // The following code implements the command-line interface for the CodeChat
 // Editor.

client/src/CodeChatEditor-test.mts

@@ -15,13 +15,13 @@
 // [http://www.gnu.org/licenses](http://www.gnu.org/licenses).
 //
 // `CodeChatEditor-test.mts` -- Tests for the CodeChat Editor client
-// =================================================================
+// =============================================================================
 //
 // To run tests, add a `?test` to any web page served by the CodeChat Editor
 // server.
 //
 // Imports
-// -------
+// -----------------------------------------------------------------------------
 import { assert } from "chai";
 import "mocha/mocha.js";
 import "mocha/mocha.css";
@@ -44,7 +44,7 @@ import {
 const sleep = (ms: number) => new Promise((r) => setTimeout(r, ms));
 
 // Tests
-// -----
+// -----------------------------------------------------------------------------
 //
 // <a id="CodeChatEditor_test"></a>Defining this global variable signals the
 // CodeChat Editor to [run tests](CodeChatEditor.mts#CodeChatEditor_test).

client/src/CodeChatEditor.mts

@@ -253,7 +253,9 @@ const _open_lp = async (
                         (
                             event: EditorEvent<Events.EditorEventMap["dirty"]>,
                         ) => {
-                            // Sometimes, `tinymce.activeEditor` is null (perhaps when it's not focused). Use the `event` data instead.
+                            // Sometimes, `tinymce.activeEditor` is null
+                            // (perhaps when it's not focused). Use the `event`
+                            // data instead.
                             event.target.setDirty(false);
                             is_dirty = true;
                             startAutosaveTimer();
@@ -320,7 +322,8 @@ const save_lp = (is_dirty: boolean) => {
             ) as HTMLDivElement;
             mathJaxUnTypeset(codechat_body);
             // To save a document only, simply get the HTML from the only Tiny
-            // MCE div. Update the `doc_contents` to stay in sync with the Server.
+            // MCE div. Update the `doc_contents` to stay in sync with the
+            // Server.
             doc_content = tinymce.activeEditor!.save();
             (
                 code_mirror_diffable as {
@@ -368,7 +371,9 @@ export const saveSelection = () => {
             (!(current_node as Element).classList.contains(
                 "CodeChat-doc-contents",
             ) &&
-                // Sometimes, the parent of a custom node (`wc-mermaid`) skips the TinyMCE div and returns the overall div. I don't know why.
+                // Sometimes, the parent of a custom node (`wc-mermaid`) skips
+                // the TinyMCE div and returns the overall div. I don't know
+                // why.
                 !(current_node as Element).classList.contains("CodeChat-doc"));
             current_node = current_node.parentNode!, is_first = false
         ) {
@@ -380,7 +385,8 @@ export const saveSelection = () => {
             // `childNodes` change based on whether text nodes (such as a
             // newline) are included are not after tinyMCE parses the content.
             const p = current_node.parentNode;
-            // In case we go off the rails, give up if there are no more parents.
+            // In case we go off the rails, give up if there are no more
+            // parents.
             if (p === null) {
                 return {
                     selection_path: [],

client/src/HashReader.mts

@@ -15,7 +15,7 @@
 // [http://www.gnu.org/licenses](http://www.gnu.org/licenses).
 //
 // `HashReader.mts` -- post-process esbuild output
-// ===============================================
+// =============================================================================
 //
 // This script reads the output produced by esbuild to determine the location of
 // the bundled files, which have hashes in their file names. It writes these

client/src/assert.mts

@@ -1,5 +1,21 @@
+// Copyright (C) 2025 Bryan A. Jones.
+//
+// This file is part of the CodeChat Editor. The CodeChat Editor is free
+// software: you can redistribute it and/or modify it under the terms of the GNU
+// General Public License as published by the Free Software Foundation, either
+// version 3 of the License, or (at your option) any later version.
+//
+// The CodeChat Editor is distributed in the hope that it will be useful, but
+// WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+// details.
+//
+// You should have received a copy of the GNU General Public License along with
+// the CodeChat Editor. If not, see
+// [http://www.gnu.org/licenses](http://www.gnu.org/licenses).
+//
 // `assert.mts`
-// ============
+// =============================================================================
 //
 // Provide a simple `assert` function to check conditions at runtime. Using
 // things like [assert](https://nodejs.org/api/assert.html) causes problems --

client/src/css/CodeChatEditorProject.css

@@ -17,10 +17,10 @@
    [http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).
 
    `CodeChatEditorProject.css` -- Styles for the CodeChat Editor for projects
-   ==========================================================================
+   =============================================================================
 
-   This is used only to store a reused variable value. See the [CSS
-   docs](https://drafts.csswg.org/css-variables/). */
+   This is used only to store a reused variable value. See the
+   [CSS docs](https://drafts.csswg.org/css-variables/). */
 :root {
     --sidebar-width: 15rem;
     --body-padding: 0.2rem;

client/src/graphviz-webcomponent-setup.mts

@@ -15,15 +15,15 @@
 // [http://www.gnu.org/licenses](http://www.gnu.org/licenses).
 //
 // `graphviz-webcomponent-setup.mts` -- Configure graphviz webcomponent options
-// ============================================================================
+// =============================================================================
 //
 // Configure the Graphviz web component to load the (large) renderer only when a
 // Graphviz web component is found on a page. See the
 // [docs](https://github.com/prantlf/graphviz-webcomponent#configuration).
 //
 // Note that this must be in a separate module which is imported before the
-// graphviz webcomponent; see the [ESBuild
-// docs](https://esbuild.github.io/content-types/#real-esm-imports).
+// graphviz webcomponent; see the
+// [ESBuild docs](https://esbuild.github.io/content-types/#real-esm-imports).
 /*eslint-disable-next-line @typescript-eslint/no-explicit-any */
 (window as any).graphvizWebComponent = {
     rendererUrl: "/static/bundled/renderer.js",

client/src/shared_types.mts

@@ -14,12 +14,18 @@
 // the CodeChat Editor. If not, see
 // [http://www.gnu.org/licenses](http://www.gnu.org/licenses).
 //
-// `shared_types.mts` -- Shared type definitions
-// =============================================
-// The time, in ms, to wait between the last user edit and sending updated data to the Server.
+// `shared_types.mts` -- Shared type definitionsz
+// =============================================================================
+//
+// The time, in ms, to wait between the last user edit and sending updated data
+// to the Server.
 export const autosave_timeout_ms = 300;
 
-// Produce a whole random number. Fractional numbers aren't consistently converted to the same number. Note that the mantissa of a JavaScript `Number` is 53 bits per the [docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number#number_encoding). To be certain, also round the result.
+// Produce a whole random number. Fractional numbers aren't consistently
+// converted to the same number. Note that the mantissa of a JavaScript `Number`
+// is 53 bits per the
+// [docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number#number_encoding).
+// To be certain, also round the result.
 export const rand = () => Math.round(Math.random() * 2 ** 53);
 
 // ### Message types
@@ -41,7 +47,8 @@ import { ResultErrTypes } from "./rust-types/ResultErrTypes.js";
 // Manually define this, since `ts-rs` can't export `webserver.MessageResult`.
 type MessageResult = { Ok: ResultOkTypes } | { Err: ResultErrTypes };
 
-// Modified from [SO](https://stackoverflow.com/a/79050131). If the value is a string, use it; otherwise, assume it's a dict and use its key.
+// Modified from [SO](https://stackoverflow.com/a/79050131). If the value is a
+// string, use it; otherwise, assume it's a dict and use its key.
 type KeysOfRustEnum<T> = T extends T ? (T extends string ? T : keyof T) : never;
 
 export type {

client/src/tinymce-config.mts

@@ -25,7 +25,9 @@ import {
     RawEditorOptions,
     TinyMCE,
 } from "tinymce";
-// This is taken from the [TinyMCE example code](https://github.com/tinymce/tinymce/blob/main/modules/tinymce/src/core/demo/ts/demo/TinyMceDemo.ts). However, esbuild doesn't accept it.
+// This is taken from the
+// [TinyMCE example code](https://github.com/tinymce/tinymce/blob/main/modules/tinymce/src/core/demo/ts/demo/TinyMceDemo.ts).
+// However, esbuild doesn't accept it.
 //export declare const tinymce: TinyMCE;
 // Here's a workaround.
 export const tinymce = tinymce_ as unknown as TinyMCE;