npmpackage.info

Gathering detailed insights and metrics for @automattic/mini-css-extract-plugin-with-rtl

@automattic/mini-css-extract-plugin-with-rtl - 0.8.0 | npmpackage.info

@automattic/mini-css-extract-plugin-with-rtl

mini-css-extract-plugin fork with support for WebpackRtlPlugin

0.8.0

MIT

JavaScript

1.7

Installations

npm install @automattic/mini-css-extract-plugin-with-rtl

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>= 6.9.0

Node Version

10.16.3

NPM Version

6.9.0 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

JavaScript

CSS

HTML

JavaScript (86.52%)

CSS (9.75%)

HTML (3.73%)

Developer

automattic

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

6 Stars

121 Commits

2 Forks

3 Watchers

3 Branches

136 Contributors

Updated on May 05, 2024

Maintainers

View All 136 Contributors

Package Meta Information

Latest Version

0.8.0

Package Id

@automattic/mini-css-extract-plugin-with-rtl@0.8.0

Size

14.46 kB

NPM Version

6.9.0

Node Version

10.16.3

Published on

Nov 27, 2019

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

This plugin is a fork of mini-css-extract-plugin but with a support for WebpackRTLPlugin. Namely, it allows to load async CSS files depending of page's current direction. Please check mentioned packages to learn how to use them.

1npm install --save-dev mini-css-extract-plugin-with-rtl

Usage

Configuration

webpack.config.js

1const MiniCssExtractPlugin = require("mini-css-extract-plugin-with-rtl");
2const WebpackRTLPlugin = require("webpack-rtl-plugin");
3
4module.exports = {
5  plugins: [
6    new MiniCssExtractPlugin({
7      // Options similar to the same options in webpackOptions.output
8      // both options are optional
9      filename: '[name].css',
10      chunkFilename: '[id].css',
11      rtlEnabled: true,
12      // Global variable (e.g., `window.pageDir`) whose value determines whether to load the LTR or
13      // RTL version of a CSS chunk at runtime. Value should be either `"ltr"` or `"rtl"`. If the
14      // `rtlGlobalVar` option is not specified, we check `document.dir` by default.
15      rtlGlobalVar: 'pageDir' 
16
17    }),
18    new WebpackRTLPlugin() // You must not pass filename option
19  ],
20  module: {
21    rules: [
22      {
23        test: /\.css$/,
24        use: [
25          {
26            loader: MiniCssExtractPlugin.loader,
27            options: {
28              // you can specify a publicPath here
29              // by default it uses publicPath in webpackOptions.output
30              publicPath: '../',
31              hmr: process.env.NODE_ENV === 'development',
32            },
33          },
34          'css-loader',
35        ],
36      },
37    ],
38  },
39};

Credits

Originally created by Maxim Valenko as beshanoe/mini-css-extract-plugin-with-rtl. Automattic updated the plugin to use the latest mini-css-extract-plugin upstream version, reorganized the commit structure to make the fork easier to maintain, and added support for data-webpack attribute in the <link> tags inserted into the HTML body.

Original mini-css-extract-plugin README continues from here

mini-css-extract-plugin

This plugin extracts CSS into separate files. It creates a CSS file per JS file which contains CSS. It supports On-Demand-Loading of CSS and SourceMaps.

It builds on top of a new webpack v4 feature (module types) and requires webpack 4 to work.

Compared to the extract-text-webpack-plugin:

Async loading
No duplicate compilation (performance)
Easier to use
Specific to CSS

Install

1npm install --save-dev mini-css-extract-plugin

Usage

Configuration

`publicPath`

Type: String|Function Default: the publicPath in webpackOptions.output

Specifies a custom public path for the target file(s).

Minimal example

webpack.config.js

1const MiniCssExtractPlugin = require('mini-css-extract-plugin');
2module.exports = {
3  plugins: [
4    new MiniCssExtractPlugin({
5      // Options similar to the same options in webpackOptions.output
6      // all options are optional
7      filename: '[name].css',
8      chunkFilename: '[id].css',
9      ignoreOrder: false, // Enable to remove warnings about conflicting order
10    }),
11  ],
12  module: {
13    rules: [
14      {
15        test: /\.css$/,
16        use: [
17          {
18            loader: MiniCssExtractPlugin.loader,
19            options: {
20              // you can specify a publicPath here
21              // by default it uses publicPath in webpackOptions.output
22              publicPath: '../',
23              hmr: process.env.NODE_ENV === 'development',
24            },
25          },
26          'css-loader',
27        ],
28      },
29    ],
30  },
31};

`publicPath` function example

webpack.config.js

