add duplicate command warning

[trajan0x]

Description

adds duplicate command warning

Summary by CodeRabbit

• New Features

  • Enhanced command processing to prevent duplicate command names, improving clarity and usability.

• Bug Fixes

  • Added logic to skip duplicate commands, ensuring a cleaner command list for users.

[coderabbitai]

Walkthrough

The changes involve the addition of a new import statement and modifications to the pruneShellCommands function in the core/commandline/shell.go file. A string set named nameSet is introduced to track command names, preventing duplicates from being included in the prunedCommands list. The function now checks for existing command names in nameSet and prints a message if a duplicate is found, altering the command processing logic.

Changes

Files	Change Summary
core/commandline/shell.go	Added import for k8s.io/apimachinery/pkg/util/sets. Modified pruneShellCommands to include a check for duplicate command names using a new nameSet.

Poem

In the shell where commands play,
A rabbit hops and clears the way.
No more duplicates to confuse,
Just tidy commands, we shall choose!
With a set to keep things neat,
Our shell commands are now a treat! 🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>, please review it.
  -- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  -- @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.
  -- @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 5 lines in your changes missing coverage. Please review.

Project coverage is 36.30561%. Comparing base (9418b40) to head (ed0393f).
Report is 18 commits behind head on master.

Files with missing lines	Patch %	Lines
core/commandline/shell.go	0.00000%	5 Missing ⚠️

❗ There is a different number of reports uploaded between BASE (9418b40) and HEAD (ed0393f). Click for more details.

HEAD has 2 uploads less than BASE

Flag	BASE (9418b40)	HEAD (ed0393f)
solidity	2	0

Additional details and impacted files

@@                 Coverage Diff                 @@
##              master       #3174         +/-   ##
===================================================
- Coverage   41.54443%   36.30561%   -5.23882%     
===================================================
  Files            460         438         -22     
  Lines          25770       25536        -234     
  Branches         357          82        -275     
===================================================
- Hits           10706        9271       -1435     
- Misses         14326       15520       +1194     
- Partials         738         745          +7     

Flag	Coverage Δ
cctp-relayer	31.97848% <ø> (ø)
core	58.62877% <0.00000%> (-0.08602%)	⬇️
ethergo	47.16284% <ø> (-0.23753%)	⬇️
git-changes-action	23.48315% <ø> (ø)
omnirpc	33.16087% <ø> (ø)
opbot	0.48870% <ø> (ø)
promexporter	6.81642% <ø> (?)
screener-api	29.45990% <ø> (ø)
scribe	18.24614% <ø> (ø)
solidity	?
tools	30.55118% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Actionable comments posted: 2

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0daec70 and ed0393f.

Files selected for processing (1)

• core/commandline/shell.go (2 hunks)

[coderabbitai]

Consider using the standard library instead of Kubernetes package for set implementation.

While the k8s.io/apimachinery/pkg/util/sets package provides a convenient set implementation, it might be overkill for this use case, especially if this is not a Kubernetes-related project. Consider using the standard library's map[string]struct{} for a simple set implementation.

Here's an alternative implementation using the standard library:

nameSet := make(map[string]struct{})

// To add an item to the set:
nameSet[itemName] = struct{}{}

// To check if an item exists in the set:
_, exists := nameSet[itemName]

This approach achieves the same functionality without introducing an external dependency.

[coderabbitai]

Fix logical error in duplicate command handling

The current implementation has a logical error that results in skipping all commands except duplicates, which is the opposite of the intended behavior. Additionally, the warning message is printed for non-duplicate commands instead of duplicate ones.

To fix this, please apply the following changes:

 nameSet := sets.NewString()
 for _, command := range commands {
     if command.Name != shellCommandName {
-        prunedCommands = append(prunedCommands, command)
-    }
-    if !nameSet.Has(command.Name) {
-        fmt.Printf("Command %s already exists, skipping\n", command.Name)
-    }
-
-    nameSet.Insert(command.Name)
+        if nameSet.Has(command.Name) {
+            fmt.Printf("Command %s already exists, skipping\n", command.Name)
+        } else {
+            prunedCommands = append(prunedCommands, command)
+            nameSet.Insert(command.Name)
+        }
+    }
 }

This change ensures that:

1. Only non-shell commands are considered.
2. Duplicate commands are skipped and a warning is printed.
3. Non-duplicate commands are added to prunedCommands and their names are inserted into the nameSet.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	nameSet := sets.NewString()
	for _, command := range commands {
	if command.Name != shellCommandName {
	prunedCommands = append(prunedCommands, command)
	}
	if !nameSet.Has(command.Name) {
	fmt.Printf("Command %s already exists, skipping\n", command.Name)
	}
	nameSet.Insert(command.Name)
	}
	nameSet := sets.NewString()
	for _, command := range commands {
	if command.Name != shellCommandName {
	if nameSet.Has(command.Name) {
	fmt.Printf("Command %s already exists, skipping\n", command.Name)
	} else {
	prunedCommands = append(prunedCommands, command)
	nameSet.Insert(command.Name)
	}
	}
	}

[cloudflare-workers-and-pages]

Deploying sanguine-fe with    Cloudflare Pages

Latest commit:	ed0393f
Status:	✅  Deploy successful!
Preview URL:	https://ebcdc226.sanguine-fe.pages.dev
Branch Preview URL:	https://fix-add-dupl-warn.sanguine-fe.pages.dev

View logs