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.

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

feat(gatsby-plugin-page-creator): Add slugify option #28485

Merged
merged 6 commits into from
Dec 7, 2020

Conversation

LekoArts
Copy link
Contributor

@LekoArts LekoArts commented Dec 4, 2020

Description

Fixes #28470

We use slugify in our derivePath function to generate the path for every File System Route API page. Since people are able to choose their own path when using createPages API we should also expose the options for this functionality to offer the most flexibility.

With this PR I'm simply passing the option through to the derivePath function. As it's a bit nested a bunch of functions needed to be changed.

The TS types for the IOptions interface on createPagesStatefully were also incorrect, so I had to enable type generation on our gatsby-page-utils to access IPathIgnoreOptions.

Documentation

I've updated the README to also include a short example of overriding src/pages defaults + added a new table for all the options. For the pipes on the type I used a divisor as MDX has a bug (mdx-js/mdx#838) of not recognizing escaped pipes (we're on a too old version of MDX/remark).

[ch20379]

@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Dec 4, 2020
@LekoArts LekoArts added topic: page creation and removed status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer labels Dec 4, 2020
@@ -11,13 +12,13 @@ import { collectionExtractQueryString } from "./collection-extract-query-string"
import { isValidCollectionPathImplementation } from "./is-valid-collection-path-implementation"
import { CODES, prefixId } from "./error-utils"

// TODO: Do we need the ignore argument?
Copy link
Contributor Author

Choose a reason for hiding this comment

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

pvdz
pvdz previously approved these changes Dec 7, 2020
Copy link
Contributor

@pvdz pvdz left a comment

Choose a reason for hiding this comment

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

lgtm
Hope it's worth the effort of juggling that through :p

packages/gatsby-page-utils/src/index.ts Outdated Show resolved Hide resolved
@LekoArts LekoArts merged commit 721f42a into master Dec 7, 2020
@LekoArts LekoArts deleted the fs/pass-slugify-options branch December 7, 2020 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants