This file defines repository-level instructions for Codex agents working in this project.
- Applies to the whole repository.
- More specific
AGENTS.mdorAGENTS.override.mdfiles in subdirectories may override parts of this guidance.
src/KoSpellCheck.Core: shared spell-check engine, dictionaries, tokenization, normalization, style learning, project conventions.src/KoSpellCheck.Core.Tests: .NET unit tests for core behavior.src/KoSpellCheck.LanguagePack.HuEn: HU+EN language pack.src/KoSpellCheck.VSCode: VS Code extension (TypeScript).src/KoSpellCheck.VS2022: Visual Studio 2022 extension (VSIX, C#).scripts: cross-platform build/test/lint/pack wrappers.tools/dictionaries,tools/licenses: required dictionary and attribution assets.docs: architecture, configuration, troubleshooting.
- Read
README.mdand relevant files underdocs/for feature context. - Keep changes minimal and limited to the affected component (
Core,VSCode, orVS2022). - Prefer source edits over generated outputs.
- Before implementing, evaluate whether any part of the requested feature can be moved into shared logic in
src/KoSpellCheck.Core; if yes, implement that part inCoreinstead of duplicating extension-specific code. - Unless explicitly requested otherwise, implement every requested feature in both extensions (
src/KoSpellCheck.VSCodeandsrc/KoSpellCheck.VS2022), sharing behavior throughCorewhen possible. - Validate with targeted tests first, then broader scripts when needed.
- Build:
./scripts/build.sh(Windows:./scripts/build.ps1) - Test:
./scripts/test.sh(Windows:./scripts/test.ps1) - Lint:
./scripts/lint.sh(Windows:./scripts/lint.ps1) - Pack VSIX artifacts:
./scripts/pack.sh(Windows:./scripts/pack.ps1)
- Install deps:
npm ci - Build:
npm run build - Test:
npm run test - Lint:
npm run lint
- Restore/build solution:
dotnet restore KoSpellCheck.sln && dotnet build KoSpellCheck.sln -c Release - Core tests:
dotnet test src/KoSpellCheck.Core.Tests/KoSpellCheck.Core.Tests.csproj -c Release
- Do not manually edit generated/transpiled artifacts unless explicitly requested:
src/KoSpellCheck.VSCode/out/**- packaged outputs under
artifacts/**
- If VS Code resources need dictionary/license sync, run
npm run prepare-assetsinsrc/KoSpellCheck.VSCode(ornpm run build, which includes it). - Preserve offline-first behavior. Do not introduce cloud-only runtime dependencies for spell-check features.
- Keep optional local typo acceleration non-blocking with safe fallback behavior.
- For
src/KoSpellCheck.VSCode/**changes: runnpm run buildandnpm run testinsrc/KoSpellCheck.VSCode. - For
src/KoSpellCheck.Core/**orsrc/KoSpellCheck.VS2022/**changes: run at least relevantdotnet test. - For cross-cutting changes: run
./scripts/test.shand, if packaging is affected,./scripts/pack.sh.
- Packaging expects dictionary and license assets under
tools/dictionariesandtools/licenses. - If missing, use:
./tools/fetch-dictionaries.sh(Linux/macOS)./tools/fetch-dictionaries.ps1(Windows)
- VS Code VSIX output:
artifacts/vscode/KoSpellCheck.VSCode.vsix - Visual Studio VSIX output:
artifacts/vsix/KoSpellCheck.VS2022.vsix
- Keep naming and behavior consistent with existing architecture (
docs/architecture.md). - Avoid unrelated refactors.
- Summarize what was changed, what was validated, and what could not be validated.