Skip to content
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.

Sign up for GitHub

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

feat(gatsby-cli): support for PREFIX_PATHS env variable #21627

Merged
merged 8 commits into from
Feb 24, 2020
Merged

feat(gatsby-cli): support for PREFIX_PATHS env variable #21627

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c4ae71e
feat(gatsby-cli): support for PREFIX_PATHS env variable
benrobertsonio Feb 20, 2020
5270b13
docs(gatsby-cli): Document env.PREFIX_PATHS in gatsby-cli README.
benrobertsonio Feb 20, 2020
f6f1d7c
Update packages/gatsby-cli/src/create-cli.js
benrobertsonio Feb 21, 2020
10bc63c
Update packages/gatsby-cli/src/create-cli.js
benrobertsonio Feb 21, 2020
3af8c08
docs(gatsby-cli): Adds more info about when to use env.PREFIX_PATHS t…
benrobertsonio Feb 21, 2020
f3bd39a
feat(gatsby-cli): Removes env switching for PATH_PREFIX description.
benrobertsonio Feb 21, 2020
51f207e
Merge branch 'feature-support-prefix-paths-env-variable' of https://g…
benrobertsonio Feb 21, 2020
5d77330
feat(gatsby-cli): Remove env checking for prefix-paths description.
benrobertsonio Feb 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions packages/gatsby-cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,25 +94,25 @@ At the root of a Gatsby app run `gatsby build` to do a production build of a sit

#### Options

| Option | Description | Default |
| :--------------------------: | ---------------------------------------------------------------------------------------------------------- | :-----: |
| `--prefix-paths` | Build site with link paths prefixed (set pathPrefix in your config) | `false` |
| `--no-uglify` | Build site without uglifying JS bundles (for debugging) | `false` |
| `--open-tracing-config-file` | Tracer configuration file (OpenTracing compatible). See https://www.gatsbyjs.org/docs/performance-tracing/ | |
| `--no-color`, `--no-colors` | Disables colored terminal output | `false` |
| Option | Description | Default |
| :--------------------------: | ---------------------------------------------------------------------------------------------------------- | :---------------------------: |
| `--prefix-paths` | Build site with link paths prefixed (set pathPrefix in your config) | `env.PREFIX_PATHS` or `false` |
| `--no-uglify` | Build site without uglifying JS bundles (for debugging) | `false` |
| `--open-tracing-config-file` | Tracer configuration file (OpenTracing compatible). See https://www.gatsbyjs.org/docs/performance-tracing/ | |
| `--no-color`, `--no-colors` | Disables colored terminal output | `false` |

### `serve`

At the root of a Gatsby app run `gatsby serve` to serve the production build of the site

#### Options

| Option | Description |
| :--------------: | ---------------------------------------------------------------------------------------- |
| `-H`, `--host` | Set host. Defaults to localhost |
| `-p`, `--port` | Set port. Defaults to 9000 |
| `-o`, `--open` | Open the site in your (default) browser for you |
| `--prefix-paths` | Serve site with link paths prefixed (if built with pathPrefix in your gatsby-config.js). |
| Option | Description | Default |
| :--------------: | ---------------------------------------------------------------------------------------- | :---------------------------: |
| `-H`, `--host` | Set host. Defaults to localhost | |
| `-p`, `--port` | Set port. Defaults to 9000 | |
| `-o`, `--open` | Open the site in your (default) browser for you | |
| `--prefix-paths` | Serve site with link paths prefixed (if built with pathPrefix in your gatsby-config.js). | `env.PREFIX_PATHS` or `false` |

### `clean`

Expand Down
12 changes: 8 additions & 4 deletions packages/gatsby-cli/src/create-cli.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,8 +166,10 @@ function buildLocalCommands(cli, isLocalSite) {
builder: _ =>
_.option(`prefix-paths`, {
type: `boolean`,
default: false,
describe: `Build site with link paths prefixed (set pathPrefix in your gatsby-config.js).`,
default: process.env.PREFIX_PATHS || false,
benrobertsonio marked this conversation as resolved.
Show resolved Hide resolved
describe: process.env.PREFIX_PATHS
? `Build site with link paths prefixed (set by env.PREFIX_PATHS) (set pathPrefix in your gatsby-config.js).`
: `Build site with link paths prefixed (set pathPrefix in your gatsby-config.js).`,
benrobertsonio marked this conversation as resolved.
Show resolved Hide resolved
})
.option(`no-uglify`, {
type: `boolean`,
Expand Down Expand Up @@ -209,8 +211,10 @@ function buildLocalCommands(cli, isLocalSite) {
})
.option(`prefix-paths`, {
type: `boolean`,
default: false,
describe: `Serve site with link paths prefixed (if built with pathPrefix in your gatsby-config.js).`,
default: process.env.PREFIX_PATHS || false,
benrobertsonio marked this conversation as resolved.
Show resolved Hide resolved
describe: process.env.PREFIX_PATHS
? `Serve site with link paths prefixed (set by env.PREFIX_PATHS) (set pathPrefix in your gatsby-config.js).`
: `Serve site with link paths prefixed (set pathPrefix in your gatsby-config.js).`,
}),

handler: getCommandHandler(`serve`),
Expand Down