157 lines
4.9 KiB
Markdown
157 lines
4.9 KiB
Markdown
# postcss-prefix-selector
|
|
|
|
[![NPM version][npm-image]][npm-url]
|
|
[![Build status][travis-image]][travis-url]
|
|
[![Test coverage][coveralls-image]][coveralls-url]
|
|
[![Dependency Status][david-image]][david-url]
|
|
[![License][license-image]][license-url]
|
|
[![Downloads][downloads-image]][downloads-url]
|
|
[![Gitpod ready-to-code][gitpod-image]][gitpod-url]
|
|
|
|
> Prefix every CSS selector with a custom namespace `.a => .prefix .a`
|
|
|
|
## Table of Contents
|
|
|
|
- [Install](#install)
|
|
- [Usage with PostCSS](#usage-with-postcss)
|
|
- [Usage with Webpack](#usage-with-webpack)
|
|
- [Options](#options)
|
|
- [Maintainer](#maintainer)
|
|
- [Contribute](#contribute)
|
|
- [License](#license)
|
|
|
|
## Install
|
|
|
|
```console
|
|
$ npm install postcss-prefix-selector
|
|
```
|
|
|
|
## Usage with PostCSS
|
|
|
|
```js
|
|
const prefixer = require('postcss-prefix-selector')
|
|
|
|
// css to be processed
|
|
const css = fs.readFileSync("input.css", "utf8")
|
|
|
|
const out = postcss().use(prefixer({
|
|
prefix: '.some-selector',
|
|
exclude: ['.c'],
|
|
|
|
// Optional transform callback for case-by-case overrides
|
|
transform: function (prefix, selector, prefixedSelector) {
|
|
if (selector === 'body') {
|
|
return 'body' + prefix;
|
|
} else {
|
|
return prefixedSelector;
|
|
}
|
|
}
|
|
})).process(css).css
|
|
```
|
|
|
|
Using the options above and the CSS below...
|
|
|
|
```css
|
|
body {
|
|
background: red;
|
|
}
|
|
|
|
.a, .b {
|
|
color: aqua;
|
|
}
|
|
|
|
.c {
|
|
color: coral;
|
|
}
|
|
```
|
|
|
|
You will get the following output
|
|
|
|
```css
|
|
body.some-selector {
|
|
background: red;
|
|
}
|
|
|
|
.some-selector .a, .some-selector .b {
|
|
color: aqua;
|
|
}
|
|
|
|
.c {
|
|
color: coral;
|
|
}
|
|
```
|
|
|
|
## Usage with webpack
|
|
|
|
Use it like you'd use any other PostCSS plugin. If you also have `autoprefixer` in your webpack config then make sure that `postcss-prefix-selector` is called first. This is needed to avoid running the prefixer twice on both standard selectors and vendor specific ones (ex: `@keyframes` and `@webkit-keyframes`).
|
|
|
|
```js
|
|
module: {
|
|
rules: [{
|
|
test: /\.css$/,
|
|
use: [
|
|
require.resolve('style-loader'),
|
|
require.resolve('css-loader'),
|
|
{
|
|
loader: require.resolve('postcss-loader'),
|
|
options: {
|
|
postcssOptions: {
|
|
plugins: {
|
|
"postcss-prefix-selector": {
|
|
prefix: '.my-prefix',
|
|
transform(prefix, selector, prefixedSelector) {
|
|
if (selector.match(/^(html|body)/)) {
|
|
return selector.replace(/^([^\s]*)/, `$1 ${prefix}`);
|
|
}
|
|
return prefixedSelector;
|
|
},
|
|
},
|
|
autoprefixer: {
|
|
browsers: ['last 4 versions']
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}]
|
|
}
|
|
```
|
|
|
|
## Options
|
|
|
|
- `prefix` - This string is added before every CSS selector.
|
|
- `exclude` - It's possible to avoid prefixing some selectors by passing an array of selectors (strings or regular expressions).
|
|
- `transform` - In cases where you may want to use the prefix differently for different selectors, it is possible to pass in a custom transform method.
|
|
- `ignoreFiles` - List of ignored files for processing.
|
|
- `includeFiles` - List of included files for processing.
|
|
|
|
## Maintainer
|
|
|
|
This project was originally created by [@jongleberry](https://github.com/jonathanong) and is being maintained by [@RadValentin](https://github.com/RadValentin). If you have any questions, feel free to ping the latter.
|
|
|
|
## Contribute
|
|
|
|
Please contribute! If you have any questions or bugs, [open an issue](https://github.com/RadValentin/postcss-prefix-selector/issues/new). Or, open a pull request with a fix.
|
|
|
|
This project uses Mocha. If you submit a PR, please add appropriate tests and make sure that everything is green for your branch.
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE) © 2015-2019 Jonathan Ong.
|
|
|
|
[gitpod-image]: https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod
|
|
[gitpod-url]: https://gitpod.io/#https://github.com/RadValentin/postcss-prefix-selector
|
|
[npm-image]: https://img.shields.io/npm/v/postcss-prefix-selector.svg?style=flat-square
|
|
[npm-url]: https://npmjs.org/package/postcss-prefix-selector
|
|
[travis-image]: https://img.shields.io/travis/RadValentin/postcss-prefix-selector.svg?style=flat-square
|
|
[travis-url]: https://travis-ci.org/RadValentin/postcss-prefix-selector
|
|
[coveralls-image]: https://img.shields.io/coveralls/jonathanong/postcss-prefix-selector.svg?style=flat-square
|
|
[coveralls-url]: https://coveralls.io/r/jonathanong/postcss-prefix-selector
|
|
[david-image]: http://img.shields.io/david/RadValentin/postcss-prefix-selector.svg?style=flat-square
|
|
[david-url]: https://david-dm.org/RadValentin/postcss-prefix-selector
|
|
[license-image]: http://img.shields.io/npm/l/postcss-prefix-selector.svg?style=flat-square
|
|
[license-url]: LICENSE
|
|
[downloads-image]: http://img.shields.io/npm/dm/postcss-prefix-selector.svg?style=flat-square
|
|
[downloads-url]: https://npmjs.org/package/postcss-prefix-selector
|