Skip to content

Add AI analysis prompt generator to config exporter #695

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.

Sign up for GitHub

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add AI analysis prompt generator to config exporter #695

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1d0b525
Add AI analysis prompt generator to config exporter
justin808 Oct 11, 2025
3fccf46
Add GitHub links to React on Rails reference configs
justin808 Oct 11, 2025
161f506
Reference React on Rails issue for exported YAML configs
justin808 Oct 11, 2025
3e4cb9f
Clarify 8 exported config files (webpack + rspack)
justin808 Oct 11, 2025
476866c
Update to 10 exported config files including HMR configs
justin808 Oct 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,17 @@
# Export EVERYTHING for troubleshooting (dev + prod, annotated YAML)
bin/export-bundler-config --doctor
# Creates: webpack-development-client.yaml, webpack-development-server.yaml,
# webpack-production-client.yaml, webpack-production-server.yaml
# webpack-production-client.yaml, webpack-production-server.yaml,
# AI-ANALYSIS-PROMPT.md (prompt file for AI analysis)
```

The `--doctor` mode also creates an `AI-ANALYSIS-PROMPT.md` file in the export directory. This file contains a comprehensive prompt you can copy and paste into AI assistants (like ChatGPT, Claude, or Gemini) along with your exported configuration files. The prompt guides the AI to analyze your configuration for:
- Migration issues (webpack ↔ rspack compatibility)
- Build errors and warnings
- Client vs server bundle optimizations
- Development vs production optimizations
- Best practices and performance improvements

**Other usage examples:**

```bash
Expand Down
330 changes: 330 additions & 0 deletions package/configExporter/aiPromptGenerator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,330 @@
import { basename } from "path"
import { ConfigMetadata } from "./types"
Comment on lines +1 to +2
Copy link

@coderabbitai coderabbitai bot Oct 11, 2025

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion | 🟠 Major

Remove unused imports.

Neither basename nor ConfigMetadata are used in this file. Removing these unused imports will clean up the code and reduce confusion.

Apply this diff to remove the unused imports:

