|
| 1 | += empty-linter: Negative-Space Diagnostics |
| 2 | +:revdate: 2026-01-14 |
| 3 | +:status: Alpha |
| 4 | +:author: Gemini 3 Flash (Web/Paid) |
| 5 | +:orchestrator: must-just-nickel |
1 | 6 |
|
| 7 | +image:https://img.shields.io/badge/Overlay-Magenta-brightgreen.svg[Crap-Overlay] |
| 8 | +image:https://img.shields.io/badge/Logic-ReScript-orange.svg[ReScript] |
| 9 | +image:https://img.shields.io/badge/Runtime-Deno-white.svg[Deno] |
| 10 | + |
| 11 | +== The Objective |
| 12 | +**empty-linter** is a toolkit designed to see "what is not there." It purges invisible artifacts—NBSPs, Zero-Width spaces, and null bytes—that corrupt file integrity and cause neural-generated character mess to fail in symbolic parsers. |
| 13 | + |
| 14 | +It acts as the "Eyes" for agents, enforcing symbolic structural intent over hidden "crap-voids." |
| 15 | + |
| 16 | +* **Config:** Managed via `config.ncl` (Nickel). |
| 17 | +* **Task Runner:** Managed via `Justfile` (Just). |
| 18 | +* **Logic:** Written in ReScript, executed via Deno. |
| 19 | +* **Deployment:** nerdctl-first, supporting Linux, Minix, macOS, iOS, Android, and PC. |
| 20 | + |
| 21 | +== Crap-Overlay Playbook |
| 22 | +1. **Audit:** Identify invisible artifacts. |
| 23 | +2. **Highlight:** Magenta-coded reporting of offsets. |
| 24 | +3. **Correct:** 0xA0 to 0x20 conversion and ZWSP stripping. |
| 25 | + |
| 26 | +== Quick Start (Bash) |
| 27 | + |
| 28 | +The primary entry point for Bash is provided below. For all other supported shells (including `nushell`, `fish`, `minix shell`, `elvish`, etc.), please refer to link:docs/SHELLS.adoc[The Multi-Shell Registry]. |
| 29 | + |
| 30 | +[source,bash] |
| 31 | +---- |
| 32 | +#!/usr/bin/env bash |
| 33 | +# Primary Bash wrapper for empty-linter |
| 34 | +# Usage: ./bin/empty-linter.sh [directory] |
| 35 | +
|
| 36 | +TARGET=${1:-"."} |
| 37 | +
|
| 38 | +if ! command -v deno &> /dev/null; then |
| 39 | + echo "Deno not found. Please install Deno to run empty-linter." |
| 40 | + exit 1 |
| 41 | +fi |
| 42 | +
|
| 43 | +deno run --allow-read lib/js/src/EmptyLinter.bs.js "$TARGET" |
| 44 | +---- |
| 45 | + |
| 46 | +== Usage via Just |
| 47 | + |
| 48 | +We prefer the use of `just` for all development tasks. Refer to the link:cookbook.adoc[Cookbook] for a full list of recipes. |
| 49 | + |
| 50 | +[source,bash] |
| 51 | +---- |
| 52 | +# Run the Magenta crap-overlay report |
| 53 | +just audit |
| 54 | +
|
| 55 | +# Sanitise the codebase (Auto-fix voids) |
| 56 | +just correct |
| 57 | +---- |
| 58 | + |
| 59 | +== Configuration (Nickel) |
| 60 | + |
| 61 | +All structural intent is defined in `config.ncl`: |
| 62 | + |
| 63 | +[source,nickel] |
| 64 | +---- |
| 65 | +{ |
| 66 | + linter = { |
| 67 | + target_dir = ".", |
| 68 | + severity = "error", |
| 69 | + overlay_color = "magenta", |
| 70 | + auto_fix = true, |
| 71 | + } |
| 72 | +} |
| 73 | +---- |
| 74 | + |
| 75 | +== Deployment |
| 76 | + |
| 77 | +Deployment is handled via Podman to ensure cross-platform compatibility across edge tech and ASICs. |
| 78 | + |
| 79 | +[source,bash] |
| 80 | +---- |
| 81 | +just deploy-nerctl |
| 82 | +---- |
0 commit comments