Fixed caching issues

Author: jsimck

README.md

@@ -14,105 +14,79 @@
     </a>
 </p>
 
-Serves as an alternative and also addition to `postcss-loader`. While webpack loaders are efficient, when you need to run some transformations on concatenated CSS (through `mini-css-extract-plugin` for example), loaders allows you to process just one file at time.
-
-This plugin tries to solve this issue while taking great inspiration from [postcss-pipeline-webpack-plugin](https://github.com/mistakster/postcss-pipeline-webpack-plugin#readme). It allows you to **run PostCSS plugins** on generated (and newly emitted) **assets**, with support for webpack 5.x **filesystem cache** and ability to change content of **existing assets**, rather than a need to always generate new ones.
+Webpack loaders are pretty cool but limited to process and generate only one file at a time. If you are extracting critical CSS or media queries into separate files, you are no longer able to process these files. This plugin was made to solve this problem.
 
 ## Quick start
 ```console
-npm i -D postcss postcss-webpack-plugin
+npx jsconfig.json
 ```
 
-```javascript
-const { PostCSSWebpackPlugin } = require('postcss-webpack-plugin');
-
-new PostCSSWebpackPlugin({
-  // Required: Array of PostCSS plugins that are passed directly to postcss function
-  plugins: [require('cssnano')],
-  /**
-   * Optional: Can be either function, which receives asset file name as first
-   * argument and should return new name ((filename: string) => string). Or a string
-   * with a support for [base], [dir], [name], [ext] template tags. Defaults to the
-   * existing filename (updates asset content) if not provided.
-   */
-  filename?: string | ((filename: string) => string),
-  /**
-   * Optional: Custom function or RegExp to filter out unwanted assets. Defaults
-   * to /\.css$/ to process only CSS files.
-   */
-  filter?: RegExp | ((filename: string) => boolean),
-  // Optional: Custom implementation of postcss, defaults to require('postcss')
-  implementation?: require('postcss'),
-  /**
-   * Optional: Runs plugin also for newly emitted assets. Should be combined
-   * with custom filter option in order to not get stuck processing the same
-   * file all over again.
-   */
-  additionalAssets?: true | undefined,
-})
-```
+By default the `jsconfig.json` is generated in **current working directory** (this is also where the script looks for existence of `webpack.config.js` or `package.json` file in order to try to extract path aliases).
+
+This can be changed by providing path to custom working directory as a **first argument** of the cli (`npx jsconfig.json ~/Workspace/my-project`).
 
-## Usage
-Sample usage in the webpack config object.
-
-```javascript
-const { PostCSSWebpackPlugin } = require('postcss-webpack-plugin');
-const MiniCssExtractPlugin = require('mini-css-extract-plugin');
-
-module.exports = {
-  entry: 'main.css',
-  plugins: [
-    new MiniCssExtractPlugin({
-      filename: '[name].css',
-      chunkFilename: '[id].[name].css',
-    }),
-    ...(config?.plugins ?? []),
-  ],
-  module: {
-    rules: [
-      {
-        test: /.css$/i,
-        use: [MiniCssExtractPlugin.loader, 'css-loader'],
-      },
-    ],
-  },
-  plugins: [
-    new PostCSSWebpackPlugin({
-      plugins: [require('postcss-pxtorem'), require('cssnano')],
-    })
-  ]
-};
+### Templates
+
+There are few predefined jsconfig.json templates, that can be selected using `-t, --template` argument to help bootstrap the correct environment (`default` [default option], `nextjs`, `react`, `vuejs` and `node`).
+
+```console
+npx jsconfig.json --template=nextjs
 ```
 
-### Advanced usage
-
-Multiple instances can be chained together:
-
-```javascript
-const { PostCSSWebpackPlugin } = require('postcss-webpack-plugin');
-
-module.exports = {
-  entry: 'main.css',
-  // ...
-  plugins: [
-    new PostCSSWebpackPlugin({
-      plugins: [require('postcss-pxtorem'), require('cssnano')],
-      filename: '[name].rem[ext]',
-    }),
-    new PostCSSWebpackPlugin({
-      plugins: [require('postcss-pxtorem'), require('cssnano')],
-      filename: '[name].min[ext]',
-    })
-  ]
-};
+### Additional CLI options
+
+These allow you to further overwrite additional defaults or even provide custom `--baseUrl` and `--webpackConfigPath` that are used to generate correct paths to aliases. Lastly `--output` is used to define custom output directory for generated jsconfig.json file (this will not change the path aliases generation in any way). For more options run:
+
+```console
+npx jsconfig.json --help
 ```
 
-This produces following output:
+```console
+Usage: npx jsconfig.json <srcPath> [options]
+
+Options:
+      --help                    Show help                                           [boolean]
+      --version                 Show version number                                 [boolean]
+  -o, --output                  Optional custom output directory for generated jsconfig.json
+                                file                                                 [string]
+  -t, --template                Base jsconfig.json template
+                [choices: "default", "nextjs", "react", "vuejs", "node"] [default: "default"]
+  -b, --baseUrl                 Custom base url used for paths generation            [string]
+  -c, --webpackConfig           Custom path to webpack.config.js                     [string]
+  -a, --target                  Specifies which default library (lib.d.ts) to use
+    [string] [choices: "es3", "es5", "es6", "es2015", "es2016", "es2017", "es2018", "es2019",
+                                                      "es2020", "esnext"] [default: "es2020"]
+  -m, --module                  Specifies the module system, when generating module code
+    [string] [choices: "amd", "commonJS", "es2015", "es6", "esnext", "none", "system", "umd"]
+                                                                          [default: "es2015"]
+  -r, --moduleResolution        Specifies how modules are resolved for imports
+                                      [string] [choices: "node", "classic"] [default: "node"]
+  -e, --experimentalDecorators  Enables experimental support for proposed ES decorators
+                                                                                    [boolean]
+  -s, --syntheticImports        Allow default imports from modules with no default export.
+                                This does not affect code emit, just type checking. [boolean]
 ```
 
+### Support
+- Node.js >= **12.x**
+
+
+## Contributions
+
+Contributions of any kind are very welcome!
+
+This repository uses **conventional commits** in order to correctly generate CHANGELOG and release automatically. This means that all commits should follow correct form defined in the conventional commits specification. To make this process easier (and since there's pre-commit hook to validate commit messages. which won't let you commit invalid messages) you can run commit wizard using:
+
 ```
+npm run commit
+```
+
+Which will take you through the process of generating correct format of the commit message.
+
+### Development
+
+To run cli in development you can use `npm run dev` to fires up nodemon which watches changes over the source files. By default the result is written to tmp/jsconfig.json when using nodemon (this looks int the root directory of the repository for webpack configs, you can provide custom webpack config while developing using CLI options `npm run dev -- --webpackConfig=/tmp/custom.webpack.test.config.js`).
+
+### Tests
 
-## Support
- - Node.js >= 14
- - postcss >= 8
- - webpack >= 5
+Tests are written using [jest framework](https://jestjs.io/). To run them use either `npm run test` or `npm run test:unit`, `npm run test e2e` to run each set of tests separately.

src/__fixtures__/base.css src/__tests__/__mocks__/base.csssrc/__fixtures__/base.css renamed to src/__tests__/__mocks__/base.css

@@ -9,7 +9,7 @@ function getCompiler(config: webpack.Configuration = {}): webpack.Compiler {
     entry: config.entry ?? './base.css',
     mode: 'development',
     devtool: config.devtool ?? false,
-    context: path.resolve(__dirname, '../../__fixtures__'),
+    context: path.resolve(__dirname, '../__mocks__'),
     output: {
       pathinfo: false,
       path: path.resolve(__dirname, '../../__outputs__'),

src/__fixtures__/component.css src/__tests__/__mocks__/component.csssrc/__fixtures__/component.css renamed to src/__tests__/__mocks__/component.css

@@ -59,13 +59,9 @@ describe('when used with additionalAssets option', () => {
   it('should apply postcss to additional assets', async () => {
     const compiler = getCompiler({
       plugins: [
-        new PostCSSWebpackPlugin({
-          plugins: [require('postcss-pxtorem')],
-          filename: '[name].pxtorem[ext]',
-        }),
         new PostCSSWebpackPlugin({
           plugins: [require('cssnano')],
-          filename: '[name].minimized[ext]',
+          filename: '[name].min[ext]',
           additionalAssets: true,
         }),
       ],
@@ -76,19 +72,13 @@ describe('when used with additionalAssets option', () => {
     expect(readAssets(compiler, stats)).toMatchInlineSnapshot(`
       Object {
         "/main.css": "body {
-        font-size: 0.9375rem;
-        font-family: sans-serif;
-      }
-
-      ",
-        "/main.pxtorem.css": "body {
-        font-size: 0.9375rem;
+        font-size: 15px;
         font-family: sans-serif;
       }
 
       ",
-        "/main.pxtorem.minimized.css": "body{font-family:sans-serif;font-size:.9375rem}",
-        "/main.pxtorem.minimized.minimized.css": "body{font-family:sans-serif;font-size:.9375rem}",
+        "/main.min.css": "body{font-family:sans-serif;font-size:15px}",
+        "/main.min.min.css": "body{font-family:sans-serif;font-size:15px}",
       }
     `);
   });
@@ -144,14 +134,15 @@ describe('when used with custom filter', () => {
       }
     `);
   });
+});
 
-  it('should apply changes only to filtered assets using regexp filter', async () => {
+describe('when used with custom filename option', () => {
+  it('should interpolate template variables and emit new asset', async () => {
     const compiler = getCompiler({
-      entry: { base: './base.css', component: './component.css' },
       plugins: [
         new PostCSSWebpackPlugin({
           plugins: [require('cssnano')],
-          filter: filename => /component\.css$/.test(filename),
+          filename: '[name].min[ext]',
         }),
       ],
     });
@@ -160,25 +151,24 @@ describe('when used with custom filter', () => {
 
     expect(readAssets(compiler, stats)).toMatchInlineSnapshot(`
       Object {
-        "/base.css": "body {
+        "/main.css": "body {
         font-size: 15px;
         font-family: sans-serif;
       }
 
       ",
-        "/component.css": ".component{background:#000;font-size:12px}",
+        "/main.min.css": "body{font-family:sans-serif;font-size:15px}",
       }
     `);
   });
-});
 
-describe('when used with custom filename option', () => {
-  it('should interpolate template variables and create new asset', async () => {
+  it('should work with custom filename function option', async () => {
     const compiler = getCompiler({
       plugins: [
         new PostCSSWebpackPlugin({
           plugins: [require('cssnano')],
-          filename: '[name].min[ext]',
+          filename: filename =>
+            `prefix__${filename.split('.')[0]}__postfix.css`,
         }),
       ],
     });
@@ -193,18 +183,17 @@ describe('when used with custom filename option', () => {
       }
 
       ",
-        "/main.min.css": "body{font-family:sans-serif;font-size:15px}",
+        "/prefix__main__postfix.css": "body{font-family:sans-serif;font-size:15px}",
       }
     `);
   });
 
-  it('should work with custom filename function option', async () => {
+  it('should work with custom paths', async () => {
     const compiler = getCompiler({
       plugins: [
         new PostCSSWebpackPlugin({
           plugins: [require('cssnano')],
-          filename: filename =>
-            `prefix__${filename.split('.')[0]}__postfix.css`,
+          filename: './minimized/[base]',
         }),
       ],
     });
@@ -219,17 +208,19 @@ describe('when used with custom filename option', () => {
       }
 
       ",
-        "/prefix__main__postfix.css": "body{font-family:sans-serif;font-size:15px}",
+        "/minimized/main.css": "body{font-family:sans-serif;font-size:15px}",
       }
     `);
   });
+});
 
-  it('should work with custom paths', async () => {
+describe('when used with source maps', () => {
+  it('should work properly with source maps enabled', async () => {
     const compiler = getCompiler({
+      devtool: 'source-map',
       plugins: [
         new PostCSSWebpackPlugin({
-          plugins: [require('cssnano')],
-          filename: './minimized/[base]',
+          plugins: [require('postcss-pxtorem'), require('cssnano')],
         }),
       ],
     });
@@ -238,25 +229,43 @@ describe('when used with custom filename option', () => {
 
     expect(readAssets(compiler, stats)).toMatchInlineSnapshot(`
       Object {
-        "/main.css": "body {
-        font-size: 15px;
-        font-family: sans-serif;
+        "/main.css": "body{font-family:sans-serif;font-size:.9375rem}
+      /*# sourceMappingURL=main.css.map*/",
       }
+    `);
+  });
 
-      ",
-        "/minimized/main.css": "body{font-family:sans-serif;font-size:15px}",
+  it('should work properly with source maps disable', async () => {
+    const compiler = getCompiler({
+      devtool: false,
+      plugins: [
+        new PostCSSWebpackPlugin({
+          plugins: [require('postcss-pxtorem'), require('cssnano')],
+        }),
+      ],
+    });
+
+    const stats = await compile(compiler);
+
+    expect(readAssets(compiler, stats)).toMatchInlineSnapshot(`
+      Object {
+        "/main.css": "body{font-family:sans-serif;font-size:.9375rem}",
       }
     `);
   });
 });
 
-describe('when used with source maps enabled', () => {
-  it('should work properly with external source maps', async () => {
+describe('when used with multiple instances', () => {
+  it('should apply plugin postcss instances sequentially', async () => {
     const compiler = getCompiler({
-      devtool: 'source-map',
       plugins: [
         new PostCSSWebpackPlugin({
-          plugins: [require('postcss-pxtorem'), require('cssnano')],
+          plugins: [require('postcss-pxtorem')],
+          filename: '[name].rem[ext]',
+        }),
+        new PostCSSWebpackPlugin({
+          plugins: [require('cssnano')],
+          filename: '[name].min[ext]',
         }),
       ],
     });
@@ -265,8 +274,20 @@ describe('when used with source maps enabled', () => {
 
     expect(readAssets(compiler, stats)).toMatchInlineSnapshot(`
       Object {
-        "/main.css": "body{font-family:sans-serif;font-size:.9375rem}
-      /*# sourceMappingURL=main.css.map*/",
+        "/main.css": "body {
+        font-size: 15px;
+        font-family: sans-serif;
+      }
+
+      ",
+        "/main.min.css": "body{font-family:sans-serif;font-size:15px}",
+        "/main.rem.css": "body {
+        font-size: 0.9375rem;
+        font-family: sans-serif;
+      }
+
+      ",
+        "/main.rem.min.css": "body{font-family:sans-serif;font-size:.9375rem}",
       }
     `);
   });