postcss-safe-important

KO | EN

gitlite — search

#llm #golang #go #rust #linux #macos #nodejs #java #windows #awesome #kubernetes #awesome-list #pytorch #security

postcss-safe-important

(★ 33)

PostCSS plugin that adds !important to style declarations safely.

postcss-safe-important 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# PostCSS Safe Important

[![Build Status][ci-img]][ci]
[![Npm Downloads Total][dt-img]][npm]
![Node Version][node-img]
[![Npm][npm-img]][npm]

[PostCSS] plugin that adds `!important` to style declarations safely.

[PostCSS]:  https://github.com/postcss/postcss
[ci-img]:   https://img.shields.io/github/actions/workflow/status/crimx/postcss-safe-important/build.yml
[ci]:       https://github.com/crimx/postcss-safe-important/actions/workflows/build.yml
[npm-img]:  https://img.shields.io/npm/v/postcss-safe-important.svg
[npm]:      https://www.npmjs.com/package/postcss-safe-important
[dt-img]:   https://img.shields.io/npm/dt/postcss-safe-important.svg
[node-img]: https://img.shields.io/npm/dm/postcss-safe-important.svg

## Why would I need it?

> You should probably look at shadow dom and web components first.

Quoted from [Cleanslate](http://cleanslatecss.com/#Why-would-I-need-it)

> When there are existing CSS styles on a page, and you want to prevent those styles cascading into some part of the page. This is not a stylesheet to use when developing your own website (for that, try [Eric Meyer’s classic “Reset CSS”](http://meyerweb.com/eric/tools/css/reset/) or the [“HTML5 Doctors’ adaptation”](http://html5doctor.com/html-5-reset-stylesheet).
>
> The stylesheet can be useful when distributing content (e.g. a widget, or syndicated news) to third-party websites. The CSS rules in the host site may be unknown and unpredictable, or may change in future without notice, or there may be so many websites you need to distribute to that it is impractical to write specific CSS that overrides the styles in each one. In such situations, the Cleanslate stylesheet will aggressively reset your portion of the content (and nothing else) back to some reasonable default values that you can then build from.
>
> ### Why not just use an iframe?
>
> Third-party content is often distributed in iframes. Because JavaScript within an iframe can be prevented from accessing the host page, iframes are particularly useful when the host site has security concerns and does not explicitly trust the third-party content.
>
> However, iframes have some drawbacks:
>
> - You cannot display content outside of the box of the iframe.
> - It is tricky to resize the iframe to match the size of its contents.
> - Your content will be unable to interact with the host page, even if it is trusted.
> - Search engines like Google will not see the content on the host page. Content that is syndicated from a partner website can avoid this by being directly included in the host page.

Whether you work with extreme CSS reset stylesheet like Cleanslate or simply just want to give maximum weight for all your declarations, don't do it manually! Use [postcss-safe-important] to keep your source styles clean and portable.

## Safe?

Adding `!important` to every declarations might break your style. For example, [declarations in a keyframe that are qualified with `!important` are ignored](https://developer.mozilla.org/en-US/docs/Web/CSS/@keyframes#!important_in_a_keyframe).

[postcss-safe-important] will skip [unnecessary declarations](#default-exclusions). You can also set your own exclusions through options or comments (see examples below).

[postcss-safe-important]: https://github.com/Crimx/postcss-safe-important

```css
/* Input example */
.foo {
    width: 100px;
    color: #000; /* no !important */ }

.bar {
    /* no important */
    color: ##fff;
    width: 100px; }
```

```css
/* Output example */
.foo {
    width: 100px !important;
    color: #000; }

.bar {
    color: ##fff;
    width: 100px; }
```

## Usage

```
$ npm install postcss-safe-important --save-dev
```

### Example

```js
var safeImportant = require("postcss-safe-important");

postcss([
    safeImportant({
        // options
        excludeSelectors: "#bar", // config with string
        excludeDeclarations: /color/, // config with regex
        excludeCSSVariables: ["--width", "--height"], // config with array of string
        excludeAtRules: (atRule) => atRule === "media", // config with function
        excludePaths: p => p.startsWith(path.resolve(__dirname, "../node_modules")), // exclude paths
        disableDefaultExcludes: false, // disable default exclusion lists
        keepComments: true, // all the `no important` comments will be erased
    }),
]);
```

See [tests](https://github.com/crimx/postcss-safe-important/blob/main/test.js) for more examples.

## Comments

You can use either `/* no !important */` or `/* no important */` to indicate no changing.

If the comment is right inside a rule(be the first child node of the rule), the whole rule will not change.

```css
/* Input example */
.foo {
    /* no important */
    width: 100px;
    color: #000; }

.bar { /* no !important */
    width: 100px;
    color: #000; }
```

```css
/* Output example */
.foo {
    width: 100px;
    color: #000; }

.bar {
    width: 100px;
    color: #000; }
```

If the comment is right behind(or below) a declaration, then only the declaration will remain the same.

```css
/* Input example */
.foo {
    width: 100px;
    color: #000; /* no important */}
```

```css
/* Output example */
.foo {
    width: 100px !important;
    color: #000; }
```

## Options

### Exclusions

- `excludeSelectors`: exclude selectors. Default empty (default exclusions still applies unless `options.disableDefaultExcludes = true`)
- `excludeDeclarations`: exclude declarations. Default empty (default exclusions still applies unless `options.disableDefaultExcludes = true`)
- `excludeAtRules`: exclude atrules(e.g. `@font-face`). Default empty (default exclusions still applies unless `options.disableDefaultExcludes = true`)
- `excludeCSSVariables`: exclude CSS variables. Default excludes all CSS Variables.
- `excludePaths`. exclude style paths. Default empty.

You can pass either a **string**, a **regexp**, an **iterable**, or a `shouldExclude(rule: string): boolean` **function**.

```js
var safeImportant = require("postcss-safe-important");

If you want styles in node_modules left untouched, let's say your postcss config file is at project root, you can:

```js
var safeImportant = require("postcss-safe-important");
var path = require("path");

postcss([
    safeImportant({
        excludePaths: p => p.startsWith(path.resolve(__dirname, "./node_modules")),
    }),
]);
```

### Keep `/* no important */` comments

- `keepComments`: **bool**, default `false`.

### Disable Default Declarations

- `disableDefaultExcludes`: **bool**, default `false`.

Disable the default exclusion list below.

## Default Exclusions

### Variables

All CSS variables.

### Atrules

- keyframes
- font-face

### Declarations

- animation
- animation-name
- animation-duration
- animation-timing-function
- animation-delay
- animation-iteration-count
- animation-direction
- animation-fill-mode
- animation-play-state

## [Change Log](CHANGELOG.md)

See [PostCSS] docs for examples for your environment.

## [License](LICENSE)

MIT

postcss-safe-important

postcss-safe-important 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

postcss-safe-important

postcss-safe-important 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README