1const MiniCssExtractPlugin = require('mini-css-extract-plugin');
2module.exports = {
3  plugins: [
4    new MiniCssExtractPlugin({
5      // Options similar to the same options in webpackOptions.output
6      // both options are optional
7      filename: '[name].css',
8      chunkFilename: '[id].css',
9    }),
10  ],
11  module: {
12    rules: [
13      {
14        test: /\.css$/,
15        use: [
16          {
17            loader: MiniCssExtractPlugin.loader,
18            options: {
19              publicPath: (resourcePath, context) => {
20                // publicPath is the relative path of the resource to the context
21                // e.g. for ./css/admin/main.css the publicPath will be ../../
22                // while for ./css/main.css the publicPath will be ../
23                return path.relative(path.dirname(resourcePath), context) + '/';
24              },
25            },
26          },
27          'css-loader',
28        ],
29      },
30    ],
31  },
32};

Advanced configuration example

This plugin should be used only on production builds without style-loader in the loaders chain, especially if you want to have HMR in development.

Here is an example to have both HMR in development and your styles extracted in a file for production builds.

(Loaders options left out for clarity, adapt accordingly to your needs.)

webpack.config.js

1const MiniCssExtractPlugin = require('mini-css-extract-plugin');
2const devMode = process.env.NODE_ENV !== 'production';
3
4module.exports = {
5  plugins: [
6    new MiniCssExtractPlugin({
7      // Options similar to the same options in webpackOptions.output
8      // both options are optional
9      filename: devMode ? '[name].css' : '[name].[hash].css',
10      chunkFilename: devMode ? '[id].css' : '[id].[hash].css',
11    }),
12  ],
13  module: {
14    rules: [
15      {
16        test: /\.(sa|sc|c)ss$/,
17        use: [
18          {
19            loader: MiniCssExtractPlugin.loader,
20            options: {
21              hmr: process.env.NODE_ENV === 'development',
22            },
23          },
24          'css-loader',
25          'postcss-loader',
26          'sass-loader',
27        ],
28      },
29    ],
30  },
31};

Hot Module Reloading (HMR)

extract-mini-css-plugin supports hot reloading of actual css files in development. Some options are provided to enable HMR of both standard stylesheets and locally scoped CSS or CSS modules. Below is an example configuration of mini-css for HMR use with CSS modules.

While we attempt to hmr css-modules. It is not easy to perform when code-splitting with custom chunk names. reloadAll is an option that should only be enabled if HMR isn't working correctly. The core challenge with css-modules is that when code-split, the chunk ids can and do end up different compared to the filename.

webpack.config.js

1const MiniCssExtractPlugin = require('mini-css-extract-plugin');
2module.exports = {
3  plugins: [
4    new MiniCssExtractPlugin({
5      // Options similar to the same options in webpackOptions.output
6      // both options are optional
7      filename: '[name].css',
8      chunkFilename: '[id].css',
9    }),
10  ],
11  module: {
12    rules: [
13      {
14        test: /\.css$/,
15        use: [
16          {
17            loader: MiniCssExtractPlugin.loader,
18            options: {
19              // only enable hot in development
20              hmr: process.env.NODE_ENV === 'development',
21              // if hmr does not work, this is a forceful method.
22              reloadAll: true,
23            },
24          },
25          'css-loader',
26        ],
27      },
28    ],
29  },
30};

Minimizing For Production

To minify the output, use a plugin like optimize-css-assets-webpack-plugin. Setting optimization.minimizer overrides the defaults provided by webpack, so make sure to also specify a JS minimizer:

webpack.config.js

1const TerserJSPlugin = require('terser-webpack-plugin');
2const MiniCssExtractPlugin = require('mini-css-extract-plugin');
3const OptimizeCSSAssetsPlugin = require('optimize-css-assets-webpack-plugin');
4module.exports = {
5  optimization: {
6    minimizer: [new TerserJSPlugin({}), new OptimizeCSSAssetsPlugin({})],
7  },
8  plugins: [
9    new MiniCssExtractPlugin({
10      filename: '[name].css',
11      chunkFilename: '[id].css',
12    }),
13  ],
14  module: {
15    rules: [
16      {
17        test: /\.css$/,
18        use: [MiniCssExtractPlugin.loader, 'css-loader'],
19      },
20    ],
21  },
22};

Features

Using preloaded or inlined CSS

The runtime code detects already added CSS via <link> or <style> tag. This can be useful when injecting CSS on server-side for Server-Side-Rendering. The href of the <link> tag has to match the URL that will be used for loading the CSS chunk. The data-href attribute can be used for <link> and <style> too. When inlining CSS data-href must be used.

Extracting all CSS in a single file

Similar to what extract-text-webpack-plugin does, the CSS can be extracted in one CSS file using optimization.splitChunks.cacheGroups.

