baroshem / compression Goto Github PK

View Code? Open in Web Editor NEW

32.0 32.0 0.0 13.4 MB

🗜 Compression module for Nuxt 3

Home Page: https://compression-nm.netlify.app/

License: MIT License

JavaScript 3.79% TypeScript 94.18% Vue 2.04%

compression module nuxt performance

compression's People

Contributors

Stargazers

compression's Issues

Typing for defineNuxtConfig options ?

Hi there ! Currently working on a template for nuxt 3 projects and installed your module for optimisation purposes. So far, it works great.. only thing though, TS complains about the "compression" property in the defineNuxtConfig. Is there any types that I should be installing ?

Thanks !

Comparison to Nitro's `compressPublicAssets`

Hey!

Since Nitro supports a compressPublicAssets option, I wonder about the differences between it and the module ☺️
Could be helpful for the users too

Documentation error: buildModules

Version

nuxt: 3.5.3

Steps to reproduce

Copy paste the example.

What is Expected?

Migration guide:
https://nuxt.com/docs/migration/configuration#migration-1

What is actually happening?

Errors.

refactor to offical nuxt 3 module structure

Is your feature request related to a problem? Please describe.

Describe the solution you'd like

https://v3.nuxtjs.org/docs/advanced/modules

Describe alternatives you've considered

Additional context

deleteOriginFile options is not working as expected

Hello,

I'd like to report that the deleteOriginFile: true is not working as expected and return an error :

 ERROR  Rollup error: Could not load /Users/User/Documents/nuxt-app/.nuxt/dist/server/client.manifest.mjs (imported by node_modules/nuxt/dist/core/runtime/nitro/renderer.mjs): ENOENT: no such file or directory, open '/Users/User/Documents/nuxt-app/.nuxt/dist/server/client.manifest.mjs'


 ERROR  Could not load /Users/User/Documents/nuxt-app/.nuxt/dist/server/client.manifest.mjs (imported by node_modules/nuxt/dist/core/runtime/nitro/renderer.mjs): ENOENT: no such file or directory, open '/Users/User/Documents/nuxt-app/.nuxt/dist/server/client.manifest.mjs'

here is my nuxt.config.ts file :

  buildModules: [
    [
      '@nuxt-modules/compression',
      {
        algorithm: 'gzip',
        filter: /\.(js|mjs|css|html)$/i,
        deleteOriginFile: true,
        success: () => {
          console.log('✅ Success gzip compression')
        }
      }
    ]
  ],

Allow for exclusion of specific files

I'm having an issue where the compression is compressing the manifest.json file generated by https://github.com/kevinmarrec/nuxt-pwa-module to manifest.json.br which prevents the PWA manifest from being seen by the browser.

I'd like to be able to either manually exclude a file from compression, or be able to exclude an entire mime-type (.json).

vite-plugin-compression module missing when building the app

Hello 👋,

I encountered a bug with @nuxt-modules/compression (v0.1.0) when building the app with Nuxt 3 (v3.0.0-rc.6) I have this error message :

Nuxt CLI v3.0.0-rc.6                                                                                                                                                                                                                      11:28:46

 ERROR  Cannot find module 'vite-plugin-compression'                                                                                                                                                                                      11:28:48
Require stack:
- /Users/User/Documents/Nuxt3App/node_modules/@nuxt-modules/compression/dist/module.cjs

  Require stack:
  - node_modules/@nuxt-modules/compression/dist/module.cjs
  at Function.Module._resolveFilename (node:internal/modules/cjs/loader:933:15)
  at Function.resolve (node:internal/modules/cjs/helpers:108:19)
  at _resolve (node_modules/jiti/dist/jiti.js:1:108226)
  at jiti (node_modules/jiti/dist/jiti.js:1:110413)
  at node_modules/@nuxt-modules/compression/dist/module.cjs:4:25
  at jiti (node_modules/jiti/dist/jiti.js:1:112282)
  at requireModule (node_modules/@nuxt/kit/dist/index.mjs:295:26)
  at normalizeModule (node_modules/@nuxt/kit/dist/index.mjs:448:53)
  at installModule (node_modules/@nuxt/kit/dist/index.mjs:431:47)
  at initNuxt (node_modules/nuxt/dist/index.mjs:1421:13)

I know that this plugin is based on vite-plugin-compression but I was wondering if it was needed to install this dependency as well.

My config :

// nuxt.config.ts|js

import { defineNuxtConfig } from 'nuxt'
export default defineNuxtConfig({
  buildModules: [
    [
      '@nuxt-modules/compression',
      {
        algorithm: 'brotliCompress'
      },
    ],
  ],
})

Also I remarked that the following config was skipped on the latest release of Nuxt 3 (v3.0.0-rc.6):

// nuxt.config.ts|js

import { defineNuxtConfig } from 'nuxt'
export default defineNuxtConfig({
  compression: {
    algorithm: 'brotliCompress',
  }
})