feat: add lineMode option to parser for flexible line formatting

[cheton]

PR Type

enhancement, documentation

---

Description

• Introduced a new lineMode option in the parser to allow different formats for parsed lines: 'original', 'minimal', and 'compact'.
• Updated the parsing logic to accommodate the new lineMode option, replacing the old noParseLine option.
• Enhanced the stripComments function to separate comment stripping and whitespace removal.
• Adjusted test cases to reflect the changes in parsing options, removing outdated tests.
• Updated the README documentation to explain the new lineMode option and provide usage examples.

---

Changes walkthrough 📝

	Relevant files
Enhancement	index.js Add lineMode option for flexible line parsing                        src/index.js Introduced lineMode option to control line parsing format. Replaced noParseLine with lineMode for more flexibility. Added functions to strip comments and whitespace separately. Updated parsing logic to handle different lineMode settings. +27/-24
Tests	index.test.js Update tests for lineMode option                                                  src/tests/index.test.js Removed test case for noParseLine option. Adjusted tests to align with new lineMode functionality. +0/-18
Documentation	README.md Document lineMode option and usage examples                            README.md Updated documentation to describe lineMode option. Removed references to deprecated noParseLine option. Provided examples for different lineMode settings. +19/-7

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪

🧪 PR contains tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Code Duplication The comment stripping logic in stripComments function has duplicate code blocks for handling parentheses and semicolon comments. Consider extracting the common functionality into a helper function. Error Handling The lineMode option validation is missing. Invalid values could be passed without any error or warning to the user. Potential Bug The comments array is used before it's defined. The code accesses comments.length but comments is only created in the stripComments function.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.69%. Comparing base (dccc721) to head (03e21aa).
Report is 1 commits behind head on master.

Additional details and impacted files

@@ Coverage Diff @@ ## master #7 +/- ## ========================================== + Coverage 92.39% 92.69% +0.29%  ========================================== Files 1 1 Lines 171 178 +7 ========================================== + Hits 158 165 +7  Misses 13 13 

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

---

🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests
• JS Bundle Analysis - Avoid shipping oversized bundles

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
General	✅ Add input validation to prevent invalid configuration values The lineMode validation is missing. Add input validation to ensure only valid values ('original', 'minimal', 'compact') are accepted. src/index.js [105] -options.lineMode = options.lineMode ?? 'original'; // One of: 'original', 'minimal', 'compact' +const validLineModes = ['original', 'minimal', 'compact']; +if (!validLineModes.includes(options.lineMode)) { + options.lineMode = 'original'; +} [Suggestion has been applied] Suggestion importance[1-10]: 7 Why: This is a valid suggestion that would improve code robustness by preventing invalid lineMode values from being used. Input validation is important for configuration options to prevent runtime errors.	7

💡 Need additional feedback ? start a PR chat

[cheton]

/ask Enhance the test coverage for lineMode option.

[codiumai-pr-agent-free]

Ask❓

Enhance the test coverage for lineMode option.

Answer:

To enhance the test coverage for the lineMode option, you can add new test cases that specifically verify the behavior of the parser with each lineMode setting: 'original', 'minimal', and 'compact'. Here are some suggestions for test cases:

1. Test for 'original' mode:

   • Verify that the parser returns the line exactly as it is, including comments and whitespace.
   • Example:

     it('should return the original line with comments and whitespace in original mode', (done) => { const line = 'G0 X0 Y0 ; comment'; const result = parseLine(line, { lineMode: 'original' }); expect(result.line).toBe('G0 X0 Y0 ; comment'); expect(result.words).toEqual([['G', 0], ['X', 0], ['Y', 0]]); done(); });

2. Test for 'minimal' mode:

   • Verify that the parser returns the line without comments but retains whitespace.
   • Example:

     it('should return the line without comments but with whitespace in minimal mode', (done) => { const line = 'G0 X0 Y0 ; comment'; const result = parseLine(line, { lineMode: 'minimal' }); expect(result.line).toBe('G0 X0 Y0'); expect(result.words).toEqual([['G', 0], ['X', 0], ['Y', 0]]); done(); });

3. Test for 'compact' mode:

   • Verify that the parser returns the line without comments and without any whitespace.
   • Example:

     it('should return the line without comments and whitespace in compact mode', (done) => { const line = 'G0 X0 Y0 ; comment'; const result = parseLine(line, { lineMode: 'compact' }); expect(result.line).toBe('G0X0Y0'); expect(result.words).toEqual([['G', 0], ['X', 0], ['Y', 0]]); done(); });

4. Edge cases:

   • Test with lines that have no comments or whitespace to ensure the modes don't alter the line unnecessarily.
   • Test with lines that are only comments to ensure they are stripped correctly in 'minimal' and 'compact' modes.

By adding these tests, you can ensure that the lineMode option behaves as expected across different scenarios.