We keep configuration in its own self-contained file so that we can load it independently in Rails 3, where the full plugin stuff is lazy-loaded.
VERSION | = | version[:string] unless defined?(Sass::VERSION) | A string representing the version of Sass. A more fine-grained representation is available from Sass.version. @api public | |
Callable | = | Struct.new(:name, :args, :splat, :environment, :tree, :has_content, :type) |
A Sass mixin or function.
`name`: `String` : The name of the mixin/function. `args`: `Array<(Script::Node, Script::Node)>` : The arguments for the mixin/function. Each element is a tuple containing the variable node of the argument and the parse tree for the default value of the argument. `splat`: `Script::Node?` : The variable node of the splat argument for this callable, or null. `environment`: {Sass::Environment} : The environment in which the mixin/function was defined. This is captured so that the mixin/function can have access to local variables defined in its scope. `tree`: `Array<Tree::Node>` : The parse tree for the mixin/function. `has_content`: `Boolean` : Whether the callable accepts a content block. `type`: `String` : The user-friendly name of the type of the callable. |
|
ROOT_DIR | = | File.expand_path(File.join(__FILE__, "../../..")) | The root directory of the Sass source tree. This may be overridden by the package manager if the lib directory is separated from the main source tree. @api public |
logger | [RW] |
Compile a Sass or SCSS string to CSS. Defaults to SCSS.
@param contents [String] The contents of the Sass file. @param options [{Symbol => Object}] An options hash;
see {file:SASS_REFERENCE.md#sass_options the Sass options documentation}
@raise [Sass::SyntaxError] if there‘s an error in the document @raise [Encoding::UndefinedConversionError] if the source encoding
cannot be converted to UTF-8
@raise [ArgumentError] if the document uses an unknown encoding with `@charset`
Compile a file on disk to CSS.
@param filename [String] The path to the Sass, SCSS, or CSS file on disk. @param options [{Symbol => Object}] An options hash;
see {file:SASS_REFERENCE.md#sass_options the Sass options documentation}
@raise [Sass::SyntaxError] if there‘s an error in the document @raise [Encoding::UndefinedConversionError] if the source encoding
cannot be converted to UTF-8
@raise [ArgumentError] if the document uses an unknown encoding with `@charset`
@overload compile_file(filename, options = {})
Return the compiled CSS rather than writing it to a file. @return [String] The compiled CSS.
@overload compile_file(filename, css_filename, options = {})
Write the compiled CSS to a file. @param css_filename [String] The location to which to write the compiled CSS.
The global load paths for Sass files. This is meant for plugins and libraries to register the paths to their Sass stylesheets to that they may be `@imported`. This load path is used by every instance of [Sass::Engine]. They are lower-precedence than any load paths passed in via the {file:SASS_REFERENCE.md#load_paths-option `:load_paths` option}.
If the `SASS_PATH` environment variable is set, the initial value of `load_paths` will be initialized based on that. The variable should be a colon-separated list of path names (semicolon-separated on Windows).
Note that files on the global load path are never compiled to CSS themselves, even if they aren‘t partials. They exist only to be imported.
@example
Sass.load_paths << File.dirname(__FILE__ + '/sass')
@return [Array<String, Pathname, Sass::Importers::Base>]