fix(cli): Added parent directory check

[Princeyadav05]

User description

Description

Add directory creation to configuration write functions to prevent CLI errors when parent folders don't exist.

Fixes #320

Dependencies

No new dependencies added. Using existing fs/promises and path modules.

Future Improvements

NA

Mentions

NA

Screenshots of relevant screens

N/A - CLI functionality update

Developer's checklist

• My PR follows the style guidelines of this project
• I have performed a self-check on my work

If changes are made in the code:

• I have followed the coding guidelines
• My changes in code generate no new warnings
• My changes are breaking another fix/feature of the project
• I have added test cases to show that my feature works
• I have added relevant screenshots in my PR
• There are no UI/UX issues

Documentation Update

• This PR requires an update to the documentation at docs.keyshade.xyz
• I have made the necessary updates to the documentation, or no documentation changes are required.

---

PR Type

Bug fix, Enhancement

---

Description

• Added ensureDirectoryExists function to ensure parent directories are created if they do not exist.
• Updated writeProfileConfig, writePrivateKeyConfig, and writeProjectRootConfig functions to call ensureDirectoryExists before writing files.
• This prevents CLI errors when parent folders do not exist.

---

Changes walkthrough 📝

	Relevant files
Enhancement	configuration.ts Add directory creation check to configuration write functions apps/cli/src/util/configuration.ts Added ensureDirectoryExists function to create parent directories if they do not exist. Updated writeProfileConfig, writePrivateKeyConfig, and writeProjectRootConfig functions to call ensureDirectoryExists. +6/-0

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review Missing Error Handling The function ensureDirectoryExists does not handle any errors that might occur during directory creation. Consider adding try-catch blocks around the mkdir call to handle potential exceptions and provide meaningful error messages to the user.

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Category	Suggestion	Score
Error handling	✅ Handle errors in directory creation to improve robustness Suggestion Impact: The suggestion to handle potential errors during directory creation was implemented by introducing a new function `ensureDirectoryExists` which likely includes error handling, and this function was then used in place of the direct `mkdir` calls. code diff: +import { ensureDirectoryExists } from './fileUtils.ts'; export const getOsType = (): 'unix' | 'windows' => { return process.platform === 'win32' ? 'windows' : 'unix' @@ -59,7 +60,7 @@ config: ProfileConfig ): Promise<void> => { const path = getProfileConfigurationFilePath() - ensureDirectoryExists(path); + await ensureDirectoryExists(path); await writeFile(path, JSON.stringify(config, null, 2), 'utf8') } @@ -67,7 +68,7 @@ config: PrivateKeyConfig ): Promise<void> => { const path = getPrivateKeyConfigurationFilePath() - ensureDirectoryExists(path); + await ensureDirectoryExists(path); await writeFile(path, JSON.stringify(config, null, 2), 'utf8') } @@ -83,8 +84,4 @@ const path = `${process.env[home]}/.keyshade` const files = await readdir(path) return `- ${files.join('\n- ')}` -} - -async function ensureDirectoryExists(path: string): Promise<void> { - await mkdir(dirname(path), { recursive: true }) -} +} To handle potential errors that could occur during directory creation, wrap the mkdir call in a try-catch block. apps/cli/src/util/configuration.ts [89] -await mkdir(dirname(path), { recursive: true }) +try { + await mkdir(dirname(path), { recursive: true }) +} catch (error) { + console.error('Failed to create directory:', error); +} Apply this suggestion Suggestion importance[1-10]: 10 Why: Wrapping the mkdir call in a try-catch block is crucial for error handling, ensuring the application can handle potential failures gracefully.	10
Performance	✅ Add a check to see if the directory exists before creating it Suggestion Impact: The commit introduced a new function `ensureDirectoryExists` which encapsulates the logic to check if a directory exists before creating it. This function was then used in place of the original directory creation calls, effectively implementing the suggestion. code diff: +import { ensureDirectoryExists } from './fileUtils.ts'; export const getOsType = (): 'unix' | 'windows' => { return process.platform === 'win32' ? 'windows' : 'unix' @@ -59,7 +60,7 @@ config: ProfileConfig ): Promise<void> => { const path = getProfileConfigurationFilePath() - ensureDirectoryExists(path); + await ensureDirectoryExists(path); await writeFile(path, JSON.stringify(config, null, 2), 'utf8') } @@ -67,7 +68,7 @@ config: PrivateKeyConfig ): Promise<void> => { const path = getPrivateKeyConfigurationFilePath() - ensureDirectoryExists(path); + await ensureDirectoryExists(path); await writeFile(path, JSON.stringify(config, null, 2), 'utf8') } @@ -83,8 +84,4 @@ const path = `${process.env[home]}/.keyshade` const files = await readdir(path) return `- ${files.join('\n- ')}` -} - -async function ensureDirectoryExists(path: string): Promise<void> { - await mkdir(dirname(path), { recursive: true }) -} Consider checking if the directory already exists before attempting to create it. This can prevent unnecessary operations and improve efficiency. apps/cli/src/util/configuration.ts [89] -await mkdir(dirname(path), { recursive: true }) +if (!existsSync(dirname(path))) { + await mkdir(dirname(path), { recursive: true }) +} Apply this suggestion Suggestion importance[1-10]: 9 Why: This suggestion improves performance by avoiding unnecessary directory creation operations. It is a logical enhancement to the existing code.	9
Maintainability	✅ Move ensureDirectoryExists to a common utilities file to reduce code duplication Suggestion Impact: The function ensureDirectoryExists was moved to a common utilities file (fileUtils.ts) and imported where needed, reducing code duplication. code diff: +import { ensureDirectoryExists } from './fileUtils.ts'; export const getOsType = (): 'unix' | 'windows' => { return process.platform === 'win32' ? 'windows' : 'unix' @@ -59,7 +60,7 @@ config: ProfileConfig ): Promise<void> => { const path = getProfileConfigurationFilePath() - ensureDirectoryExists(path); + await ensureDirectoryExists(path); await writeFile(path, JSON.stringify(config, null, 2), 'utf8') } @@ -67,7 +68,7 @@ config: PrivateKeyConfig ): Promise<void> => { const path = getPrivateKeyConfigurationFilePath() - ensureDirectoryExists(path); + await ensureDirectoryExists(path); await writeFile(path, JSON.stringify(config, null, 2), 'utf8') } @@ -83,8 +84,4 @@ const path = `${process.env[home]}/.keyshade` const files = await readdir(path) return `- ${files.join('\n- ')}` -} - -async function ensureDirectoryExists(path: string): Promise<void> { - await mkdir(dirname(path), { recursive: true }) -} Since ensureDirectoryExists is used in multiple places, consider moving this function to a common utilities file to avoid duplication and improve maintainability. apps/cli/src/util/configuration.ts [88-90] -async function ensureDirectoryExists(path: string): Promise<void> { - await mkdir(dirname(path), { recursive: true }) -} +// This function should be moved to a common utilities file +// and imported where needed. Apply this suggestion Suggestion importance[1-10]: 8 Why: This suggestion enhances maintainability by reducing code duplication, making it easier to manage and update the utility function.	8
Best practice	Normalize or resolve the directory path to handle relative paths correctly To ensure that the directory path is correctly handled, use path.resolve or path.normalize on the path parameter to avoid issues with relative paths. apps/cli/src/util/configuration.ts [89] -await mkdir(dirname(path), { recursive: true }) +await mkdir(dirname(path.resolve(path)), { recursive: true }) Apply this suggestion Suggestion importance[1-10]: 7 Why: Using path.resolve or path.normalize ensures that the directory path is handled correctly, which is a good practice to avoid issues with relative paths.	7