Class: Sass::Compiler

Inherits:
Object
  • Object
show all
Defined in:
lib/sass/compiler.rb,
lib/sass/compiler/varint.rb,
lib/sass/compiler/channel.rb,
lib/sass/compiler/session.rb,
lib/sass/compiler/connection.rb,
lib/sass/compiler/dispatcher.rb,
lib/sass/compiler/session/path.rb,
lib/sass/compiler/session/struct.rb,
lib/sass/compiler/session/protofier.rb,
lib/sass/compiler/session/stack_trace.rb,
lib/sass/compiler/session/logger_registry.rb,
lib/sass/compiler/session/function_registry.rb,
lib/sass/compiler/session/importer_registry.rb

Overview

A synchronous Compiler. Each compiler instance exposes the #compile and #compile_string methods within the lifespan of the compiler.

Examples:

sass = Sass::Compiler.new
result = sass.compile_string('h1 { font-size: 40px; }')
result = sass.compile('style.scss')
sass.close

See Also:

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Compiler

Returns a new instance of Compiler.



34
35
36
 
# File 'lib/sass/compiler.rb', line 34

def initialize
  @channel = Channel.new
end

Instance Method Details

#close ⇒ Object 



206
207
208
 
# File 'lib/sass/compiler.rb', line 206

def close
  @channel.close
end

#closed? ⇒ Boolean

Returns:

  • (Boolean) 


210
211
212
 
# File 'lib/sass/compiler.rb', line 210

def closed?
  @channel.closed?
end

#compile(path, load_paths: [], charset: true, source_map: false, source_map_include_sources: false, style: :expanded, functions: {}, importers: [], alert_ascii: false, alert_color: nil, fatal_deprecations: [], future_deprecations: [], logger: nil, quiet_deps: false, silence_deprecations: [], verbose: false) ⇒ CompileResult

Compiles the Sass file at path to CSS.

Parameters:

  • path (String)
  • load_paths (Array<String>) (defaults to: []) —

    Paths in which to look for stylesheets loaded by rules like @use and @import.

  • charset (Boolean) (defaults to: true) —

    By default, if the CSS document contains non-ASCII characters, Sass adds a @charset declaration (in expanded output mode) or a byte-order mark (in compressed mode) to indicate its encoding to browsers or other consumers. If charset is false, these annotations are omitted.

  • source_map (Boolean) (defaults to: false) —

    Whether or not Sass should generate a source map.

  • source_map_include_sources (Boolean) (defaults to: false) —

    Whether Sass should include the sources in the generated source map.

  • style (Symbol) (defaults to: :expanded) —

    The OutputStyle of the compiled CSS.

  • functions (Hash<String, Proc>) (defaults to: {}) —

    Additional built-in Sass functions that are available in all stylesheets.

  • importers (Array<Object>) (defaults to: []) —

    Custom importers that control how Sass resolves loads from rules like @use and @import.

  • alert_ascii (Boolean) (defaults to: false) —

    If this is true, the compiler will exclusively use ASCII characters in its error and warning messages. Otherwise, it may use non-ASCII Unicode characters as well.

  • alert_color (Boolean) (defaults to: nil) —

    If this is true, the compiler will use ANSI color escape codes in its error and warning messages. If it’s false, it won’t use these. If it’s nil, the compiler will determine whether or not to use colors depending on whether the user is using an interactive terminal.

  • fatal_deprecations (Array<String>) (defaults to: []) —

    A set of deprecations to treat as fatal.

  • future_deprecations (Array<String>) (defaults to: []) —

    A set of future deprecations to opt into early.

  • logger (Object) (defaults to: nil) —

    An object to use to handle warnings and/or debug messages from Sass.

  • quiet_deps (Boolean) (defaults to: false) —

    If this option is set to true, Sass won’t print warnings that are caused by dependencies. A “dependency” is defined as any file that’s loaded through load_paths or importer. Stylesheets that are imported relative to the entrypoint are not considered dependencies.

  • silence_deprecations (Array<String>) (defaults to: []) —

    A set of active deprecations to ignore.

  • verbose (Boolean) (defaults to: false) —

    By default, Dart Sass will print only five instances of the same deprecation warning per compilation to avoid deluging users in console noise. If you set verbose to true, it will instead print every deprecation warning it encounters.

Returns:

Raises:

See Also:



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/sass/compiler.rb', line 69

def compile(path,
            load_paths: [],

            charset: true,
            source_map: false,
            source_map_include_sources: false,
            style: :expanded,

            functions: {},
            importers: [],

            alert_ascii: false,
            alert_color: nil,
            fatal_deprecations: [],
            future_deprecations: [],
            logger: nil,
            quiet_deps: false,
            silence_deprecations: [],
            verbose: false)
  raise ArgumentError, 'path must be set' if path.nil?

  Session.new(@channel).compile_request(
    path:,
    source: nil,
    importer: nil,
    load_paths:,
    syntax: nil,
    url: nil,
    charset:,
    source_map:,
    source_map_include_sources:,
    style:,
    functions:,
    importers:,
    alert_color:,
    alert_ascii:,
    fatal_deprecations:,
    future_deprecations:,
    logger:,
    quiet_deps:,
    silence_deprecations:,
    verbose:
  )
