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

refactor: try using swc to compile generated code #1604

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Jul 20, 2024

No description provided.

Copy link
Contributor

coderabbitai bot commented Jul 20, 2024

Walkthrough

Walkthrough

The recent changes streamline the emitProject function by removing error handling and focusing on directly transforming TypeScript files to JavaScript. This shift emphasizes code transformation over error management. Additionally, the loadSchema function now performs type checking without generating output files, enhancing validation without cluttering the file system. Overall, these modifications simplify processes while potentially impacting error robustness and output management.

Changes

File Path Change Summary
packages/sdk/src/code-gen.ts The emitProject function's error handling has been removed, simplifying its logic to focus solely on transforming TypeScript files to JavaScript.
packages/testtools/src/schema.ts The loadSchema function has been modified to include the --noEmit flag in the TypeScript compiler command, enabling type checks without generating files.

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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 96f6516 and a0b4c0d.

Files ignored due to path filters (2)
  • packages/sdk/package.json is excluded by !**/*.json
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml, !**/*.yaml
Files selected for processing (2)
  • packages/sdk/src/code-gen.ts (2 hunks)
  • packages/testtools/src/schema.ts (1 hunks)
Additional comments not posted (3)
packages/sdk/src/code-gen.ts (2)

1-3: Imports look good.

The new imports for transformFile from @swc/core, fs, and path are appropriate for the changes made in the emitProject function.


36-36: Ensure project save is necessary.

Saving the project before transformation is a good practice to ensure all changes are persisted. However, ensure that this operation is necessary and does not introduce performance bottlenecks.

packages/testtools/src/schema.ts (1)

297-297: Change looks good.

Adding the --noEmit flag to the TypeScript compiler command ensures that type checking is performed without generating output files. This change enhances validation without cluttering the file system.

Comment on lines +38 to +58
await Promise.all(
project
.getSourceFiles()
.map((sf) => sf.getFilePath())
.filter((file) => !file.endsWith('.d.ts'))
.map(async (file) => {
const output = await transformFile(file, {
jsc: {
parser: {
syntax: 'typescript',
tsx: false,
},
target: 'es2020',
},
module: {
type: 'commonjs',
},
});
fs.writeFileSync(path.join(path.dirname(file), path.basename(file, '.ts') + '.js'), output.code);
})
);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Refactor suggestion: Handle potential errors during file transformation.

The current implementation does not handle potential errors during the file transformation process. Consider adding error handling to ensure robustness.

await Promise.all(
  project
    .getSourceFiles()
    .map((sf) => sf.getFilePath())
    .filter((file) => !file.endsWith('.d.ts'))
    .map(async (file) => {
      try {
        const output = await transformFile(file, {
          jsc: {
            parser: {
              syntax: 'typescript',
              tsx: false,
            },
            target: 'es2020',
          },
          module: {
            type: 'commonjs',
          },
        });
        fs.writeFileSync(path.join(path.dirname(file), path.basename(file, '.ts') + '.js'), output.code);
      } catch (error) {
        console.error(`Error transforming file ${file}:`, error);
        throw error;
      }
    })
);
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
await Promise.all(
project
.getSourceFiles()
.map((sf) => sf.getFilePath())
.filter((file) => !file.endsWith('.d.ts'))
.map(async (file) => {
const output = await transformFile(file, {
jsc: {
parser: {
syntax: 'typescript',
tsx: false,
},
target: 'es2020',
},
module: {
type: 'commonjs',
},
});
fs.writeFileSync(path.join(path.dirname(file), path.basename(file, '.ts') + '.js'), output.code);
})
);
await Promise.all(
project
.getSourceFiles()
.map((sf) => sf.getFilePath())
.filter((file) => !file.endsWith('.d.ts'))
.map(async (file) => {
try {
const output = await transformFile(file, {
jsc: {
parser: {
syntax: 'typescript',
tsx: false,
},
target: 'es2020',
},
module: {
type: 'commonjs',
},
});
fs.writeFileSync(path.join(path.dirname(file), path.basename(file, '.ts') + '.js'), output.code);
} catch (error) {
console.error(`Error transforming file ${file}:`, error);
throw error;
}
})
);

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.

1 participant