chore: revert references related changes
#85
Conversation
|
WalkthroughThis change refactors the project's TypeScript configuration by deleting legacy config files, simplifying remaining configs, and introducing a dedicated ESLint TypeScript config. The build and lint scripts in Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant Scripts as NPM Scripts
participant TS as TypeScript Compiler
participant ESLint as ESLint
Dev->>Scripts: Run build
Scripts->>TS: tsc -p src
TS-->>Scripts: Compile using new base config
Dev->>Scripts: Run lint
Scripts->>ESLint: tsc -p tsconfig.eslint.json --noEmit
ESLint-->>Scripts: Type-check with ESLint config
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (7)
💤 Files with no reviewable changes (2)
🚧 Files skipped from review as they are similar to previous changes (4)
🧰 Additional context used🪛 Biome (1.9.4)tsconfig.eslint.json[error] 2-2: Expected a property but instead found '// dominikg/tsconfck#220'. Expected a property here. (parse) [error] 3-3: End of file expected Use an array for a sequence of values: (parse) [error] 3-3: End of file expected Use an array for a sequence of values: (parse) [error] 3-3: End of file expected Use an array for a sequence of values: (parse) [error] 3-3: End of file expected Use an array for a sequence of values: (parse) 8000[error] 4-4: End of file expected Use an array for a sequence of values: (parse) [error] 4-4: End of file expected Use an array for a sequence of values: (parse) [error] 4-8: End of file expected Use an array for a sequence of values: (parse) [error] 8-9: End of file expected Use an array for a sequence of values: (parse) ⏰ Context from checks skipped due to timeout of 90000ms (5)
🔇 Additional comments (2)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Pull Request Overview
Reverting recent references changes by removing outdated tsconfig configurations and updating other configuration files to reflect the intended project setup. Key changes include:
- Removal of tsconfig.node.json and tsconfig.lib.json, reverting previous changes.
- Introduction of a new tsconfig.eslint.json and updating configuration extends in test/tsconfig.json and src/tsconfig.json.
- Adjustment of build and lint scripts alongside version number changes in package.json.
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tsconfig.node.json | Removed the node-specific tsconfig revert. |
| tsconfig.lib.json | Removed the library tsconfig revert. |
| tsconfig.eslint.json | Added a new eslint tsconfig file to support linting configurations. |
| test/tsconfig.json | Updated to extend the new tsconfig.eslint.json. |
| src/tsconfig.json | Modified the extends value; verify it references the correct config. |
| package.json | Adjusted version and updated build scripts to match the revert. |
Comments suppressed due to low confidence (2)
src/tsconfig.json:2
- The new extends path ".." in src/tsconfig.json is ambiguous; please confirm that it accurately references the desired configuration file.
"extends": "..",
package.json:3
- The version downgrade from "0.0.1" to "0.0.0" may be unintentional; please verify that this change was deliberate.
"version": "0.0.0",
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
commit: |
size-limit report 📦
|
|
Deploy preview for lib-boilerplate ready! ✅ Preview Built with commit ed1aae2. |
📊 Package size report -0.04%↓
Unchanged files
🤖 This report was automatically generated by pkg-size-action |
There was a problem hiding this comment.
Important
Looks good to me! 👍
Reviewed everything up to 11a89c6 in 1 minute and 41 seconds. Click for details.
- Reviewed
71lines of code in4files - Skipped
3files when reviewing. - Skipped posting
7draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. package.json:3
- Draft comment:
Version changed to 0.0.0; confirm that this reversion is intentional. - Reason this comment was not posted:
Confidence changes required:50%<= threshold50%None
2. package.json:35
- Draft comment:
build:tsc now uses 'tsc -p src' instead of 'tsc -b'; ensure removing project references is expected. - Reason this comment was not posted:
Comment looked like it was already resolved.
3. package.json:36
- Draft comment:
build:tsdown removed the '--tsconfig' flag; verify that the default tsconfig is applied correctly. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%The comment is asking the PR author to verify that the default tsconfig is applied correctly after a flag was removed. This falls under asking the author to ensure behavior is intended or to double-check something, which is against the rules.
4. package.json:44
- Draft comment:
lint:tsc now uses 'tsc -p tsconfig.eslint.json --noEmit'; confirm the lint configuration remains accurate. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%The comment is asking the PR author to confirm the accuracy of the lint configuration after a change. This falls under the rule of not asking the author to confirm their intention or ensure behavior is intended. Therefore, this comment should be removed.
5. tsconfig.eslint.json:1
- Draft comment:
New tsconfig.eslint.json added; ensure that extending '.' provides the intended base TS settings. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%The comment is asking the PR author to ensure that the newtsconfig.eslint.jsonfile is extending the intended base TypeScript settings. This falls under asking the author to confirm their intention, which is against the rules.
6. tsconfig.lib.json:1
- Draft comment:
Deleted tsconfig.lib.json; verify that its removal does not impact any build or type-checking processes. - Reason this comment was not posted:
Comment was not on a location in the diff, so it can't be submitted as a review comment.
7. tsconfig.node.json:1
- Draft comment:
Deleted tsconfig.node.json; confirm that node-specific TypeScript settings are no longer needed. - Reason this comment was not posted:
Comment was not on a location in the diff, so it can't be submitted as a review comment.
Workflow ID: wflow_1bObqzMHnPDMP6gq
You can customize 
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
tsconfig.eslint.json (1)
2-3: Prefer explicit file reference inextends.Using
"extends": "."relies on implicit directory resolution. For clarity and to avoid confusion, change it to point directly at your root tsconfig file.- "extends": ".", + "extends": "./tsconfig.json",test/tsconfig.json (1)
2-2: Specify the.jsonextension inextends.While TypeScript can resolve
extends: "../tsconfig.eslint", including the file extension improves readability and tool compatibility.- "extends": "../tsconfig.eslint" + "extends": "../tsconfig.eslint.json"src/tsconfig.json (1)
8-9: Refine theincludepattern.Using
"include": [".""]may pull in non-TypeScript assets. To explicitly target source files, consider:- "include": ["."] + "include": ["**/*"]package.json (1)
46-46: Scope linting to source and test files.Running
tsc -p tsconfig.eslint.json --noEmitwill, by default, include all TS files (including generatedlib). To avoid type-checking artifacts, consider adding an"exclude": ["lib"]or defining an explicit"include"intsconfig.eslint.json.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (7)
package.json(3 hunks)src/tsconfig.json(1 hunks)test/tsconfig.json(1 hunks)tsconfig.eslint.json(1 hunks)tsconfig.json(1 hunks)tsconfig.lib.json(0 hunks)tsconfig.node.json(0 hunks)
💤 Files with no reviewable changes (2)
- tsconfig.node.json
- tsconfig.lib.json
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Codacy Static Code Analysis
- GitHub Check: Lint and Test with Node.js 22 on windows-latest
- GitHub Check: Lint and Test with Node.js 20 on windows-latest
- GitHub Check: Lint and Test with Node.js 18 on windows-latest
🔇 Additional comments (4)
src/tsconfig.json (1)
2-7: Re-evaluatecompositeand project references.You've enabled
"composite": trueinsrc/tsconfig.jsonbut removed all"references"from the root config. If you intend to leverage TypeScript project references for incremental and cross-project builds, you'll need to re-add:"references": [ { "path": "./src" }, { "path": "./test" } ]Otherwise, if you’re building
srcin isolation, consider disabling"composite"to simplify the configuration.package.json (2)
3-3: Confirm version bump strategy.Setting
"version": "0.0.0"is unusual for a published package. Ensure this aligns with your Changesets or release process, where the placeholder is auto-replaced before publishing.
36-38: Validate TypeScript build outputs.Switching to
tsc -p srcrelies onsrc/tsconfig.jsonemitting declarations via"composite": true. Confirm thattsc -p srcproduces both.jsand.d.tsfiles inlib/without overlap or conflicts withtsdown.tsconfig.json (1)
2-7: Verify removal of project references.The root config now extends
@1stg/tsconfig/node16and omits all"references". If you still need project references for composite compilation acrosssrcandtest, re-add them:"references": [ { "path": "./src" }, { "path": "./test" } ]Otherwise, confirm that you intend to compile each subproject separately.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #85 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 1 1
Lines 3 3
Branches 1 1
=========================================
Hits 3 3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Important
Looks good to me! 👍
Reviewed ed1aae2 in 46 seconds. Click for details.
- Reviewed
68lines of code in4files - Skipped
3files when reviewing. - Skipped posting
5draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. package.json:3
- Draft comment:
Confirm intentional version reset to '0.0.0'. - Reason this comment was not posted:
Confidence changes required:33%<= threshold50%None
2. package.json:36
- Draft comment:
Verify 'tsc -p src' is the desired build config after reverting project references. - Reason this comment was not posted:
Confidence changes required:33%<= threshold50%None
3. package.json:37
- Draft comment:
Ensure removal of '--tsconfig' from tsdown script is intended and defaults are correct. - Reason this comment was not posted:
Confidence changes required:33%<= threshold50%None
4. package.json:46
- Draft comment:
Check that linting with tsconfig.eslint.json preserves expected type-check behavior. - Reason this comment was not posted:
Confidence changes required:33%<= threshold50%None
5. tsconfig.eslint.json:2
- Draft comment:
Ensure JSON comment is supported by all tooling; tsconfig files allow comments but verify ESLint integration. - Reason this comment was not posted:
Confidence changes required:33%<= threshold50%None
Workflow ID: wflow_fXJ2Vyonotty5HRY
You can customize
Important
Reverted
referencesrelated changes by updating TypeScript configurations and scripts inpackage.json.tsconfig.eslint.jsonfor enhanced TypeScript linting support.tsconfig.lib.jsonandtsconfig.node.jsonas they were redundant.build:tscscript inpackage.jsonto usetsc -p src.lint:tscscript inpackage.jsonto usetsconfig.eslint.json.package.jsonfrom0.0.1to0.0.0.This description was created by
for ed1aae2. You can customize this summary. It will automatically update as commits are pushed.
Summary by CodeRabbit