Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michaeltaranto/less-vars-to-js
Read LESS variables from the contents of a file and returning them as a javascript object.
https://github.com/michaeltaranto/less-vars-to-js
Last synced: 3 months ago
JSON representation
Read LESS variables from the contents of a file and returning them as a javascript object.
- Host: GitHub
- URL: https://github.com/michaeltaranto/less-vars-to-js
- Owner: michaeltaranto
- Created: 2016-04-27T11:18:59.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-04-01T09:38:15.000Z (almost 5 years ago)
- Last Synced: 2024-05-17T20:03:39.395Z (8 months ago)
- Language: JavaScript
- Size: 16.6 KB
- Stars: 135
- Watchers: 2
- Forks: 21
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome - less-vars-to-js - Read LESS variables from the contents of a file and returning them as a javascript object. (JavaScript)
README
[](https://travis-ci.org/michaeltaranto/less-vars-to-js)
[](https://coveralls.io/github/michaeltaranto/less-vars-to-js?branch=master)
[](https://www.npmjs.com/package/less-vars-to-js) [](https://github.com/semantic-release/semantic-release) [](http://commitizen.github.io/cz-cli/)
# less-vars-to-js
Read [LESS](http://lesscss.org/) variables from the contents of a file and return them as a javascript object.
```js
$ npm install --save less-vars-to-js
```
### Why?
I wrote this to use in our living style guide where we document our colour palette, typography, grid, components etc. This allows variables to be visualised in the style guide without having to read through the code (useful for non-technical team members).
### What does it do?
Takes in the contents of a less file as a `string` and returns an `object` containing all the variables it found. It is deliberately naive as it is not intending to be a less parser. Basically it reads anything starting with an `@`, so it will ignore comments, rule definitions, import statements etc.
Example :
```less
@import (reference) "theme";
// Colour palette
@blue: #0d3880;
@pink: #e60278;
// Elements
@background: @gray;
@favourite: blanchedalmond;
// Grid
@row-height: 9;
.element {
@foreground: black;
color: @foreground;
}
```
Example output:
```json
{
"@blue": "#0d3880",
"@pink": "#e60278",
"@background": "@gray",
"@favourite": "blanchedalmond",
"@row-height": 9,
"@foreground": "black"
}
```
**Note:** while it does return variables it finds within rules, it is recommended to use this on files containing only variables, as it's not a parser and is designed to extract design principles for style guides.
### Options
| Option | Effect |
| ----------------- | ------------------------------------------------------------------------------------------------------------ |
| resolveVariables | Resolves variables when they are defined in the same file. |
| dictionary | When `resolveVariables` is true, passes an object to use when the value cannot be resolved in the same file. |
| stripPrefix | Removes the `@` or `$` in the returned object keys. |
### Usage
```js
import lessToJs from 'less-vars-to-js';
import fs from 'fs';
// Read the less file in as string
const paletteLess = fs.readFileSync('palette.less', 'utf8');
// Pass in file contents
const palette = lessToJs(paletteLess, {resolveVariables: true, stripPrefix: true});
// Use the variables (example React component)
export default class Palette extends Component {
render() {
return (
{
Object.keys(palette)
.forEach(colour => (
{ colour }
{ palette[colour] }
))
}
);
}
}
```
### License
[MIT](http://michaeltaranto.mit-license.org)