Class: Sass::Exec::Sass

Inherits:
Generic show all
Defined in:
lib/sass/exec.rb

Overview

The sass executable.

Direct Known Subclasses

Scss

Constant Summary

Constants inherited from Generic

Generic::COLORS

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Generic

#color, #get_line, #parse, #parse!, #puts, #puts_action, #to_s

Constructor Details

#initialize(args) ⇒ Sass

Returns a new instance of Sass.

Parameters:

  • args (Array<String>) —

    The command-line arguments



183
184
185
186
187
188
189
 
# File 'lib/sass/exec.rb', line 183

def initialize(args)
  super
  @options[:for_engine] = {
    :load_paths => ['.'] + (ENV['SASSPATH'] || '').split(File::PATH_SEPARATOR)
  }
  @default_syntax = :sass
end

Instance Attribute Details

#default_syntax (readonly)

Returns the value of attribute default_syntax.



180
181
182
 
# File 'lib/sass/exec.rb', line 180

def default_syntax
  @default_syntax
end

Instance Method Details

#process_result (protected)

Processes the options set by the command-line arguments, and runs the Sass compiler appropriately.



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/sass/exec.rb', line 294

def process_result
  require 'sass'

  if !@options[:update] && !@options[:watch] &&
      @args.first && colon_path?(@args.first)
    if @args.size == 1
      @args = split_colon_path(@args.first)
    else
      @options[:update] = true
    end
  end
  load_compass if @options[:compass]
  return interactive if @options[:interactive]
  return watch_or_update if @options[:watch] || @options[:update]
  super
  @options[:for_engine][:filename] = @options[:filename]

  begin
    input = @options[:input]
    output = @options[:output]

    @options[:for_engine][:syntax] ||= :scss if input.is_a?(File) && input.path =~ /\.scss$/
    @options[:for_engine][:syntax] ||= @default_syntax
    engine =
      if input.is_a?(File) && !@options[:check_syntax]
        ::Sass::Engine.for_file(input.path, @options[:for_engine])
      else
        # We don't need to do any special handling of @options[:check_syntax] here,
        # because the Sass syntax checking happens alongside evaluation
        # and evaluation doesn't actually evaluate any code anyway.
        ::Sass::Engine.new(input.read(), @options[:for_engine])
      end

    input.close() if input.is_a?(File)

    output.write(engine.render)
    output.close() if output.is_a? File
  rescue ::Sass::SyntaxError => e
    raise e if @options[:trace]
    raise e.sass_backtrace_str("standard input")
  end
end

#set_opts(opts) (protected)

Tells optparse how to parse the arguments.

Parameters:

  • opts (OptionParser) 


196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/sass/exec.rb', line 196

def set_opts(opts)
  super

  opts.banner = <<END
Usage: #{default_syntax} [options] [INPUT] [OUTPUT]

Description:
  Converts SCSS or Sass files to CSS.

Options:
END

  if @default_syntax == :sass
    opts.on('--scss',
            'Use the CSS-superset SCSS syntax.') do
      @options[:for_engine][:syntax] = :scss
    end
  else
    opts.on('--sass',
            'Use the Indented syntax.') do
      @options[:for_engine][:syntax] = :sass
    end
  end
  opts.on('--watch', 'Watch files or directories for changes.',
                     'The location of the generated CSS can be set using a colon:',
                     "  #{@default_syntax} --watch input.#{@default_syntax}:output.css",
                     "  #{@default_syntax} --watch input-dir:output-dir") do
    @options[:watch] = true
  end
  opts.on('--update', 'Compile files or directories to CSS.',
                      'Locations are set like --watch.') do
    @options[:update] = true
  end
  opts.on('--stop-on-error', 'If a file fails to compile, exit immediately.',
                             'Only meaningful for --watch and --update.') do
    @options[:stop_on_error] = true
  end
  opts.on('--poll', 'Check for file changes manually, rather than relying on the OS.',
                    'Only meaningful for --watch.') do
    @options[:poll] = true
  end
  opts.on('-f', '--force', 'Recompile all Sass files, even if the CSS file is newer.',
                           'Only meaningful for --update.') do
    @options[:force] = true
  end
  opts.on('-c', '--check', "Just check syntax, don't evaluate.") do
    require 'stringio'
    @options[:check_syntax] = true
    @options[:output] = StringIO.new
  end
  opts.on('-t', '--style NAME',
          'Output style. Can be nested (default), compact, compressed, or expanded.') do |name|
    @options[:for_engine][:style] = name.to_sym
  end
  opts.on('--precision NUMBER_OF_DIGITS', Integer,
          'How many digits of precision to use when outputting decimal numbers. Defaults to 3.') do |precision|
    ::Sass::Script::Number.precision = precision
  end
  opts.on('-q', '--quiet', 'Silence warnings and status messages during compilation.') do
    @options[:for_engine][:quiet] = true
  end
  opts.on('--compass', 'Make Compass imports available and load project configuration.') do
    @options[:compass] = true
  end
  opts.on('-g', '--debug-info',
          'Emit extra information in the generated CSS that can be used by the FireSass Firebug plugin.') do
    @options[:for_engine][:debug_info] = true
  end
  opts.on('-l', '--line-numbers', '--line-comments',
          'Emit comments in the generated CSS indicating the corresponding source line.') do
    @options[:for_engine][:line_numbers] = true
  end
  opts.on('-i', '--interactive',
          'Run an interactive SassScript shell.') do
    @options[:interactive] = true
  end
  opts.on('-I', '--load-path PATH', 'Add a sass import path.') do |path|
    @options[:for_engine][:load_paths] << path
  end
  opts.on('-r', '--require LIB', 'Require a Ruby library before running Sass.') do |lib|
    require lib
  end
  opts.on('--cache-location PATH', 'The path to put cached Sass files. Defaults to .sass-cache.') do |loc|
    @options[:for_engine][:cache_location] = loc
  end
  opts.on('-C', '--no-cache', "Don't cache to sassc files.") do
    @options[:for_engine][:cache] = false
  end

  unless ::Sass::Util.ruby1_8?
    opts.on('-E encoding', 'Specify the default encoding for Sass files.') do |encoding|
      Encoding.default_external = encoding
    end
  end
end