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

refactor: use flake instead of devbox #45

Merged
merged 9 commits into from
Jun 8, 2024
Merged

refactor: use flake instead of devbox #45

merged 9 commits into from
Jun 8, 2024

Conversation

kwaa
Copy link
Member

@kwaa kwaa commented Jun 7, 2024

#18

Summary by CodeRabbit

  • New Features

    • Introduced a new development environment configuration using flake for better integration and management.
  • Chores

    • Updated .gitignore to include exclusions for .direnv and .devenv directories.
    • Removed exclusion for .devbox in .gitignore.
    • Added configurations for Rust language support and specific toolchain settings in devenv.nix.
    • Reordered components in rust-toolchain.toml for better clarity and updated the information link.

@kwaa kwaa added the enhancement New feature or request label Jun 7, 2024
Copy link

coderabbitai bot commented Jun 7, 2024

Walkthrough

The recent updates have revamped the development environment setup by replacing the previous devbox configuration with a new flake-based setup. The .gitignore file has been adjusted to reflect these changes, and new configurations for the development environment and Rust toolchain have been introduced. This overhaul aims to streamline the development process, enhance tool integration, and improve project configuration management.

Changes

File Change Summary
.envrc Replaced devbox environment integration via direnv with a new flake-based configuration.
.gitignore Updated to exclude .direnv and .devenv, and removed the exclusion for .devbox.
devenv.nix Introduced configurations for a development environment "hatsu" with Rust support and tool setup.
flake.nix Added Nix flake configuration, defining inputs, configurations, and outputs for the project.
rust-toolchain.toml Reordered Rust toolchain components and updated the information link.

Poem

In the code's serene embrace,
Flakes now guide our dev space.
Rusty tools aligned in cheer,
Mold and sccache, ever near.
Gitignore's new attire,
Hatsu's flames rise higher.
CodeRabbit hops with glee,
In this flake-filled harmony.


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.

@kwaa kwaa marked this pull request as ready for review June 8, 2024 08:22
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: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 289f7f4 and 549a000.

Files ignored due to path filters (2)
  • devbox.lock is excluded by !**/*.lock
  • flake.lock is excluded by !**/*.lock
Files selected for processing (5)
  • .envrc (1 hunks)
  • .gitignore (1 hunks)
  • devenv.nix (1 hunks)
  • flake.nix (1 hunks)
  • rust-toolchain.toml (1 hunks)
Files skipped from review due to trivial changes (2)
  • .gitignore
  • rust-toolchain.toml
Additional comments not posted (5)
.envrc (1)

1-1: Looks good! Ensure that the devenv-root path is correctly set up as this configuration is crucial for the environment setup.

devenv.nix (2)

3-12: The dynamic configuration of the Rust toolchain using an external TOML file enhances maintainability and flexibility. Good job!


21-27: The setup of Rust-related tools is correctly implemented. Using with pkgs; simplifies the syntax and improves readability.

flake.nix (2)

22-25: The configuration for extra trusted public keys and substituters is set up correctly, enhancing both security and performance.


27-61: The outputs are well-structured, using mkFlake for modular configuration. Ensure that the default settings for shells meet the project's requirements.

Comment on lines +14 to +18
imports = [
# This is just like the imports in devenv.nix.
# See https://devenv.sh/guides/using-with-flake-parts/#import-a-devenv-module
# ./devenv-foo.nix
];
Copy link

Choose a reason for hiding this comment

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

The imports are commented out. If these are not needed, consider removing them to clean up the code.

Comment on lines +4 to +20
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";

devenv-root.url = "file+file:///dev/null";
devenv-root.flake = false;
devenv.url = "github:cachix/devenv";

flake-parts.url = "github:hercules-ci/flake-parts";

fenix.url = "github:nix-community/fenix/monthly";
fenix.inputs.nixpkgs.follows = "nixpkgs";

# nix2container.url = "github:nlewo/nix2container";
# nix2container.inputs.nixpkgs.follows = "nixpkgs";

# mk-shell-bin.url = "github:rrbutani/nix-mk-shell-bin";
};
Copy link

Choose a reason for hiding this comment

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

The inputs are well-defined with clear URLs and follow settings. If the commented-out inputs are not needed, consider removing them to avoid confusion.

@kwaa kwaa merged commit 7d49aef into main Jun 8, 2024
1 check passed
@kwaa kwaa deleted the refactor/flake branch June 8, 2024 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant