1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
[![npm][npm]][npm-url]
[![node][node]][node-url]
[![deps][deps]][deps-url]
[![tests][tests]][tests-url]
[![coverage][cover]][cover-url]
[![code style][style]][style-url]
[![chat][chat]][chat-url]
<div align="center">
<img width="100" height="100" title="Load Options"
src="https://michael-ciniawsky.github.io/postcss-load-options/logo.svg"
<a href="https://github.com/postcss/postcss">
<img width="110" height="110" title="PostCSS" src="http://postcss.github.io/postcss/logo.svg" hspace="10">
</a>
<h1>Load Options</h1>
</div>
<h2 align="center">Install</h2>
```bash
npm i -D postcss-load-options
```
<h2 align="center">Usage</h2>
### `package.json`
Create **`postcss`** section in your projects **`package.json`**.
```
App
|– client
|– public
|
|- package.json
```
```json
{
"dependencies": {
"sugarss": "0.2.0"
},
"postcss": {
"parser": "sugarss",
"map": false,
"from": "path/to/src/file.css",
"to": "path/to/dest/file.css"
}
}
```
### `.postcssrc`
Create a **`.postcssrc`** file.
```
App
|– client
|– public
|
|- (.postcssrc|.postcssrc.json|.postcssrc.yaml)
|- package.json
```
**`JSON`**
```json
{
"parser": "sugarss",
"map": false,
"from": "path/to/src/file.css",
"to": "path/to/dest/file.css"
}
```
**`YAML`**
```yaml
parser: sugarss
map: false
from: "/path/to/src.sss"
to: "/path/to/dest.css"
```
### `postcss.config.js` or `.postcssrc.js`
You may need some JavaScript logic to generate your config. For this case you can use a file named **`postcss.config.js`** or **`.postcssrc.js`**.
```
App
|– client
|– public
|
|- (postcss.config.js|.postcssrc.js)
|- package.json
```
```js
module.exports = (ctx) => {
return {
parser: ctx.sugar ? 'sugarss' : false,
map: ctx.env === 'development' ? ctx.map || false,
from: 'path/to/src/file.css',
to: 'path/to/dest/file.css'
}
}
```
<h2 align="center">Options</h2>
**`parser`**:
```js
'parser': 'sugarss'
```
**`syntax`**:
```js
'syntax': 'postcss-scss'
```
**`stringifier`**:
```js
'stringifier': 'midas'
```
[**`map`**:](https://github.com/postcss/postcss/blob/master/docs/source-maps.md)
```js
'map': 'inline'
```
**`from`**:
```js
from: 'path/to/dest/file.css'
```
**`to`**:
```js
to: 'path/to/dest/file.css'
```
### Context
When using a function `(postcss.config.js)`, it is possible to pass context to `postcss-load-options`, which will be evaluated before loading your options. By default `ctx.env (process.env.NODE_ENV)` and `ctx.cwd (process.cwd())` are available.
<h2 align="center">Example</h2>
### <img width="80" height="80" src="https://worldvectorlogo.com/logos/nodejs-icon.svg">
```js
const { readFileSync } = require('fs')
const postcss = require('postcss')
const optionsrc = require('postcss-load-options')
const sss = readFileSync('index.sss', 'utf8')
const ctx = { sugar: true, map: 'inline' }
optionsrc(ctx).then((options) => {
postcss()
.process(sss, options)
.then(({ css }) => console.log(css))
}))
```
<h2 align="center">Maintainers</h2>
<table>
<tbody>
<tr>
<td align="center">
<img width="150 height="150"
src="https://avatars.githubusercontent.com/u/5419992?v=3&s=150">
<br />
<a href="https://github.com/michael-ciniawsky">Michael Ciniawsky</a>
</td>
</tr>
<tbody>
</table>
[npm]: https://img.shields.io/npm/v/postcss-load-options.svg
[npm-url]: https://npmjs.com/package/postcss-load-options
[node]: https://img.shields.io/node/v/postcss-load-options.svg
[node-url]: https://nodejs.org/
[deps]: https://david-dm.org/michael-ciniawsky/postcss-load-options.svg
[deps-url]: https://david-dm.org/michael-ciniawsky/postcss-load-options
[tests]: http://img.shields.io/travis/michael-ciniawsky/postcss-load-options.svg
[tests-url]: https://travis-ci.org/michael-ciniawsky/postcss-load-options
[cover]: https://coveralls.io/repos/github/michael-ciniawsky/postcss-load-options/badge.svg
[cover-url]: https://coveralls.io/github/michael-ciniawsky/postcss-load-options
[style]: https://img.shields.io/badge/code%20style-standard-yellow.svg
[style-url]: http://standardjs.com/
[chat]: https://img.shields.io/gitter/room/postcss/postcss.svg
[chat-url]: https://gitter.im/postcss/postcss
|
