feat(backend): common file struct and backend, frontend code generate prompt

[ZHallen122]

Summary by CodeRabbit

• New Features

  • Introduced functions to generate backend and frontend code prompts, guiding developers in creating structured codebases.
  • Added a function for generating common file structures tailored for frontend and backend projects.
  • Created a new package.json file for the spotify-backend project, detailing project metadata and dependencies.
  • Added a TypeScript configuration file to establish foundational settings for the project.

• Documentation

  • Included comprehensive comments and guidelines in the new TypeScript configuration file.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

backend/src/build-system/node/backend-code-generate/prompt.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-prettier".

(The package "eslint-plugin-prettier" was not found when loaded as a Node module from the directory "/backend".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-prettier@latest --save-dev

The plugin "eslint-plugin-prettier" was referenced from the config file in "backend/.eslintrc.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

This pull request introduces several new functions and configuration files aimed at generating structured prompts for backend and frontend code, as well as establishing a foundational setup for a new TypeScript project. The functions generateBackendCodePrompt, generateFrontEndCodePrompt, and generateCommonFileStructurePrompt provide templates for creating backend code, frontend code, and file structures, respectively. Additionally, new package.json and tsconfig.json files are created for the spotify-backend project, defining project metadata, dependencies, and TypeScript compiler options.

Changes

File Path	Change Summary
backend/src/build-system/node/backend-code-generate/prompt.ts	Added method generateBackendCodePrompt for generating backend code prompts with specific requirements.
backend/src/build-system/node/frontend-code-generate/prompt.ts	Added method generateFrontEndCodePrompt for generating frontend code prompts with detailed implementation guidelines.
backend/src/build-system/node/frontend-file-structure/prompt.ts	Added method generateCommonFileStructurePrompt for creating folder and file structures based on project part.
backend/template/template-backend/package.json	Created new package.json file for spotify-backend project with metadata, scripts, and dependencies.
backend/template/template-backend/tsconfig.json	Created new tsconfig.json file defining TypeScript compiler options and project configuration.

Possibly related PRs

• Feat(backend) file structure #59: Introduces a method generateFileStructurePrompt in the FileStructureHandler class, similar in purpose to the generateBackendCodePrompt.
• feat(backend):ux sitemap generation #50: Features the generateUxsmdrompt method, related to generating structured prompts like the generateBackendCodePrompt.
• Feat(bcakend) more detail ux structure #62: Modifications to the FileStructureHandler class for generating a file structure document, aligning with the generateBackendCodePrompt.

🐇 In the land of code where rabbits play,
New prompts and files brighten the day.
With structure and care, we build and create,
Backend and frontend, oh, isn't it great?
So hop along, dear coder, take flight,
In the world of development, everything's bright! 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0d8900a and f6d1a1b.

⛔ Files ignored due to path filters (1)

• backend/template/template-backend/package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (5)

• backend/src/build-system/node/backend-code-generate/prompt.ts (1 hunks)
• backend/src/build-system/node/frontend-code-generate/prompt.ts (1 hunks)
• backend/src/build-system/node/frontend-file-structure/prompt.ts (1 hunks)
• backend/template/template-backend/package.json (1 hunks)
• backend/template/template-backend/tsconfig.json (1 hunks)

---

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 generate docstrings to generate docstrings for this PR. (Experiment)
• @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.