feat: add templatesDir configuration option

[Romakita]

Summary by CodeRabbit

• New Features

  • Introduced a new property, templatesDir, for dynamically specifying the templates directory.
  • Enhanced asynchronous capabilities for component and file scanning, improving error management.

• Bug Fixes

  • Improved error handling during file imports and parsing processes.

• Refactor

  • Removed the writeTemplate method, streamlining the module's functionality related to template processing.

• Documentation

  • Updated configuration settings to centralize the templates directory management.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces several modifications across multiple files in the ts-doc package. Key changes include the addition of a templatesDir property in configuration objects, allowing for dynamic path resolution for template files. The scanComponents and scanFiles methods are updated to be asynchronous, enhancing their file handling capabilities. The buildApi function has been modified to utilize the new configuration parameter instead of hardcoded paths, and the writeTemplate method has been removed entirely, streamlining the module's functionality.

Changes

File Path	Change Summary
packages/ts-doc/bin/tsdoc.js	Added import for path; updated config object to include templatesDir.
packages/ts-doc/src/context/context.js	Added import for path; updated settings object to include templatesDir; added getter for templatesDir.
packages/ts-doc/src/scan/scan.js	Updated scanComponents and scanFiles methods to be asynchronous; improved error handling.
packages/ts-doc/src/tasks/build-api.js	Removed writeTemplate call; updated buildApi to use config.templatesDir instead of hardcoded path.
packages/ts-doc/src/write/write.js	Removed writeTemplate method entirely.
packages/ts-doc/test/utils.js	Added import for path; updated context.settings to include templatesDir; modified scanComponents call.

Possibly related PRs

• feat: support esm project to parse documentation #30: The changes in the main PR regarding the addition of the templatesDir property in the config object are related to the updates in the context.js file, which also introduces a templatesDir property in the settings object, indicating a shared focus on template directory configuration.

Poem

🐇 In the land of code where templates lie,
A new path emerges, reaching for the sky.
With async magic, we scan and we write,
Errors caught softly, our futures look bright.
So hop along, dear friends, let’s cheer and play,
For the templatesDir is here to stay! 🌟

---

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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

[Romakita]

🎉 This PR is included in version 4.3.0 🎉

The release is available on:

• v4.3.0
• GitHub release

Your semantic-release bot 📦🚀