-
Notifications
You must be signed in to change notification settings - Fork 10.3k
Add gatsby-compression-plugin. #2913
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| *.DS_Store | ||
| node_modules/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| src | ||
| .gitignore |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| Copyright 2017 Harrison C Bowden, Minneapolis, Minnesota | ||
|
|
||
| Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| # Gatsby plugin compression | ||
|
|
||
| First install `gatsby-plugin-compression`. | ||
|
|
||
| ```bash | ||
|
|
||
| npm install gatsby-plugin-compression --save | ||
|
|
||
| ``` | ||
|
|
||
| Then add `gatsby-plugin-compression` to your app's `gatsby-config.js`. | ||
|
|
||
| ```javascript | ||
|
|
||
| module.exports = { | ||
| plugins: [ | ||
| `gatsby-plugin-compression`, | ||
| ], | ||
| } | ||
|
|
||
| ``` | ||
|
|
||
| That's it, when you build your app you will have gzipped versions of your files. | ||
|
|
||
| # Nginx | ||
|
|
||
| If your using nginx you can use `gzip_static on;` to serve your gzipped assets, here's a full example. | ||
|
|
||
| ```bash | ||
|
|
||
| #user nobody; | ||
| worker_processes 1; | ||
|
|
||
| events { | ||
| worker_connections 1024; | ||
| } | ||
|
|
||
| pid /usr/local/nginx/logs/nginx.pid; | ||
|
|
||
| server { | ||
| listen 80; | ||
| server_name localhost; | ||
|
|
||
| #access_log logs/host.access.log main; | ||
|
|
||
| location / { | ||
| gzip_static on; | ||
| root Users/nah/Desktop/web; | ||
| index index.html index.htm; | ||
| } | ||
| } | ||
|
|
||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| { | ||
| "name": "gatsby-plugin-compression", | ||
| "version": "0.0.1", | ||
| "description": "Gatsby plugin for compressing assets.", | ||
| "main": "gatsby-node.js", | ||
| "scripts": { | ||
| "test": "echo \"Error: no test specified\" && exit 1" | ||
| }, | ||
| "keywords": [ | ||
| "gatsby", | ||
| "plugin", | ||
| "compression" | ||
| ], | ||
| "author": "Harrison Bowden", | ||
| "license": "ISC", | ||
| "dependencies": { | ||
| "compression-webpack-plugin": "^1.0.1" | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| const CompressionPlugin = require(`compression-webpack-plugin`) | ||
|
|
||
| exports.modifyWebpackConfig = ({ config, stage }, options) => { | ||
| switch (stage) { | ||
| case `build-html`: | ||
| case `build-javascript`: | ||
| case `build-css`: { | ||
| config.plugin(`compression`, | ||
| CompressionPlugin, | ||
| [{ asset: `[path].gz[query]`, algorithm: `gzip` }] | ||
| ) | ||
| return config | ||
| } | ||
| default: { | ||
| return config | ||
| } | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hbowden
you’reAlso, this is rad, nice work.