feat(vite-plugin-nitro): add initial support for sitemap generation #497
Conversation
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
added 2 commits
July 2, 2023 22:28
Add sitemap generation for users upon passing a small config object.
Followup - removed unnecessary property in vite.config.ts files in apps
✅ Deploy Preview for analog-app ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for analog-blog ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for analog-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
brandonroberts
changed the title
brandonroberts
requested changes
Jul 3, 2023
apps/blog-app/vite.config.ts
Outdated
| @@ -26,6 +26,9 @@ export default defineConfig(() => { | |||
| '/blog/2022-12-31-my-second-post', | |||
| ]; | |||
| }, | |||
| sitemap: { | |||
| domain: 'example.com/', | |||
There was a problem hiding this comment.
nit: use the deployment URL
Suggested change
| domain: 'example.com/', | |
| domain: 'https://analog-blog.netlify.app/', |
|
|
||
| if (routeList.length) { | ||
| const sitemapData: PagesJson[] = routeList.map((page: string) => ({ | ||
| page: `https://www.${sitemapConfig.domain}${page.replace(/^\/+/g, '')}`, |
There was a problem hiding this comment.
Let the user customize the entire host, for example https://myblog.dev
Suggested change
| page: `https://www.${sitemapConfig.domain}${page.replace(/^\/+/g, '')}`, | |
| page: `${sitemapConfig.host}${page.replace(/^\/+/g, '')}`, |
apps/analog-app/vite.config.ts
Outdated
| @@ -32,6 +32,9 @@ export default defineConfig(({ mode }) => { | |||
| apiPrefix: 'api', | |||
| prerender: { | |||
| routes: ['/', '/cart'], | |||
| sitemap: { | |||
| domain: 'example.com/', | |||
There was a problem hiding this comment.
Use the custom base URL for this example
Suggested change
| domain: 'example.com/', | |
| domain: process.env['VITE_ANALOG_PUBLIC_BASE_URL'], |
| @@ -155,6 +156,7 @@ | |||
| "vite-plugin-eslint": "^1.8.1", | |||
| "vite-tsconfig-paths": "4.2.0", | |||
| "vitest": "0.32.2", | |||
| "webpack-bundle-analyzer": "^4.7.0" | |||
| "webpack-bundle-analyzer": "^4.7.0", | |||
| "xmlbuilder2": "^3.0.2" | |||
There was a problem hiding this comment.
This needs to be added to the dependencies in packages/platform/package.json also
| } | ||
|
|
||
| export interface SitemapConfig { | ||
| domain: string; |
There was a problem hiding this comment.
Suggested change
| domain: string; | |
| host: string; |
|
|
||
| const mapPath = `${path.resolve( | ||
| 'dist', | ||
| config.root!, |
There was a problem hiding this comment.
Let's add a fallback root
Suggested change
| config.root!, | |
| config.root || '.', |
| @@ -0,0 +1,73 @@ | |||
| import { SitemapConfig } from './options'; | |||
There was a problem hiding this comment.
nit: put local imports last
Suggested change
| import { SitemapConfig } from './options'; | |
| import { SitemapConfig } from './options'; |
Followup - Fix PR comments. Update config and properties in the config files with examples.
|
Thanks for the review. Made requested changes. |
Followup - Add check for slash to display or not to avoid doubles
brandonroberts
approved these changes
Jul 4, 2023
|
Thanks! @allcontributors add @QuantariusRay for code |
|
I've put up a pull request to add @QuantariusRay! 🎉 |
Villanuevand
pushed a commit
to Villanuevand/analog
that referenced
this pull request
Sep 12, 2023
…nalogjs#497) Co-authored-by: Q <q.ray@jbhunt.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
Which package are you modifying?
What is the current behavior?
Closes #307
What is the new behavior?
Added a config property in pre-render (though, now, that could probably change in the end). This ends up being a property that is just used to generate the domain name needed... I'm open to changing that to a top-level property, I think it'll make more sense.
Does this PR introduce a breaking change?
Other information
[optional] What gif
none yet :(