@octalmesh/seagull-core 0.0.2

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 OctalMesh
+
+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,52 @@
+# @octalmesh/seagull-core
+
+**Internal package** - not published to npm on its own. This is the config
+loading + SDK generator engine, bundled straight into
+[`@octalmesh/seagull`](../..) at build time (see the root `tsdown.config.ts`).
+It's organized as its own package for a clean internal boundary, not as a
+separately installable one.
+
+See the [main README](https://github.com/OctalMesh/Seagull#readme) for the
+full config reference (`generators:`, `contracts:`, `publishing:`, custom
+README templates, ...) and the [`@octalmesh/seagull`](../..) package for the
+actual public API surface (this package's exports, re-exported).
+
+## What lives here
+
+- `config/` - the `seagull.yaml` schema (zod), loader, `{...}` template
+  engine, and publishing-conventions resolution.
+- `generator/` - the `Generator` abstract primitive and `GeneratorRegistry`
+  every concrete generator plugs into.
+- `generators/` - the built-in `openapi-generator-cli` and `openapi-typescript`
+  generator implementations.
+- `readme/` - README rendering for generated SDK artifacts (custom template
+  or built-in default, per language/kind).
+- `redocly/` - keeps `redocly.yaml` in sync with `seagull.yaml`.
+- `git/`, `process/`, `version/` - small process/git/versioning utilities
+  used by the pipeline commands (which live in
+  [`@octalmesh/seagull-cli`](../cli)).
+
+## Extending seagull with a custom generator
+
+`Generator` is the root primitive every SDK generator implements -
+`GeneratorRegistry` looks one up by the `tool` name referenced in
+`generators.*.tool` in the config:
+
+```ts
+import { Generator, GeneratorRegistry } from "@octalmesh/seagull-core";
+import type { GenerateContext } from "@octalmesh/seagull-core";
+
+class MyGenerator extends Generator {
+  readonly tool = "my-tool";
+
+  async generate(ctx: GenerateContext): Promise<void> {
+    // ...
+  }
+}
+
+const registry = new GeneratorRegistry().register(new MyGenerator());
+```
+
+## License
+
+MIT