HTML to SCSS
HTML / テンプレートから SpiraCSS 設計原則に沿った SCSS ファイルを自動生成する VS Code 拡張です。
内部で HTML CLI パッケージを使用しています。
<section class="hero-section"> <h1 class="title">Welcome</h1></section>インストール
VS Code >= 1.99.0 が必要です。
v0.6.0 は共通のHTML / WebC / JSX / TSX / Astro / Vue engineに接続し、editorの言語 / 拡張子で形式を選びます。元範囲の診断と実効設定に応じた修復条件を表示し、同じcore parseを生成にも使います。parser assetsは同梱し、workspaceへのparser追加は不要です。最低VS Code版は変更しません。この機能は0.5.1では利用できません。範囲・未解決・APIの詳細は HTML CLI を参照してください。placeholder挿入は従来どおり別の静的HTML機能です。
元位置を証明できない報告は、拡張自身の未対応formatを含めoutputだけに残し、文書先頭や非先頭selectionの先頭に波線を捏造しません。位置のあるAstro / Vue負例は元文書UTF-16範囲・reason・repair案内を保持し、生成を停止します。source treeを保てないAstro終了タグ省略は局所の対応制約として未解決にし、独立検証できる兄弟は検査しますが、不確実な範囲は未検査で文書生成もできません。命名違反や資源失敗の根拠にはしません。class合成順、生成parse失敗の原因不明分類、供給HTMLのtext境界制約は共通CLIの説明を参照してください。
共通coreはnative Astro属性の実出力とcomponent class / list畳込みを区別し、必要なclassless枝だけhidden inputのtypeを判断して、証明済みSVG文脈も保持します。未知type・parse後の関係照合不能は必要な根拠を求め、class変更や資源復旧を断定しません。Astroの終了境界は元sourceとの対応が必要で、metadata-only rootは既存どおりです。native終了タグの大小文字対応は外部ESLint parserのrule前拒否を変更しません。詳細な契約は共通CLIを参照してください。
出力元属性本体・値範囲・未知の存在は枝ごとの別の事実で、勝者が一意でなければ修復rangeを捏造しません。dataモードの設定済み動的ARIAはlintがpassで、真偽文字列への書換えは強制しません。例えばAstroの <div class="card-list" {...{"aria-expanded":open}} aria-expanded="true"/> はpass、到達可能な既知true selectorだけ生成し、coverage.generationUnenumeratedSites: 1となります。非ゼロ時だけOutputへ1行表示し、既存の生成前lint結果を使うため再parse・再集計はしません。旧同期APIの生成ファイル配列は件数を持ちません。設定済みdata属性の動的値は未解決となり、0.5.1と結果が変わる場合があります。意図を保てる場合だけ有限値を示してください。共通のFragment処理は元範囲と独立検証できた兄弟を保持し、拡張へcore判断を複製しません。生成・互換性の詳細はHTML CLIを参照してください。
VS Code Marketplace または Open VSX から SpiraCSS HTML to SCSS を検索してインストールします。
→ VS Code Marketplace / Open VSX からインストール
使い方
コマンド
| コマンド | キーバインド | 説明 |
|---|---|---|
| Generate SpiraCSS SCSS from Root | Cmd+Ctrl+A |
ルート要素から SCSS ファイル群を生成 |
| Generate SpiraCSS SCSS from Selection | Cmd+Ctrl+S |
選択要素から SCSS ファイル群を生成 |
| Insert SpiraCSS placeholders | Cmd+Ctrl+D |
HTML にプレースホルダクラスを付与 |
ルートモード
- ルート Block 要素を含む範囲を選択
Cmd+Ctrl+Aまたは右クリックメニューから実行- 編集中ファイルと同じフォルダにルート SCSS、
childScssDir/(既定:scss/)に子 SCSS が生成される
ルート要素には class 属性が必要です。ない場合はエラーになります。
選択モード
- 個別に SCSS 化したい Block 要素を選択
Cmd+Ctrl+Sまたは右クリックメニューから実行childScssDir/(既定:scss/)に各 Block の SCSS が生成される
選択範囲内に複数の Block がある場合はそれぞれ生成されます。トップレベルに class を持つ要素が 1 つも無い場合はエラーになります。
プレースホルダ付与
SCSS を生成せず、HTML に SpiraCSS 用の目印クラスだけを付与します。クラス名が未定の段階で構造を先に整えたい場合に便利です。
- ルートにしたい要素を含む範囲を選択
Cmd+Ctrl+Dまたは右クリックメニューから実行- すべての子孫要素を再帰的に走査し、Block > Element 構造に整形
プレースホルダ名(block-box / element)は blockCase / elementCase 設定に応じて変わります。
設定
プロジェクトルートの spiracss.config.js で動作をカスタマイズできます。
package.json に "type": "module" がある場合は export default を使用してください。
SCSS ルート書式(v0.5.0+)
拡張は HTML CLI と共通の generator.scssRootStyle を spiracss.config.js から読み込みます。VS Code 独自の設定項目は追加しません。
generator: { scssRootStyle: 'scope-explicit'}デフォルトは scope-explicit です。root mode ではコンポーネントルートだけを @scope (.hero-section) { :scope { ... } } として生成します。meta.load-css() で読む子 Block のファイルと selection mode の出力はクラス形式です。独立した子がないルートも設定に従い、不要な meta 呼び出しだけを省略します。直下形式なら scope、従来のルート書式なら class を選択できます。既存ファイルを自動変換することはありません。
設定した childDir 配下の子・孫 Block ファイルはクラス形式にします。Stylelint は子ファイル内のすべての @scope を、テーマの囲みを含めルート設定に関係なくエラーにします。Stylelint の createRules() 連携では scope 設定時にコンポーネントルートへ scope を要求しますが、どちらの scope 設定でも :scope のラッパーを必須にしません。HTML クラス・HTML 構造は変更しません。詳細は scope の設定 を参照してください。v0.5.0 より前のバージョンでは使えない設定です。
子 scope の禁止は、Sass が読み込み元の親セレクタを子 scope へ追加し、一致しない :scope :scope にすることを防ぐ規約です。生成する子の詳細度を維持するため、ルートの include 位置は変更しません。既存の子 scope は手動移行が必要です。修正方法を参照してください。
制限事項
- プレースホルダ付与コマンドはテンプレート構文(EJS、Nunjucks、Astro frontmatter 等)を含む HTML には適用されません
- プレースホルダ付与は静的な HTML 断片のみ対応
変換仕様、対応テンプレート、Block/Element 判定、動的クラスの制限などの詳細は HTML CLI ドキュメントを参照してください。
使用例
入力 HTML:
<section class="hero-section"> <h1 class="title">Welcome</h1> <div class="feature-card"> <h2 class="heading">Feature</h2> </div></section>出力構造:
your-component/├─ hero-section.scss ← ルート Block├─ scss/│ ├─ feature-card.scss ← 子 Block│ └─ index.scss ← @use 自動マージ└─ your-template.html