feat: add new LangVariant option LangAuto although it's unsupported
#107
Conversation
🦋 Changeset detectedLatest commit: 06ff81e The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
WalkthroughThis pull request introduces several codebase updates and documentation improvements. A new language variant option, Changes
Possibly related PRs
Poem
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
eslint.config.jsOops! Something went wrong! :( ESLint: 9.24.0 Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@1stg/eslint-config' imported from /eslint.config.js src/types.tsOops! Something went wrong! :( ESLint: 9.24.0 Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@1stg/eslint-config' imported from /eslint.config.js src/processor.tsOops! Something went wrong! :( ESLint: 9.24.0 Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@1stg/eslint-config' imported from /eslint.config.js ✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
|
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. |
size-limit report 📦
|
commit: |
|
Removed dependencies detected. Learn more about Socket for GitHub ↗︎ 🚮 Removed packages: npm/[email protected] |
JounQin
changed the title
LangAuto LangVariant although it's unsupportedLangVariant option LangAuto although it's unsupported
📊 Package size report 0.8%↑
Unchanged files
🤖 This report was automatically generated by pkg-size-action |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #107 +/- ##
=======================================
Coverage 96.25% 96.25%
=======================================
Files 4 4
Lines 80 80
Branches 32 32
=======================================
Hits 77 77
Misses 3 3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Co-authored-by: Copilot <[email protected]>
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
package.json (1)
52-52: Modified TypeScript build process.The build:tsc script has been updated to separate the compilation process into two steps: first compiling without declarations, then generating only the declarations without removing comments. This appears to be related to the GitHub issue mentioned in a previous review.
🧹 Nitpick comments (2)
src/types.ts (2)
39-46: Clarify "[Variant]" in the documentationThe comment "At this time, [Variant] does not support LangAuto" is unclear about what "[Variant]" refers to. It would be more helpful to specify exactly which component or function doesn't support this option.
- * At this time, [Variant] does not support LangAuto. + * At this time, the parser/interpreter does not support LangAuto.
152-153: Inconsistent comment styleAll other properties use JSDoc-style comments (
/**...*/), but this property uses a single-line comment (//). For consistency, consider using the same JSDoc style as the other properties.- // FunctionNextLine will place a function's opening braces on the next line. + /** + * FunctionNextLine will place a function's opening braces on the next line. + */
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (5)
.changeset/gentle-pets-prove.md(1 hunks)eslint.config.js(1 hunks)package.json(2 hunks)src/processor.ts(2 hunks)src/types.ts(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
- GitHub Check: Lint and Test with Node.js 20 on windows-latest
- GitHub Check: Lint and Test with Node.js 22 on windows-latest
- GitHub Check: Lint and Test with Node.js 18 on windows-latest
- GitHub Check: Lint and Test with Node.js 18 on windows-latest
- GitHub Check: Lint and Test with Node.js 20 on windows-latest
- GitHub Check: Lint and Test with Node.js 22 on windows-latest
- GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (9)
.changeset/gentle-pets-prove.md (1)
1-6: LGTM - The changeset file is correctly structured.The changeset file properly documents the new feature and follows the expected format for a patch release. It clearly indicates that a new
LangVariantoption calledLangAutois being added, while noting it's unsupported.src/processor.ts (2)
94-95: Appropriate ESLint directive for deprecated parameter.The ESLint directive is correctly added to suppress deprecation warnings for the
keepPaddingparameter, which aligns with its deprecated status in the codebase.
122-126: Improved comment formatting.The previously inline comment has been properly converted to a starred block comment, providing better readability while maintaining the same explanation about not awaiting the Go runtime promise.
eslint.config.js (2)
2-2: LGTM - New ESLint plugin imported.The stylistic plugin is correctly imported and will help enforce consistent code style.
9-16: New ESLint configuration for multiline comments.The new configuration properly sets up the stylistic plugin and enforces the starred-block style for multiline comments, which aligns with the comment formatting changes in the codebase.
package.json (1)
74-74: Added ESLint stylistic plugin dependency.The addition of
@stylistic/eslint-plugin-jsas a development dependency aligns with the ESLint configuration changes to enforce consistent multiline comment formatting.src/types.ts (3)
4-46: Good documentation for language variantsThe detailed documentation for all language variants is excellent. Each variant now has a clear description, information about its string representation, and version details where applicable. The new
LangAutooption is properly documented with a note about its current limitations.
52-96: Well-documented parser optionsThe comprehensive documentation for the
ShParserOptionsinterface properties significantly improves code understandability. The examples provided forstopAtandrecoverErrorsare particularly helpful for developers using this library.
100-151: Clear documentation for printer optionsThe detailed explanations for all printer options make the API much more user-friendly. The deprecation notice for
keepPaddingis also well-documented with information about when it will be removed and a reference to the relevant issue.
@coderabbitai Didn't I tell you that this repo uses |
|
Tip For best results, initiate chat on the files or code changes. @JounQin Yes, you're right - I have a stored learning that this repository uses Yarn v4.8.1 and that dependency warnings related to the package structure should be ignored as false positives. I apologize for the redundant comment. I'll ensure I don't comment on these package management issues for this PR and future PRs. 🧠 Learnings used |
Summary by CodeRabbit