Skip to content

chore: update README description#31

Merged
9romise merged 2 commits intonpmx-dev:mainfrom
RYGRIT:chore/README
Feb 6, 2026
Merged

chore: update README description#31
9romise merged 2 commits intonpmx-dev:mainfrom
RYGRIT:chore/README

Conversation

@RYGRIT
Copy link
Copy Markdown
Collaborator

@RYGRIT RYGRIT commented Feb 6, 2026

No description provided.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Feb 6, 2026

📝 Walkthrough

Walkthrough

This pull request updates documentation to change the description of the npmx.completion.excludePrerelease configuration option, extending the example list of prerelease identifiers from "alpha, beta, rc, canary" to "alpha, beta, rc, canary, etc." No code, behaviour, defaults or exported API are modified; the change is textual only.

🚥 Pre-merge checks | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Description check ❓ Inconclusive The pull request has no author-provided description; however, the PR objectives and commit messages clearly indicate the purpose of updating the excludePrerelease configuration description in both README and package.json. Add a brief pull request description explaining the changes, such as: 'Update excludePrerelease configuration description to include additional prerelease identifier examples (etc.)'. This helps maintainers understand the intent at a glance.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Member

@9romise 9romise left a comment

Choose a reason for hiding this comment

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

Thank you! But this part of README is auto-generated, so we should make changes in package.json instead.
https://github.com/npmx-dev/vscode-npmx/blob/main/package.json#L70

@RYGRIT
Copy link
Copy Markdown
Collaborator Author

RYGRIT commented Feb 6, 2026

Thank you! But this part of README is auto-generated, so we should make changes in package.json instead. https://github.com/npmx-dev/vscode-npmx/blob/main/package.json#L70

Okay, I'll adjust it.

@RYGRIT
Copy link
Copy Markdown
Collaborator Author

RYGRIT commented Feb 6, 2026

I found that automatically generating readmes leads to unnecessary updates, but there's no way to avoid it because changes in the length of the description text will increase the width of the entire markdown table accordingly.

@9romise
Copy link
Copy Markdown
Member

9romise commented Feb 6, 2026

I think this is fine. It’s only meant to improve readability when the md file is not rendered.

Copy link
Copy Markdown
Member

@9romise 9romise left a comment

Choose a reason for hiding this comment

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

Thank you! ❤️

@9romise 9romise merged commit 9081e3b into npmx-dev:main Feb 6, 2026
6 checks passed
@RYGRIT RYGRIT deleted the chore/README branch February 6, 2026 10:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants