StringOptions<sync>

@use や @import などのルールでロードされたスタイルシートを探すパス。

ロードパス loadPath は、次の FileImporter と同等です。

{
  findFileUrl(url) {
    // Load paths only support relative URLs.
    if (/^[a-z]+:/i.test(url)) return null;
    return new URL(url, pathToFileURL(loadPath));
  }
}
Copy

互換性

Dart Sass

1.54.0以降

Node Sass

✗

trueの場合、コンパイラーは非ASCII CSSを出力する場合、@charset "UTF-8";またはU+FEFF（バイトオーダーマーク）を先頭に追加する場合があります。

falseの場合、コンパイラーはこれらのバイトシーケンスを絶対に出力しません。これは、HTMLの<style>タグで連結または埋め込む場合に最適です。（出力は依然としてUTF-8になります。）

デフォルト値

true

Sassがソースマップを生成するかどうか。生成する場合、ソースマップはsourceMapとして利用できます。

デフォルト値

false

Sassが生成されたソースマップにソースを含めるかどうか。

このオプションは、sourceMapがfalseの場合、効果はありません。

デフォルト値

false

コンパイルされた CSSのOutputStyleです。

例

const source = `
h1 {
  font-size: 40px;
  code {
    font-face: Roboto Mono;
  }
}`;

let result = sass.compileString(source, {style: "expanded"});
console.log(result.css.toString());
// h1 {
//   font-size: 40px;
// }
// h1 code {
//   font-face: Roboto Mono;
// }

result = sass.compileString(source, {style: "compressed"})
console.log(result.css.toString());
// h1{font-size:40px}h1 code{font-face:Roboto Mono}
Copy

すべてのスタイルシートで利用可能な追加の組み込みSass関数。このオプションは、@function ruleで記述するように、キーがSass関数シグネチャであり、値がCustomFunctionであるオブジェクトを受け取ります。

関数にはValueのサブクラスが渡され、同じものを返す必要があります。戻り値にSassCalculationが含まれている場合、返される前に簡略化されます。

カスタム関数を作成するときは、できるだけユーザーフレンドリーで、Sassのコア関数によって設定された標準にできるだけ近づけることが重要です。従うべき良いガイドラインをいくつか示します。

• assertStringのようなValue.assert*メソッドを使用して、型付けされていないValueオブジェクトをより具体的な型にキャストします。引数として直接渡された値の場合は、引数名も渡します。これにより、ユーザーが間違った型を関数に渡したときに、適切なエラーメッセージが表示されます。

• 個々のクラスには、assertIntのようなより具体的なassert*メソッドがある場合があります。可能な場合は使用する必要があります。

• Sassでは、すべての値がリストとしてカウントされます。SassList型を検出しようとするのではなく、asListを使用して、すべての値をリストとして扱う必要があります。

• リスト、文字列、およびメタデータ（コンマ区切りかスペース区切りか、括弧で囲まれているか否か、引用符付きか引用符なし、単位）を持つ数値などの値を操作する場合、出力メタデータは入力メタデータと一致する必要があります。

• 不明な場合は、リストはデフォルトでコンマ区切り、文字列はデフォルトで引用符付き、数値はデフォルトで単位なしにする必要があります。

• Sassでは、リストと文字列は1から始まるインデックスを使用し、負のインデックスを使用して値の末尾からインデックスを作成します。関数はこれらの規則に従う必要があります。sassIndexToListIndexおよびsassIndexToStringIndexを使用すると、これを自動的に行うことができます。

• Sassの文字列インデックスはUnicodeコードポイントを参照しますが、JavaScriptの文字列インデックスはUTF-16コード単位を参照します。たとえば、文字U+1F60ASMILINGFACEWITHSMILINGEYESは単一のUnicodeコードポイントですが、UTF-16では2つのコード単位（0xD83Dと0xDE0A）として表されます。したがって、JavaScriptでは、"a😊b".charCodeAt(1)は0xD83Dを返しますが、Sassでは、str-slice("a😊b", 1, 1)は"😊"を返します。関数はSassの規則に従う必要があります。sassIndexToStringIndexを使用すると、これを自動的に行うことができ、sassLengthゲッターを使用して、コードポイントでの文字列の長さにアクセスできます。

例

sass.compileString(`
h1 {
  font-size: pow(2, 5) * 1px;
}`, {
  functions: {
    // Note: in real code, you should use `math.pow()` from the built-in
    // `sass:math` module.
    'pow($base, $exponent)': function(args) {
      const base = args[0].assertNumber('base').assertNoUnits('base');
      const exponent =
          args[1].assertNumber('exponent').assertNoUnits('exponent');

      return new sass.SassNumber(Math.pow(base.value, exponent.value));
    }
  }
});
Copy

@useや@importのようなルールからのSassのロード解決方法を制御するカスタムインポーターです。

ロードは、次の順序で試行することによって解決されます。

• 現在のスタイルシートをロードするために使用されたインポーター。ロードされたURLは、現在のスタイルシートの正規URLを基準に解決されます。

• Importer、FileImporter、またはNodePackageImporterは、importersの順序で指定します。

• loadPathsの各ロードパスを順番に指定します。

これらのいずれもSassファイルを返さない場合、ロードは失敗し、Sassはエラーをスローします。

これがtrueの場合、コンパイラーはエラーメッセージと警告メッセージでASCII文字のみを使用します。それ以外の場合は、非ASCIIのUnicode文字も使用する場合があります。

デフォルト値

false

これがtrueの場合、コンパイラーはエラーおよび警告メッセージでANSIカラーエスケープコードを使用します。falseの場合は、これらを使用しません。未定義の場合、コンパイラーはユーザーがインタラクティブ ターミナルを使用しているかどうかに応じて、色を使用するかどうかを判断します。

致命的とみなす非推奨のセットです 。

コンパイル中に、提供されたいずれかのタイプの非推奨警告が発生した場合、コンパイラーは代わりにエラーを発生させます 。

Versionが提供された場合、そのコンパイラーバージョンでアクティブだったすべての非推奨が致命的とみなされます 。

互換性

dart: "1.74.0", node: false

早期にオプトインする将来の非推奨のセットです 。

ここに渡された将来の非推奨は、コンパイラーによってアクティブとして扱われ、必要に応じて警告を発行します 。

互換性

dart: "1.74.0", node: false

Sassからの警告やデバッグメッセージを処理するために使用するオブジェクトです 。

デフォルトでは、Sassは標準エラーに警告とデバッグメッセージを出力しますが、warnまたはdebugが設定されている場合、代わりにこれらを呼び出します 。

特別な値silentを使用すると、すべてのメッセージを簡単に抑制できます 。

このオプションがtrueに設定されている場合、Sassは依存関係によって引き起こされた警告を出力しません。「依存関係」は、loadPathsまたはimportersを通じてロードされるすべてのファイルとして定義されます。エントリポイントに対して相対的にインポートされるスタイルシートは、依存関係とはみなされません 。

これは、自分で修正できない非推奨警告を抑制するのに役立ちます。ただし、できるだけ早く修正できるように、依存関係にも非推奨について通知してください !

デフォルト値

false

無視するアクティブな非推奨のセットです 。

コンパイル中に、提供されたいずれかのタイプの非推奨警告が発生した場合、コンパイラーは代わりにそれを無視します 。

互換性

dart: "1.74.0", node: false

デフォルトでは、Dart Sassはコンソールノイズでユーザーを圧倒するのを避けるために、コンパイルごとに同じ非推奨警告の5つのインスタンスのみを出力します。verboseをtrueに設定すると、代わりに遭遇したすべての非推奨警告が出力されます 。

デフォルト値

false