diff options
| -rw-r--r-- | .changeset/stupid-shoes-complain.md | 7 | ||||
| -rw-r--r-- | packages/astro/package.json | 3 | ||||
| -rw-r--r-- | packages/astro/src/content/types-generator.ts | 43 | ||||
| -rw-r--r-- | packages/astro/src/content/utils.ts | 52 | ||||
| -rw-r--r-- | packages/astro/src/content/vite-plugin-content-assets.ts | 20 | ||||
| -rw-r--r-- | packages/astro/src/content/vite-plugin-content-server.ts | 26 | ||||
| -rw-r--r-- | packages/astro/test/content-collections.test.js | 17 | ||||
| -rw-r--r-- | packages/astro/test/fixtures/content-collections/src/content/without-config/promo/_launch-week-styles.css (renamed from packages/astro/test/fixtures/content-collections/src/content/without-config/promo/launch-week-styles.css) | 0 | ||||
| -rw-r--r-- | packages/astro/test/fixtures/content-collections/src/content/without-config/promo/launch week.mdx (renamed from packages/astro/test/fixtures/content-collections/src/content/without-config/promo/launch-week.mdx) | 2 | ||||
| -rw-r--r-- | packages/astro/test/units/content-collections/get-entry-info.test.js | 44 | ||||
| -rw-r--r-- | pnpm-lock.yaml | 6 |
11 files changed, 158 insertions, 62 deletions
diff --git a/.changeset/stupid-shoes-complain.md b/.changeset/stupid-shoes-complain.md new file mode 100644 index 000000000..09669cf15 --- /dev/null +++ b/.changeset/stupid-shoes-complain.md @@ -0,0 +1,7 @@ +--- +'astro': minor +--- + +Correctly handle spaces and capitalization in `src/content/` file names. This introduces github-slugger for slug generation to ensure slugs are usable by `getStaticPaths`. Changes: +- Resolve spaces and capitalization: `collection/Entry With Spaces.md` becomes `collection/entry-with-spaces`. +- Truncate `/index` paths to base URL: `collection/index.md` becomes `collection` diff --git a/packages/astro/package.json b/packages/astro/package.json index f3beb7fa8..395e43260 100644 --- a/packages/astro/package.json +++ b/packages/astro/package.json @@ -102,6 +102,7 @@ "postbuild": "astro-scripts copy \"src/**/*.astro\"", "benchmark": "node test/benchmark/dev.bench.js && node test/benchmark/build.bench.js", "test:unit": "mocha --exit --timeout 30000 ./test/units/**/*.test.js", + "test:unit:match": "mocha --exit --timeout 30000 ./test/units/**/*.test.js -g", "test": "pnpm run test:unit && mocha --exit --timeout 20000 --ignore **/lit-element.test.js && mocha --timeout 20000 **/lit-element.test.js", "test:match": "mocha --timeout 20000 -g", "test:e2e": "playwright test", @@ -137,7 +138,7 @@ "estree-walker": "^3.0.1", "execa": "^6.1.0", "fast-glob": "^3.2.11", - "github-slugger": "^1.4.0", + "github-slugger": "^2.0.0", "gray-matter": "^4.0.3", "html-entities": "^2.3.3", "html-escaper": "^3.0.3", diff --git a/packages/astro/src/content/types-generator.ts b/packages/astro/src/content/types-generator.ts index 9b9f925b8..e579861f9 100644 --- a/packages/astro/src/content/types-generator.ts +++ b/packages/astro/src/content/types-generator.ts @@ -12,18 +12,15 @@ import { ContentConfig, ContentObservable, ContentPaths, + getEntryInfo, getContentPaths, loadContentConfig, + NoCollectionError, } from './utils.js'; type ChokidarEvent = 'add' | 'addDir' | 'change' | 'unlink' | 'unlinkDir'; type RawContentEvent = { name: ChokidarEvent; entry: string }; type ContentEvent = { name: ChokidarEvent; entry: URL }; -type EntryInfo = { - id: string; - slug: string; - collection: string; -}; export type GenerateContentTypes = { init(): Promise<void>; @@ -123,13 +120,13 @@ export async function createContentTypesGenerator({ return { shouldGenerateTypes: true }; } - const entryInfo = getEntryInfo({ - entry: event.entry, - contentDir: contentPaths.contentDir, - }); - // Not a valid `src/content/` entry. Silently return. - if (entryInfo instanceof Error) return { shouldGenerateTypes: false }; if (fileType === 'unknown') { + const entryInfo = getEntryInfo({ + entry: event.entry, + contentDir: contentPaths.contentDir, + // Allow underscore `_` files outside collection directories + allowFilesOutsideCollection: true, + }); if (entryInfo.id.startsWith('_') && (event.name === 'add' || event.name === 'change')) { // Silently ignore `_` files. return { shouldGenerateTypes: false }; @@ -140,7 +137,11 @@ export async function createContentTypesGenerator({ }; } } - if (entryInfo.collection === '.') { + const entryInfo = getEntryInfo({ + entry: event.entry, + contentDir: contentPaths.contentDir, + }); + if (entryInfo instanceof NoCollectionError) { if (['info', 'warn'].includes(logLevel)) { warn( logging, @@ -256,24 +257,6 @@ function removeEntry(contentTypes: ContentTypes, collectionKey: string, entryKey delete contentTypes[collectionKey][entryKey]; } -export function getEntryInfo({ - entry, - contentDir, -}: Pick<ContentPaths, 'contentDir'> & { entry: URL }): EntryInfo | Error { - const rawRelativePath = path.relative(fileURLToPath(contentDir), fileURLToPath(entry)); - const rawCollection = path.dirname(rawRelativePath).split(path.sep).shift(); - if (!rawCollection) return new Error(); - - const rawId = path.relative(rawCollection, rawRelativePath); - const rawSlug = rawId.replace(path.extname(rawId), ''); - const res = { - id: normalizePath(rawId), - slug: normalizePath(rawSlug), - collection: normalizePath(rawCollection), - }; - return res; -} - export function getEntryType( entryPath: string, paths: ContentPaths diff --git a/packages/astro/src/content/utils.ts b/packages/astro/src/content/utils.ts index dcb0a63ca..9017072ed 100644 --- a/packages/astro/src/content/utils.ts +++ b/packages/astro/src/content/utils.ts @@ -1,7 +1,9 @@ import matter from 'gray-matter'; +import { slug as githubSlug } from 'github-slugger'; import type fsMod from 'node:fs'; +import path from 'node:path'; import { fileURLToPath } from 'node:url'; -import { createServer, ErrorPayload as ViteErrorPayload, ViteDevServer } from 'vite'; +import { createServer, ErrorPayload as ViteErrorPayload, normalizePath, ViteDevServer } from 'vite'; import { z } from 'zod'; import { AstroSettings } from '../@types/astro.js'; import { AstroError, AstroErrorData } from '../core/errors/index.js'; @@ -40,6 +42,12 @@ type Entry = { _internal: { rawData: string; filePath: string }; }; +export type EntryInfo = { + id: string; + slug: string; + collection: string; +}; + export const msg = { collectionConfigMissing: (collection: string) => `${collection} does not have a config. We suggest adding one for type safety!`, @@ -87,11 +95,49 @@ export async function getEntryData(entry: Entry, collectionConfig: CollectionCon return data; } -const flattenPath = (path: (string | number)[]) => path.join('.'); +export class NoCollectionError extends Error {} + +export function getEntryInfo( + params: Pick<ContentPaths, 'contentDir'> & { entry: URL; allowFilesOutsideCollection?: true } +): EntryInfo; +export function getEntryInfo({ + entry, + contentDir, + allowFilesOutsideCollection = false, +}: Pick<ContentPaths, 'contentDir'> & { entry: URL; allowFilesOutsideCollection?: boolean }): + | EntryInfo + | NoCollectionError { + const rawRelativePath = path.relative(fileURLToPath(contentDir), fileURLToPath(entry)); + const rawCollection = path.dirname(rawRelativePath).split(path.sep).shift(); + const isOutsideCollection = rawCollection === '..' || rawCollection === '.'; + + if (!rawCollection || (!allowFilesOutsideCollection && isOutsideCollection)) + return new NoCollectionError(); + + const rawId = path.relative(rawCollection, rawRelativePath); + const rawIdWithoutFileExt = rawId.replace(new RegExp(path.extname(rawId) + '$'), ''); + const rawSlugSegments = rawIdWithoutFileExt.split(path.sep); + + const slug = rawSlugSegments + // Slugify each route segment to handle capitalization and spaces. + // Note: using `slug` instead of `new Slugger()` means no slug deduping. + .map((segment) => githubSlug(segment)) + .join('/') + .replace(/\/index$/, ''); + + const res = { + id: normalizePath(rawId), + slug, + collection: normalizePath(rawCollection), + }; + return res; +} + +const flattenErrorPath = (errorPath: (string | number)[]) => errorPath.join('.'); const errorMap: z.ZodErrorMap = (error, ctx) => { if (error.code === 'invalid_type') { - const badKeyPath = JSON.stringify(flattenPath(error.path)); + const badKeyPath = JSON.stringify(flattenErrorPath(error.path)); if (error.received === 'undefined') { return { message: `${badKeyPath} is required.` }; } else { diff --git a/packages/astro/src/content/vite-plugin-content-assets.ts b/packages/astro/src/content/vite-plugin-content-assets.ts index 71a220c86..a76dcead8 100644 --- a/packages/astro/src/content/vite-plugin-content-assets.ts +++ b/packages/astro/src/content/vite-plugin-content-assets.ts @@ -12,7 +12,8 @@ import { STYLES_PLACEHOLDER, } from './consts.js'; -function isDelayedAsset(url: URL): boolean { +function isDelayedAsset(viteId: string): boolean { + const url = new URL(viteId, 'file://'); return ( url.searchParams.has(DELAYED_ASSET_FLAG) && contentFileExts.some((ext) => url.pathname.endsWith(ext)) @@ -30,10 +31,10 @@ export function astroDelayedAssetPlugin({ mode }: { mode: string }): Plugin { } }, load(id) { - const url = new URL(id, 'file://'); - if (isDelayedAsset(url)) { + if (isDelayedAsset(id)) { + const basePath = id.split('?')[0]; const code = ` - export { Content, getHeadings, _internal } from ${JSON.stringify(url.pathname)}; + export { Content, getHeadings, _internal } from ${JSON.stringify(basePath)}; export const collectedLinks = ${JSON.stringify(LINKS_PLACEHOLDER)}; export const collectedStyles = ${JSON.stringify(STYLES_PLACEHOLDER)}; `; @@ -42,14 +43,13 @@ export function astroDelayedAssetPlugin({ mode }: { mode: string }): Plugin { }, async transform(code, id, options) { if (!options?.ssr) return; - const url = new URL(id, 'file://'); - if (devModuleLoader && isDelayedAsset(url)) { - const { pathname } = url; - if (!devModuleLoader.getModuleById(pathname)?.ssrModule) { - await devModuleLoader.import(pathname); + if (devModuleLoader && isDelayedAsset(id)) { + const basePath = id.split('?')[0]; + if (!devModuleLoader.getModuleById(basePath)?.ssrModule) { + await devModuleLoader.import(basePath); } const { stylesMap, urls } = await getStylesForURL( - pathToFileURL(pathname), + pathToFileURL(basePath), devModuleLoader, 'development' ); diff --git a/packages/astro/src/content/vite-plugin-content-server.ts b/packages/astro/src/content/vite-plugin-content-server.ts index a56df3b42..5030ec002 100644 --- a/packages/astro/src/content/vite-plugin-content-server.ts +++ b/packages/astro/src/content/vite-plugin-content-server.ts @@ -5,13 +5,11 @@ import { pathToFileURL } from 'node:url'; import type { Plugin } from 'vite'; import type { AstroSettings } from '../@types/astro.js'; import { info, LogOptions } from '../core/logger/core.js'; -import { prependForwardSlash } from '../core/path.js'; -import { escapeViteEnvReferences } from '../vite-plugin-utils/index.js'; +import { escapeViteEnvReferences, getFileInfo } from '../vite-plugin-utils/index.js'; import { contentFileExts, CONTENT_FLAG } from './consts.js'; import { createContentTypesGenerator, GenerateContentTypes, - getEntryInfo, getEntryType, } from './types-generator.js'; import { @@ -20,6 +18,7 @@ import { ContentPaths, getContentPaths, getEntryData, + getEntryInfo, getEntrySlug, parseFrontmatter, } from './utils.js'; @@ -109,8 +108,8 @@ export function astroContentServerPlugin({ { name: 'astro-content-flag-plugin', async load(id) { - const fileUrl = new URL(prependForwardSlash(id), 'file://'); - if (isContentFlagImport(fileUrl)) { + const { fileId } = getFileInfo(id, settings.config); + if (isContentFlagImport(id)) { const observable = contentConfigObserver.get(); let contentConfig: ContentConfig | undefined = observable.status === 'loaded' ? observable.config : undefined; @@ -128,19 +127,19 @@ export function astroContentServerPlugin({ }); }); } - const rawContents = await fs.promises.readFile(fileUrl, 'utf-8'); + const rawContents = await fs.promises.readFile(fileId, 'utf-8'); const { content: body, data: unparsedData, matter: rawData = '', - } = parseFrontmatter(rawContents, fileUrl.pathname); + } = parseFrontmatter(rawContents, fileId); const entryInfo = getEntryInfo({ - entry: fileUrl, + entry: pathToFileURL(fileId), contentDir: contentPaths.contentDir, }); if (entryInfo instanceof Error) return; - const _internal = { filePath: fileUrl.pathname, rawData }; + const _internal = { filePath: fileId, rawData }; const partialEntry = { data: unparsedData, body, _internal, ...entryInfo }; const collectionConfig = contentConfig?.collections[entryInfo.collection]; const data = collectionConfig @@ -157,7 +156,7 @@ export const slug = ${JSON.stringify(slug)}; export const body = ${JSON.stringify(body)}; export const data = ${devalue.uneval(data) /* TODO: reuse astro props serializer */}; export const _internal = { - filePath: ${JSON.stringify(fileUrl.pathname)}, + filePath: ${JSON.stringify(fileId)}, rawData: ${JSON.stringify(rawData)}, }; `); @@ -172,7 +171,7 @@ export const _internal = { ) { // Content modules depend on config, so we need to invalidate them. for (const modUrl of viteServer.moduleGraph.urlToModuleMap.keys()) { - if (isContentFlagImport(new URL(modUrl, 'file://'))) { + if (isContentFlagImport(modUrl)) { const mod = await viteServer.moduleGraph.getModuleByUrl(modUrl); if (mod) { viteServer.moduleGraph.invalidateModule(mod); @@ -183,7 +182,7 @@ export const _internal = { }); }, async transform(code, id) { - if (isContentFlagImport(new URL(id, 'file://'))) { + if (isContentFlagImport(id)) { // Escape before Rollup internal transform. // Base on MUCH trial-and-error, inspired by MDX integration 2-step transform. return { code: escapeViteEnvReferences(code) }; @@ -193,6 +192,7 @@ export const _internal = { ]; } -function isContentFlagImport({ searchParams, pathname }: Pick<URL, 'searchParams' | 'pathname'>) { +function isContentFlagImport(viteId: string) { + const { pathname, searchParams } = new URL(viteId, 'file://'); return searchParams.has(CONTENT_FLAG) && contentFileExts.some((ext) => pathname.endsWith(ext)); } diff --git a/packages/astro/test/content-collections.test.js b/packages/astro/test/content-collections.test.js index a66287080..934f50017 100644 --- a/packages/astro/test/content-collections.test.js +++ b/packages/astro/test/content-collections.test.js @@ -59,7 +59,22 @@ describe('Content Collections', () => { 'columbia.md', 'endeavour.md', 'enterprise.md', - 'promo/launch-week.mdx', + // Spaces allowed in IDs + 'promo/launch week.mdx', + ]); + }); + + it('Handles spaces in `without config` slugs', async () => { + expect(json).to.haveOwnProperty('withoutConfig'); + expect(Array.isArray(json.withoutConfig)).to.equal(true); + + const slugs = json.withoutConfig.map((item) => item.slug); + expect(slugs).to.deep.equal([ + 'columbia', + 'endeavour', + 'enterprise', + // "launch week.mdx" is converted to "launch-week.mdx" + 'promo/launch-week', ]); }); diff --git a/packages/astro/test/fixtures/content-collections/src/content/without-config/promo/launch-week-styles.css b/packages/astro/test/fixtures/content-collections/src/content/without-config/promo/_launch-week-styles.css index cce2effe2..cce2effe2 100644 --- a/packages/astro/test/fixtures/content-collections/src/content/without-config/promo/launch-week-styles.css +++ b/packages/astro/test/fixtures/content-collections/src/content/without-config/promo/_launch-week-styles.css diff --git a/packages/astro/test/fixtures/content-collections/src/content/without-config/promo/launch-week.mdx b/packages/astro/test/fixtures/content-collections/src/content/without-config/promo/launch week.mdx index f7c4bac16..22ed07c43 100644 --- a/packages/astro/test/fixtures/content-collections/src/content/without-config/promo/launch-week.mdx +++ b/packages/astro/test/fixtures/content-collections/src/content/without-config/promo/launch week.mdx @@ -5,7 +5,7 @@ publishedDate: 'Sat May 21 2022 00:00:00 GMT-0400 (Eastern Daylight Time)' tags: ['announcement'] --- -import './launch-week-styles.css'; +import './_launch-week-styles.css'; Join us for the space blog launch! diff --git a/packages/astro/test/units/content-collections/get-entry-info.test.js b/packages/astro/test/units/content-collections/get-entry-info.test.js new file mode 100644 index 000000000..9f413bbee --- /dev/null +++ b/packages/astro/test/units/content-collections/get-entry-info.test.js @@ -0,0 +1,44 @@ +import { getEntryInfo } from '../../../dist/content/utils.js'; +import { expect } from 'chai'; + +describe('Content Collections - getEntryInfo', () => { + const contentDir = new URL('src/content/', import.meta.url); + + it('Returns correct entry info', () => { + const entry = new URL('blog/first-post.md', contentDir); + const info = getEntryInfo({ entry, contentDir }); + expect(info.id).to.equal('first-post.md'); + expect(info.slug).to.equal('first-post'); + expect(info.collection).to.equal('blog'); + }); + + it('Returns correct slug when spaces used', () => { + const entry = new URL('blog/first post.mdx', contentDir); + const info = getEntryInfo({ entry, contentDir }); + expect(info.slug).to.equal('first-post'); + }); + + it('Returns correct slug when nested directories used', () => { + const entry = new URL('blog/2021/01/01/index.md', contentDir); + const info = getEntryInfo({ entry, contentDir }); + expect(info.slug).to.equal('2021/01/01'); + }); + + it('Returns correct collection when nested directories used', () => { + const entry = new URL('blog/2021/01/01/index.md', contentDir); + const info = getEntryInfo({ entry, contentDir }); + expect(info.collection).to.equal('blog'); + }); + + it('Returns error when outside collection directory', () => { + const entry = new URL('blog.md', contentDir); + expect(getEntryInfo({ entry, contentDir }) instanceof Error).to.equal(true); + }); + + it('Silences error on `allowFilesOutsideCollection`', () => { + const entry = new URL('blog.md', contentDir); + const entryInfo = getEntryInfo({ entry, contentDir, allowFilesOutsideCollection: true }); + expect(entryInfo instanceof Error).to.equal(false); + expect(entryInfo.id).to.equal('blog.md'); + }); +}); diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index b8c4c37d1..9f88b60b5 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -439,7 +439,7 @@ importers: estree-walker: ^3.0.1 execa: ^6.1.0 fast-glob: ^3.2.11 - github-slugger: ^1.4.0 + github-slugger: ^2.0.0 gray-matter: ^4.0.3 html-entities: ^2.3.3 html-escaper: ^3.0.3 @@ -514,7 +514,7 @@ importers: estree-walker: 3.0.1 execa: 6.1.0 fast-glob: 3.2.12 - github-slugger: 1.5.0 + github-slugger: 2.0.0 gray-matter: 4.0.3 html-entities: 2.3.3 html-escaper: 3.0.3 @@ -9960,7 +9960,7 @@ packages: /@types/sax/1.2.4: resolution: {integrity: sha512-pSAff4IAxJjfAXUG6tFkO7dsSbTmf8CtUpfhhZ5VhkRpC4628tJhh3+V6H1E+/Gs9piSzYKT5yzHO5M4GG9jkw==} dependencies: - '@types/node': 17.0.45 + '@types/node': 18.11.9 dev: false /@types/scheduler/0.16.2: |