Skip to content

docs: 增加 AGENTS.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
residua1 merged 5 commits into from
Oct 22, 2026
Merged

docs: 增加 AGENTS.md #1

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7a5bf07
docs: 增加 AGENTS.md
Yushu2606 Oct 22, 2026
5173cb6
docs: 修正加载器包清单与引用层
Yushu2606 Oct 22, 2026
71755a9
docs: 去掉不存在的 pack.sh
Yushu2606 Oct 22, 2026
c8eea78
docs: 修正 McMaster 目录与入口判定
Yushu2606 Oct 22, 2026
c0232eb
docs: 入口路径按清单解析
Yushu2606 Oct 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# AGENTS.md

F# source loader for the Hosihikari Framework. It compiles `.fsx` files with FSharp.Compiler.Service
at load and runs the result in a collectible assembly load context.

## Repository map

- `src/` — loader implementation and cache.
- `host/` — assertion host for compilation, caching, isolation, and unload.
- `test/` — fixture packages and private dependencies.
- `pack.ps1` — build the `hosihikari-fsharp` lip package.
- `tooth.json` — lip package metadata.

## Build and verify

```bash
dotnet run --project host/Hosihikari.PluginLoader.FSharp.Host.csproj -c Release --nologo
pwsh ./pack.ps1 -Version 1.0.0 -OutputRoot artifacts
```

The host expects sibling `PluginManager`, `Plugin.Abstractions`, and `McMaster.NETCore.Plugins`
checkouts. `pack.ps1` calls the core packer and needs the same `PluginManager` checkout.

## Invariants

- The loader package is named `hosihikari-fsharp`; it routes on `extraInfo.loader: assembly` with
entry `Hosihikari.PluginLoader.FSharp.dll`. Source packages conventionally use
`extraInfo.loader: fsharp` and entry `main.fsx`; the loader follows the manifest's `EntryPath`,
so nested or renamed script paths remain valid.
- Compile-time references follow the runtime order: framework shared layer, package-local DLLs,
the loader directory (for dependencies such as `FSharp.Core`), then trusted platform assemblies.
- Cache keys cover source text, `#load` and local `#r` inputs, package-local DLLs, compiler version,
and runtime version. Keep the checksum check in sync.
- A failed load releases its ALC. After excluding abstract/interface types and implementations
without a public parameterless constructor, a package exposes exactly one `IPlugin` candidate.
- Public default branches are protected. Work on a branch, open a pull request, and squash merge.

## Context

- [Design record](https://github.com/HosihikariFramework/Design) — GLOSSARY and ADRs.
- [F# loader](https://github.com/HosihikariFramework/FSharpLoader) and the
[F# plugin template](https://github.com/HosihikariFramework/FSharpPluginTemplate).
Loading