Feature/compiler improvements

[0xF6]

Summary by CodeRabbit

• New Features

  • Enhanced error messages to include the full path of the project file when not found.
  • Introduced support for NO_CONSOLE environment variable to disable console output.

• Refactor

  • Improved readability and maintainability of various methods and assignments.
  • Updated label definitions in code generation for better clarity.

• Bug Fixes

  • Adjusted OutputEncoding for Windows to ensure correct display of characters.

• Tests

  • Updated tests to use more specific GeneratorContext configurations and named labels for clarity.

[coderabbitai]

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

Commits

Files that changed from the base of the PR and between de680fa and e69e5d5.

Files selected for processing (1)

• test/vc_test/generator_test.cs (4 hunks)

 ______________________________
< torvalds@linux:~$ git review >
 ------------------------------
  \
   \   \
        \ /\
        ( )
      .( o ).

Walkthrough

The update introduces several key enhancements: environmental control for console output, refactoring for clarity and improved code readability, more robust project file error messaging, and refined array handling in method returns. Additionally, constructors in test files now accommodate new configuration requirements, and label definitions in code generation components are explicitly named for greater clarity. New configuration and utility functionalities are also added, such as the RawConsole class for ANSI console support.

Changes

File	Change Summary
compiler/Program.cs	Added environment check for "NO_CONSOLE", refactored skipIntro, updated Windows OutputEncoding.
compiler/RawConsole.cs	Introduced RawConsole class with Create method to configure ANSI console settings.
compiler/cmd/CompileCommand.cs	Enhanced error messaging to include the full path of the missing project file.
compiler/compilation/parts/props.cs	Refactored getArgList method's return statements to use efficient array literals and Array.Empty<VeinArgumentRef>().
test/vc_test/expression_test.cs	Updated GeneratorContext instantiation to use GeneratorContextConfig object with a true parameter.
test/vc_test/generator_test.cs	Explicitly named labels in code generation for better clarity, updated GeneratorContext instantiation.
test/vc_test/il_test.cs	Modified DefineLabel method calls to use explicit string labels in DeconstructOpcodes3.

Poem

In code and test, a dance we see,
Refactors flow with simple glee,
Labels named and functions clear,
An ANSI console now we cheer,
Settings bright, the path refined,
Errors shout the file we need to find.
So here we sing of updates neat,
A bunny’s work, a coder’s feat.

---

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

[coderabbitai]

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 889c259 and de680fa.

Files selected for processing (7)

• compiler/Program.cs (1 hunks)
• compiler/RawConsole.cs (1 hunks)
• compiler/cmd/CompileCommand.cs (1 hunks)
• compiler/compilation/parts/props.cs (2 hunks)
• test/vc_test/expression_test.cs (2 hunks)
• test/vc_test/generator_test.cs (4 hunks)
• test/vc_test/il_test.cs (1 hunks)

Files not reviewed due to errors (1)

• test/vc_test/expression_test.cs (no review received)

Files skipped from review due to trivial changes (1)

• compiler/cmd/CompileCommand.cs

Additional comments not posted (5)

compiler/RawConsole.cs (1)

5-20: Well-implemented RawConsole class for non-interactive console environments.

The implementation of the RawConsole class is concise and adheres to the principles of single responsibility and encapsulation. The Create method correctly configures the AnsiConsole for environments where ANSI support and interactive features are not desired. This is particularly useful for logging or running scripts in environments that do not support ANSI codes.

compiler/compilation/parts/props.cs (1)

52-58: Refactor of array initializations in getArgList enhances readability and performance.

The use of Array.Empty<VeinArgumentRef>() instead of creating a new empty array each time is a good practice as it avoids unnecessary memory allocation. Similarly, the use of simplified array initializers (new[] { val_ref } instead of new VeinArgumentRef[] { val_ref }) makes the code cleaner and more readable.

test/vc_test/il_test.cs (1)

64-65: Use of explicit label names improves readability and maintainability of test cases.

The update to use explicit names for labels ("1", "2") in DeconstructOpcodes3 enhances the readability of the test code, making it easier to understand the flow and purpose of each label. This is especially useful in complex test scenarios where the flow of execution can be hard to follow.

test/vc_test/generator_test.cs (2)

251-251: Approved label naming for clarity.

Using "while" as a label name clearly describes its usage in the loop, improving code readability.

---

190-190: Good use of configuration object in generator context instantiation.

Introducing a configuration object enhances the modularity and configurability of the generator context, aligning with best practices for scalable and maintainable code.