feat: enhance rule file loading with .roo/rules directory support #2354

upamune · 2025-04-06T17:38:22Z

Context

This PR enhances the custom instructions system by adding support for directory-based rule loading and improving the file handling functionality. The main goal is to allow users to organize their rules in directories (.roo/rules/ and .roo/rules-${mode}/) while maintaining backward compatibility with existing file-based rules (.roorules and .clinerules).

Design Doc: https://hackmd.io/@upamune/roo-rule-directory

Implementation

The changes introduce several new functions and modify existing ones to support directory-based rule loading:

Added directoryExists function to safely check if a directory exists
Added readTextFilesFromDirectory function to read all text files from a directory recursively
Added formatDirectoryContent function to format content from multiple files with proper headers
Enhanced loadRuleFiles to first check for .roo/rules/ directory before falling back to single file rules
Modified addCustomInstructions to support .roo/rules-${mode}/ directory for mode-specific rules

The implementation follows a progressive enhancement approach:

First tries to load rules from the new directory structure
Falls back to the existing single-file approach if directory-based rules are not found
Maintains consistent formatting of rule content regardless of the source

Key improvements:

Better organization of rules through directory structure
Support for multiple rule files in a single directory
Recursive file reading with proper error handling
Consistent formatting of rule content from different sources

How to Test

Create a new .roo/rules/ directory and add some rule files
Create a .roo/rules-${mode}/ directory (e.g., .roo/rules-dev/) and add mode-specific rule files
Verify that rules are properly loaded from both directories
Test fallback behavior by:
- Removing the directories and using .roorules and .clinerules files
- Using .roorules-${mode} and .clinerules-${mode} files for mode-specific rules
Verify that the content formatting is consistent across all sources

Get in Touch

I'm available in the Roo Code Discord for any questions or discussions about these changes. (serizawa_ )

Important

Enhance rule file loading by supporting .roo/rules/ directories, updating UI, tests, and translations for directory-based rule management.

Behavior:
- loadRuleFiles and addCustomInstructions now support loading rules from .roo/rules/ and .roo/rules-${mode}/ directories.
- Falls back to .roorules and .clinerules if directories are not found.
- Consistent formatting of rule content from directories and files.
Functions:
- Added directoryExists, readTextFilesFromDirectory, and formatDirectoryContent in custom-instructions.ts.
UI:
- Updated PromptsView.tsx to open rule files from new directory structure.
Tests:
- Enhanced tests in custom-instructions.test.ts to cover new directory-based rule loading.
Translations:
- Updated translation files to reflect new directory-based rule loading paths.

^{This description was created by}^{for 381d526. It will automatically update as commits are pushed.}

- Introduced functions to safely read files and check for directory existence. - Added capability to read all text files from a specified directory in alphabetical order. - Updated `loadRuleFiles` to prioritize loading rules from a `.roo/rules/` directory, falling back to existing rule files if necessary. - Enhanced `addCustomInstructions` to support loading mode-specific rules from a `.roo/rules-{mode}/` directory, improving flexibility in rule management. This change improves the organization and retrieval of rule files, allowing for better modularity and maintainability.

changeset-bot · 2025-04-06T17:38:25Z

⚠️ No Changeset found

Latest commit: 67dee67

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

upamune · 2025-04-06T17:42:55Z

@mrubens I would like you to review the Pull Request to confirm if the direction is aligned 😄 I am intentionally leaving .roomodes as is. This Pull Request is targeting only .roo/rules.
If the implementation direction and pull request content are acceptable, I will modify the tests and update the documentation.

mrubens

Seems on the right track to me! Let's do it.

mrubens · 2025-04-06T21:42:05Z

I just pushed a small change to update the promptsview and associated strings, hopefully not stepping on toes!

src/core/prompts/sections/custom-instructions.ts

webview-ui/src/components/prompts/PromptsView.tsx

webview-ui/src/i18n/locales/en/prompts.json

ellipsis-dev · 2025-04-07T13:38:17Z

src/core/prompts/sections/custom-instructions.ts

