refactor(core): Make load plugins modular, prepare for TS #34813
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| import { slash } from "gatsby-core-utils" | ||
|
There was a problem hiding this comment. This file used to be |
||
| import path from "path" | ||
| import reporter from "gatsby-cli/lib/reporter" | ||
| import { store } from "../../redux" | ||
| import { | ||
| IPluginInfo, | ||
| IPluginRefObject, | ||
| IPluginRefOptions, | ||
| ISiteConfig, | ||
| } from "./types" | ||
| import { processPlugin } from "./process-plugin" | ||
| import { createPluginId } from "./utils/create-id" | ||
| import { createFileContentHash } from "./utils/create-hash" | ||
| import { | ||
| addGatsbyPluginCloudPluginWhenInstalled, | ||
| incompatibleGatsbyCloudPlugin, | ||
| GATSBY_CLOUD_PLUGIN_NAME, | ||
| } from "./utils/handle-gatsby-cloud" | ||
|
|
||
| const TYPESCRIPT_PLUGIN_NAME = `gatsby-plugin-typescript` | ||
|
|
||
| export async function loadInternalPlugins( | ||
| config: ISiteConfig = {}, | ||
| rootDir: string | ||
| ): Promise<Array<IPluginInfo>> { | ||
| // Instantiate plugins. | ||
| const plugins: Array<IPluginInfo> = [] | ||
| const configuredPluginNames = new Set() | ||
|
|
||
| // Add internal plugins | ||
| const internalPluginPaths = [ | ||
| `../../internal-plugins/dev-404-page`, | ||
| `../../internal-plugins/load-babel-config`, | ||
| `../../internal-plugins/internal-data-bridge`, | ||
| `../../internal-plugins/prod-404-500`, | ||
| `../../internal-plugins/webpack-theme-component-shadowing`, | ||
| `../../internal-plugins/bundle-optimisations`, | ||
| `../../internal-plugins/functions`, | ||
| ].filter(Boolean) as Array<string> | ||
|
|
||
| for (const internalPluginPath of internalPluginPaths) { | ||
| const internalPluginAbsolutePath = path.join(__dirname, internalPluginPath) | ||
| const processedPlugin = await processPlugin( | ||
| internalPluginAbsolutePath, | ||
| rootDir | ||
| ) | ||
| plugins.push(processedPlugin) | ||
| } | ||
|
|
||
| // Add plugins from the site config. | ||
| if (config.plugins) { | ||
| for (const plugin of config.plugins) { | ||
| const processedPlugin = await processPlugin(plugin, rootDir) | ||
| plugins.push(processedPlugin) | ||
| configuredPluginNames.add(processedPlugin.name) | ||
| } | ||
| } | ||
|
|
||
| // the order of all of these page-creators matters. The "last plugin wins", | ||
| // so the user's site comes last, and each page-creator instance has to | ||
| // match the plugin definition order before that. This works fine for themes | ||
| // because themes have already been added in the proper order to the plugins | ||
| // array | ||
| for (const plugin of [...plugins]) { | ||
| const processedPlugin = await processPlugin( | ||
| { | ||
| resolve: require.resolve(`gatsby-plugin-page-creator`), | ||
| options: { | ||
| path: slash(path.join(plugin.resolve, `src/pages`)), | ||
| pathCheck: false, | ||
| }, | ||
| }, | ||
| rootDir | ||
| ) | ||
|
|
||
| plugins.push(processedPlugin) | ||
| } | ||
|
|
||
| if ( | ||
| _CFLAGS_.GATSBY_MAJOR === `4` && | ||
| configuredPluginNames.has(GATSBY_CLOUD_PLUGIN_NAME) && | ||
| incompatibleGatsbyCloudPlugin(plugins) | ||
| ) { | ||
| reporter.panic( | ||
| `Plugin gatsby-plugin-gatsby-cloud is not compatible with your gatsby version. Please upgrade to gatsby-plugin-gatsby-cloud@next` | ||
| ) | ||
| } | ||
|
|
||
| if ( | ||
| !configuredPluginNames.has(GATSBY_CLOUD_PLUGIN_NAME) && | ||
| (process.env.GATSBY_CLOUD === `true` || process.env.GATSBY_CLOUD === `1`) | ||
| ) { | ||
| await addGatsbyPluginCloudPluginWhenInstalled(plugins, rootDir) | ||
| } | ||
|
|
||
| // Support Typescript by default but allow users to override it | ||
| if (!configuredPluginNames.has(TYPESCRIPT_PLUGIN_NAME)) { | ||
| const processedTypeScriptPlugin = await processPlugin( | ||
| { | ||
| resolve: require.resolve(TYPESCRIPT_PLUGIN_NAME), | ||
| options: { | ||
| // TODO(@mxstbr): Do not hard-code these defaults but infer them from the | ||
| // pluginOptionsSchema of gatsby-plugin-typescript | ||
| allExtensions: false, | ||
| isTSX: false, | ||
| jsxPragma: `React`, | ||
| }, | ||
| }, | ||
| rootDir | ||
| ) | ||
| plugins.push(processedTypeScriptPlugin) | ||
| } | ||
|
|
||
| // Add the site's default "plugin" i.e. gatsby-x files in root of site. | ||
| plugins.push({ | ||
| resolve: slash(process.cwd()), | ||
| id: createPluginId(`default-site-plugin`), | ||
| name: `default-site-plugin`, | ||
| version: createFileContentHash(process.cwd(), `gatsby-*`), | ||
| pluginOptions: { | ||
| plugins: [], | ||
| }, | ||
| }) | ||
|
|
||
| const program = store.getState().program | ||
|
|
||
| // default options for gatsby-plugin-page-creator | ||
| let pageCreatorOptions: IPluginRefOptions | undefined = { | ||
| path: slash(path.join(program.directory, `src/pages`)), | ||
| pathCheck: false, | ||
| } | ||
|
|
||
| if (config.plugins) { | ||
| const pageCreatorPlugin = config.plugins.find( | ||
| (plugin): plugin is IPluginRefObject => | ||
| typeof plugin !== `string` && | ||
| plugin.resolve === `gatsby-plugin-page-creator` && | ||
| slash((plugin.options && plugin.options.path) || ``) === | ||
| slash(path.join(program.directory, `src/pages`)) | ||
| ) | ||
| if (pageCreatorPlugin) { | ||
| // override the options if there are any user specified options | ||
| pageCreatorOptions = pageCreatorPlugin.options | ||
| } | ||
| } | ||
|
|
||
| const processedPageCreatorPlugin = await processPlugin( | ||
| { | ||
| resolve: require.resolve(`gatsby-plugin-page-creator`), | ||
| options: pageCreatorOptions, | ||
| }, | ||
| rootDir | ||
| ) | ||
|
|
||
| plugins.push(processedPageCreatorPlugin) | ||
|
|
||
| return plugins | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file was renamed from
load-config-and-pluginstoload-config/index.tsand now exportsloadConfig