feat: Add originalLineNumbers option for line number placement control #727
Conversation
This feature adds a new configuration option 'originalLineNumbers' and CLI flag '--output-original-line-numbers' that allows users to control when line numbers are added to the content. When enabled, line numbers are added to the original content before any transformations (like comment removal, empty line removal, or compression) are applied. - Added originalLineNumbers to configuration schema - Added --output-original-line-numbers CLI option - Refactored file processing logic to support the new option - Updated documentation - Added tests for the new functionality
![greptile-apps[bot]](https://cdn.statically.io/img/avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.
![gemini-code-assist[bot]](https://cdn.statically.io/img/avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @dorianjp, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request enhances the file processing capabilities by providing granular control over when line numbers are added to the output. Previously, line numbers were always added after content transformations. With this change, users can now choose to have line numbers applied to the original content before any modifications, which can be particularly useful for maintaining context when transformations like comment removal or compression are applied.
Highlights
- New Configuration Option: Introduced a new
originalLineNumbersboolean option within theoutputconfiguration, defaulting tofalse. This option controls whether line numbers are added to the content before or after transformations. - New CLI Flag: Added a corresponding
--output-original-line-numbersCLI flag to allow users to control this new behavior directly from the command line. - Refactored Processing Logic: The core file processing logic in
src/core/file/fileProcessContent.tshas been refactored. Line number addition is now conditional, occurring either at the very beginning of the processing pipeline (iforiginalLineNumbersis true) or after other transformations like comment/empty line removal and compression (iforiginalLineNumbersis false, maintaining the previous behavior). - Comprehensive Testing and Documentation: New unit and integration tests have been added to cover the various scenarios and interactions of the
originalLineNumbersfeature. TheREADME.mdand website documentation have also been updated to reflect the new option and its usage.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces a new originalLineNumbers option to control when line numbers are added during file processing. The implementation refactors the content processing logic and adds corresponding CLI options, configuration schema updates, tests, and documentation.
However, applying transformations after prepending line numbers breaks key features like code compression and empty line removal, as these tools expect valid source code, not text with arbitrary prefixes. These issues are critical and need to be addressed before this feature can be merged.
| if (manipulator) { | ||
| if (config.output.removeComments && typeof manipulator.removeComments === 'function') { | ||
| processedContent = manipulator.removeComments(processedContent); | ||
| } | ||
|
|
||
| if (config.output.removeEmptyLines && typeof manipulator.removeEmptyLines === 'function') { | ||
| processedContent = manipulator.removeEmptyLines(processedContent); | ||
| } | ||
| } |
There was a problem hiding this comment.
When originalLineNumbers is true, removeComments and removeEmptyLines will not function as expected. After adding line numbers, an originally empty line becomes a non-empty string like '42: '. The current implementation of removeEmptyLines will not identify this as an empty line to be removed.
This issue likely affects other manipulators as well, as they are designed to work on source code, not source code with line number prefixes. For example, block comment removal might fail if the start and end of the block are on different lines, each with a prefix.
To fix this, the manipulators would need to be aware of the line number prefixes and ignore them, which makes them more complex and brittle. A better approach might be to perform manipulations before adding line numbers.
| const result = await processContent(rawFile, config); | ||
| // Line numbers should be added before compression | ||
| expect(parseFile).toHaveBeenCalledWith('1: const x = 1;\n2: const y = 2;', rawFile.path, config); | ||
| expect(result).toBe('parsed content'); |
There was a problem hiding this comment.
This test is misleading as it tests a success path for a scenario that is fundamentally broken. When originalLineNumbers and compress are both true, parseFile is called with content that includes line numbers (e.g., '1: const x = 1;...'). This is not valid source code and will cause Tree-sitter to fail parsing.
The test mock for parseFile currently returns a successful result ('parsed content'), which hides the underlying issue. A more accurate test would:
- Mock
parseFileto throw an error when it receives content with line numbers. - Assert that
processContenteither handles this error gracefully (e.g., falls back to using the uncompressed content) or re-throws the error as expected.
As it stands, this test gives a false sense of security that the feature combination works correctly.
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughA new feature was added to the Repomix CLI and configuration: the ability to add line numbers to the original content before any processing occurs, controlled by the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant CLI
participant Config
participant FileProcessor
User->>CLI: Runs with --output-original-line-numbers
CLI->>Config: Merge CLI options into config
Config->>FileProcessor: Pass config with originalLineNumbers flag
FileProcessor->>FileProcessor: If originalLineNumbers, add line numbers before processing
FileProcessor->>FileProcessor: Process content (compression, comment removal, etc.)
FileProcessor->>User: Output content (with line numbers as per config)
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://cdn.statically.io/img/avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
…ations Added originalLineNumbers: false to all test mock configurations to fix TypeScript compilation errors after the originalLineNumbers feature was merged. This ensures all test configurations match the updated schema. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Extract the addLineNumbers helper function from processContent to improve code organization and reusability. The function is now exported and can be used by other modules if needed. Changes: - Move addLineNumbers function outside processContent - Add proper JSDoc documentation - Export function for potential reuse 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
|
@dorianjp I've made some minor adjustments to the code. Regarding the option name, since this option is dependent on |
Remove the unnecessary `?? false` fallback for config.output.originalLineNumbers since it already has a default value of false in the schema. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
|
I need to be cautious here since I'm not sure if compression (tree-sitter) will work correctly with this implementation. My initial assumption was that we would need to properly insert the original line numbers after compression within the compress function itself. |
Good call, I never tested that since I don't use the compression aspect. I found it speeds up LLM comprehension and edits by a huge factor with original line numbers, in fact some of the 'dumb' LLMs are effective now with accurate line numbers to go on, whereas before without line numbers or misleading line numbers they would just YOLO random shit or break similar but not the same code blocks for intentional edits. The 'new' line numbering actually trips up a few LLMs, which is why I made this PR. |
2 participants
Add originalLineNumbers option for line number placement control
Overview
This PR introduces a new configuration option
originalLineNumbersand CLI flag--output-original-line-numbersthat allows users to control when line numbers are added to the content during processing. When enabled, line numbers are added to the original content before any transformations (like comment removal, empty line removal, or compression) are applied.Changes
Configuration Schema
originalLineNumbersto the configuration schema insrc/config/configSchema.tsfalseCLI Option
--output-original-line-numbersCLI option insrc/cli/cliRun.tsCliOptionsinterface insrc/cli/types.tssrc/cli/actions/defaultAction.tsProcessing Logic
src/core/file/fileProcessContent.ts:addLineNumbersfunctionoriginalLineNumberssettingDocumentation
website/client/src/en/guide/configuration.mdwebsite/client/src/en/guide/command-line-options.mdTests
originalLineNumbersfeature intests/core/file/fileProcessContent.test.tstests/cli/actions/defaultAction.test.tstests/config/configSchema.test.tstests/core/file/fileProcess.test.tsFeature Behavior
The
originalLineNumbersfeature works as follows:When
showLineNumbersis false:originalLineNumberssettingWhen
showLineNumbersis true andoriginalLineNumbersis false:When
showLineNumbersis true andoriginalLineNumbersis true:Benefits
Preserves Original Line Numbers: When using features like comment removal or empty line removal, the original line numbers are preserved, making it easier to reference specific lines in the original file.
Better Compression Integration: When using compression with line numbers, the line numbers are included in the compressed output, providing context for the compressed code.
Improved Readability: Line numbers added before transformations can make it easier to understand how the transformations affected the content.
Usage Examples
Configuration File
{ "output": { "showLineNumbers": true, "originalLineNumbers": true, "removeComments": true } }CLI Command
Testing
All tests are passing. The implementation has been tested with various combinations of options to ensure it works correctly in all scenarios.