Summary
The standalone repository javierbrea/epb-ts-example was created as a reference for using eslint-plugin-boundaries with TypeScript. Since the project has migrated to a monorepo structure, maintaining a separate example repository introduces overhead and risks becoming (further) outdated.
Proposed Changes
- Add an
examples/ folder to this monorepo containing setup examples for different use cases, starting with a TypeScript example (migrating the content of epb-ts-example).
- Archive
javierbrea/epb-ts-example once the TypeScript example has been moved here, pointing users to the new location.
- Update the TypeScript Support documentation at jsboundaries.dev/docs/guides/typescript-support to link to the new
examples/ folder in this repo instead of the archived standalone repo.
Motivation
- Keeps all examples co-located with the source code and documentation, making them easier to maintain and keep up to date.
- Reduces fragmentation across repositories.
- The
examples/ folder can be extended in the future with additional setup examples (e.g., JavaScript flat config, path aliases, etc.).
Suggested Folder Structure
examples/
└── typescript/
├── package.json
├── tsconfig.json
├── eslint.config.js
└── src/
└── ...
Additional Context
The current epb-ts-example repo is already outdated. Archiving it and replacing the link in the TypeScript Support guide will ensure users always land on a maintained, working example.
Summary
The standalone repository javierbrea/epb-ts-example was created as a reference for using
eslint-plugin-boundarieswith TypeScript. Since the project has migrated to a monorepo structure, maintaining a separate example repository introduces overhead and risks becoming (further) outdated.Proposed Changes
examples/folder to this monorepo containing setup examples for different use cases, starting with a TypeScript example (migrating the content ofepb-ts-example).javierbrea/epb-ts-exampleonce the TypeScript example has been moved here, pointing users to the new location.examples/folder in this repo instead of the archived standalone repo.Motivation
examples/folder can be extended in the future with additional setup examples (e.g., JavaScript flat config, path aliases, etc.).Suggested Folder Structure
Additional Context
The current
epb-ts-examplerepo is already outdated. Archiving it and replacing the link in the TypeScript Support guide will ensure users always land on a maintained, working example.