Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support allow scopes #3

Merged
merged 4 commits into from
May 18, 2024
Merged

feat: support allow scopes #3

merged 4 commits into from
May 18, 2024

Conversation

fengmk2
Copy link
Member

@fengmk2 fengmk2 commented May 18, 2024

cnpm/cnpmcore#686

Summary by CodeRabbit

  • Documentation

    • Updated README to specify the addition of @eggjs to the allowed scopes.
  • Tests

    • Improved scope validation by renaming variables and adding a new loop to count and validate scopes.

@fengmk2 fengmk2 marked this pull request as draft May 18, 2024 05:11
Copy link

coderabbitai bot commented May 18, 2024

Walkthrough

The recent update introduces a scope to the whitelist in the README.md, specifically adding @eggjs to the allowScopes. Additionally, the test/index.js file sees a renaming of the count variable to packages, alongside the addition of a loop to iterate and validate scopes within pkg.allowScopes.

Changes

File Change Summary
README.md Added @eggjs to the whitelist in "allowScopes".
.../test/... Renamed count to packages and added a loop for validating pkg.allowScopes.

In code we trust, with changes bright,
New scopes take flight, in the night.
Variables dance, in tests they gleam,
A rabbit's dream, in lines of stream.
🎩🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@fengmk2 fengmk2 marked this pull request as ready for review May 18, 2024 06:36
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Out of diff range and nitpick comments (3)
README.md (3)

Line range hint 48-48: Remove multiple consecutive blank lines to maintain clean and consistent formatting.


Line range hint 6-6: Consider using Markdown to format the bare URL to improve readability and aesthetics.

- [https://github.com/cnpm/unpkg-white-list/actions/workflows/nodejs.yml]
+ [CI](https://github.com/cnpm/unpkg-white-list/actions/workflows/nodejs.yml)

Line range hint 45-45: Add alternate text to the image for better accessibility.

- <img src="https://avatars.githubusercontent.com/u/156269?v=4" width="100px;"/>
+ <img src="https://avatars.githubusercontent.com/u/156269?v=4" width="100px;" alt="Contributor: fengmk2"/>
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 1a4666a and 957490e.
Files selected for processing (2)
  • README.md (1 hunks)
  • test/index.js (2 hunks)
Additional comments not posted (3)
README.md (1)

25-33: The addition of the allowScopes section clearly explains how to add scoped packages to the whitelist.

test/index.js (2)

13-13: Renaming count to packages improves clarity by better reflecting what the variable represents.


30-40: The new loop for iterating over pkg.allowScopes is correctly implemented and includes comprehensive checks and assertions.

@fengmk2 fengmk2 merged commit 6e1b821 into master May 18, 2024
4 checks passed
@fengmk2 fengmk2 deleted the allow-scopes branch May 18, 2024 06:38
fengmk2 pushed a commit that referenced this pull request May 18, 2024
[skip ci]

## [1.2.0](v1.1.0...v1.2.0) (2024-05-18)

### Features

* support allow scopes ([#3](#3)) ([6e1b821](6e1b821))
@coderabbitai coderabbitai bot mentioned this pull request Jun 5, 2024
@coderabbitai coderabbitai bot mentioned this pull request Dec 12, 2024
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.

1 participant