@chromamark/cli 0.2.0 → 0.3.0

package/LICENSE.md

@@ -1,15 +1,9 @@
-Copyright 2026 CJ Fravel
+# MIT License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Copyright (c) 2026 CJ Fravel
 
-1. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-2. **SaaS Provision**: If you use this software to provide a Software-as-a-Service (SaaS) offering, you must provide access to the source code of the modified version of the Software that you are using in your service, under the terms of this license. The access must be provided within a reasonable time, but no later than 30 days, and the access method should be publicly documented.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
----
-
-## Third-party components
-
-The published browser bundles in `packages/renderer/dist/` and the bundled VS Code extension embed [markdown-it](https://github.com/markdown-it/markdown-it), which is licensed under the [MIT License](https://github.com/markdown-it/markdown-it/blob/master/LICENSE).
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -2,8 +2,8 @@
 
 Compile [ChromaMark](https://github.com/cjfravel-dev/ChromaMark) (`.cm`) files
 into **self-contained HTML** — the theme is inlined, so there's no CDN or build
-step to deploy — render them straight to a **color terminal**, or **lint** them
-in CI.
+step to deploy — transpile them to **GitHub-native GFM**, render them straight
+to a **color terminal**, or **lint** them in CI.
 
 ## Install
 
@@ -27,6 +27,10 @@ chromamark render report.cm                # render to the terminal (ANSI)
 cat report.cm | chromamark render          # render piped stdin
 chromamark render report.cm --no-color     # plain, icon-annotated text
 
+chromamark github report.cm                # GitHub-native GFM on stdout
+chromamark github report.cm -o report.md   # write GitHub-native GFM
+cat report.cm | chromamark github          # render piped stdin
+
 chromamark lint report.cm                  # check for common mistakes (CI)
 chromamark lint report.cm --disable CM001  # suppress a rule
 ```
@@ -35,11 +39,18 @@ Options: `-o/--output`, `--stdout`, `--title <text>`, `--watch`,
 `--color <auto|always|never>`, `--no-color`, `--disable <rules>`, `-h/--help`,
 `-v/--version`.
 
+Commands accept one input source. Extra positional arguments, including a second
+`-` stdin marker, are rejected instead of being silently ignored.
+
 The `render` command turns tones into terminal colors, pills into bracketed
 icon chips (`[✓ PASS]`), blocks into a colored left bar, and meters into a
 unicode bar. Color is automatic on a TTY and can be forced with `--color`; it
 also honors the [`NO_COLOR`](https://no-color.org) convention.
 
+The `github` command maps callouts to GitHub Alerts, details and tables to native
+GitHub structures, and pills to tone-aware `<kbd>` badges. See the complete
+[mapping contract](../../docs/github-export.md).
+
 The `lint` command flags mistakes that otherwise degrade silently — a construct
 wrapped in backticks (`CM001`), an unknown tone (`CM002`), an unknown block kind
 (`CM003`), a bad meter value (`CM004`), or an unclosed container (`CM005`) — and
@@ -48,15 +59,20 @@ exits non-zero when any are found. Suppress rules with `--disable CM001,CM003`.
 ## Programmatic
 
 ```js
-import { compile, render, renderAnsi, lint } from '@chromamark/cli';
+import { compile, render, renderAnsi, renderGitHub, lint } from '@chromamark/cli';
 
 const page = compile('::: success\nAll good [!pass]\n:::', { title: 'Report' });
 // → complete <!DOCTYPE html> document with the theme inlined
 const fragment = render('[!pass]'); // just the HTML fragment
 const ansi = renderAnsi('[!pass]', { color: 'always' }); // terminal-styled text
+const github = renderGitHub('[!pass]'); // ✅ <kbd>PASS</kbd>
 const problems = lint('Use `[!pass]` here'); // [{ line, column, rule, ... }]
 ```
 
+TypeScript declarations ship with the package.
+
 ## License
 
-Modified MIT License with a SaaS source-availability provision — see LICENSE.md.
+This software package is licensed under the MIT License; see LICENSE.md. The
+[ChromaMark specification](https://github.com/cjfravel-dev/ChromaMark/blob/main/LICENSE-SPEC.md)
+is licensed separately under CC BY-SA 4.0.

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@chromamark/cli",
-  "version": "0.2.0",
-  "description": "ChromaMark command-line tool — compile .cm to self-contained HTML, render to a color terminal, or lint.",
-  "license": "SEE LICENSE IN LICENSE.md",
+  "version": "0.3.0",
+  "description": "ChromaMark command-line tool — compile .cm to HTML or GitHub GFM, render to a color terminal, or lint.",
+  "license": "MIT",
   "author": "cjfravel-dev",
   "homepage": "https://github.com/cjfravel-dev/ChromaMark#readme",
   "repository": {
@@ -24,8 +24,12 @@
     "chromamark": "./bin/chromamark.js"
   },
   "main": "./src/index.js",
+  "types": "./src/index.d.ts",
   "exports": {
-    ".": "./src/index.js"
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    }
   },
   "files": [
     "bin/",
@@ -39,9 +43,10 @@
     "markdown",
     "cli",
     "static-site",
-    "html"
+    "html",
+    "github"
   ],
   "dependencies": {
-    "@chromamark/renderer": "^0.3.0"
+    "@chromamark/renderer": "^0.4.0"
   }
 }

package/src/cli.js

@@ -8,21 +8,25 @@ import {
 } from 'node:fs';
 import { join, basename, extname, dirname, relative } from 'node:path';
 import { fileURLToPath } from 'node:url';
-import { compile, renderAnsi, lint } from './index.js';
+import {
+  compile, renderAnsi, renderGitHub, lint,
+} from './index.js';
 
-const HELP = `chromamark — compile ChromaMark (.cm) to HTML, render it, or lint it
+const HELP = `chromamark — compile ChromaMark (.cm) to HTML, GitHub GFM, ANSI, or lint it
 
 Usage:
   chromamark [build] <input.cm> [-o <output.html>]   compile one file to HTML
   chromamark [build] <dir> -o <outdir>               compile every .cm in a tree
   chromamark render <input.cm>                       render to ANSI on stdout
+  chromamark github <input.cm> [-o <output.md>]       render to GitHub-native GFM
   chromamark lint <input.cm>                         check for common mistakes
   cat file.cm | chromamark render                    render stdin to ANSI
+  cat file.cm | chromamark github                    render stdin to GitHub GFM
   chromamark <input.cm> --stdout                     write HTML to stdout
   cat file.cm | chromamark -                          read HTML from stdin
 
 Options:
-  -o, --output <path>   output file or directory (build)
+  -o, --output <path>   output file or directory (build/github)
   --stdout              write HTML to stdout instead of a file
   --title <text>        page title (default: derived from the file name)
   --color <when>        colorize render output: auto (default), always, never
@@ -33,7 +37,7 @@ Options:
   -v, --version         print the version
 `;
 
-const COMMANDS = new Set(['build', 'render', 'lint']);
+const COMMANDS = new Set(['build', 'render', 'github', 'lint']);
 
 /**
  * Read all of stdin synchronously. Unlike readFileSync(0), this tolerates a
@@ -66,7 +70,8 @@ function version() {
 
 function parseArgs(argv) {
   const opts = {
-    command: 'build', input: null, output: null, stdout: false, title: null, watch: false, color: 'auto', disable: [],
+    command: 'build', input: null, output: null, stdout: false, title: null, watch: false,
+    color: 'auto', colorSpecified: false, disable: [],
   };
   let rest = argv;
   if (argv.length && COMMANDS.has(argv[0])) {
@@ -87,18 +92,24 @@ function parseArgs(argv) {
     else if (a === '-v' || a === '--version') opts.version = true;
     else if (a === '--stdout') opts.stdout = true;
     else if (a === '--watch') opts.watch = true;
-    else if (a === '--no-color') opts.color = 'never';
+    else if (a === '--no-color') {
+      opts.color = 'never';
+      opts.colorSpecified = true;
+    }
     else if (a === '--color') {
       const v = takeValue(a);
       if (!['auto', 'always', 'never'].includes(v)) throw new Error('--color must be auto, always, or never');
       opts.color = v;
+      opts.colorSpecified = true;
     } else if (a === '--disable') {
       opts.disable = opts.disable.concat(takeValue(a).split(',').map((s) => s.trim()).filter(Boolean));
     } else if (a === '-o' || a === '--output') opts.output = takeValue(a);
     else if (a === '--title') opts.title = takeValue(a);
-    else if (a === '-') opts.input = '-';
+    else if (a === '-' && opts.input == null) opts.input = '-';
+    else if (a === '-') throw new Error('unexpected argument: -');
     else if (a.startsWith('-')) throw new Error(`unknown option: ${a}`);
     else if (opts.input == null) opts.input = a;
+    else throw new Error(`unexpected argument: ${a}`);
   }
   return opts;
 }
@@ -136,6 +147,44 @@ function runRender(opts) {
   return 0;
 }
 
+/** Render ChromaMark to GitHub-native GFM, from a file, `-`, or piped stdin. */
+function runGitHub(opts) {
+  const unsupported = [];
+  if (opts.watch) unsupported.push('--watch');
+  if (opts.title !== null) unsupported.push('--title');
+  if (opts.colorSpecified) unsupported.push('--color');
+  if (opts.disable.length) unsupported.push('--disable');
+  if (unsupported.length) {
+    process.stderr.write(`error: ${unsupported.join(', ')} not supported by the github command\n`);
+    return 1;
+  }
+
+  let input;
+  try {
+    input = readInput(opts);
+  } catch (err) {
+    process.stderr.write(`error: ${err.message}\n`);
+    return 1;
+  }
+  if (!input || input.empty) {
+    process.stderr.write(`error: github needs an input file or piped stdin\n\n${HELP}`);
+    return 1;
+  }
+  const output = renderGitHub(input.src);
+  try {
+    if (opts.output && !opts.stdout) {
+      mkdirSync(dirname(opts.output), { recursive: true });
+      writeFileSync(opts.output, output);
+    } else {
+      process.stdout.write(output);
+    }
+  } catch (err) {
+    process.stderr.write(`error: ${err.message}\n`);
+    return 1;
+  }
+  return 0;
+}
+
 /** Lint ChromaMark and print diagnostics; exit non-zero when any are found. */
 function runLint(opts) {
   let input;
@@ -211,6 +260,9 @@ export function run(argv = process.argv.slice(2)) {
   if (opts.command === 'render') {
     return runRender(opts);
   }
+  if (opts.command === 'github') {
+    return runGitHub(opts);
+  }
   if (opts.command === 'lint') {
     return runLint(opts);
   }
@@ -234,23 +286,38 @@ export function run(argv = process.argv.slice(2)) {
 
   try {
     info = statSync(opts.input);
-    rebuild();
   } catch (err) {
     process.stderr.write(`error: ${err.message}\n`);
     return 1;
   }
 
   if (opts.watch && !opts.stdout) {
-    process.stderr.write('watching for changes… (Ctrl+C to stop)\n');
-    const onChange = () => {
+    const onChange = (_eventType, filename) => {
+      if (info.isDirectory() && filename && extname(String(filename)) !== '.cm') return;
       try { rebuild(); } catch (err) { process.stderr.write(`error: ${err.message}\n`); }
     };
+    let watcher;
     try {
-      watch(opts.input, { recursive: info.isDirectory() }, onChange);
-    } catch {
-      watch(opts.input, onChange); // non-recursive fallback (older Node / platforms)
+      try {
+        watcher = watch(opts.input, { recursive: info.isDirectory() }, onChange);
+      } catch {
+        watcher = watch(opts.input, onChange); // non-recursive fallback (older Node / platforms)
+      }
+      process.stderr.write('watching for changes… (Ctrl+C to stop)\n');
+      rebuild();
+    } catch (err) {
+      if (watcher) watcher.close();
+      process.stderr.write(`error: ${err.message}\n`);
+      return 1;
     }
     return 0;
   }
+
+  try {
+    rebuild();
+  } catch (err) {
+    process.stderr.write(`error: ${err.message}\n`);
+    return 1;
+  }
   return 0;
 }

package/src/index.d.ts

@@ -0,0 +1,28 @@
+import type {
+  LintDiagnostic,
+  LintOptions,
+  RendererOptions,
+  RenderAnsiOptions,
+  RenderGitHubOptions,
+} from '@chromamark/renderer';
+
+export interface CompileOptions {
+  title?: string;
+  theme?: string;
+  rendererOptions?: RendererOptions;
+}
+
+export function render(source: unknown, options?: RendererOptions): string;
+export function renderAnsi(source: unknown, options?: RenderAnsiOptions): string;
+export function renderGitHub(source: unknown, options?: RenderGitHubOptions): string;
+export function lint(source: unknown, options?: LintOptions): LintDiagnostic[];
+export function theme(): string;
+export function compile(source: unknown, options?: CompileOptions): string;
+
+export type {
+  LintDiagnostic,
+  LintOptions,
+  RendererOptions,
+  RenderAnsiOptions,
+  RenderGitHubOptions,
+};

package/src/index.js

@@ -5,7 +5,9 @@
 
 import { readFileSync } from 'node:fs';
 import { createRequire } from 'node:module';
-import { render as renderFragment, renderAnsi, lint } from '@chromamark/renderer';
+import {
+  render as renderFragment, renderAnsi, renderGitHub, lint,
+} from '@chromamark/renderer';
 
 const require = createRequire(import.meta.url);
 
@@ -15,6 +17,9 @@ export const render = renderFragment;
 /** Render ChromaMark to ANSI-styled text for a terminal. */
 export { renderAnsi };
 
+/** Render ChromaMark to GitHub-native GFM. */
+export { renderGitHub };
+
 /** Lint ChromaMark source, returning an array of diagnostics. */
 export { lint };