Skip to content

filelinks v1.0.0 — MVP (core + CLI)

Choose a tag to compare

View all tags
@malekelkssas malekelkssas released this 12 Apr 21:46
· 80 commits to main since this release
v1.0.0
1fd38b8
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Description

Milestone: v1.0.0 MVP — shipped per GSD (4 phases, 7 plans; archived 2026-04-06).

What filelinks is
Declare semantic relationships between files in a repo (any language). When a trigger changes, you get a clear signal about affected companions that should be reviewed or updated—without relying only on same-language import graphs.

Shipped in v1.0

  • @filelinks/core — defineLinks, filelinks.config.ts loaded with jiti (walk-up from cwd), Effect Schema for public config shapes, typed errors (FilelinksError + normalizeError), git staged paths, minimatch link matching, optional linkType (file-file | dir-dir | file-dir | dir-file), resolvePrompt for global + per-link prompt merge (for future tooling).
  • filelinks CLI — check (staged paths vs links; warn/error by severity), list, interactive add (Ink + React), global --cwd, optional --config, --json on check / list, publishable bin for npx filelinks after publish.
  • Docs & contributor path — Root README for install and basic usage; CONTRIBUTING.md, AGENTS.md, architecture notes under .planning/codebase/; Husky + lint-staged + tests as in repo.

Intentionally not in v1.0 (tracked for later milestones)
AI suggest, shipped @filelinks/git-hook, graph, VS Code extension, Nx plugin—see archived v2 section in .planning/milestones/v1.0-REQUIREMENTS.md.

Traceability
Requirements CORE-01–CORE-09, CLI-01–CLI-04, DOC-01–DOC-02 in the v1.0 requirements archive; roadmap phases 01–04 in .planning/milestones/v1.0-ROADMAP.md.

Assets 2
Loading