Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Add support for consumer side customization of the actual astro config

Ouverte
  • Quelque chose ne va pas ?
#216 1 commentaire 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
42/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
typescript
Domaine
build-system, cli, documentation

Piste de recherche

Commencez par cli/setFsRootDir.ts:17-19 et cli/cli.ts:138-141, puis suivez la manière dont les commandes CLI start, build, preview et les autres invoquent l’API programmatique. Définissez comment une configuration optionnelle du consumer est fusionnée avec la configuration de base, notamment la priorité et la prise en charge des types ; le travail est considéré comme terminé lorsque les valeurs par défaut existantes restent inchangées et que toutes les commandes listées prennent en charge la personnalisation sans manipulation de chaînes.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

enhancement PF Team

Problem Summary

Consumers cannot customize the Astro configuration from their side. The framework uses a hardcoded astro.config.mjs file within the doc-core package, preventing users from:

  • Adding custom Astro integrations
  • Modifying Vite configuration for their specific needs
  • Changing the deployment adapter (currently hardcoded to Cloudflare)
  • Customizing build settings, output options, or other Astro configurations

Current limitation: While users can customize content via pf-docs.config.mjs, they cannot modify the actual Astro config without forking doc-core and requesting npm releases.

Use Cases

Consumers need to customize Astro config for:

  1. Deployment targets: Different hosting platforms (AWS, Netlify, Vercel) require different adapters
  2. Vite configuration: Custom resolve aliases, plugins, or build optimizations
  3. Integrations: Adding sitemap, analytics, or other Astro integrations
  4. Performance tuning: Customizing bundle splitting, compression, or caching strategies
  5. Environment-specific settings: Different configs for dev/staging/production

Current Architecture

The CLI currently modifies the Astro config via string replacement in setFsRootDir() (cli/setFsRootDir.ts:17-19), which is brittle and doesn't support general user customization.

// cli/cli.ts:138-141
await build({
  root: astroRoot,
  outDir: docsOutputDir,
})

The CLI invokes Astro's programmatic API with the hardcoded astroRoot config location. Consumers have no way to inject or merge their own configuration.

Completion Criteria

The issue is resolved when:

  1. User config file supported: Consumers can create an optional Astro config file that gets merged with the base config
  2. Configuration merging: User config is properly merged with doc-core's base config
  3. Backward compatibility: Existing setups without user config continue to work with default behavior
  4. Clear precedence rules: Documentation clearly explains which config values take precedence (user overrides vs. base defaults)
  5. Type safety: User config gets proper TypeScript support and validation
  6. All CLI commands supported: Config merging works for start, build, preview, and other commands
  7. No string manipulation: Replace the brittle string replacement approach in setFsRootDir() with proper config merging

Technical Notes

  • Astro 5.4.0+ supports mergeConfig() for configuration merging (docs)
  • The CLI already uses Astro's programmatic API (build(), dev(), preview())
  • inlineConfig parameter in programmatic API allows config override
  • File locations: cli/cli.ts:138-141, cli/setFsRootDir.ts
  • Current string replacement hack: cli/setFsRootDir.ts:17-19

Related Links

Langage dominant
TypeScript
Étoiles
3
Forks
11
Merge moyen
3 j 22 h
PR mergées (30 j)
1

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de patternfly/patternfly-doc-core

Toutes les issues de patternfly/patternfly-doc-core

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.