-import { basename } from "path"
-import { ConfigMetadata } from "./types"
-
 /**
  * Generates an AI prompt file for analyzing webpack/rspack configuration exports.
  * The prompt helps AI identify issues and suggest optimizations for the bundler configuration.
  */
 export class AiPromptGenerator {
📝 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
import { basename } from "path"
import { ConfigMetadata } from "./types"
/**
* Generates an AI prompt file for analyzing webpack/rspack configuration exports.
* The prompt helps AI identify issues and suggest optimizations for the bundler configuration.
*/
export class AiPromptGenerator {
🤖 Prompt for AI Agents 
In package/configExporter/aiPromptGenerator.ts around lines 1 to 2, the imports
"basename" from path and "ConfigMetadata" from ./types are unused; remove those
two named imports from the file's import statements (delete the basename import
and the ConfigMetadata import) and run a quick grep/TS compile to ensure no
remaining references, leaving only actually used imports in this module.


/**
* Generates an AI prompt file for analyzing webpack/rspack configuration exports.
* The prompt helps AI identify issues and suggest optimizations for the bundler configuration.
*/
export class AiPromptGenerator {
/**
* Generate a comprehensive AI analysis prompt based on exported config files.
*
* @param exportedFiles - Array of exported config file basenames
* @param targetDir - Directory where configs were exported
* @param bundler - The bundler type (webpack or rspack)
* @param includeReactOnRailsContext - Whether to include React on Rails specific context
* @returns Markdown-formatted AI prompt
*/
generatePrompt(
exportedFiles: string[],
targetDir: string,
bundler: string,
includeReactOnRailsContext = true
): string {
const clientDevFile = exportedFiles.find((f) =>
f.includes("development-client")
)
const serverDevFile = exportedFiles.find((f) =>
f.includes("development-server")
)
const clientProdFile = exportedFiles.find((f) =>
f.includes("production-client")
)
const serverProdFile = exportedFiles.find((f) =>
f.includes("production-server")
)

const sections: string[] = []

// Header
sections.push("# AI Configuration Analysis Request")
sections.push("")
sections.push(
`This directory contains exported ${bundler} configuration files for analysis.`
)
sections.push(
"Please analyze these configurations and provide recommendations."
)
sections.push("")

// Context section
sections.push("## Context")
sections.push("")
sections.push(`- **Bundler**: ${bundler}`)
sections.push(`- **Exported At**: ${new Date().toISOString()}`)
sections.push(`- **Export Directory**: ${targetDir}`)
sections.push("")

// Configuration files
sections.push("## Configuration Files")
sections.push("")
sections.push(
"The following configuration files are available for analysis:"
)
sections.push("")

if (clientDevFile) {
sections.push(
`- **Development (Client)**: \`${clientDevFile}\` - Client bundle for development mode`
)
}
if (serverDevFile) {
sections.push(
`- **Development (Server)**: \`${serverDevFile}\` - Server-side rendering bundle for development mode`
)
}
if (clientProdFile) {
sections.push(
`- **Production (Client)**: \`${clientProdFile}\` - Client bundle for production mode`
)
}
if (serverProdFile) {
sections.push(
`- **Production (Server)**: \`${serverProdFile}\` - Server-side rendering bundle for production mode`
)
}
sections.push("")

// React on Rails context
if (includeReactOnRailsContext) {
sections.push("## React on Rails Standard Configuration")
sections.push("")
sections.push(
"This project uses React on Rails, which typically includes these standard configuration files:"
)
sections.push("")
sections.push(
"1. **`config/webpack/webpack.config.js`** (or rspack equivalent)"
)
sections.push(
" - Main entry point that loads environment-specific configs"
)
sections.push("")
sections.push("2. **`config/webpack/commonWebpackConfig.js`**")
sections.push(
" - Shared configuration between client and server bundles"
)
sections.push(" - Sets up common loaders, resolve extensions, etc.")
sections.push("")
sections.push("3. **`config/webpack/clientWebpackConfig.js`**")
sections.push(" - Client-specific configuration")
sections.push(" - Removes server-bundle entry")
sections.push(" - Optimized for browser execution")
sections.push("")
sections.push("4. **`config/webpack/serverWebpackConfig.js`**")
sections.push(" - Server-side rendering (SSR) configuration")
sections.push(" - Single chunk output (no code splitting)")
sections.push(" - Removes MiniCssExtractPlugin (CSS handled by client)")
sections.push(" - Uses `css-loader` with `exportOnlyLocals: true`")
sections.push(" - Target can be 'web' or 'node' depending on renderer")
sections.push("")
sections.push("### Reference Configuration Examples")
sections.push("")
sections.push(
"For comparison, you can reference the standard React on Rails configuration examples:"
)
sections.push("")
sections.push("**Source Configuration Files (JavaScript):**")
sections.push("")
sections.push(
"- [commonWebpackConfig.js](https://github.com/shakacode/react_on_rails/blob/master/spec/dummy/config/webpack/commonWebpackConfig.js)"
)
sections.push(
"- [clientWebpackConfig.js](https://github.com/shakacode/react_on_rails/blob/master/spec/dummy/config/webpack/clientWebpackConfig.js)"
)
sections.push(
"- [serverWebpackConfig.js](https://github.com/shakacode/react_on_rails/blob/master/spec/dummy/config/webpack/serverWebpackConfig.js)"
)
sections.push(
"- [webpack.config.js](https://github.com/shakacode/react_on_rails/blob/master/spec/dummy/config/webpack/webpack.config.js)"
)
sections.push("")
sections.push(
"**Exported Configuration References (YAML - Coming Soon):**"
)
sections.push("")
sections.push(
"The React on Rails team is working on providing exported reference configurations"
)
sections.push(
"in YAML format (similar to the files in this directory) for easier comparison."
)
sections.push(
"These will include 10 exported config files (5 for webpack, 5 for rspack):"
)
sections.push("")
sections.push("- Development client (standard build)")
sections.push("- Development client with HMR (dev server configuration)")
sections.push("- Development server (SSR)")
sections.push("- Production client")
sections.push("- Production server (SSR)")
sections.push("")
sections.push(
"The HMR configs are especially useful for troubleshooting dev server, hot reload,"
)
sections.push("and live reload issues.")
sections.push("")
sections.push(
"Track progress at: https://github.com/shakacode/react_on_rails/issues/1862"
)
sections.push("")
sections.push(
"These files demonstrate best practices for React on Rails webpack/rspack configuration."
)
sections.push("")
}

// Analysis requests
sections.push("## Analysis Objectives")
sections.push("")
sections.push(
"Please analyze the exported configuration files and provide:"
)
sections.push("")

sections.push("### 1. Migration Issues")
sections.push("")
sections.push(
"If this is a migration from webpack to rspack (or vice versa):"
)
sections.push("")
sections.push("- Identify any incompatible plugins or loaders")
sections.push("- Flag deprecated or removed options")
sections.push("- Suggest equivalent replacements")
sections.push(
"- Check for rspack-specific optimizations that can be enabled"
)
sections.push("")

sections.push("### 2. Build Errors & Warnings")
sections.push("")
sections.push(
"Examine the configuration for common issues that cause build failures:"
)
sections.push("")
sections.push("- Misconfigured loaders or plugins")
sections.push("- Incorrect module resolution settings")
sections.push("- Missing or incorrect output path configurations")
sections.push("- Entry point issues")
sections.push("- DevServer configuration problems")
sections.push("")
sections.push(
"**Note**: If build error logs are provided separately (from `bin/shakapacker` or "
)
sections.push(
"`bin/shakapacker-dev-server`), correlate them with configuration issues."
)
sections.push("")

sections.push("### 3. Client vs Server Optimization")
sections.push("")
sections.push("Compare client and server configurations and recommend:")
sections.push("")
sections.push("**Client Bundle Optimizations:**")
sections.push("- Code splitting strategy")
sections.push("- Asset optimization (images, fonts)")
sections.push("- CSS extraction and optimization")
sections.push("- Tree shaking effectiveness")
sections.push("- Bundle size reduction opportunities")
sections.push("")
sections.push("**Server Bundle Optimizations:**")
sections.push("- Verify single-chunk output (no code splitting)")
sections.push("- Ensure CSS is not extracted (handled by client)")
sections.push("- Check for proper `exportOnlyLocals` for CSS modules")
sections.push("- Validate target environment (web vs node)")
sections.push("- Confirm assets are not emitted during SSR")
sections.push("")

sections.push("### 4. Development vs Production Optimization")
sections.push("")
sections.push("Compare development and production configurations:")
sections.push("")
sections.push("**Development:**")
sections.push("- Fast rebuild times (appropriate devtool setting)")
sections.push("- Hot Module Replacement (HMR) configuration")
sections.push("- Detailed error messages")
sections.push("- DevServer setup")
sections.push("")
sections.push("**Production:**")
sections.push("- Minification and optimization")
sections.push("- Source map strategy (balance between debugging and size)")
sections.push("- Cache busting with content hashes")
sections.push("- Compression and asset optimization")
sections.push("- Performance budgets")
sections.push("")

sections.push("### 5. Common Best Practices")
sections.push("")
sections.push("Check for adherence to bundler best practices:")
sections.push("")
sections.push("- Efficient caching strategies")
sections.push("- Proper externals configuration")
sections.push("- Loader performance (e.g., thread-loader, cache-loader)")
sections.push("- Plugin optimization")
sections.push("- Module resolution efficiency")
sections.push("")

// Providing additional context
sections.push("## Providing Additional Context")
sections.push("")
sections.push(
"To get the most accurate analysis, you can provide additional information:"
)
sections.push("")
sections.push("### Build Error Logs")
sections.push("")
sections.push("Paste output from:")
sections.push("```bash")
sections.push("bin/shakapacker")
sections.push("# or")
sections.push("bin/shakapacker-dev-server")
sections.push("```")
sections.push("")
sections.push("### Custom Configuration Files")
sections.push("")
sections.push("Include content from your custom config files:")
sections.push("- `config/webpack/commonWebpackConfig.js`")
sections.push("- `config/webpack/clientWebpackConfig.js`")
sections.push("- `config/webpack/serverWebpackConfig.js`")
sections.push("- `config/webpack/development.js`")
sections.push("- `config/webpack/production.js`")
sections.push("")
sections.push("(Or equivalent rspack files in `config/rspack/` directory)")
sections.push("")

// Output format
sections.push("## Desired Output Format")
sections.push("")
sections.push("Please structure your analysis as follows:")
sections.push("")
sections.push("1. **Executive Summary**: High-level overview of findings")
sections.push(
"2. **Critical Issues**: Problems that will prevent builds from working"
)
sections.push(
"3. **Warnings**: Suboptimal configurations that should be addressed"
)
sections.push("4. **Optimizations**: Recommendations for improvement")
sections.push(
"5. **Configuration Diffs**: Specific code changes to implement (if applicable)"
)
sections.push("")

// Footer
sections.push("---")
sections.push("")
sections.push("**Generated by Shakapacker Config Exporter**")
sections.push(`**Bundler**: ${bundler}`)
sections.push(`**Date**: ${new Date().toISOString()}`)
sections.push("")

return sections.join("\n")
}

/**
* Generate filename for the AI prompt.
*/
generatePromptFilename(): string {
return "AI-ANALYSIS-PROMPT.md"
}
}
Loading