ce4c83ff
 wxy
初始提交
|
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
|
# [postcss][postcss]-discard-comments [][ci] [][npm] [][deps]
> Discard comments in your CSS files with PostCSS.
## Install
With [npm](https://npmjs.org/package/postcss-discard-comments) do:
```
npm install postcss-discard-comments --save
```
## Example
### Input
```css
h1/* heading */{
margin: 0 auto
}
```
### Output
```css
h1 {
margin: 0 auto
}
```
This module discards comments from your CSS files; by default, it will remove
all regular comments (`/* comment */`) and preserve comments marked as important
(`/*! important */`).
Note that this module does not handle source map comments because they are not
available to it; PostCSS handles this internally, so if they are removed then
you will have to [configure source maps in PostCSS][maps].
[maps]: https://github.com/postcss/postcss/blob/master/docs/source-maps.md
## API
### comments([options])
#### options
##### remove(function)
Type: `function`
Return: `boolean`
Variable: `comment` contains a comment without `/**/`
For each comment, return true to remove, or false to keep the comment.
```js
function(comment) {}
```
```js
var css = '/* headings *//*@ h1 */h1{margin:0 auto}/*@ h2 */h2{color:red}';
console.log(postcss(comments({
remove: function(comment) { return comment[0] == "@"; }
})).process(css).css);
//=> /* headings */h1{margin:0 auto}h2{color:red}
```
**NOTE:** If you use the `remove` function other options will not be available.
##### removeAll
Type: `boolean`
Default: `false`
Remove all comments marked as important.
```js
var css = '/*! heading */h1{margin:0 auto}/*! heading 2 */h2{color:red}';
console.log(postcss(comments({removeAll: true})).process(css).css);
//=> h1{margin:0 auto}h2{color:red}
```
##### removeAllButFirst
Type: `boolean`
Default: `false`
Remove all comments marked as important, but the first one.
```js
var css = '/*! heading */h1{margin:0 auto}/*! heading 2 */h2{color:red}';
console.log(postcss(comments({removeAllButFirst: true})).process(css).css);
//=> /*! heading */h1{margin:0 auto}h2{color:red}
```
## Usage
See the [PostCSS documentation](https://github.com/postcss/postcss#usage) for
examples for your environment.
## Contributing
Pull requests are welcome. If you add functionality, then please add unit tests
to cover it.
## License
MIT © Ben Briggs
[ci]: https://travis-ci.org/ben-eb/postcss-discard-comments
[deps]: https://gemnasium.com/ben-eb/postcss-discard-comments
[npm]: http://badge.fury.io/js/postcss-discard-comments
[postcss]: https://github.com/postcss/postcss
|