+/**
+ * Safely read a file and return its trimmed content
+ */
 async function safeReadFile(filePath: string): Promise<string> {


This function is identical to the existing implementation. Consider importing and reusing the existing function instead.

function safeReadFile (custom-system-prompt.ts)

mrubens · 2025-04-07T14:12:21Z

I'm not sure that the system prompt preview is loading the rules directories correctly

- Implemented functionality in `custom-instruction.ts` to handle loading rules from custom instruction paths. - Refactored and fixed previously incorrect logic in `custom-instruction.ts` for better reliability and maintainability. (comment in RooCodeInc#2354) - Enhanced `system.ts` to pass custom instruction paths to `addCustomInstructions`. - Extended `roo-code.d.ts` and `types.ts` to include `customInstructionsPaths` in `ModeConfig`. - Modified `index.ts` schema to define `customInstructionsPathsConfigSchema` and integrate it into `ModeConfig`. - Updated `modes.ts` to support `customInstructionsPaths` in mode configuration and full mode details.

* initial * More error handling and git option * Cleanup and tweaks * one small change * Update src/integrations/checkpoints/CheckpointUtils.ts Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com> --------- Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>

github-project-automation bot added this to Roo Code Roadmap Apr 6, 2025

github-project-automation bot moved this to New in Roo Code Roadmap Apr 6, 2025

mrubens reviewed Apr 6, 2025

View reviewed changes

Updated strings and translations

7eec9ac

mrubens reviewed Apr 6, 2025

View reviewed changes

src/core/prompts/sections/custom-instructions.ts Show resolved Hide resolved

mrubens reviewed Apr 6, 2025

View reviewed changes

webview-ui/src/components/prompts/PromptsView.tsx Show resolved Hide resolved

mrubens reviewed Apr 6, 2025

View reviewed changes

webview-ui/src/i18n/locales/en/prompts.json Show resolved Hide resolved

hannesrudolph moved this from New to PR [Pre Approval Review] in Roo Code Roadmap Apr 6, 2025

Add tests

381d526

mrubens marked this pull request as ready for review April 7, 2025 13:35

mrubens requested a review from cte as a code owner April 7, 2025 13:35

dosubot bot added size:XL This PR changes 500-999 lines, ignoring generated files. enhancement New feature or request labels Apr 7, 2025

ellipsis-dev bot reviewed Apr 7, 2025

View reviewed changes

mrubens added 2 commits April 7, 2025 09:39

Revert changes to system prompt translations

0d97c2c

Merge remote-tracking branch 'origin/main' into support-roo-directory

dbcb0b7

mrubens added 4 commits April 7, 2025 10:59

Fix path resolution

210a69a

Make instruction structure clearer

0670844

Merge remote-tracking branch 'origin/main' into support-roo-directory

579dcd5

Merge remote-tracking branch 'origin/main' into support-roo-directory

67dee67

mrubens approved these changes Apr 7, 2025

View reviewed changes

dosubot bot added the lgtm This PR has been approved by a maintainer label Apr 7, 2025

mrubens merged commit 580672f into RooCodeInc:main Apr 7, 2025
12 checks passed

github-project-automation bot moved this from PR [Pre Approval Review] to Done in Roo Code Roadmap Apr 7, 2025

mrubens mentioned this pull request Apr 7, 2025

Move .roorules to .roo/rules/ #2385

Merged

snoyiatk mentioned this pull request Apr 7, 2025

feat: Add support for custom instructions paths in custom mode config #2374

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: enhance rule file loading with .roo/rules directory support #2354

feat: enhance rule file loading with .roo/rules directory support #2354

Uh oh!

upamune commented Apr 6, 2025 •

edited by ellipsis-dev bot

Loading

Uh oh!

changeset-bot bot commented Apr 6, 2025 •

edited

Loading

Uh oh!

upamune commented Apr 6, 2025

Uh oh!

mrubens left a comment •

edited

Loading

Uh oh!

mrubens commented Apr 6, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ellipsis-dev bot Apr 7, 2025

Uh oh!

mrubens commented Apr 7, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

feat: enhance rule file loading with .roo/rules directory support #2354

feat: enhance rule file loading with .roo/rules directory support #2354

Uh oh!

Conversation

upamune commented Apr 6, 2025 • edited by ellipsis-dev bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Context

Implementation

How to Test

Get in Touch

Uh oh!

changeset-bot bot commented Apr 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

upamune commented Apr 6, 2025

Uh oh!

mrubens left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mrubens commented Apr 6, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ellipsis-dev bot Apr 7, 2025

Choose a reason for hiding this comment

Uh oh!

mrubens commented Apr 7, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

upamune commented Apr 6, 2025 •

edited by ellipsis-dev bot

Loading

changeset-bot bot commented Apr 6, 2025 •

edited

Loading

mrubens left a comment •

edited

Loading