Document the Sass migrator #372
Conversation
| end | ||
|
|
||
| task :version => :checkout do | ||
| add_version 'migrator', Dir.chdir(".sass-migrator") {latest_stable_tag} |
There was a problem hiding this comment.
Style/StringLiterals: Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.
Layout/SpaceInsideBlockBraces: Space missing inside {.
Layout/SpaceInsideBlockBraces: Space missing inside }.
| end | ||
| end | ||
|
|
||
| task :version => :checkout do |
There was a problem hiding this comment.
Style/HashSyntax: Use the new Ruby 1.9 hash syntax.
| Dir.chdir(".sass-migrator") do | ||
| sh %{git fetch} | ||
| if ENV["SASS_MIGRATOR_REVISION"] | ||
| sh %{git checkout #{ENV["SASS_MIGRATOR_REVISION"]}} |
There was a problem hiding this comment.
Style/StringLiteralsInInterpolation: Prefer single-quoted strings inside interpolations.
| namespace :migrator do | ||
| # Check out the latest commit of the Sass migrator into the .sass-migrator directory. | ||
| task :checkout do | ||
| unless Dir.exists?(".sass-migrator") |
There was a problem hiding this comment.
Lint/DeprecatedClassMethods: Dir.exists? is deprecated in favor of Dir.exist?.
| @@ -67,6 +67,28 @@ namespace :sass do | |||
| end | |||
| end | |||
|
|
|||
| namespace :migrator do | |||
| # Check out the latest commit of the Sass migrator into the .sass-migrator directory. | |||
There was a problem hiding this comment.
Metrics/LineLength: Line is too long. [89/80]
|
|
||
| <%= partial 'code-snippets/example-module-migrator' %> | ||
|
|
||
| #### `--remove-prefix` |
There was a problem hiding this comment.
It would be good to mention here that passing this option will also generate an import-only stylesheet that forwards the entrypoint with the prefixes still intact, and that this option is unnecessary when migrating downstream stylesheets whose dependencies have already been migrated following this pattern.
|
|
||
| This migration converts stylesheets that use the old [`@import` rule][] to load | ||
| dependencies so that they use the Sass module system via the [`@use` rule][] | ||
| instead. It doesn't just naïvely change `@import`s to `@use`s—it updates |
There was a problem hiding this comment.
Consider splitting this up:
This migration updates stylesheets that load dependencies to use the Sass module system. Any usages of the old [@import rule][] get converted to the [@use rule][].
There was a problem hiding this comment.
I'd like to keep this as-is, because I feel like the existing wording makes it clearer that you can run the migrator on stylesheets that mix @import and @use rules.
Closes #358