Add sprit option to list command

[noborus]

Summary by CodeRabbit

• New Features
  • Added a strip option to the list command, allowing users to strip newlines and join fields in the output.

[coderabbitai]

Walkthrough

The recent changes introduce a new strip parameter to the List and TSVList functions in cmd/list.go and jpugdoc/list.go. This parameter controls whether newlines are stripped and fields are joined. The strip parameter has been added to function signatures, variable declarations, and flag initializations, ensuring consistent handling across list generation and TSV output processes.

Changes

File Path	Change Summary
cmd/list.go	Added strip parameter to variable declarations and function calls. Updated flag initialization.
jpugdoc/list.go	Added strip parameter to List, list, writeCatalog, TSVList, tsvList, and writeTSV functions.

🐰
In code we trust, with changes bright,
A strip of newline, fields unite.
Functions tuned, with flags to guide,
Our lists and TSVs now stride.
Through lines of code, we hop with glee,
For clarity and order, we decree. 🌸

---

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1db6720 and b8f4290.

Files selected for processing (2)

• cmd/list.go (3 hunks)
• jpugdoc/list.go (4 hunks)

Additional comments not posted (8)

cmd/list.go (3)

Line range hint 16-41: The addition and handling of the strip flag are implemented correctly. Good use of consistent error handling for flag retrieval.

---

45-48: Integration of the strip flag into the command logic is correctly implemented. The flag is properly passed to the respective functions.

---

59-59: The initialization of the strip flag with appropriate defaults and description is well-implemented.

jpugdoc/list.go (5)

19-21: The update to the List function signature and the call to the list function to include the strip parameter are correctly implemented.

---

Line range hint 24-33: The use of the strip parameter in the list function to conditionally modify string handling is correctly implemented.

---

Line range hint 37-59: The integration of the strip parameter in the writeCatalog function and its use in conditionally modifying catalog entries are correctly implemented.

---

71-82: The addition of the strip parameter to the TSVList and tsvList functions and its correct usage within the tsvList function are well-implemented.

---

86-102: The use of the strip parameter in the writeTSV function to conditionally format the TSV output is correctly implemented.