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

gonzales-ast

v0.0.6

Published

Gonzales' CSS AST traversal

Downloads

468

Readme

This is library to help navigate CSS AST produced by the Gonzales CSS parser

Installation

$ npm install gonzales-ast

Why

Gonzales eats CSS and spits AST. It also eats AST and spits CSS.

But it doesn't have an API for AST-to-AST manipulations.

Tell me more

Additionally, this library makes the Gonzales' APIs a little more sensible (in the author's opinion).

E.g. the srcToCSSP() method is available as parse().

Currently this library offers:

  • renamed APIs
  • a method traverse() to walk the AST and visit each node

Renamed APIs

Simple usage:

var gonzo = require('gonzales-ast');
var ast = gonzo.parse('a {margin: 0}'); // formerly `srcToCSSP()`
var css_string = gonzo.toCSS(ast); // formerly `csspToSrc()`

There's also toTree() (formerly csspToTree()) that shows a formatted view of the AST.

gonzo.toTree(ast);

Returns the string:

['stylesheet', 
  ['ruleset', 
    ['selector', 
      ['simpleselector', 
        ['ident', 'a'], 
        ['s', ' ']]], 
    ['block', 
      ['declaration', 
        ['property', 
          ['ident', 'margin']], 
        ['value', 
          ['s', ' '], 
          ['number', '0']]]]]]

AST visitors

When traversing the AST you can provide any number of "visitors" that take a node and look at it, and maybe do something with it.

Like:

var newast = gonzo.traverse(ast, [
  visitor1,
  visitor2,
  {
    test: function(name, nodes) {
      return true;
    },
    process: function(node) {
      return node;
    }
  }
]);

Each visitor must provide a process() method which returns a node or false (which removes the node from the tree)

A visitor may provide an optional test() method which is a lightweight way to see whether or not the process() method should be called. test()methods return boolean.

See the examples directory for an examples of visitors that add, remove and change nodes.

UI

To admire the AST that Gonzales produces, check this out.

Other stuffs

  • https://github.com/css/gonzales - Gonzales itself
  • https://github.com/tonyganch/gonzales-pe - Fork of Gonzales that also supports preprocessors
  • https://github.com/csscomb/csscomb.js/ - Formatter on top of -pe. No AST-to-AST, only AST-to-string
  • https://github.com/ai/postcss/ - Another parser, source maps and more fun. Simpler AST.
  • https://github.com/visionmedia/rework - like above