-
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: add glob loader * Enable watching and fix paths * Store the full entry object, not just data * Add generateId support * Fix test * Rename loaders to sync * Refacctor imports * Use getEntry * Format * Fix import * Remove type from output * Windows path * Add test for absolute path * Update lockfile * Debugging windows * Allow file URL for base dir * Reset time limit
- Loading branch information
Showing
32 changed files
with
590 additions
and
177 deletions.
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,176 @@ | ||
| import { promises as fs } from 'fs'; | ||
| import { fileURLToPath, pathToFileURL } from 'url'; | ||
| import fastGlob from 'fast-glob'; | ||
| import { green } from 'kleur/colors'; | ||
| import micromatch from 'micromatch'; | ||
| import pLimit from 'p-limit'; | ||
| import { relative } from 'path/posix'; | ||
| import type { ContentEntryType } from '../../@types/astro.js'; | ||
| import { getContentEntryIdAndSlug, getEntryConfigByExtMap } from '../utils.js'; | ||
| import type { Loader, LoaderContext } from './types.js'; | ||
|
|
||
| export interface GenerateIdOptions { | ||
| /** The path to the entry file, relative to the base directory. */ | ||
| entry: string; | ||
|
|
||
| /** The base directory URL. */ | ||
| base: URL; | ||
| /** The parsed, unvalidated data of the entry. */ | ||
| data: Record<string, unknown>; | ||
| } | ||
| export interface GlobOptions { | ||
| /** The glob pattern to match files, relative to the base directory */ | ||
| pattern: string; | ||
| /** The base directory to resolve the glob pattern from. Relative to the root directory, or an absolute file URL. Defaults to `.` */ | ||
| base?: string | URL; | ||
| /** | ||
| * Function that generates an ID for an entry. Default implementation generates a slug from the entry path. | ||
| * @returns The ID of the entry. Must be unique per collection. | ||
| **/ | ||
| generateId?: (options: GenerateIdOptions) => string; | ||
| } | ||
|
|
||
| function generateIdDefault({ entry, base, data }: GenerateIdOptions): string { | ||
| if (data.slug) { | ||
| return data.slug as string; | ||
| } | ||
| const entryURL = new URL(entry, base); | ||
| const { slug } = getContentEntryIdAndSlug({ | ||
| entry: entryURL, | ||
| contentDir: base, | ||
| collection: '', | ||
| }); | ||
| return slug; | ||
| } | ||
|
|
||
| /** | ||
| * Loads multiple entries, using a glob pattern to match files. | ||
| * @param pattern A glob pattern to match files, relative to the content directory. | ||
| */ | ||
| export function glob(globOptions: GlobOptions): Loader { | ||
| if (globOptions.pattern.startsWith('../')) { | ||
| throw new Error( | ||
| 'Glob patterns cannot start with `../`. Set the `base` option to a parent directory instead.' | ||
| ); | ||
| } | ||
| if (globOptions.pattern.startsWith('/')) { | ||
| throw new Error( | ||
| 'Glob patterns cannot start with `/`. Set the `base` option to a parent directory or use a relative path instead.' | ||
| ); | ||
| } | ||
|
|
||
| const generateId = globOptions?.generateId ?? generateIdDefault; | ||
|
|
||
| const fileToIdMap = new Map<string, string>(); | ||
|
|
||
| async function syncData( | ||
| entry: string, | ||
| base: URL, | ||
| { logger, parseData, store }: LoaderContext, | ||
| entryType?: ContentEntryType | ||
| ) { | ||
| if (!entryType) { | ||
| logger.warn(`No entry type found for ${entry}`); | ||
| return; | ||
| } | ||
| const fileUrl = new URL(entry, base); | ||
| const { body, data } = await entryType.getEntryInfo({ | ||
| contents: await fs.readFile(fileUrl, 'utf-8'), | ||
| fileUrl, | ||
| }); | ||
|
|
||
| const id = generateId({ entry, base, data }); | ||
|
|
||
| const filePath = fileURLToPath(fileUrl); | ||
|
|
||
| const parsedData = await parseData({ | ||
| id, | ||
| data, | ||
| filePath, | ||
| }); | ||
|
|
||
| store.set(id, parsedData, body, filePath); | ||
|
|
||
| fileToIdMap.set(filePath, id); | ||
| } | ||
|
|
||
| return { | ||
| name: 'glob-loader', | ||
| load: async (options) => { | ||
| const { settings, logger, watcher } = options; | ||
|
|
||
| const entryConfigByExt = getEntryConfigByExtMap([ | ||
| ...settings.contentEntryTypes, | ||
| ...settings.dataEntryTypes, | ||
| ] as Array<ContentEntryType>); | ||
|
|
||
| const baseDir = globOptions.base | ||
| ? new URL(globOptions.base, settings.config.root) | ||
| : settings.config.root; | ||
|
|
||
| if (!baseDir.pathname.endsWith('/')) { | ||
| baseDir.pathname = `${baseDir.pathname}/`; | ||
| } | ||
|
|
||
| const files = await fastGlob(globOptions.pattern, { | ||
| cwd: fileURLToPath(baseDir), | ||
| }); | ||
|
|
||
| function configForFile(file: string) { | ||
| const ext = file.split('.').at(-1); | ||
| if (!ext) { | ||
| logger.warn(`No extension found for ${file}`); | ||
| return; | ||
| } | ||
| return entryConfigByExt.get(`.${ext}`); | ||
| } | ||
|
|
||
| const limit = pLimit(10); | ||
| options.store.clear(); | ||
| await Promise.all( | ||
| files.map((entry) => | ||
| limit(async () => { | ||
| const entryType = configForFile(entry); | ||
| await syncData(entry, baseDir, options, entryType); | ||
| }) | ||
| ) | ||
| ); | ||
|
|
||
| if (!watcher) { | ||
| return; | ||
| } | ||
|
|
||
| const matcher: RegExp = micromatch.makeRe(globOptions.pattern); | ||
|
|
||
| const matchesGlob = (entry: string) => !entry.startsWith('../') && matcher.test(entry); | ||
|
|
||
| const basePath = fileURLToPath(baseDir); | ||
|
|
||
| async function onChange(changedPath: string) { | ||
| const entry = relative(basePath, changedPath); | ||
| if (!matchesGlob(entry)) { | ||
| return; | ||
| } | ||
| const entryType = configForFile(changedPath); | ||
| const baseUrl = pathToFileURL(basePath); | ||
| await syncData(entry, baseUrl, options, entryType); | ||
| logger.info(`Reloaded data from ${green(entry)}`); | ||
| } | ||
| watcher.on('change', onChange); | ||
|
|
||
| watcher.on('add', onChange); | ||
|
|
||
| watcher.on('unlink', async (deletedPath) => { | ||
| const entry = relative(basePath, deletedPath); | ||
| if (!matchesGlob(entry)) { | ||
| return; | ||
| } | ||
| const id = fileToIdMap.get(deletedPath); | ||
| if (id) { | ||
| options.store.delete(id); | ||
| fileToIdMap.delete(deletedPath); | ||
| } | ||
| }); | ||
| }, | ||
| }; | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| export { file } from './file.js'; | ||
| export { glob } from './glob.js'; | ||
| export * from './types.js'; |
Oops, something went wrong.