Skip to content

Docs: Document Scoped CSS Source Maps Configuration (sourceMap) in StyleProcessor and CLI Reference #776

Description

@nathanschmid08

Summary

Document the sourceMap styling option in avenx.config.json ("style": { "sourceMap": true }) which enables CSS source map generation during component stylesheet compilation in StyleProcessor.

Context & Current State

The framework's StyleProcessor supports generating CSS source maps during build compilation when style.sourceMap is configured in avenx.config.json. This allows browser developer tools to trace compiled scoped CSS rules back to original .component.css files. However, neither styling.md nor configuration.md documents the sourceMap option or how CSS source maps work in Avenx-JS.

Proposed Documentation Changes

  1. Scoped & Global CSS Guide (docs/src/content/docs/core-concepts/styling.md):
    • Add a section on debugging scoped component CSS with source maps.
    • Explain how source maps map generated .avenx-<hash> scoped selectors back to original .component.css lines in browser DevTools.
  2. Configuration Reference (docs/src/content/docs/getting-started/configuration.md):
    • Update the CSS Preprocessor & Style Settings section to include style.sourceMap and style.inlineSourceMap.
    • Provide JSON configuration examples and outline production build recommendations.

Labels

  • documentation
  • enhancement
  • good first issue

Metadata

Metadata

Labels

documentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomers

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions