kei-lisp-plugin-graphics 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Keisuke Ikeda
+
+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:
+
+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.

package/README.md

@@ -0,0 +1,106 @@
+# kei-lisp-plugin-graphics
+
+[![npm version](https://img.shields.io/npm/v/kei-lisp-plugin-graphics.svg)](https://www.npmjs.com/package/kei-lisp-plugin-graphics)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
+[![Node.js](https://img.shields.io/badge/node-%3E%3D24.0.0-brightgreen.svg)](https://nodejs.org/)
+
+A Canvas2D drawing plugin for the [kei-lisp](https://github.com/ike-keichan/kei-lisp)
+interpreter. Register it on a `LispInterpreter` and call drawing primitives
+(`gopen`, `gline-to`, `gfill-rect`, ...) directly from Lisp source.
+
+## Installation
+
+```sh
+pnpm add kei-lisp-plugin-graphics kei-lisp
+# or: npm install kei-lisp-plugin-graphics kei-lisp
+```
+
+`kei-lisp` is a **peer dependency**; install both into your project. Requires
+**Node.js >= 24** for the build toolchain (the plugin itself targets any
+environment that exposes a `CanvasRenderingContext2D`).
+
+## Quick start
+
+```ts
+import { LispInterpreter } from 'kei-lisp';
+import { createGraphicsPlugin } from 'kei-lisp-plugin-graphics';
+
+const canvas = document.querySelector<HTMLCanvasElement>('#stage')!;
+
+const interpreter = new LispInterpreter();
+interpreter.use(createGraphicsPlugin({ canvas }));
+
+interpreter.evalString(`
+  (gopen)
+  (gfill-color "tomato")
+  (gfill-rect 10 10 120 80)
+  (gstroke-color "black")
+  (gline-width 2)
+  (gstroke-rect 10 10 120 80)
+  (gclose)
+`);
+```
+
+`HTMLCanvasElement` and `OffscreenCanvas` are both accepted.
+
+## API
+
+```ts
+import type { KeiLispPlugin } from 'kei-lisp';
+
+export function createGraphicsPlugin(options: {
+  canvas: HTMLCanvasElement | OffscreenCanvas;
+}): KeiLispPlugin;
+```
+
+The returned plugin implements the [`KeiLispPlugin`](https://github.com/ike-keichan/kei-lisp/blob/main/docs/plugins.md)
+interface and registers a fixed set of `g…` symbols that proxy to the
+canvas's 2D rendering context.
+
+## Provided Lisp functions
+
+| Category       | Symbols                                                                                                            |
+| -------------- | ------------------------------------------------------------------------------------------------------------------ |
+| Lifecycle      | `gopen`, `gclose`, `gclear`, `gsleep`                                                                              |
+| Path           | `gstart-path`, `gfinish-path`, `gmove-to`, `gline-to`, `gquadcurve-to`, `gbezcurve-to`, `garc`, `garc-to`, `grect` |
+| Fill / stroke  | `gfill`, `gstroke`, `gfill-rect`, `gstroke-rect`, `gfill-tri`, `gstroke-tri`, `gfill-text`, `gstroke-text`         |
+| Style          | `gcolor`, `gfill-color`, `gstroke-color`, `gline-width`, `gline-cap`, `gline-join`, `galpha`, `gpattern`           |
+| Shadow         | `gshadow-color`, `gshadow-blur`, `gshadow-offsetx`, `gshadow-offsety`                                              |
+| Text           | `gtext-font`, `gtext-align`, `gtext-line`, `gtext-dire`                                                            |
+| Transform      | `gtranslate`, `gscale`, `grotate`                                                                                  |
+| Image / export | `gimage`, `gsave-png`, `gsave-jpeg`                                                                                |
+
+Each function returns `t` on success. See [`docs/graphics.md`](./docs/graphics.md)
+for argument signatures and side effects.
+
+## Documentation
+
+- [API Reference](./docs/api.md) — TypeScript / JavaScript API
+- [Graphics Reference](./docs/graphics.md) — every `g…` Lisp function
+- [kei-lisp Plugin Guide](https://github.com/ike-keichan/kei-lisp/blob/main/docs/plugins.md) — how plugins integrate with the interpreter
+
+## Development
+
+```sh
+git clone https://github.com/ike-keichan/kei-lisp-plugin-graphics.git
+cd kei-lisp-plugin-graphics
+pnpm install
+```
+
+Requires [pnpm](https://pnpm.io/) and Node.js 24+
+(see [`.node-version`](./.node-version) for the exact version).
+
+| Command           | Description                                |
+| ----------------- | ------------------------------------------ |
+| `pnpm build`      | Build for distribution (CJS + ESM + types) |
+| `pnpm test`       | Run tests                                  |
+| `pnpm test:watch` | Run tests in watch mode                    |
+| `pnpm typecheck`  | Type check (`tsc --noEmit`)                |
+| `pnpm check`      | Run all checks (format, lint, spell, ...)  |
+| `pnpm fix`        | Auto-fix format and lint issues            |
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for the branch policy and PR flow.
+
+## License
+
+[MIT](./LICENSE)