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

rename to uHTTP #4

Merged
merged 9 commits into from
May 31, 2024
Merged

rename to uHTTP #4

merged 9 commits into from
May 31, 2024

Conversation

esterlus
Copy link
Member

@esterlus esterlus commented May 31, 2024

Summary by CodeRabbit

  • New Features

    • Introduced configuration settings for versioning and publishing.
    • Added initial implementation of uHTTP in the @hoprnet/uhttp-crypto package.
  • Updates

    • Renamed pHTTP-crypto to uHTTP-crypto throughout the project.
    • Updated deployment instructions for staging and production environments.
    • Enhanced tag input options in the GitHub Actions workflow.
  • Dependencies

    • Added @changesets/cli to devDependencies.

@esterlus esterlus requested a review from mjadach-iv May 31, 2024 11:59
Copy link

coderabbitai bot commented May 31, 2024

Walkthrough

Walkthrough

The update transitions the @hoprnet/phttp-crypto package to @hoprnet/uhttp-crypto, reflecting a shift in naming and functionality. This includes renaming constants, functions, and variables, updating documentation, and modifying deployment instructions. Configuration and workflow files are also introduced or updated to support the new naming and versioning system, ensuring smooth deployment and version management.

Changes

File/Path Change Summary
.changeset/README.md Added information about the @changesets/cli build tool for versioning and publishing code.
.changeset/config.json Introduced configuration settings for versioning and publishing, including changelog location and access restrictions.
.changeset/curly-hotels-joke.md Introduced an initial implementation of uHTTP in the @hoprnet/uhttp-crypto package.
.github/workflows/publish.yml Changed tag input type from string to choice with options latest and beta, defaulting to beta.
README.md Renamed from pHTTP-crypto to uHTTP-crypto and updated deployment instructions for staging and production.
package.json Updated package name, description, keyword, and added @changesets/cli to devDependencies.
src/index.ts Renamed constants, functions, and variables from pHTTP to uHTTP.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant GitHub Actions
    participant Changesets CLI
    participant Repository

    User->>GitHub Actions: Push changes
    GitHub Actions->>Changesets CLI: Trigger publish workflow
    Changesets CLI->>Repository: Update versioning and changelog
    Changesets CLI->>Repository: Commit changes
    Changesets CLI->>Repository: Publish to registry
    Repository-->>User: Deployment complete
Loading
sequenceDiagram
    participant Developer
    participant Codebase
    participant Documentation

    Developer->>Codebase: Rename pHTTP to uHTTP
    Developer->>Codebase: Update constants and functions
    Developer->>Documentation: Update README and deployment instructions
    Codebase-->>Developer: Refactoring complete
    Documentation-->>Developer: Documentation updated
Loading

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.
    • @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 as 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.

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.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 25ad932 and ca09e4f.

Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/*.lock
Files selected for processing (7)
  • .changeset/README.md (1 hunks)
  • .changeset/config.json (1 hunks)
  • .changeset/curly-hotels-joke.md (1 hunks)
  • .github/workflows/publish.yml (1 hunks)
  • README.md (1 hunks)
  • package.json (3 hunks)
  • src/index.ts (8 hunks)
Files skipped from review due to trivial changes (4)
  • .changeset/README.md
  • .changeset/config.json
  • .changeset/curly-hotels-joke.md
  • README.md
Additional context used
Biome
src/index.ts

[error] 15-15: This enum declaration contains members that are implicitly initialized.


[error] 152-152: This variable implicitly has the any type.


[error] 153-153: This variable implicitly has the any type.


[error] 163-163: This variable implicitly has the any type.


[error] 170-170: This variable implicitly has the any type.


[error] 218-218: Use !== instead of !=.
!= is only allowed when comparing against null


[error] 239-239: This variable implicitly has the any type.


[error] 256-256: This variable implicitly has the any type.


[error] 266-266: This variable implicitly has the any type.


[error] 306-306: This variable implicitly has the any type.


[error] 316-316: This variable implicitly has the any type.


[error] 367-367: This variable implicitly has the any type.


[error] 377-377: This variable implicitly has the any type.


[error] 397-397: Use === instead of ==.
== is only allowed when comparing against null


[error] 401-401: Use === instead of ==.
== is only allowed when comparing against null


[error] 1-2: Some named imports are only used as types.


[error] 48-48: Reassigning a function parameter is confusing.

Additional comments not posted (5)
.github/workflows/publish.yml (1)

6-11: Updated workflow dispatch options to use choice type for tag with options latest and beta, defaulting to beta.

package.json (2)

2-4: Updated package name and description to reflect the renaming to uHTTP.

Also applies to: 13-13


28-28: Added @changesets/cli to devDependencies for versioning and publishing.

src/index.ts (2)

25-26: Renaming from pHTTP to uHTTP applied consistently across constants and functions.

Also applies to: 89-89, 128-130, 181-181, 202-204, 288-290, 341-343


89-89: Updated cryptographic functions to use uHTTP_CRYPTO_VERSION and adjusted encryption/decryption logic.

Also applies to: 128-130, 181-181, 202-204, 288-290, 341-343

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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ca09e4f and de897aa.

Files selected for processing (1)
  • README.md (1 hunks)
Additional context used
LanguageTool
README.md

[uncategorized] ~10-~10: You might be missing the article “the” here.
Context: ... run yarn changeset version to create current changelog - commit everything, create...

Additional comments not posted (3)
README.md (3)

1-1: LGTM! The title has been updated to reflect the new project name.


3-3: LGTM! The description now accurately reflects the functionality of the uHTTP-crypto library.


5-18: The deployment instructions are clear and concise. However, consider adding more detailed steps or prerequisites for each deployment stage if necessary.

README.md Outdated
### Staging

- staging can be deployed from main
- run `yarn changeset version` to create current changelog
Copy link

Choose a reason for hiding this comment

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

Consider adding the definite article "the" before "current changelog" for grammatical correctness.

- run `yarn changeset version` to create current changelog
+ run `yarn changeset version` to create the current changelog
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.

Suggested change
- run `yarn changeset version` to create current changelog
run `yarn changeset version` to create the current changelog
Tools
LanguageTool

[uncategorized] ~10-~10: You might be missing the article “the” here.
Context: ... run yarn changeset version to create current changelog - commit everything, create...

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between de897aa and d70af3b.

Files selected for processing (1)
  • README.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • README.md

@esterlus esterlus merged commit 6627dc9 into main May 31, 2024
3 checks passed
@esterlus esterlus deleted the este/uhttp branch May 31, 2024 13:48
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