-
Notifications
You must be signed in to change notification settings - Fork 10.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Release gatsby plugin gatsby cloud for Gatsby v2 (#29738)
* Add gatsby-plugin-gatsby-cloud * Fix babel-preset-gatsby-package version * Update engines
- Loading branch information
1 parent
d806703
commit 8a2fac9
Showing
15 changed files
with
1,248 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,3 @@ | ||
{ | ||
"presets": [["babel-preset-gatsby-package"]] | ||
} |
This file contains 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 @@ | ||
yarn.lock | ||
/*.js |
This file contains 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,34 @@ | ||
# Logs | ||
logs | ||
*.log | ||
|
||
# Runtime data | ||
pids | ||
*.pid | ||
*.seed | ||
|
||
# Directory for instrumented libs generated by jscoverage/JSCover | ||
lib-cov | ||
|
||
# Coverage directory used by tools like istanbul | ||
coverage | ||
|
||
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) | ||
.grunt | ||
|
||
# node-waf configuration | ||
.lock-wscript | ||
|
||
# Compiled binary addons (http://nodejs.org/api/addons.html) | ||
build/Release | ||
|
||
# Dependency directory | ||
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git | ||
node_modules | ||
*.un~ | ||
yarn.lock | ||
src | ||
flow-typed | ||
coverage | ||
decls | ||
examples |
This file contains 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,8 @@ | ||
# Change Log | ||
|
||
All notable changes to this project will be documented in this file. | ||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. | ||
|
||
# 1.1.0-next.2 (2021-02-19) | ||
|
||
**Note:** Version bump only for package gatsby-plugin-gatsby-cloud |
This file contains 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,142 @@ | ||
# gatsby-plugin-gatsby-cloud | ||
|
||
Automatically generates a `_headers.json` file and a `_redirects.json` file at the root of the public folder to configure | ||
Headers and Redirects on Gatsby Cloud | ||
|
||
By default, the plugin will add some basic security headers. You can easily add or replace headers through the plugin config. | ||
|
||
## Install | ||
|
||
`npm install --save gatsby-plugin-gatsby-cloud` | ||
|
||
## How to use | ||
|
||
```javascript | ||
// In your gatsby-config.js | ||
plugins: [`gatsby-plugin-gatsby-cloud`] | ||
``` | ||
|
||
## Configuration | ||
|
||
If you just need the critical assets, you don't need to add any additional | ||
config. However, if you want to add headers, remove default headers, or | ||
transform the given headers, you can use the following configuration options. | ||
|
||
```javascript | ||
plugins: [ | ||
{ | ||
resolve: `gatsby-plugin-gatsby-cloud`, | ||
options: { | ||
headers: {}, // option to add more headers. `Link` headers are transformed by the below criteria | ||
allPageHeaders: [], // option to add headers for all pages. `Link` headers are transformed by the below criteria | ||
mergeSecurityHeaders: true, // boolean to turn off the default security headers | ||
mergeLinkHeaders: true, // boolean to turn off the default gatsby js headers | ||
mergeCachingHeaders: true, // boolean to turn off the default caching headers | ||
transformHeaders: (headers, path) => headers, // optional transform for manipulating headers under each path (e.g.sorting), etc. | ||
generateMatchPathRewrites: true, // boolean to turn off automatic creation of redirect rules for client only paths | ||
}, | ||
}, | ||
] | ||
``` | ||
|
||
### Headers | ||
|
||
You should pass in an object with string keys (representing the paths) and an | ||
array of strings for each header. | ||
|
||
An example: | ||
|
||
```javascript | ||
{ | ||
options: { | ||
headers: { | ||
"/*": [ | ||
"Basic-Auth: someuser:somepassword anotheruser:anotherpassword", | ||
], | ||
"/my-page": [ | ||
// matching headers (by type) are replaced by Gatsby Cloud with more specific routes | ||
"Basic-Auth: differentuser:differentpassword", | ||
], | ||
}, | ||
} | ||
} | ||
``` | ||
|
||
Link paths are specially handled by this plugin. Since most files are processed | ||
and cache-busted through Gatsby (with a file hash), the plugin will transform | ||
any base file names to the hashed variants. If the file is not hashed, it will | ||
ensure the path is valid relative to the output `public` folder. You should be | ||
able to reference assets imported through javascript in the `static` folder. | ||
|
||
Do not specify the public path in the config, as the plugin will provide it for | ||
you. | ||
|
||
The `_headers.json` file does not inherit headers, and it will replace any | ||
matching headers it finds in more specific routes. For example, if you add a | ||
link to the root wildcard path (`/*`), it will be replaced by any more | ||
specific path. If you want a resource to put linked across the site, you will | ||
have to add to every path. To make this easier, the plugin provides the | ||
`allPageHeaders` option to inject the same headers on every path. | ||
|
||
```javascript | ||
{ | ||
options: { | ||
allPageHeaders: [ | ||
"Link: </static/my-logo.png>; rel=preload; as=image", | ||
], | ||
headers: { | ||
"/*": [ | ||
"Basic-Auth: someuser:somepassword anotheruser:anotherpassword", | ||
], | ||
}, | ||
} | ||
} | ||
``` | ||
|
||
### Redirects | ||
|
||
You can create redirects using the [`createRedirect`](https://www.gatsbyjs.org/docs/actions/#createRedirect) action. | ||
|
||
In addition to the options provided by the Gatsby API, you can pass these options specific to this plugin: | ||
|
||
| Attribute | Description | | ||
| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| `statusCode` | Overrides the HTTP status code which is set to `302` by default or `301` when [`isPermanent`](https://www.gatsbyjs.org/docs/actions/#createRedirect) is `true`. You can set one here. For example, `200` for rewrites, or `404` for a custom error page. | | ||
|
||
An example: | ||
|
||
```javascript | ||
createRedirect({ fromPath: "/old-url", toPath: "/new-url", isPermanent: true }) | ||
createRedirect({ fromPath: "/url", toPath: "/zn-CH/url", Language: "zn" }) | ||
createRedirect({ | ||
fromPath: "/url_that_is/not_pretty", | ||
toPath: "/pretty/url", | ||
statusCode: 200, | ||
}) | ||
createRedirect({ | ||
fromPath: "/packages/*", | ||
toPath: "/plugins/*", | ||
}) | ||
``` | ||
|
||
Redirect rules are automatically added for [client only paths](https://www.gatsbyjs.org/docs/client-only-routes-and-user-authentication). The plugin uses the [matchPath](https://www.gatsbyjs.org/docs/gatsby-internals-terminology/#matchpath) syntax to match all possible requests in the range of your client-side routes and serves the HTML file for the client-side route. Without it, only the exact route of the client-side route works. | ||
|
||
If those rules are conflicting with custom rules or if you want to have more control over them you can disable them in [configuration](#configuration) by setting `generateMatchPathRewrites` to `false`. | ||
|
||
An asterix, `*`, will match anything that follows. i.e. `/packages/gatsby-plugin-gatsby-cloud/` will be redirected to `/plugins/gatsby-plugin-gatsby-cloud/`. | ||
|
||
### HTTP Strict Transport Security | ||
|
||
[HSTS Cheatsheet](https://cheatsheetseries.owasp.org/cheatsheets/HTTP_Strict_Transport_Security_Cheat_Sheet.html) | ||
|
||
Since this header is an opt-in security enhancement with permanent consequences we don't include it as a default feature but use can use the `allPagesHeaders` to include it. | ||
|
||
```javascript | ||
{ | ||
options: { | ||
allPageHeaders: [ | ||
"Strict-Transport-Security: max-age=31536000; includeSubDomains; preload", | ||
], | ||
} | ||
} | ||
``` |
This file contains 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,47 @@ | ||
{ | ||
"name": "gatsby-plugin-gatsby-cloud", | ||
"description": "A Gatsby plugin which optimizes working with Gatsby Cloud", | ||
"version": "1.0.1", | ||
"author": "Kyle Mathews <mathews.kyle@gmail.com>", | ||
"bugs": { | ||
"url": "https://github.com/gatsbyjs/gatsby/issues" | ||
}, | ||
"dependencies": { | ||
"@babel/runtime": "^7.12.5", | ||
"fs-extra": "^8.1.0", | ||
"kebab-hash": "^0.1.2", | ||
"lodash": "^4.17.20", | ||
"webpack-assets-manifest": "^3.1.1" | ||
}, | ||
"devDependencies": { | ||
"@babel/cli": "^7.12.1", | ||
"@babel/core": "^7.12.3", | ||
"babel-preset-gatsby-package": "^0.12.0", | ||
"cross-env": "^7.0.3" | ||
}, | ||
"homepage": "https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-gatsby-cloud#readme", | ||
"keywords": [ | ||
"gatsby", | ||
"gatsby-plugin", | ||
"http/2-server-push", | ||
"gatsby-cloud" | ||
], | ||
"license": "MIT", | ||
"main": "index.js", | ||
"peerDependencies": { | ||
"gatsby": "^2.0.0" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/gatsbyjs/gatsby.git", | ||
"directory": "packages/gatsby-plugin-gatsby-cloud" | ||
}, | ||
"scripts": { | ||
"build": "babel src --out-dir . --ignore \"**/__tests__\"", | ||
"prepare": "cross-env NODE_ENV=production npm run build", | ||
"watch": "babel -w src --out-dir . --ignore \"**/__tests__\"" | ||
}, | ||
"engines": { | ||
"node": ">=10.13.0" | ||
} | ||
} |
9 changes: 9 additions & 0 deletions
9
...ages/gatsby-plugin-gatsby-cloud/src/__tests__/__snapshots__/build-headers-program.js.snap
Large diffs are not rendered by default.
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
packages/gatsby-plugin-gatsby-cloud/src/__tests__/__snapshots__/create-redirects.js.snap
This file contains 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,3 @@ | ||
// Jest Snapshot v1, https://goo.gl/fbAQLP | ||
|
||
exports[`create-redirects should assemble a redirects file 1`] = `"{\\"redirects\\":[{\\"fromPath\\":\\"/old-url\\",\\"toPath\\":\\"/new-url\\",\\"isPermanent\\":true},{\\"fromPath\\":\\"/url_that_is/not_pretty\\",\\"toPath\\":\\"/pretty/url\\",\\"statusCode\\":201}],\\"rewrites\\":[{\\"fromPath\\":\\"/url_that_is/ugly\\",\\"toPath\\":\\"/not_ugly/url\\"},{\\"fromPath\\":\\"/path2/*splatparam\\",\\"toPath\\":\\"/path2/[...splatparam]/\\"},{\\"fromPath\\":\\"/path/*\\",\\"toPath\\":\\"/path/[...]/\\"},{\\"fromPath\\":\\"/path3/:level1/:level2\\",\\"toPath\\":\\"/path3/[level1]/[level2]/\\"},{\\"fromPath\\":\\"/path4/:param1\\",\\"toPath\\":\\"/path4/[param1]/\\"}]}"`; |
Oops, something went wrong.