frenchrabbit / nuxt-precompress Goto Github PK

View Code? Open in Web Editor NEW

119.0 4.0 3.0 2.08 MB

Nuxt module for gzip and Brotli auto compress and serve

JavaScript 98.82% Vue 1.18%

nuxt-precompress's Introduction

Precompress files to gzip and brotli and serve them automatically

This may increase performance of your nuxt application:

Compress files to gzip and brotli at build-time, And serve them if browser supports them.

Please note:

This module uses compression-webpack-plugin for gzip and brotli. compression-webpack-plugin support brotli based on native nodejs support added in 11.7.0, so if you use lower nodejs version, this module will make only gzip version for you, but will serve brotli as well if they exist.

Module does not override render.compressor option, so it compress only build static files /.nuxt/dist/client/.

Installation

$ yarn add nuxt-precompress # or npm install

Usage

As usual, add to modules section, not buildModules because of middleware using set options, if needed, this are defaults:

// nuxt.config.js
export default {
  // ...
  modules: ['nuxt-precompress'],
  // Default options, override if needed
  nuxtPrecompress: {
    enabled: true, // Enable in production
    report: false, // set true to turn one console messages during module init
    test: /\.(js|css|html|txt|xml|svg)$/, // files to compress on build
    // Serving options
    middleware: {
      // You can disable middleware if you serve static files using nginx...
      enabled: true,
      // Enable if you have .gz or .br files in /static/ folder
      enabledStatic: true, 
      // Priority of content-encodings, first matched with request Accept-Encoding will me served
      encodingsPriority: ['br', 'gzip'],
    },
 
    // build time compression settings
    gzip: {
      // should compress to gzip?
      enabled: true,
      // compression config
      // https://www.npmjs.com/package/compression-webpack-plugin
      filename: '[path].gz[query]', // middleware will look for this filename
      threshold: 10240,
      minRatio: 0.8,
      compressionOptions: { level: 9 },
    },
    brotli: {
      // should compress to brotli?
      enabled: true,
      // compression config
      // https://www.npmjs.com/package/compression-webpack-plugin
      filename: '[path].br[query]', // middleware will look for this filename
      compressionOptions: { level: 11 },
      threshold: 10240,
      minRatio: 0.8,
    },
  }
  // ...
}

Development

$ git clone https://github.com/frenchrabbit/nuxt-precompress.git
$ cd nuxt-precompress
$ yarn

License

Note

This project generated by create-nuxt-module

nuxt-precompress's People

Contributors

Stargazers

Watchers

Forkers

yohane55 bottlehs kane-mason

nuxt-precompress's Issues

Wrong instruction in README.md: Brotli compression level is ignored

I noticed that no matter what level of Brotli compression I specify in the options, files are always compressed with the maximum level (11).

Then I realized that the README.md file of the library has this invalid instruction:

brotli: {
  // other options...
  compressionOptions: { level: 11 },
},

According to the documentation, for Brotli, the level option should be passed like this:

module.exports = {
  plugins: [
    new CompressionPlugin({
      // other options...
      compressionOptions: {
        params: {
          [zlib.constants.BROTLI_PARAM_QUALITY]: 11,
        },
      }
    }),
  ],
};

Please, update the README.md.

P.S. Thanks for the library!

Upgrade compression-webpack-plugin

Version used in this package does not support node 18+. Support was added with v6.1.2

https://github.com/webpack-contrib/compression-webpack-plugin/releases/tag/v6.1.2

compression-webpack-plugin required on start

The compression-webpack-plugin dependency should only be required when building a site.

Currently the dependency is also required when running nuxt-cli start which doesn't make a lot of sense to me.

The issue currently is in order to use nuxt-precompress I have to bundle a bunch of unused code (including all of webpack) with my deployments.

Big images are not compressed

In the first place, thank you SO MUCH for this library.

But now I have an issue: I'm using large image files that are larger than the "recommended size limit (244KiB)", and this is why I was looking for server-side compression in the first place.

But it seems that "big" files (in my case they are in the assets folder) are not compressed (but small files (smaller than 244KiB) are).
Do you have any clue about why this happens and how to fix it?

Thank you in advance for your answer.

Using nuxt-bridge, dont see any compression at all

Is this plugin supported with the nuxt-bridge/nuxt3?

ISSUE in nuxt-precompress module

i have added the nuxt-precompress module in the module section of nuxt.config.ts and getting this error
followed the step mentioed in warning, set type: module in package.json.. still its the same issue.