Skip to content

chore: reorganize tsconfig files for clarity - #257

Open
ulissesferreira wants to merge 1 commit into
mainfrom
chore/rename-and-reorganize-tsconfig-files
Open

chore: reorganize tsconfig files for clarity#257
ulissesferreira wants to merge 1 commit into
mainfrom
chore/rename-and-reorganize-tsconfig-files

Conversation

@ulissesferreira

@ulissesferreira ulissesferreira commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Explanation

One more clarity improving PR for the tsconfig files on our repository so anyone can understand what is happening under the hood and keeping as many similarities as possible with core. The hierarchy of the config files is explained below but I believe that with their names and comments inside it should be self explanatory. Please raise if this is not extremely intuitive.

tsconfig.base.json                              - Configurations shared by all `tsconfig` files
│
├── tsconfig.json                               - Repository root configuration
├── tsconfig.scripts.json                       - Used for the `scripts/` directory
└── tsconfig.packages.json                      - Shared by all `packages/`, whether Snaps or not
    │
    ├── 👻 tsconfig.packages.non-snaps.json     - Not needed because it's the same thing as
    │                                             `tsconfig.packages.json`
    ├── tsconfig.packages.non-snaps.build.json  - Needed changed for the emission of
    │                                             declarations
    │
    ├── tsconfig.packages.snaps.json            - Snap specific configurations
    └── 👻 tsconfig.packages.snaps.build.json   - Not needed because mm-snap handles
                                                    everything automatically

References

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've communicated my changes to consumers by updating changelogs for packages I've changed
  • I've introduced breaking changes in this PR and have prepared draft pull requests for clients and consumer packages to resolve them

@ulissesferreira
ulissesferreira requested review from a team as code owners September 2, 2026 16:16
@ulissesferreira
ulissesferreira force-pushed the chore/rename-and-reorganize-tsconfig-files branch 2 times, most recently from 3b21025 to b58adfc Compare September 2, 2026 16:34

@taran-a taran-a left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. GG

@@ -1,10 +1,9 @@
{
"extends": "../../tsconfig.packages.build.json",
"extends": "../../../tsconfig.packages.non-snaps.build.json",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3 levels isn't it make it outside the repo from this tree level?

@@ -1,8 +1,7 @@
{
"extends": "../../tsconfig.packages.json",
"extends": "../../../tsconfig.packages.json",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also might be too deep here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants