scss-analyzer/README.md

A module that analyzes a scss file and infers hint tokens for mixin, functions, variables etc.

<p align="center">
  <a href="https://github.com/shubhsnov/scss-analyzer/blob/master/README.md">
    <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="scss-analyzer is released under the MIT license." />
  </a>
  <a href="https://www.npmjs.com/package/scss-analyzer">
    <img src="https://badge.fury.io/js/scss-analyzer.svg" alt="Current npm package version." />
  </a>
  <a href="https://github.com/shubhsnov/scss-analyzer/blob/master/CONTRIBUTING.md">
    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="Help us" />
  </a>
</p>

# Sass Analyzer

Sass Analyzer is project to make instrumentation around sass files easier in an editing environment.
Currently the analyzer can be used to pass valid scss text and get contexual hints as output. This output can be used
by an editor to provide code hinting.

## Brackets Extension

See `scss-analyzer` in action in this [code hinting extension](https://github.com/shubhsnov/intelligent-scss-hints) for [Brackets](http://brackets.io)

## Getting Started

Require as:
`var Analyzer = require("scss-analyzer").Analyzer;`

Create a sass file analyzer instance associated with some valid sass text
`var sassAnalyzer = new Analyzer(filepath, text);`

Following are the APIs that are meant to be used with the analyzer
```
var hints = sassAnalyzer.getAllHints();
var hints = sassAnalyzer.getAllGlobalHints();
var hints = sassAnalyzer.getHints("mixin"); //pass a type string
var hints = sassAnalyzer.getHints(["mixin", "imports", "variables"]); //pass an array of types
var hints = sassAnalyzer.getHintsForCursorPos(["variable", "import"], {line: 98, column: 22});
```

The analyzer is meant to be stateful, once text is passed, the analyzer gets associated
with the text and analyzes the text based on the given type parametes.

The above APIs can be called more than one with the same or different type parameters

Also one a type has been queried, the results are cached and not computed again.
So if a user does getAllHints once, then he can hold the hint data as long as he holds a valid analyzer.

A reset API is also provided for helping in debugging various workflows, but functionally
is not necessary. It simply resets the cache and we can call getHints and getAllHints again
to recompute the hints.


## Built With

* Fault tolerant [fork](https://github.com/tonyganch/gonzales-pe) of [gonzales-pe](https://github.com/tonyganch/gonzales-pe) - CSS parser with support of preprocessors

## Authors

* **Shubham Yadav** - [shubhsnov](https://github.com/shubhsnov)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details