Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added codegen afterOneFileWrite script which fixes generated imports #32

Merged
merged 1 commit into from
Jan 23, 2024

Conversation

RokasVaitkevicius
Copy link
Collaborator

No description provided.

Copy link
Contributor

PR Analysis

  • 🎯 Main theme: Enhancement of the code generation process for TypeScript by adding a script to fix generated imports.
  • 📝 PR summary: This PR introduces an afterOneFileWrite hook in the code generation configuration that applies regex replacements to fix the imports in the generated resolvers-types.ts file. It replaces the standard imports with type-only imports for GraphQL and Apollo context types.
  • 📌 Type of PR: Enhancement
  • ⏱️ Estimated effort to review [1-5]: 2, because the PR is focused on a single functionality change and the code changes are not extensive or complex.
  • 🔒 Security concerns: No security concerns found

PR Feedback

💡 General suggestions: The PR effectively addresses the issue of incorrect import statements in the generated code. However, it's important to ensure that the regex patterns used are robust enough to handle all expected variations of the import statements. Additionally, consider the maintainability of the regex approach as the project evolves.

🤖 Code feedback:
relevant filebackend/codegen.ts
suggestion      

Consider using path.extname from the path module to check the file extension instead of endsWith. This is a more robust method to handle file extensions and is less error-prone. [important]

relevant lineif (filePath.endsWith('resolvers-types.ts')) {

relevant filebackend/codegen.ts
suggestion      

It's a good practice to handle potential errors when reading and writing files. Consider wrapping fs.readFileSync and fs.writeFileSync in a try-catch block to handle any IO errors that may occur. [important]

relevant lineconst content = fs.readFileSync(filePath, 'utf8');

relevant filebackend/codegen.ts
suggestion      

To improve performance, you could check if the content actually changed before writing it back to the file system. This avoids unnecessary writes when the file content is already correct. [medium]

relevant linefs.writeFileSync(filePath, modifiedContent);

relevant filebackend/codegen.ts
suggestion      

Consider extracting the replacement logic into a separate function. This will improve readability and make the code easier to test and maintain. [medium]

relevant linelet modifiedContent = content.replace(graphqlImportRegex, "import type { $1 } from 'graphql';");


✨ Usage guide:

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...
Utilizing extra instructions

The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.

Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.

Examples for extra instructions:

[pr_reviewer] # /review #
extra_instructions="""
In the code feedback section, emphasize the following:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""

Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation
  • When you first install PR-Agent app, the default mode for the review tool is:
pr_commands = ["/review", ...]

meaning the review tool will run automatically on every PR, with the default configuration.
Edit this field to enable/disable the tool, or to change the used configurations

About the 'Code feedback' section

The review tool provides several type of feedbacks, one of them is code suggestions.
If you are interested only in the code suggestions, it is recommended to use the improve feature instead, since it dedicated only to code suggestions, and usually gives better results.
Use the review tool if you want to get a more comprehensive feedback, which includes code suggestions as well.

Auto-labels

The review tool can auto-generate two specific types of labels for a PR:

  • a possible security issue label, that detects possible security issues (enable_review_labels_security flag)
  • a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)
Extra sub-tools

The review tool provides a collection of possible feedbacks about a PR.
It is recommended to review the possible options, and choose the ones relevant for your use case.
Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example:
require_score_review, require_soc2_review, enable_review_labels_effort, and more.

More PR-Agent commands

To invoke the PR-Agent, add a comment using one of the following commands:

  • /review: Request a review of your Pull Request.
  • /describe: Update the PR title and description based on the contents of the PR.
  • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
  • /ask <QUESTION>: Ask a question about the PR.
  • /update_changelog: Update the changelog based on the PR's contents.
  • /add_docs 💎: Generate docstring for new components introduced in the PR.
  • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
  • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

See the tools guide for more details.
To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

@RokasVaitkevicius RokasVaitkevicius merged commit 40ea3ce into master Jan 23, 2024
2 checks passed
@RokasVaitkevicius RokasVaitkevicius deleted the codegen-fix branch January 23, 2024 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants