refactor: ♻️ Move prompt related entities to @prompt/domain #32
Conversation
WalkthroughThis pull request introduces several changes to the Changes
Possibly related PRs
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
tsconfig.base.json (1)
19-19: LGTM! Path consolidation aligns with domain-driven design.The consolidation of prompt-related entities under a single
@prompt/domainpath mapping is a good architectural decision that improves maintainability and follows domain-driven design principles.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (21)
libs/prompt/domain/README.md(1 hunks)libs/prompt/domain/eslint.config.js(1 hunks)libs/prompt/domain/jest.config.ts(1 hunks)libs/prompt/domain/project.json(1 hunks)libs/prompt/domain/src/index.ts(1 hunks)libs/prompt/domain/tsconfig.json(1 hunks)libs/prompt/domain/tsconfig.lib.json(1 hunks)libs/prompt/domain/tsconfig.spec.json(1 hunks)libs/prompt/domain/user-prompt-log-entity/README.md(0 hunks)libs/prompt/domain/user-prompt-log-entity/eslint.config.js(0 hunks)libs/prompt/domain/user-prompt-log-entity/project.json(0 hunks)libs/prompt/domain/user-prompt-log-entity/src/index.ts(0 hunks)libs/prompt/domain/user-prompt-log-entity/tsconfig.spec.json(0 hunks)libs/prompt/domain/wellbeing-prompt-entity/README.md(0 hunks)libs/prompt/domain/wellbeing-prompt-entity/eslint.config.js(0 hunks)libs/prompt/domain/wellbeing-prompt-entity/jest.config.ts(0 hunks)libs/prompt/domain/wellbeing-prompt-entity/project.json(0 hunks)libs/prompt/domain/wellbeing-prompt-entity/tsconfig.json(0 hunks)libs/prompt/domain/wellbeing-prompt-entity/tsconfig.lib.json(0 hunks)libs/user/domain/project.json(1 hunks)tsconfig.base.json(1 hunks)
💤 Files with no reviewable changes (11)
- libs/prompt/domain/user-prompt-log-entity/README.md
- libs/prompt/domain/user-prompt-log-entity/eslint.config.js
- libs/prompt/domain/user-prompt-log-entity/project.json
- libs/prompt/domain/user-prompt-log-entity/src/index.ts
- libs/prompt/domain/user-prompt-log-entity/tsconfig.spec.json
- libs/prompt/domain/wellbeing-prompt-entity/README.md
- libs/prompt/domain/wellbeing-prompt-entity/eslint.config.js
- libs/prompt/domain/wellbeing-prompt-entity/jest.config.ts
- libs/prompt/domain/wellbeing-prompt-entity/project.json
- libs/prompt/domain/wellbeing-prompt-entity/tsconfig.json
- libs/prompt/domain/wellbeing-prompt-entity/tsconfig.lib.json
✅ Files skipped from review due to trivial changes (6)
- libs/prompt/domain/README.md
- libs/prompt/domain/eslint.config.js
- libs/prompt/domain/project.json
- libs/prompt/domain/tsconfig.json
- libs/prompt/domain/tsconfig.spec.json
- libs/user/domain/project.json
🔇 Additional comments (5)
libs/prompt/domain/src/index.ts (1)
1-2: LGTM! Export statements are correctly structured.
The barrel exports align with the PR objective of consolidating prompt-related entities under @prompt/domain.
Let's verify the module structure and dependencies:
✅ Verification successful
Export statements are correctly implemented and modules exist
The verification confirms:
- Both exported modules exist in the correct location
- The interfaces are properly defined without circular dependencies
- The module structure aligns with the PR objective of consolidating prompt-related entities
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the module structure and check for potential circular dependencies
# Check if the module exists at the specified path
echo "Checking if the module exists..."
fd -t f "user-prompt-log-entity.(ts|js)" libs/prompt/domain/src/lib
# Look for potential circular dependencies
echo "Checking for circular dependencies..."
rg -l "from.*@prompt/domain" libs/prompt/domain/src/lib
Length of output: 340
Script:
#!/bin/bash
# Let's verify the content of the user-prompt-log-entity.ts and check its imports
echo "Content of user-prompt-log-entity.ts:"
cat libs/prompt/domain/src/lib/user-prompt-log-entity.ts
echo -e "\nChecking imports in wellbeing-prompt-entity.ts for potential circular dependencies:"
cat libs/prompt/domain/src/lib/wellbeing-prompt-entity.ts
Length of output: 832
libs/prompt/domain/tsconfig.lib.json (1)
5-5: LGTM! Verify path resolution in the new structure.
The updated output directory path correctly points to the dist directory at the repository root, which aligns with the project restructuring.
Let's verify the path resolution works in the new structure:
✅ Verification successful
Path resolution is correct and consistent with other domain libraries
The outDir path "../../../dist/out-tsc" in libs/prompt/domain/tsconfig.lib.json is correct because:
- It matches the path used in the parallel libs/user/domain/tsconfig.lib.json
- The directory structure confirms three levels up from libs/prompt/domain/ reaches the root
- It follows the same pattern as other domain libraries in the monorepo
- Only the shallower libs/config uses "../../dist/out-tsc" due to its different nesting level
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the existence and structure of the new project layout
# Check if we're in the expected project structure
fd -t d "prompt/domain" libs/
# Verify the path can be resolved from the current location
realpath --relative-to="$(pwd)/libs/prompt/domain" "$(pwd)/dist/out-tsc" | grep -q "^../../../dist/out-tsc$" && echo "Path resolution is correct" || echo "Path resolution is incorrect"
Length of output: 317
Script:
#!/bin/bash
# Let's try a different approach to verify the directory structure and path resolution
# Check if the project structure exists
ls -la libs/prompt/domain/
# Check the parent directories to verify relative path
ls -la libs/prompt/
ls -la libs/
ls -la ./
# Look for other tsconfig files to compare paths
find . -name "tsconfig*.json" -type f -exec grep -l "outDir" {} \;
Length of output: 3146
Script:
#!/bin/bash
# Let's check the outDir paths in other similar library configurations to verify consistency
# Check outDir in other library tsconfig.lib.json files
echo "=== libs/config/tsconfig.lib.json ==="
cat libs/config/tsconfig.lib.json
echo -e "\n=== libs/user/domain/tsconfig.lib.json ==="
cat libs/user/domain/tsconfig.lib.json
echo -e "\n=== libs/prompt/domain/tsconfig.lib.json ==="
cat libs/prompt/domain/tsconfig.lib.json
Length of output: 1241
libs/prompt/domain/jest.config.ts (2)
Line range hint 1-11: Verify test setup with the new configuration
The configuration looks complete with all necessary Jest properties. Let's ensure it works with the TypeScript setup.
#!/bin/bash
# Description: Verify TypeScript configuration for tests
# Check if tsconfig.spec.json exists in the prompt domain
fd --type f "tsconfig.spec.json" libs/prompt/domain/
# Verify test files exist
fd --type f --extension ts --extension spec.ts --extension test.ts libs/prompt/domain/2-3: LGTM! Configuration paths and naming look correct.
The updated paths and display name align well with the new domain structure. The relative paths are consistent throughout the configuration.
Let's verify the Jest configuration paths are correct:
Also applies to: 9-9
✅ Verification successful
Jest configuration paths are correct and properly set up
The verification confirms:
- The
jest.preset.jsexists at the repository root, validating the../../../jest.preset.jspath - The directory structure shows
libs/prompt/domain/exists at the correct level - The Jest configuration file is properly located at
libs/prompt/domain/jest.config.ts
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify Jest preset file exists and the coverage directory structure is valid
# Check if the Jest preset file exists at the specified location
if [ -f "jest.preset.js" ]; then
echo "Jest preset file found at repository root"
fi
# Verify the libs/prompt/domain directory structure
fd --type d --max-depth 3 "prompt" libs/
Length of output: 708
Script:
#!/bin/bash
# Let's verify the Jest configuration more thoroughly
# Check if jest.preset.js exists at the root
if [ -f "jest.preset.js" ]; then
echo "=== Jest preset file content ==="
cat jest.preset.js
fi
# Check the actual directory structure and related config files
echo -e "\n=== Directory structure ==="
fd --type d --max-depth 4 prompt libs/
echo -e "\n=== Related Jest configs ==="
fd jest.config.ts libs/prompt/
echo -e "\n=== TypeScript config ==="
fd tsconfig.json libs/prompt/domain/
Length of output: 615
tsconfig.base.json (1)
19-19: Verify updates to import statements across the codebase.
Since this change consolidates the paths from individual entity mappings to a single domain mapping, we should verify that all import statements have been updated accordingly.
✅ Verification successful
No import updates needed - path mapping is only referenced in tsconfig
The verification shows that the @prompt/domain path is only referenced in tsconfig.base.json and there are no actual imports using either the old paths (@prompt/user-prompt-log-entity, @prompt/wellbeing-prompt-entity) or the new path (@prompt/domain) in the codebase. This suggests this is a new path mapping being added to the configuration without any existing code dependencies to update.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Search for any remaining imports using the old paths that might need updating
echo "Checking for old import patterns..."
rg -l '@prompt/(user-prompt-log-entity|wellbeing-prompt-entity)' \
--type ts \
--type tsx \
--type js \
--type jsx
echo "Checking new import pattern usage..."
rg -l '@prompt/domain' \
--type ts \
--type tsx \
--type js \
--type jsx
Length of output: 393
Script:
#!/bin/bash
# Let's try with simpler ripgrep commands without file type filters
echo "Checking for old import patterns..."
rg -l '@prompt/(user-prompt-log-entity|wellbeing-prompt-entity)'
echo "Checking new import pattern usage..."
rg -l '@prompt/domain'
Length of output: 272
Script:
#!/bin/bash
# Let's check the actual content of files importing from @prompt paths
echo "Checking imports with context..."
rg -C 3 'from.*@prompt/'
# Also check for require statements
echo "Checking require statements..."
rg -C 3 "require.*@prompt/"
Length of output: 202
|
🎉 This PR is included in version 1.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
related #22
Summary by CodeRabbit
Release Notes
New Features
prompt-domainlibrary with setup and testing instructions.prompt-domainlibrary.Bug Fixes
Documentation
user-prompt-log-entityandwellbeing-prompt-entity.Chores