Skip to content

Commit 1b24d55

Browse files
Postcss normalize display values (#203)
* WIP: PostCSS Normalize Display Values * Completing plugin * Labeler work * Some changes
1 parent 5b15998 commit 1b24d55

File tree

18 files changed

+836
-0
lines changed

18 files changed

+836
-0
lines changed

.github/labeler.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,10 @@
117117
- plugins/postcss-nesting/**
118118
- experimental/postcss-nesting/**
119119

120+
"plugins/postcss-normalize-display-values":
121+
- plugins/postcss-normalize-display-values/**
122+
- experimental/postcss-normalize-display-values/**
123+
120124
"plugins/postcss-overflow-shorthand":
121125
- plugins/postcss-overflow-shorthand/**
122126
- experimental/postcss-overflow-shorthand/**

package-lock.json

Lines changed: 24 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
node_modules
2+
package-lock.json
3+
yarn.lock
4+
*.result.css
5+
*.result.css.map
6+
dist/*
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v16.13.1
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
import postcssTape from '../../packages/postcss-tape/dist/index.mjs';
2+
import plugin from '@csstools/postcss-normalize-display-values';
3+
4+
postcssTape(plugin)({
5+
basic: {
6+
message: 'supports basic usage',
7+
},
8+
'basic:preserve-false': {
9+
message: 'supports variables with { preserve: true } usage',
10+
options: {
11+
preserve: false
12+
}
13+
},
14+
});
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Changes to PostCSS Normalize Display Values
2+
3+
### 1.0.0
4+
5+
- Initial version
Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
# Installing PostCSS Normalize Display Values
2+
3+
[PostCSS Normalize Display Values] runs in all Node environments, with special
4+
instructions for:
5+
6+
| [Node](#node) | [PostCSS CLI](#postcss-cli) | [Webpack](#webpack) | [Create React App](#create-react-app) | [Gulp](#gulp) | [Grunt](#grunt) |
7+
| --- | --- | --- | --- | --- | --- |
8+
9+
## Node
10+
11+
Add [PostCSS Normalize Display Values] to your project:
12+
13+
```bash
14+
npm install postcss @csstools/postcss-normalize-display-values --save-dev
15+
```
16+
17+
Use it as a [PostCSS] plugin:
18+
19+
```js
20+
const postcss = require('postcss');
21+
const postcssNormalizeDisplayValues = require('@csstools/postcss-normalize-display-values');
22+
23+
postcss([
24+
postcssNormalizeDisplayValues(/* pluginOptions */)
25+
]).process(YOUR_CSS /*, processOptions */);
26+
```
27+
28+
## PostCSS CLI
29+
30+
Add [PostCSS CLI] to your project:
31+
32+
```bash
33+
npm install postcss-cli --save-dev
34+
```
35+
36+
Use [PostCSS Normalize Display Values] in your `postcss.config.js` configuration
37+
file:
38+
39+
```js
40+
const postcssNormalizeDisplayValues = require('@csstools/postcss-normalize-display-values');
41+
42+
module.exports = {
43+
plugins: [
44+
postcssNormalizeDisplayValues(/* pluginOptions */)
45+
]
46+
}
47+
```
48+
49+
## Webpack
50+
51+
Add [PostCSS Loader] to your project:
52+
53+
```bash
54+
npm install postcss-loader --save-dev
55+
```
56+
57+
Use [PostCSS Normalize Display Values] in your Webpack configuration:
58+
59+
```js
60+
const postcssNormalizeDisplayValues = require('@csstools/postcss-normalize-display-values');
61+
62+
module.exports = {
63+
module: {
64+
rules: [
65+
{
66+
test: /\.css$/,
67+
use: [
68+
'style-loader',
69+
{ loader: 'css-loader', options: { importLoaders: 1 } },
70+
{ loader: 'postcss-loader', options: {
71+
ident: 'postcss',
72+
plugins: () => [
73+
postcssNormalizeDisplayValues(/* pluginOptions */)
74+
]
75+
} }
76+
]
77+
}
78+
]
79+
}
80+
}
81+
```
82+
83+
## Create React App
84+
85+
Add [React App Rewired] and [React App Rewire PostCSS] to your project:
86+
87+
```bash
88+
npm install react-app-rewired react-app-rewire-postcss --save-dev
89+
```
90+
91+
Use [React App Rewire PostCSS] and [PostCSS Normalize Display Values] in your
92+
`config-overrides.js` file:
93+
94+
```js
95+
const reactAppRewirePostcss = require('react-app-rewire-postcss');
96+
const postcssNormalizeDisplayValues = require('@csstools/postcss-normalize-display-values');
97+
98+
module.exports = config => reactAppRewirePostcss(config, {
99+
plugins: () => [
100+
postcssNormalizeDisplayValues(/* pluginOptions */)
101+
]
102+
});
103+
```
104+
105+
## Gulp
106+
107+
Add [Gulp PostCSS] to your project:
108+
109+
```bash
110+
npm install gulp-postcss --save-dev
111+
```
112+
113+
Use [PostCSS Normalize Display Values] in your Gulpfile:
114+
115+
```js
116+
const postcss = require('gulp-postcss');
117+
const postcssNormalizeDisplayValues = require('@csstools/postcss-normalize-display-values');
118+
119+
gulp.task('css', () => gulp.src('./src/*.css').pipe(
120+
postcss([
121+
postcssNormalizeDisplayValues(/* pluginOptions */)
122+
])
123+
).pipe(
124+
gulp.dest('.')
125+
));
126+
```
127+
128+
## Grunt
129+
130+
Add [Grunt PostCSS] to your project:
131+
132+
```bash
133+
npm install grunt-postcss --save-dev
134+
```
135+
136+
Use [PostCSS Normalize Display Values] in your Gruntfile:
137+
138+
```js
139+
const postcssNormalizeDisplayValues = require('@csstools/postcss-normalize-display-values');
140+
141+
grunt.loadNpmTasks('grunt-postcss');
142+
143+
grunt.initConfig({
144+
postcss: {
145+
options: {
146+
use: [
147+
postcssNormalizeDisplayValues(/* pluginOptions */)
148+
]
149+
},
150+
dist: {
151+
src: '*.css'
152+
}
153+
}
154+
});
155+
```
156+
157+
[Gulp PostCSS]: https://github.com/postcss/gulp-postcss
158+
[Grunt PostCSS]: https://github.com/nDmitry/grunt-postcss
159+
[PostCSS]: https://github.com/postcss/postcss
160+
[PostCSS CLI]: https://github.com/postcss/postcss-cli
161+
[PostCSS Loader]: https://github.com/postcss/postcss-loader
162+
[PostCSS Normalize Display Values]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-normalize-display-values
163+
[React App Rewire PostCSS]: https://github.com/csstools/react-app-rewire-postcss
164+
[React App Rewired]: https://github.com/timarney/react-app-rewired
Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
# CC0 1.0 Universal
2+
3+
## Statement of Purpose
4+
5+
The laws of most jurisdictions throughout the world automatically confer
6+
exclusive Copyright and Related Rights (defined below) upon the creator and
7+
subsequent owner(s) (each and all, an “owner”) of an original work of
8+
authorship and/or a database (each, a “Work”).
9+
10+
Certain owners wish to permanently relinquish those rights to a Work for the
11+
purpose of contributing to a commons of creative, cultural and scientific works
12+
(“Commons”) that the public can reliably and without fear of later claims of
13+
infringement build upon, modify, incorporate in other works, reuse and
14+
redistribute as freely as possible in any form whatsoever and for any purposes,
15+
including without limitation commercial purposes. These owners may contribute
16+
to the Commons to promote the ideal of a free culture and the further
17+
production of creative, cultural and scientific works, or to gain reputation or
18+
greater distribution for their Work in part through the use and efforts of
19+
others.
20+
21+
For these and/or other purposes and motivations, and without any expectation of
22+
additional consideration or compensation, the person associating CC0 with a
23+
Work (the “Affirmer”), to the extent that he or she is an owner of Copyright
24+
and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and
25+
publicly distribute the Work under its terms, with knowledge of his or her
26+
Copyright and Related Rights in the Work and the meaning and intended legal
27+
effect of CC0 on those rights.
28+
29+
1. Copyright and Related Rights. A Work made available under CC0 may be
30+
protected by copyright and related or neighboring rights (“Copyright and
31+
Related Rights”). Copyright and Related Rights include, but are not limited
32+
to, the following:
33+
1. the right to reproduce, adapt, distribute, perform, display, communicate,
34+
and translate a Work;
35+
2. moral rights retained by the original author(s) and/or performer(s);
36+
3. publicity and privacy rights pertaining to a person’s image or likeness
37+
depicted in a Work;
38+
4. rights protecting against unfair competition in regards to a Work,
39+
subject to the limitations in paragraph 4(i), below;
40+
5. rights protecting the extraction, dissemination, use and reuse of data in
41+
a Work;
42+
6. database rights (such as those arising under Directive 96/9/EC of the
43+
European Parliament and of the Council of 11 March 1996 on the legal
44+
protection of databases, and under any national implementation thereof,
45+
including any amended or successor version of such directive); and
46+
7. other similar, equivalent or corresponding rights throughout the world
47+
based on applicable law or treaty, and any national implementations
48+
thereof.
49+
50+
2. Waiver. To the greatest extent permitted by, but not in contravention of,
51+
applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
52+
unconditionally waives, abandons, and surrenders all of Affirmer’s Copyright
53+
and Related Rights and associated claims and causes of action, whether now
54+
known or unknown (including existing as well as future claims and causes of
55+
action), in the Work (i) in all territories worldwide, (ii) for the maximum
56+
duration provided by applicable law or treaty (including future time
57+
extensions), (iii) in any current or future medium and for any number of
58+
copies, and (iv) for any purpose whatsoever, including without limitation
59+
commercial, advertising or promotional purposes (the “Waiver”). Affirmer
60+
makes the Waiver for the benefit of each member of the public at large and
61+
to the detriment of Affirmer’s heirs and successors, fully intending that
62+
such Waiver shall not be subject to revocation, rescission, cancellation,
63+
termination, or any other legal or equitable action to disrupt the quiet
64+
enjoyment of the Work by the public as contemplated by Affirmer’s express
65+
Statement of Purpose.
66+
67+
3. Public License Fallback. Should any part of the Waiver for any reason be
68+
judged legally invalid or ineffective under applicable law, then the Waiver
69+
shall be preserved to the maximum extent permitted taking into account
70+
Affirmer’s express Statement of Purpose. In addition, to the extent the
71+
Waiver is so judged Affirmer hereby grants to each affected person a
72+
royalty-free, non transferable, non sublicensable, non exclusive,
73+
irrevocable and unconditional license to exercise Affirmer’s Copyright and
74+
Related Rights in the Work (i) in all territories worldwide, (ii) for the
75+
maximum duration provided by applicable law or treaty (including future time
76+
extensions), (iii) in any current or future medium and for any number of
77+
copies, and (iv) for any purpose whatsoever, including without limitation
78+
commercial, advertising or promotional purposes (the “License”). The License
79+
shall be deemed effective as of the date CC0 was applied by Affirmer to the
80+
Work. Should any part of the License for any reason be judged legally
81+
invalid or ineffective under applicable law, such partial invalidity or
82+
ineffectiveness shall not invalidate the remainder of the License, and in
83+
such case Affirmer hereby affirms that he or she will not (i) exercise any
84+
of his or her remaining Copyright and Related Rights in the Work or (ii)
85+
assert any associated claims and causes of action with respect to the Work,
86+
in either case contrary to Affirmer’s express Statement of Purpose.
87+
88+
4. Limitations and Disclaimers.
89+
1. No trademark or patent rights held by Affirmer are waived, abandoned,
90+
surrendered, licensed or otherwise affected by this document.
91+
2. Affirmer offers the Work as-is and makes no representations or warranties
92+
of any kind concerning the Work, express, implied, statutory or
93+
otherwise, including without limitation warranties of title,
94+
merchantability, fitness for a particular purpose, non infringement, or
95+
the absence of latent or other defects, accuracy, or the present or
96+
absence of errors, whether or not discoverable, all to the greatest
97+
extent permissible under applicable law.
98+
3. Affirmer disclaims responsibility for clearing rights of other persons
99+
that may apply to the Work or any use thereof, including without
100+
limitation any person’s Copyright and Related Rights in the Work.
101+
Further, Affirmer disclaims responsibility for obtaining any necessary
102+
consents, permissions or other rights required for any use of the Work.
103+
4. Affirmer understands and acknowledges that Creative Commons is not a
104+
party to this document and has no duty or obligation with respect to this
105+
CC0 or use of the Work.
106+
107+
For more information, please see
108+
http://creativecommons.org/publicdomain/zero/1.0/.

0 commit comments

Comments
 (0)