webpack.config.js

1const MiniCssExtractPlugin = require('mini-css-extract-plugin');
2module.exports = {
3  optimization: {
4    splitChunks: {
5      cacheGroups: {
6        styles: {
7          name: 'styles',
8          test: /\.css$/,
9          chunks: 'all',
10          enforce: true,
11        },
12      },
13    },
14  },
15  plugins: [
16    new MiniCssExtractPlugin({
17      filename: '[name].css',
18    }),
19  ],
20  module: {
21    rules: [
22      {
23        test: /\.css$/,
24        use: [MiniCssExtractPlugin.loader, 'css-loader'],
25      },
26    ],
27  },
28};

Extracting CSS based on entry

You may also extract the CSS based on the webpack entry name. This is especially useful if you import routes dynamically but want to keep your CSS bundled according to entry. This also prevents the CSS duplication issue one had with the ExtractTextPlugin.

1const path = require('path');
2const MiniCssExtractPlugin = require('mini-css-extract-plugin');
3
4function recursiveIssuer(m) {
5  if (m.issuer) {
6    return recursiveIssuer(m.issuer);
7  } else if (m.name) {
8    return m.name;
9  } else {
10    return false;
11  }
12}
13
14module.exports = {
15  entry: {
16    foo: path.resolve(__dirname, 'src/foo'),
17    bar: path.resolve(__dirname, 'src/bar'),
18  },
19  optimization: {
20    splitChunks: {
21      cacheGroups: {
22        fooStyles: {
23          name: 'foo',
24          test: (m, c, entry = 'foo') =>
25            m.constructor.name === 'CssModule' && recursiveIssuer(m) === entry,
26          chunks: 'all',
27          enforce: true,
28        },
29        barStyles: {
30          name: 'bar',
31          test: (m, c, entry = 'bar') =>
32            m.constructor.name === 'CssModule' && recursiveIssuer(m) === entry,
33          chunks: 'all',
34          enforce: true,
35        },
36      },
37    },
38  },
39  plugins: [
40    new MiniCssExtractPlugin({
41      filename: '[name].css',
42    }),
43  ],
44  module: {
45    rules: [
46      {
47        test: /\.css$/,
48        use: [MiniCssExtractPlugin.loader, 'css-loader'],
49      },
50    ],
51  },
52};

Module Filename Option

With the moduleFilename option you can use chunk data to customize the filename. This is particularly useful when dealing with multiple entry points and wanting to get more control out of the filename for a given entry point/chunk. In the example below, we'll use moduleFilename to output the generated css into a different directory.

1const miniCssExtractPlugin = new MiniCssExtractPlugin({
2  moduleFilename: ({ name }) => `${name.replace('/js/', '/css/')}.css`,
3});

Long Term Caching

For long term caching use filename: "[contenthash].css". Optionally add [name].

Remove Order Warnings

For projects where css ordering has been mitigated through consistent use of scoping or naming conventions, the css order warnings can be disabled by setting the ignoreOrder flag to true for the plugin.

1new MiniCssExtractPlugin({
2  ignoreOrder: true,
3}),

Media Query Plugin

If you'd like to extract the media queries from the extracted CSS (so mobile users don't need to load desktop or tablet specific CSS anymore) you should use one of the following plugins:

License

MIT

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

SAST

Determines if the project uses static code analysis.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Security-Policy

Determines if the project has published a security policy.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

123 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-3wcq-x3mq-6r9p
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2
Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh
Warn: Project is vulnerable to: GHSA-3gx7-xhv7-5mx3
Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-6x33-pw7p-hmpq
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr
Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-92xj-mqp7-vmcj
Warn: Project is vulnerable to: GHSA-wxgw-qj99-44c2
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-8g77-54rh-46hx
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6
Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-c9g6-9335-x697
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-7xcx-6wjh-7xp2
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v
Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h
Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.7

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@automattic/mini-css-extract-plugin-with-rtl

Installations

Developer Guide

No

CommonJS

>= 6.9.0

10.16.3

6.9.0

Pull Requests

0

0

0

Issues

0

0

0

Releases

Unable to fetch releases

Languages

Developer

automattic

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

Usage

Configuration

Credits

mini-css-extract-plugin

Install

Usage

Configuration

publicPath

Minimal example

publicPath function example

Advanced configuration example

Hot Module Reloading (HMR)

Minimizing For Production

Features

Using preloaded or inlined CSS

Extracting all CSS in a single file

Extracting CSS based on entry

Module Filename Option

Long Term Caching

Remove Order Warnings

Media Query Plugin

License

10

10

0

0

0

0

0

0

0

0

1.7

/10

`publicPath`

`publicPath` function example