end

#compile_string(source, importer: nil, load_paths: [], syntax: :scss, url: nil, charset: true, source_map: false, source_map_include_sources: false, style: :expanded, functions: {}, importers: [], alert_ascii: false, alert_color: nil, fatal_deprecations: [], future_deprecations: [], logger: nil, quiet_deps: false, silence_deprecations: [], verbose: false) ⇒ CompileResult

Compiles a stylesheet whose contents is source to CSS.

Parameters:

  • source (String)
  • importer (Object) (defaults to: nil) —

    The importer to use to handle loads that are relative to the entrypoint stylesheet.

  • load_paths (Array<String>) (defaults to: []) —

    Paths in which to look for stylesheets loaded by rules like @use and @import.

  • syntax (Symbol) (defaults to: :scss) —

    The Syntax to use to parse the entrypoint stylesheet.

  • url (String) (defaults to: nil) —

    The canonical URL of the entrypoint stylesheet. If this is passed along with importer, it’s used to resolve relative loads in the entrypoint stylesheet.

  • charset (Boolean) (defaults to: true) —

    By default, if the CSS document contains non-ASCII characters, Sass adds a @charset declaration (in expanded output mode) or a byte-order mark (in compressed mode) to indicate its encoding to browsers or other consumers. If charset is false, these annotations are omitted.

  • source_map (Boolean) (defaults to: false) —

    Whether or not Sass should generate a source map.

  • source_map_include_sources (Boolean) (defaults to: false) —

    Whether Sass should include the sources in the generated source map.

  • style (Symbol) (defaults to: :expanded) —

    The OutputStyle of the compiled CSS.

  • functions (Hash<String, Proc>) (defaults to: {}) —

    Additional built-in Sass functions that are available in all stylesheets.

  • importers (Array<Object>) (defaults to: []) —

    Custom importers that control how Sass resolves loads from rules like @use and @import.

  • alert_ascii (Boolean) (defaults to: false) —

    If this is true, the compiler will exclusively use ASCII characters in its error and warning messages. Otherwise, it may use non-ASCII Unicode characters as well.

  • alert_color (Boolean) (defaults to: nil) —

    If this is true, the compiler will use ANSI color escape codes in its error and warning messages. If it’s false, it won’t use these. If it’s nil, the compiler will determine whether or not to use colors depending on whether the user is using an interactive terminal.

  • fatal_deprecations (Array<String>) (defaults to: []) —

    A set of deprecations to treat as fatal.

  • future_deprecations (Array<String>) (defaults to: []) —

    A set of future deprecations to opt into early.

  • logger (Object) (defaults to: nil) —

    An object to use to handle warnings and/or debug messages from Sass.

  • quiet_deps (Boolean) (defaults to: false) —

    If this option is set to true, Sass won’t print warnings that are caused by dependencies. A “dependency” is defined as any file that’s loaded through load_paths or importer. Stylesheets that are imported relative to the entrypoint are not considered dependencies.

  • silence_deprecations (Array<String>) (defaults to: []) —

    A set of active deprecations to ignore.

  • verbose (Boolean) (defaults to: false) —

    By default, Dart Sass will print only five instances of the same deprecation warning per compilation to avoid deluging users in console noise. If you set verbose to true, it will instead print every deprecation warning it encounters.

Returns:

Raises:

See Also:



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/sass/compiler.rb', line 149

def compile_string(source,
                   importer: nil,
                   load_paths: [],
                   syntax: :scss,
                   url: nil,

                   charset: true,
                   source_map: false,
                   source_map_include_sources: false,
                   style: :expanded,

                   functions: {},
                   importers: [],

                   alert_ascii: false,
                   alert_color: nil,
                   fatal_deprecations: [],
                   future_deprecations: [],
                   logger: nil,
                   quiet_deps: false,
                   silence_deprecations: [],
                   verbose: false)
  raise ArgumentError, 'source must be set' if source.nil?

  Session.new(@channel).compile_request(
    path: nil,
    source:,
    importer:,
    load_paths:,
    syntax:,
    url:,
    charset:,
    source_map:,
    source_map_include_sources:,
    style:,
    functions:,
    importers:,
    alert_color:,
    alert_ascii:,
    fatal_deprecations:,
    future_deprecations:,
    logger:,
    quiet_deps:,
    silence_deprecations:,
    verbose:
  )
end

#info ⇒ String

Returns Information about the Sass implementation.

Returns:

  • (String) —

    Information about the Sass implementation.

See Also:



199
200
201
202
203
204
 
# File 'lib/sass/compiler.rb', line 199

def info
  @info ||= [
    ['sass-embedded', Embedded::VERSION, '(Embedded Host)', '[Ruby]'].join("\t"),
    Session.new(@channel).version_request.join("\t")
  ].join("\n").freeze
end