|
| 1 | +# Effect TS Skills |
| 2 | + |
| 3 | +The repository includes the `effect-ts-guide` Codex skill from `ProverCoderAI/effect-ts-skills` as a project-scoped skill through a git submodule. |
| 4 | + |
| 5 | +## Source |
| 6 | + |
| 7 | +- Repository: https://github.com/ProverCoderAI/effect-ts-skills |
| 8 | +- Submodule path: `third_party/effect-ts-skills` |
| 9 | +- Skill source path: `third_party/effect-ts-skills/plugins/effect-ts-skills/skills/effect-ts-guide` |
| 10 | +- Submodule commit: `178adff12f5bf020b55e1aef347e2258e5033192` |
| 11 | +- Project skill path: `.codex/skills/effect-ts-guide` |
| 12 | + |
| 13 | +`.codex/skills/effect-ts-guide` is a symlink to the submodule skill directory. This keeps Codex discovery on the usual project-scoped skill path without copying the upstream skill files into this repository. |
| 14 | + |
| 15 | +## Usage |
| 16 | + |
| 17 | +Codex can use the skill directly from this workspace when a task mentions `$effect-ts-guide` or asks for Effect-TS compliance work. |
| 18 | + |
| 19 | +The submodule skill bundles a reusable `effect-ts-check` runner and tarball asset, so the OpenAPI Effect boundary can be checked without installing the plugin globally: |
| 20 | + |
| 21 | +```bash |
| 22 | +bun run effect:skill:check |
| 23 | +``` |
| 24 | + |
| 25 | +The check command initializes `third_party/effect-ts-skills` first. To only initialize the submodule, run: |
| 26 | + |
| 27 | +```bash |
| 28 | +bun run effect:skill:init |
| 29 | +``` |
| 30 | + |
| 31 | +For exploratory migration scans across more of the monorepo, run the bundled checker directly and choose the target paths: |
| 32 | + |
| 33 | +```bash |
| 34 | +bash .codex/skills/effect-ts-guide/scripts/run-effect-ts-check.sh <paths> --profile minimal |
| 35 | +bash .codex/skills/effect-ts-guide/scripts/run-effect-ts-check.sh <paths> --profile strict |
| 36 | +``` |
| 37 | + |
| 38 | +## Current Scope |
| 39 | + |
| 40 | +`bun run effect:skill:check` is intentionally scoped to the OpenAPI Effect client boundary that is currently green under the strict profile. A full monorepo scan still reports known legacy migration violations in API and session-sync code, so it is useful as backlog discovery rather than a merge gate. |
| 41 | + |
| 42 | +## Update Procedure |
| 43 | + |
| 44 | +Initialize the submodule after cloning this repository: |
| 45 | + |
| 46 | +```bash |
| 47 | +bun run effect:skill:init |
| 48 | +``` |
| 49 | + |
| 50 | +To refresh the project skill from upstream: |
| 51 | + |
| 52 | +```bash |
| 53 | +git -C third_party/effect-ts-skills fetch origin main |
| 54 | +git -C third_party/effect-ts-skills checkout <commit-or-origin/main> |
| 55 | +git add third_party/effect-ts-skills |
| 56 | +``` |
| 57 | + |
| 58 | +After updating, run: |
| 59 | + |
| 60 | +```bash |
| 61 | +bun run effect:skill:check |
| 62 | +``` |
0 commit comments