Code Monkey home page Code Monkey logo

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

dependabot-preview[bot] avatar dependabot[bot] avatar maddocnc avatar rinu avatar semantic-release-bot avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

yohane55 bottlehs

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!

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.

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.

ISSUE in nuxt-precompress module

image

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.