Skip to content

Comments

Add migration guides and package READMEs#338

Open
deanmarano wants to merge 9 commits intosalsify:standalone-template-transformfrom
deanmarano:standalone-template-transform
Open

Add migration guides and package READMEs#338
deanmarano wants to merge 9 commits intosalsify:standalone-template-transformfrom
deanmarano:standalone-template-transform

Conversation

@deanmarano
Copy link

@deanmarano deanmarano commented Feb 23, 2026

Summary

  • Add migration guides for apps and addons moving from ember-css-modules to the standalone packages (glimmer-local-class-transform, rollup-plugin-preprocess-css-modules)
  • Flesh out READMEs for glimmer-local-class-transform and rollup-plugin-preprocess-css-modules
  • Make ember-css-modules README docs expandable
  • Link migration guides from root README and ember-css-modules deprecation notice

Migration guides

Both guides include preparation steps that can be done incrementally before the final migration:

  • App guide (docs/MIGRATING-V1-APP.md): Staged path from classic Broccoli → Embroider+Webpack → Embroider+Vite, with prep steps (colocate files, rename to .module.css, remove legacy config, migrate PostCSS). Includes a dedicated section for apps using SCSS via PostCSS plugins.
  • Addon guide (docs/MIGRATING-V1-ADDON.md): Prep steps while still v1 (colocate files, rename to .module.css), then v2 conversion steps

Test plan

  • Verify all code snippets and config examples match the actual test-packages
  • Confirm links between docs are correct
  • Review migration steps for accuracy and completeness

Add setup instructions for v2 apps and addons, document config
options (pathMapping, runtimeModule), usage examples for static,
dynamic, and mixed class names, and a brief explanation of how
the compile-time transform works.
Add explanation of what the plugin does (with before/after example),
setup instructions for v2 addon rollup configs, and documentation
for all three config options (include, generateScopedName,
getOutputFilename).
Replace the HTML comment hiding the full documentation with a
<details> element so it's still visible but collapsed by default,
given the package is in maintenance mode.
Describe compatibility at each stage: ember-css-modules works with
classic builds and Embroider+Webpack but not Vite, so the build
pipeline migration and CSS Modules swap can be done separately.
Break out steps that can be done incrementally while still on
ember-css-modules: consolidate to colocated layout, rename to
.module.css, remove legacy config options, migrate PostCSS config.
Break out steps that can be done while still a v1 addon: consolidate
to colocated layout and rename to .module.css. Converting-to-v2 steps
now account for whether prep was already done.
Cover the common case of apps using SCSS via PostCSS plugins with
ember-css-modules, and how to migrate to Vite's native Sass support.
Copy link
Contributor

@RobbieTheWagner RobbieTheWagner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great to me! Thanks for taking the time to write this up @deanmarano.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants