go-libsass: github.com/wellington/go-libsass Index | Examples | Files | Directories

package libsass

import "github.com/wellington/go-libsass"

Package context wraps access to libsass. Higher level abstractions are used to make the package more like Go than C. For low level access see: http://godoc.org/github.com/wellington/go-libsass/libs

For more info, see https://github.com/sass/libsass



Package Files

compiler.go context.go doc.go encoding.go error.go export.go func.go header.go importer.go mixins.go options.go toscss.go version.go


const (
    NESTED_STYLE = iota

Constants/enums for the output style.


var (
    ErrPayloadEmpty = errors.New("empty payload")
    ErrNoCompile    = errors.New("No compile has occurred")
var ErrCompilerNotFound = errors.New("compiler not found")
var (
    ErrImportNotFound = errors.New("Import unreachable or not found")
var (
    ErrSassNumberNoUnit = errors.New("SassNumber has no units")
var Style map[string]int
var TestCallback = testCallback(func(_ interface{}, _ SassValue, _ *SassValue) error {
    return nil

TestCallback implements libs.SassCallback. TestCallback is a useful place to start when developing new handlers.

func BasePath Uses

func BasePath(basePath string) option

BasePath sets the internal path provided to handlers requiring a base path for http calls. This is useful for hosted solutions that need to provided absolute paths to assets.

func BuildDir Uses

func BuildDir(path string) option

BuildDir only used for spriting, how terrible!

func CacheBust Uses

func CacheBust(t string) option

CacheBust append timestamps to static assets to prevent caching

func Comments Uses

func Comments(b bool) option

Comments toggles whether comments should be included in the output

func FontDir Uses

func FontDir(path string) option

FontDir specifies where to find fonts

func HTTPPath Uses

func HTTPPath(u string) option

HTTPPath prefixes all sprites and generated images with this uri. Enabling wellington to serve images when used in HTTP mode

func Handler Uses

func Handler(h HandlerFunc) libs.SassCallback

Handler accepts a HandlerFunc and returns SassCallback for sending to libsass. The third argument must be a pointer and the function must return an error.

func ImgBuildDir Uses

func ImgBuildDir(path string) option

ImgBuildDir specifies the destination directory for images

func ImgDir Uses

func ImgDir(path string) option

ImgDir specifies where to locate images for spriting

func ImportsOption Uses

func ImportsOption(imports *Imports) option

ImportsOption specifies configuration for import resolution

func IncludePaths Uses

func IncludePaths(includes []string) option

IncludePaths adds additional directories to search for Sass files

func LineComments Uses

func LineComments(b bool) option

LineComments removes the line by line playby of the Sass compiler

func NewCompilerContext Uses

func NewCompilerContext(c Compiler) context.Context

func OutputStyle Uses

func OutputStyle(style int) option

OutputStyle controls the presentation of the CSS available option: nested, expanded, compact, compressed

func Path Uses

func Path(path string) option

Path specifies a file to read instead of using the provided io.Reader. This activates file compiling that includes line numbers in the resulting output.

func Payload Uses

func Payload(load context.Context) option

Payload gives access to sprite and image information for handlers to perform spriting functions.

func Precision Uses

func Precision(prec int) option

Precision specifies the number of points beyond the decimal place is preserved during math calculations.

func RegisterHandler Uses

func RegisterHandler(sign string, callback HandlerFunc)

RegisterHandler sets the passed signature and callback to the handlers array.

func RegisterHeader Uses

func RegisterHeader(body string)

RegisterHeader fifo

func RegisterSassFunc Uses

func RegisterSassFunc(sign string, fn SassFunc)

RegisterSassFunc assigns the passed Func to the specified signature sign

func SassHandler Uses

func SassHandler(h SassFunc) libs.SassCallback

SassHandler contains callback context for running code within a libsass handler

func SourceMap Uses

func SourceMap(b bool, path, sourceMapRoot string) option

SourceMap behaves differently depending on compiler used. For compile, it will embed sourcemap into the source. For file compile, it will include a separate file with the source map.

func ToScss Uses

func ToScss(r io.Reader, w io.Writer) error

ToScss converts Sass to Scss with libsass sass2scss.h

func Unmarshal Uses

func Unmarshal(arg SassValue, v ...interface{}) error

Decode converts Sass Value to Go compatible data types.

func Version Uses

func Version() string

Version reports libsass version information

func WithSyntax Uses

func WithSyntax(mode Syntax) option

type Compiler Uses

type Compiler interface {
    // Run does a synchronous build via cgo. It is thread safe, but there is
    // no guarantee that the cgo calls will always be that way.
    Run() error
    // Imports returns the imports used for a compile. This is built
    // at parser time in libsass
    Imports() []string
    // Option allows the configuration of the compiler. The option is
    // unexported to encourage use of preconfigured option functions.
    Option(...option) error

    // CacheBust specifies the cache bust method used by the compiler
    // Available options: ts, sum
    CacheBust() string

    // LineComments specifies whether line comments were inserted into
    // output CSS
    LineComments() bool

    // Payload returns the attached spritewell information attached
    // to the compiler context
    Payload() context.Context

    // Syntax represents the style of code Sass or SCSS
    Syntax() Syntax

Compiler interface is used to translate input Sass network, filepath, or otherwise and transforms it to CSS. The interface includes methods for adding imports and specifying build options necessary to do the transformation.


src := bytes.NewBufferString(`div { p { color: red; } }`)

comp, err := New(os.Stdout, src)
if err != nil {
err = comp.Run()
if err != nil {


div p {
  color: red; }

func CompFromCtx Uses

func CompFromCtx(ctx context.Context) (Compiler, error)

CompFromCtx retrieves a compiler from a passed context

func New Uses

func New(dst io.Writer, src io.Reader, opts ...option) (Compiler, error)

type Func Uses

type Func struct {
    Sign string
    Fn   libs.SassCallback
    Ctx  interface{}

Cookie is used for passing context information to libsass. Cookie is passed to custom handlers when libsass executes them through the go bridge.

type Funcs Uses

type Funcs struct {
    // contains filtered or unexported fields

func NewFuncs Uses

func NewFuncs(ctx *compctx) *Funcs

func (*Funcs) Add Uses

func (fs *Funcs) Add(f Func)

func (*Funcs) Bind Uses

func (fs *Funcs) Bind(goopts libs.SassOptions)

SetFunc assigns the registered methods to SassOptions. Functions are called when the compiler encounters the registered signature.

func (*Funcs) Close Uses

func (fs *Funcs) Close()

type HandlerFunc Uses

type HandlerFunc func(v interface{}, req SassValue, res *SassValue) error

HandlerFunc describes the method signature for registering a Go function to be called by libsass.

type Header struct {
    Content string
    // contains filtered or unexported fields

type Headers Uses

type Headers struct {
    // contains filtered or unexported fields

func NewHeaders Uses

func NewHeaders() *Headers

NewHeaders instantiates a Headers for prefixing Sass to input See: https://github.com/sass/libsass/wiki/API-Sass-Importer

func (*Headers) Add Uses

func (h *Headers) Add(s string)

func (*Headers) Bind Uses

func (hdrs *Headers) Bind(opts libs.SassOptions)

func (*Headers) Close Uses

func (hdrs *Headers) Close()

func (*Headers) Has Uses

func (h *Headers) Has(s string) bool

func (*Headers) Len Uses

func (h *Headers) Len() int

type Import Uses

type Import struct {
    Body io.ReadCloser

    Prev string
    Path string
    // contains filtered or unexported fields

Import contains Rel and Abs path and a string of the contents representing an import.

func (Import) ModTime Uses

func (i Import) ModTime() time.Time

ModTime returns modification time

type Imports Uses

type Imports struct {
    // contains filtered or unexported fields

Imports is a map with key of "path/to/file"

func NewImports Uses

func NewImports() *Imports

func NewImportsWithResolver Uses

func NewImportsWithResolver(resolver libs.ImportResolver) *Imports

func (*Imports) Add Uses

func (p *Imports) Add(prev string, path string, bs []byte) error

Add registers an import in the context.Imports

func (*Imports) Bind Uses

func (p *Imports) Bind(opts libs.SassOptions)

Bind accepts a SassOptions and adds the registered importers in the context.

func (*Imports) Close Uses

func (i *Imports) Close()

func (*Imports) Del Uses

func (p *Imports) Del(path string)

Del removes the import from the context.Imports

func (*Imports) Get Uses

func (p *Imports) Get(prev, path string) ([]byte, error)

Get retrieves import bytes by path

func (*Imports) Init Uses

func (p *Imports) Init()

Init sets up a new Imports map

func (*Imports) Len Uses

func (p *Imports) Len() int

Len counts the number of entries in context.Imports

func (*Imports) Update Uses

func (p *Imports) Update(name string)

Update attempts to create a fresh Body from the given path Files last modified stamps are compared against import timestamp

type Pather Uses

type Pather interface {
    ImgDir() string
    BuildDir() string
    HTTPPath() string
    ImgBuildDir() string
    FontDir() string

Pather describes the file system paths necessary for a project

type SassError Uses

type SassError struct {
    Status, Line, Column int
    File, Message        string

SassError represents an error object returned from Sass. SassError stores useful information for bubbling up libsass errors.

type SassFunc Uses

type SassFunc func(ctx context.Context, in SassValue) (*SassValue, error)

SassFunc describes func for handling Sass Values

type SassValue Uses

type SassValue struct {
    // contains filtered or unexported fields

func Error Uses

func Error(err error) SassValue

Error takes a Go error and returns a libsass Error

func Marshal Uses

func Marshal(v interface{}) (SassValue, error)

func NewSassValue Uses

func NewSassValue() SassValue

func Warn Uses

func Warn(s string) SassValue

Warn takes a string and causes a warning in libsass

func (SassValue) Val Uses

func (sv SassValue) Val() libs.UnionSassValue

type Syntax Uses

type Syntax int

Syntax lists that available syntaxes for the compiler

const (
    SCSSSyntax Syntax = iota


libslibs is a direct mapping to libsass C API.

Package libsass imports 17 packages (graph) and is imported by 18 packages. Updated 2019-02-18. Refresh now. Tools for package owners.