mirror of
https://github.com/zebrajr/react.git
synced 2025-12-06 12:20:20 +01:00
<!-- Thanks for submitting a pull request! We appreciate you spending the time to work on these changes. Please provide enough information so that others can review your pull request. The three fields below are mandatory. Before submitting a pull request, please make sure the following is done: 1. Fork [the repository](https://github.com/facebook/react) and create your branch from `main`. 2. Run `yarn` in the repository root. 3. If you've fixed a bug or added code that should be tested, add tests! 4. Ensure the test suite passes (`yarn test`). Tip: `yarn test --watch TestName` is helpful in development. 5. Run `yarn test --prod` to test in the production environment. It supports the same options as `yarn test`. 6. If you need a debugger, run `yarn test --debug --watch TestName`, open `chrome://inspect`, and press "Inspect". 7. Format your code with [prettier](https://github.com/prettier/prettier) (`yarn prettier`). 8. Make sure your code lints (`yarn lint`). Tip: `yarn linc` to only check changed files. 9. Run the [Flow](https://flowtype.org/) type checks (`yarn flow`). 10. If you haven't already, complete the CLA. Learn more about contributing: https://reactjs.org/docs/how-to-contribute.html --> ## Summary Part 3 of adding a "Config Override" panel to the React compiler playground. Added a button to apply config changes to the Input panel, as well as making the tab collapsible. Added validation for the the PluginOptions type (although comes with a bit more boilerplate) to make it very obvious what the possible config errors could be. Added some toasts for trying to apply broken configs. <!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? --> ## How did you test this change? https://github.com/user-attachments/assets/63ab8636-396f-45ba-aaa5-4136e62ccccc <!-- Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes the user interface. How exactly did you verify that your PR solves the issue you wanted to solve? If you leave this empty, your PR will very likely be closed. -->
121 lines
3.5 KiB
TypeScript
121 lines
3.5 KiB
TypeScript
/**
|
|
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
import parserBabel from 'prettier/plugins/babel';
|
|
import prettierPluginEstree from 'prettier/plugins/estree';
|
|
import * as prettier from 'prettier/standalone';
|
|
import {parsePluginOptions} from 'babel-plugin-react-compiler';
|
|
import {parseConfigPragmaAsString} from '../../../packages/babel-plugin-react-compiler/src/Utils/TestUtils';
|
|
|
|
export class ConfigError extends Error {
|
|
constructor(message: string) {
|
|
super(message);
|
|
this.name = 'ConfigError';
|
|
}
|
|
}
|
|
/**
|
|
* Parse config from pragma and format it with prettier
|
|
*/
|
|
export async function parseAndFormatConfig(source: string): Promise<string> {
|
|
const pragma = source.substring(0, source.indexOf('\n'));
|
|
let configString = parseConfigPragmaAsString(pragma);
|
|
if (configString !== '') {
|
|
configString = `\
|
|
import type { PluginOptions } from 'babel-plugin-react-compiler/dist';
|
|
|
|
(${configString} satisfies Partial<PluginOptions>)`;
|
|
}
|
|
|
|
try {
|
|
const formatted = await prettier.format(configString, {
|
|
semi: true,
|
|
parser: 'babel-ts',
|
|
plugins: [parserBabel, prettierPluginEstree],
|
|
});
|
|
return formatted;
|
|
} catch (error) {
|
|
console.error('Error formatting config:', error);
|
|
return ''; // Return empty string if not valid for now
|
|
}
|
|
}
|
|
|
|
function extractCurlyBracesContent(input: string): string {
|
|
const startIndex = input.indexOf('({') + 1;
|
|
const endIndex = input.lastIndexOf('}');
|
|
if (startIndex === -1 || endIndex === -1 || endIndex <= startIndex) {
|
|
throw new Error('No outer curly braces found in input.');
|
|
}
|
|
return input.slice(startIndex, endIndex + 1);
|
|
}
|
|
|
|
function cleanContent(content: string): string {
|
|
return content
|
|
.replace(/[\r\n]+/g, ' ')
|
|
.replace(/\s+/g, ' ')
|
|
.trim();
|
|
}
|
|
|
|
/**
|
|
* Validate that a config string can be parsed as a valid PluginOptions object
|
|
* Throws an error if validation fails.
|
|
*/
|
|
function validateConfigAsPluginOptions(configString: string): void {
|
|
// Validate that config can be parse as JS obj
|
|
let parsedConfig: unknown;
|
|
try {
|
|
parsedConfig = new Function(`return (${configString})`)();
|
|
} catch (_) {
|
|
throw new ConfigError('Config has invalid syntax.');
|
|
}
|
|
|
|
// Validate against PluginOptions schema
|
|
try {
|
|
parsePluginOptions(parsedConfig);
|
|
} catch (_) {
|
|
throw new ConfigError('Config does not match the expected schema.');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Generate a the override pragma comment from a formatted config object string
|
|
*/
|
|
export async function generateOverridePragmaFromConfig(
|
|
formattedConfigString: string,
|
|
): Promise<string> {
|
|
const content = extractCurlyBracesContent(formattedConfigString);
|
|
const cleanConfig = cleanContent(content);
|
|
|
|
validateConfigAsPluginOptions(cleanConfig);
|
|
|
|
// Format the config to ensure it's valid
|
|
await prettier.format(`(${cleanConfig})`, {
|
|
semi: false,
|
|
parser: 'babel-ts',
|
|
plugins: [parserBabel, prettierPluginEstree],
|
|
});
|
|
|
|
return `// @OVERRIDE:${cleanConfig}`;
|
|
}
|
|
|
|
/**
|
|
* Update the override pragma comment in source code.
|
|
*/
|
|
export function updateSourceWithOverridePragma(
|
|
source: string,
|
|
newPragma: string,
|
|
): string {
|
|
const firstLineEnd = source.indexOf('\n');
|
|
const firstLine = source.substring(0, firstLineEnd);
|
|
|
|
const pragmaRegex = /^\/\/\s*@/;
|
|
if (firstLineEnd !== -1 && pragmaRegex.test(firstLine.trim())) {
|
|
return newPragma + source.substring(firstLineEnd);
|
|
} else {
|
|
return newPragma + '\n' + source;
|
|
}
|
|
}
|