npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

get-sass-vars-sync

v4.0.1

Published

Get Sass variables synchronously as JSON object

Downloads

16

Readme

get-sass-vars-sync

NPM version Travis Build Status dependencies Status devDependencies Status Greenkeeper badge

Get Sass variables synchronously as JSON object.

Install

npm install get-sass-vars-sync node-sass --save-dev

The sass-loader requires node-sass as peerDependency. Thus you are able to specify the required versions accurately.

Usage

const fs = require('fs');
const sassVarsSync = require('get-sass-vars-sync').default;

sassVarsSync(fs.readFileSync('./index.scss', 'utf-8'))
    .then(function ( json ) {
        console.log(json);
        /* {
        "$foo": "16px",
        "$bar": "17.6px",
        "$baz": 42,
        "$foo-bar": "#666",
        "$foo-bar-baz": "#262626",
        "$foo-bar-baz-bad": "#123",
        "$grault": [1, 2, "3", "4px", "42%", "1.23457px", [4, 5, 6], {"foo": "bar baz"}],
        "$garply": {"foo": 1, "bar": [2, 3], "baz": "3 3 3"},
        "$qux": false,
        "$fred": true,
        "$corgle": null
        } */
  });

index.scss

$foo: 16px;
$bar: $foo * 1.1;
$baz: 42;
$foo-bar: #666;
$foo-bar-baz: darken($foo-bar, 25%);
$foo-bar-baz-bad: #123 !default;
$grault: 1, 2, "3", 4px, 42%, 1.23456789px, (4,5,6), (foo: "bar baz");
$garply: (
    foo: 1,
    bar: (2, 3),
    baz: "3 3 3"
);
$qux: false;
$fred: true;
$corgle: null;

.nested {
    .selector {
        $nested-var: thud;
    }
}

API

sassVarsSync(str, options)

Returns: Object

Gets Sass variables from Sass string.

Only top-level variables will be considered, anything inside selector or at-rule is ignored. PR welcome.

str

Type: String

Sass input string.

opts

Type: Object

camelize

Type: Boolean
Default: false

Camelize first-level JSON object keys and strip inital $ (e.g. $foo-bar will become fooBar).

sassOptions

Type: Object

Options for node-sass.

Related

Contribution

Feel free to push your code if you agree with publishing under the MIT license.

Changelog

License