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.

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

Jump to bottom

feat(v2): add option validation for remaining official plugins #2970

Merged
merged 41 commits into from
Jun 26, 2020
Merged

feat(v2): add option validation for remaining official plugins #2970

merged 41 commits into from
Jun 26, 2020

Conversation

teikjun
Copy link
Contributor

@teikjun teikjun commented Jun 19, 2020 •
edited
Loading

Motivation

This PR provides option validation for the remaining official plugins.

This is a follow-up PR to #2943. #2943 generalizes option validation for plugins and themes. This PR uses the same pattern to validate and normalize options for the remaining official plugins.

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

Tests have been added for the respective plugins.

Related PRs

This PR should be merged after #2943. I will pull the changes after #2943 is merged to resolve any merge conflicts first. (Edit: done)

teikjun added 21 commits June 17, 2020 23:37
@teikjun
feat(v2): add option validation lifecycle method
1b49445
@teikjun
chore(v2): add dependencies
f28eb1d
@teikjun
chore(v2): add yup dependency
032de42
@teikjun
feat(v2): add option validation for plugin-content-docs
43132fb
@teikjun
chore(v2): add facebook copyright
09a80cd
@teikjun
refactor(v2): remove unused variable
c4035b3
@teikjun
chore(v2): add dependencies
c9921e9
@teikjun
chore(v2): add copyright
ab9200d
@teikjun
fix(v2): use strict for option validation
890d092
@teikjun
feat(v2): add option validation for plugin-content-pages
9cb9901
@teikjun
feat(v2): add schema for plugin-google-analytics and plugin-google-gtag
da49235
@teikjun
feat(v2): add option validation for plugin-sitemap
b77572f
@teikjun
chore(v2): add dependency for yup
877bff0
@teikjun
fix(v2): remove strict to allow normalization
a34eb1d
@teikjun
refactor(v2): refactor validate method
e2a98cc
@teikjun
feat(v2): modify existing tests
73d9c79
@teikjun
feat(v2): add tests for plugin normalization
13fdc69
@teikjun
style(v2): use a more descriptive filename for schema
dc82ecb
@teikjun
feat(v2): add normalization tests
e43887c
@teikjun
feat(v2): add more tests for option validation
8ec540b
@teikjun
refactor(v2): remove unused code
a85fe6b
@teikjun teikjun requested a review from yangshun as a code owner June 19, 2020 13:54
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jun 19, 2020
@teikjun teikjun marked this pull request as draft June 19, 2020 13:55
@teikjun teikjun changed the title feat(v2): option validation and normalization for remaining official plugins feat(v2): add option validation and normalization for remaining official plugins Jun 19, 2020
@docusaurus-bot
Copy link
Contributor

docusaurus-bot commented Jun 19, 2020 •
edited
Loading

Deploy preview for docusaurus-2 ready!

Built with commit d89d118

https://deploy-preview-2970--docusaurus-2.netlify.app

@teikjun teikjun changed the title feat(v2): add option validation and normalization for remaining official plugins feat(v2): add option validation for remaining official plugins Jun 19, 2020
slorber
slorber reviewed Jun 22, 2020
View reviewed changes
Copy link
Collaborator

@slorber slorber left a comment

Choose a reason for hiding this comment

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

looks nice, waiting for the other PR

packages/docusaurus-plugin-content-docs/src/__tests__/pluginOptionSchema.test.ts Show resolved Hide resolved
packages/docusaurus-plugin-content-pages/src/pluginOptionSchema.ts Show resolved Hide resolved
@anshulrgoyal anshulrgoyal mentioned this pull request Jun 22, 2020
Merged
@slorber
Copy link
Collaborator

slorber commented Jun 24, 2020

Hey, is this ready to review/merge?

The other pr has been merged: #2943

@anshulrgoyal
Copy link
Contributor

It is almost ready, we need to rebase it and make some minor changes

@teikjun teikjun marked this pull request as ready for review June 25, 2020 14:46
@teikjun
Copy link
Contributor Author

teikjun commented Jun 25, 2020

Ready for review now :D

@slorber
Copy link
Collaborator

slorber commented Jun 25, 2020

there's a conflict :p

@teikjun
Copy link
Contributor Author

teikjun commented Jun 25, 2020

conflict resolved! :)

@slorber
Copy link
Collaborator

slorber commented Jun 26, 2020

great job, let's merge this 👍

@slorber slorber merged commit 0f59cd1 into facebook:master Jun 26, 2020
@slorber slorber added pr: maintenance This PR does not produce any behavior differences to end users when upgrading. pr: polish This PR adds a very minor behavior improvement that users will enjoy. labels Jun 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anshulrgoyal anshulrgoyal anshulrgoyal left review comments

@slorber slorber slorber left review comments

@yangshun yangshun Awaiting requested review from yangshun

Assignees
No one assigned
Labels
CLA Signed Signed Facebook CLA pr: maintenance This PR does not produce any behavior differences to end users when upgrading. pr: polish This PR adds a very minor behavior improvement that users will enjoy.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@teikjun @docusaurus-bot @slorber @anshulrgoyal @facebook-github-bot