Skip to content

Commit 95de4c1

Browse files
michael-ciniawskymichael-ciniawsky
committedAug 8, 2018
docs(LOADER): update JSDoc
·
v8.1.1v3.0.0
1 parent ea68a42 commit 95de4c1

File tree

7 files changed

+197
-71
lines changed

7 files changed

+197
-71
lines changed
 

‎LOADER.md

-46
This file was deleted.

‎docs/LOADER.md

+130
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
## Modules
2+
3+
<dl>
4+
<dt><a href="#module_postcss-loader">postcss-loader</a></dt>
5+
<dd></dd>
6+
</dl>
7+
8+
## Classes
9+
10+
<dl>
11+
<dt><a href="#SyntaxError">SyntaxError</a> ⇐ <code>Error</code></dt>
12+
<dd></dd>
13+
<dt><a href="#Warning">Warning</a> ⇐ <code>Error</code></dt>
14+
<dd></dd>
15+
</dl>
16+
17+
## Functions
18+
19+
<dl>
20+
<dt><a href="#loader">loader(css, map)</a> ⇒ <code>cb</code></dt>
21+
<dd><p><strong>PostCSS Loader</strong></p>
22+
<p>Loads &amp;&amp; processes CSS with <a href="https://github.com/postcss/postcss">PostCSS</a></p>
23+
</dd>
24+
<dt><a href="#parseOptions">parseOptions(exec, parser, syntax, stringifier, plugins)</a> ⇒ <code>Promise</code></dt>
25+
<dd><p><strong>PostCSS Options Parser</strong></p>
26+
<p>Transforms the loader options into a valid postcss config <code>{Object}</code></p>
27+
</dd>
28+
</dl>
29+
30+
<a name="module_postcss-loader"></a>
31+
32+
## postcss-loader
33+
**Requires**: <code>module:path</code>, <code>module:loader-utils</code>, <code>module:schema-utils</code>, <code>module:postcss</code>, <code>module:postcss-load-config</code>, <code>module:./options.js</code>, <code>module:./Warning.js</code>, <code>module:./SyntaxError.js</code>
34+
**Version**: 3.0.0
35+
**Author**: Andrey Sitnik (@ai) <andrey@sitnik.ru>
36+
**License**: MIT
37+
<a name="SyntaxError"></a>
38+
39+
## SyntaxError ⇐ <code>Error</code>
40+
**Kind**: global class
41+
**Extends**: <code>Error</code>
42+
<a name="new_SyntaxError_new"></a>
43+
44+
### new SyntaxError(err)
45+
**PostCSS Syntax Error**
46+
47+
Loader wrapper for postcss syntax errors
48+
49+
50+
| Param | Type | Description |
51+
| --- | --- | --- |
52+
| err | <code>Object</code> | CssSyntaxError |
53+
54+
<a name="Warning"></a>
55+
56+
## Warning ⇐ <code>Error</code>
57+
**Kind**: global class
58+
**Extends**: <code>Error</code>
59+
<a name="new_Warning_new"></a>
60+
61+
### new Warning(warning)
62+
**PostCSS Plugin Warning**
63+
64+
Loader wrapper for postcss plugin warnings (`root.messages`)
65+
66+
67+
| Param | Type | Description |
68+
| --- | --- | --- |
69+
| warning | <code>Object</code> | PostCSS Warning |
70+
71+
<a name="loader"></a>
72+
73+
## loader(css, map) ⇒ <code>cb</code>
74+
**PostCSS Loader**
75+
76+
Loads && processes CSS with [PostCSS](https://github.com/postcss/postcss)
77+
78+
**Kind**: global function
79+
**Returns**: <code>cb</code> - cb Result
80+
81+
| Param | Type | Description |
82+
| --- | --- | --- |
83+
| css | <code>String</code> | Source |
84+
| map | <code>Object</code> | Source Map |
85+
86+
87+
* [loader(css, map)](#loader) ⇒ <code>cb</code>
88+
* [.cb](#loader.cb) : <code>function</code>
89+
* [.cb](#loader.cb) : <code>function</code>
90+
91+
<a name="loader.cb"></a>
92+
93+
### loader.cb : <code>function</code>
94+
**Kind**: static typedef of [<code>loader</code>](#loader)
95+
96+
| Param | Type | Description |
97+
| --- | --- | --- |
98+
| null | <code>Object</code> | Error |
99+
| css | <code>String</code> | Result (JS Module) |
100+
| map | <code>Object</code> | Source Map |
101+
102+
<a name="loader.cb"></a>
103+
104+
### loader.cb : <code>function</code>
105+
**Kind**: static typedef of [<code>loader</code>](#loader)
106+
107+
| Param | Type | Description |
108+
| --- | --- | --- |
109+
| null | <code>Object</code> | Error |
110+
| css | <code>String</code> | Result (Raw Module) |
111+
| map | <code>Object</code> | Source Map |
112+
113+
<a name="parseOptions"></a>
114+
115+
## parseOptions(exec, parser, syntax, stringifier, plugins) ⇒ <code>Promise</code>
116+
**PostCSS Options Parser**
117+
118+
Transforms the loader options into a valid postcss config `{Object}`
119+
120+
**Kind**: global function
121+
**Returns**: <code>Promise</code> - PostCSS Config
122+
123+
| Param | Type | Description |
124+
| --- | --- | --- |
125+
| exec | <code>Boolean</code> | Execute CSS-in-JS |
126+
| parser | <code>String</code> \| <code>Object</code> | PostCSS Parser |
127+
| syntax | <code>String</code> \| <code>Object</code> | PostCSS Syntax |
128+
| stringifier | <code>String</code> \| <code>Object</code> | PostCSS Stringifier |
129+
| plugins | <code>Array</code> \| <code>Object</code> \| <code>function</code> | PostCSS Plugins |
130+

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
"scripts": {
3030
"lint": "standard --env jest",
3131
"test": "jest --env node --verbose --coverage",
32-
"docs": "jsdoc2md src/*.js > LOADER.md",
32+
"docs": "jsdoc2md src/*.js > docs/LOADER.md",
3333
"clean": "rm -rf coverage test/outputs",
3434
"release": "standard-version"
3535
},

‎src/Error.js

+10
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
/**
2+
* **PostCSS Syntax Error**
3+
*
4+
* Loader wrapper for postcss syntax errors
5+
*
6+
* @class SyntaxError
7+
* @extends Error
8+
*
9+
* @param {Object} err CssSyntaxError
10+
*/
111
class SyntaxError extends Error {
212
constructor (err) {
313
super(err)

‎src/Warning.js

+10
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
/**
2+
* **PostCSS Plugin Warning**
3+
*
4+
* Loader wrapper for postcss plugin warnings (`root.messages`)
5+
*
6+
* @class Warning
7+
* @extends Error
8+
*
9+
* @param {Object} warning PostCSS Warning
10+
*/
111
class Warning extends Error {
212
constructor (warning) {
313
super()

‎src/index.js

+31-24
Original file line numberDiff line numberDiff line change
@@ -11,33 +11,18 @@ const SyntaxError = require('./Error.js')
1111
const parseOptions = require('./options.js')
1212

1313
/**
14-
* PostCSS Loader
14+
* **PostCSS Loader**
1515
*
16-
* > Loads && processes CSS with [PostCSS](https://github.com/postcss/postcss)
17-
*
18-
* @author Andrey Sitnik (@ai) <andrey@sitnik.ru>
19-
*
20-
* @license MIT
21-
* @version 2.0.0
22-
*
23-
* @requires path
24-
*
25-
* @requires loader-utils
26-
* @requires schema-utils
27-
*
28-
* @requires postcss
29-
* @requires postcss-load-config
30-
*
31-
* @requires Error
16+
* Loads && processes CSS with [PostCSS](https://github.com/postcss/postcss)
3217
*
3318
* @method loader
3419
*
35-
* @param {String} css Source
36-
* @param {Object} map Source Map
20+
* @param {String} css Source
21+
* @param {Object} map Source Map
3722
*
38-
* @return {cb} cb Result
23+
* @return {cb} cb Result
3924
*/
40-
module.exports = function loader (css, map, meta) {
25+
function loader (css, map, meta) {
4126
const options = Object.assign({}, getOptions(this))
4227

4328
validateOptions(require('./options.json'), options, 'PostCSS Loader')
@@ -192,9 +177,9 @@ module.exports = function loader (css, map, meta) {
192177
* @memberof loader
193178
* @callback cb
194179
*
195-
* @param {Object} null Error
196-
* @param {String} result Result (JS Module)
197-
* @param {Object} map Source Map
180+
* @param {Object} null Error
181+
* @param {String} css Result (JS Module)
182+
* @param {Object} map Source Map
198183
*/
199184
cb(null, `module.exports = ${JSON.stringify(css)}`, map)
200185

@@ -223,3 +208,25 @@ module.exports = function loader (css, map, meta) {
223208
: cb(err)
224209
})
225210
}
211+
212+
/**
213+
* @author Andrey Sitnik (@ai) <andrey@sitnik.ru>
214+
*
215+
* @license MIT
216+
* @version 3.0.0
217+
*
218+
* @module postcss-loader
219+
*
220+
* @requires path
221+
*
222+
* @requires loader-utils
223+
* @requires schema-utils
224+
*
225+
* @requires postcss
226+
* @requires postcss-load-config
227+
*
228+
* @requires ./options.js
229+
* @requires ./Warning.js
230+
* @requires ./SyntaxError.js
231+
*/
232+
module.exports = loader

‎src/options.js

+15
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
/**
2+
* **PostCSS Options Parser**
3+
*
4+
* Transforms the loader options into a valid postcss config `{Object}`
5+
*
6+
* @method parseOptions
7+
*
8+
* @param {Boolean} exec Execute CSS-in-JS
9+
* @param {String|Object} parser PostCSS Parser
10+
* @param {String|Object} syntax PostCSS Syntax
11+
* @param {String|Object} stringifier PostCSS Stringifier
12+
* @param {Array|Object|Function} plugins PostCSS Plugins
13+
*
14+
* @return {Promise} PostCSS Config
15+
*/
116
function parseOptions ({ exec, parser, syntax, stringifier, plugins }) {
217
if (typeof plugins === 'function') {
318
plugins = plugins.call(this, this)

0 commit comments

Comments
 (0)
Please sign in to comment.