feat(gatsby): release plugin option validation by mxstbr · Pull Request #27437 · gatsbyjs/gatsby

mxstbr · 2020-10-14T08:20:30Z

Merging and publishing this PR releases plugin option validation once we're ready! 🎉

Removes the feature flag from all plugin options schemas and core. [ch16665]
Adds a @gatsbyVersion pragma to pluginOptionsSchema Node API. This will make Gatsby prompt users on old versions of gatsby that don't support the API to upgrade to the new version. [ch17018]

⚠️ After this is merged we need to publish gatsby@2.25.0, i.e. a minor version. ⚠️

This will make Gatsby prompt users on old versions of gatsby that don't support the API to upgrade to the new version.

mfrachet · 2020-10-14T08:57:35Z

packages/gatsby/src/utils/api-node-docs.ts


 /**
 * Called during `gatsby develop` bootstrap to get and validate a plugins options schema
+ * @gatsbyVersion 2.24.69


Oh wow, is the PR only that size? How is it working under the hood?

Yep! @DSchau implemented this way back in 2019 in #16105, I just didn't know! Soooo goooood 😍

Oh wow, this is an incredible feature! Thanks for pointing the PR, will study on that 🚀

@mxstbr what do you think of arbitrarily bumping the version of Gatsby here? (e.g. to 2.25.0 or something)

Seems better user behavior (cc @vladar useful to think about as a concrete example of release cadence being useful!)

Sorry, I'm not quite following... How are users meant to upgrade to 2.25.0 if it doesn't exist yet? 🤔

Oh -- I mean bump the version locally and then ship this 🚀

Let's bump that version after we land #27381 and set the minimum version to that!

mxstbr · 2020-10-14T11:07:36Z

packages/gatsby/src/utils/api-node-docs.ts


 /**
 * Called during `gatsby develop` bootstrap to get and validate a plugins options schema
+ * @gatsbyVersion 2.24.69


Note that this is going to need to be bumped to whatever version is the first to include the .default()s support from #27381 (which isn't merged yet).

mxstbr · 2020-10-19T14:47:00Z

This is ready to go! Will need to publish this as gatsby@2.25.0 after merging this to ensure this works as expected 👍 👍 👍

pravinthan · 2020-11-02T16:59:32Z

packages/gatsby-plugin-sass/src/gatsby-node.js

-      )
-        .description(`This plugin resolves url() paths relative to the entry SCSS/Sass file not – as might be expected – the location relative to the declaration. Under the hood, it makes use of sass-loader and this is documented in the readme.
+const MATCH_ALL_KEYS = /^/
+exports.pluginOptionsSchema = function ({ Joi }) {


Isn't this missing the cssLoader validation?

Great catch! Would appreciate if you open an issue 🙏

cpboyd · 2020-11-02T21:41:25Z

Any specific reason that webpackImporter was excluded?
It's required for any Sass files using @forward syntax which all of Google's Material design styles use now: webpack/sass-loader#804

My Gatsby projects broke today, due to these changes.

MichaelDeBoey · 2020-11-03T13:21:55Z

packages/gatsby/src/bootstrap/load-plugins/index.ts

-  if (process.env.GATSBY_EXPERIMENTAL_PLUGIN_OPTION_VALIDATION) {
-    await validateConfigPluginsOptions(config, rootDir)
-  }
+  await validateConfigPluginsOptions(config, rootDir)


@mxstbr Isn't this technically a breaking change for all plugins when they remove the feature flag? 🤔
Since these plugins won't work anymore with older gatsby versions, because it now errors out with the message to upgrade.

So if that's correct, the peerDependency of all plugins that remove the feature flag should be updated to gatsby@^2.25.0 (which is a breaking change) or am I forgetting something?

@mxstbr Any thoughts on this? 🤔

frantic1048 · 2020-11-10T13:11:14Z

packages/gatsby-remark-images/src/gatsby-node.js

+    quality: Joi.number()
+      .default(50)
+      .description(`The quality level of the generated files.`),
+    withWebp: Joi.boolean()


It looks like we can no longer pass an object with quality config for withWebp option?

Woops, it looks something that we missed here. I'll make it back :)

Available in #27944 😊

* chore(gatsby): add @gatsbyVersion pragma to pluginOptionsSchema Node API This will make Gatsby prompt users on old versions of gatsby that don't support the API to upgrade to the new version. * 2.25.0! * Remove GATSBY_EXPERIMENTAL_PLUGIN_OPTION_VALIDATION feature flag * Fix incorrect option in gatsby-admin; * Fix tests * Remove obsolete snapshots * Trigger Build * Remove flag from remark-autolink-headers * Fix gatsby-plugin-mdx default

chore(gatsby): add @gatsbyVersion pragma to pluginOptionsSchema Node API

fdd8ae6

This will make Gatsby prompt users on old versions of gatsby that don't support the API to upgrade to the new version.

mxstbr requested a review from a team October 14, 2020 08:20

gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Oct 14, 2020

$mfrachet$

mfrachet reviewed Oct 14, 2020

View reviewed changes

mxstbr commented Oct 14, 2020

View reviewed changes

mxstbr mentioned this pull request Oct 14, 2020

feat(gatsby-plugin-utils): save validation resulting value to plugin options #27381

Merged

LekoArts added type: documentation An issue or pull request for improving or updating Gatsby's documentation and removed status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer labels Oct 15, 2020

mxstbr added 2 commits October 19, 2020 16:45

2.25.0!

fae44f8

Merge branch 'master' into plugin-options-schema-gatsby-version

32ba7d3

Merge branch 'master' into plugin-options-schema-gatsby-version

1aabfda

mxstbr requested a review from a team October 27, 2020 09:00

Remove GATSBY_EXPERIMENTAL_PLUGIN_OPTION_VALIDATION feature flag

69614e4

mxstbr requested a review from a team October 27, 2020 09:11

mxstbr changed the title ~~chore(gatsby): add @gatsbyVersion pragma to pluginOptionsSchema Node API~~ feat(gatsby): release plugin option validation Oct 27, 2020

mxstbr added 3 commits October 27, 2020 10:19

Fix incorrect option in gatsby-admin;

1c46c62

Fix tests

2709129

Remove obsolete snapshots

a68bd74

meganesu added the hacktoberfest-accepted label Nov 1, 2020

mxstbr added 4 commits November 2, 2020 09:46

Merge branch 'master' into plugin-options-schema-gatsby-version

75cd960

Trigger Build

d0e2d34

Remove flag from remark-autolink-headers

7392fb6

Fix gatsby-plugin-mdx default

1dde97d

mxstbr merged commit 41ae1c0 into master Nov 2, 2020

delete-merged-branch bot deleted the plugin-options-schema-gatsby-version branch November 2, 2020 13:26

pravinthan reviewed Nov 2, 2020

View reviewed changes

cpboyd mentioned this pull request Nov 2, 2020

bug(gatsby-plugin-sass): plugin option issues #27796

Closed

MichaelDeBoey reviewed Nov 3, 2020

View reviewed changes

ediblecode mentioned this pull request Nov 9, 2020

gatsby-plugin-manifest doesn't allow app shortcuts #27927

Closed

frantic1048 reviewed Nov 10, 2020

View reviewed changes

$@mfrachet$ mfrachet mentioned this pull request Nov 10, 2020

fix(gatsby-remark-images): adding missing plugin options #27944

Merged

frantic1048 mentioned this pull request Nov 10, 2020

chore(dependencies): update gatsby monorepo (minor) frantic1048/Restia#224

Merged

1 task

dependabot bot mentioned this pull request Mar 15, 2021

Bump gatsby-plugin-feed from 2.12.0 to 2.13.1 in /website softmaxsg/tuist#70

Closed

Conversation

mxstbr commented Oct 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mxstbr commented Oct 19, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cpboyd commented Nov 2, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

mxstbr commented Oct 14, 2020 •

edited

Loading

mxstbr commented Oct 19, 2020 •

edited

Loading