Give the possibility to add a --output website for build and develop commands

Calderis · Calderis · commit 3f97ecc596ec · 2018-03-28T17:02:42.000+02:00
diff --git a/docs/docs/building-with-components.md b/docs/docs/building-with-components.md
@@ -163,7 +163,7 @@ import favicon from "./favicon.png";
 let inlinedStyles = "";
 if (process.env.NODE_ENV === "production") {
   try {
-    inlinedStyles = require("!raw-loader!../public/styles.css");
+    inlinedStyles = require(`!raw-loader!../${process.env.GATSBY_OUTPUT_DIR}/styles.css`);
   } catch (e) {
     console.log(e);
   }
diff --git a/docs/docs/environment-variables.md b/docs/docs/environment-variables.md
@@ -71,3 +71,4 @@ Reserved environment variables:
 
 * `NODE_ENV`
 * `PUBLIC_DIR`
+* `GATSBY_OUTPUT_DIR`
diff --git a/examples/client-only-paths/src/html.js b/examples/client-only-paths/src/html.js
@@ -6,7 +6,7 @@ import typography from "./utils/typography"
 let stylesStr
 if (process.env.NODE_ENV === `production`) {
   try {
-    stylesStr = require(`!raw-loader!../public/styles.css`)
+    stylesStr = require(`!raw-loader!../${process.env.OUTPUT_DIRECTORY}/styles.css`)
   } catch (e) {
     console.log(e)
   }
diff --git a/examples/using-postcss-sass/src/html.js b/examples/using-postcss-sass/src/html.js
@@ -8,7 +8,7 @@ const typography = new Typography()
 let stylesStr
 if (process.env.NODE_ENV === `production`) {
   try {
-    stylesStr = require(`!raw-loader!../public/styles.css`)
+    stylesStr = require(`!raw-loader!../${process.env.GATSBY_OUTPUT_DIR}/styles.css`)
   } catch (e) {
     console.log(e)
   }
diff --git a/examples/using-remark/src/html.js b/examples/using-remark/src/html.js
@@ -6,7 +6,7 @@ import typography from "./utils/typography"
 let stylesStr
 if (process.env.NODE_ENV === `production`) {
   try {
-    stylesStr = require(`!raw-loader!../public/styles.css`)
+    stylesStr = require(`!raw-loader!../${process.env.GATSBY_OUTPUT_DIR}/styles.css`)
   } catch (e) {
     console.log(e)
   }
diff --git a/examples/using-sass/src/html.js b/examples/using-sass/src/html.js
@@ -8,7 +8,7 @@ const typography = new Typography()
 let stylesStr
 if (process.env.NODE_ENV === `production`) {
   try {
-    stylesStr = require(`!raw-loader!../public/styles.css`)
+    stylesStr = require(`!raw-loader!../${process.env.GATSBY_OUTPUT_DIR}/styles.css`)
   } catch (e) {
     console.log(e)
   }
diff --git a/examples/using-styled-components/src/html.js b/examples/using-styled-components/src/html.js
@@ -6,7 +6,7 @@ import typography from "./utils/typography"
 let stylesStr
 if (process.env.NODE_ENV === `production`) {
   try {
-    stylesStr = require(`!raw-loader!../public/styles.css`)
+    stylesStr = require(`!raw-loader!../${process.env.GATSBY_OUTPUT_DIR}/styles.css`)
   } catch (e) {
     console.log(e)
   }
diff --git a/examples/using-styletron/src/html.js b/examples/using-styletron/src/html.js
@@ -6,7 +6,7 @@ import typography from "./utils/typography"
 let stylesStr
 if (process.env.NODE_ENV === `production`) {
   try {
-    stylesStr = require(`!raw-loader!../public/styles.css`)
+    stylesStr = require(`!raw-loader!../${process.env.GATSBY_OUTPUT_DIR}/styles.css`)
   } catch (e) {
     console.log(e)
   }
diff --git a/examples/using-stylus/src/html.js b/examples/using-stylus/src/html.js
@@ -8,7 +8,7 @@ const typography = new Typography()
 let stylesStr
 if (process.env.NODE_ENV === `production`) {
   try {
-    stylesStr = require(`!raw-loader!../public/styles.css`)
+    stylesStr = require(`!raw-loader!../${process.env.GATSBY_OUTPUT_DIR}/styles.css`)
   } catch (e) {
     console.log(e)
   }
diff --git a/examples/using-typescript/src/html.tsx b/examples/using-typescript/src/html.tsx
@@ -7,7 +7,7 @@ import * as React from "react";
 let styles: string;
 if (process.env.NODE_ENV === `production`) {
   try {
-    styles = require("!raw-loader!../public/styles.css");
+    styles = require("!raw-loader!../${process.env.GATSBY_OUTPUT_DIR}/styles.css");
   } catch (err) {
     console.log(err);
   }
diff --git a/infrastructure/build-site.js b/infrastructure/build-site.js
@@ -142,7 +142,7 @@ const Main = async () => {
       updateBuild(buildId, "FAILURE")
       process.exit(code)
     }
-    const publicDir = `${pathToSite}/public`
+    const publicDir = `${pathToSite}/${process.env.GATSBY_OUTPUT_DIR}`
     console.log(`uploading files from ${publicDir}`)
 
     // 1. Push built files to s3 bucket
diff --git a/packages/gatsby-cli/src/create-cli.js b/packages/gatsby-cli/src/create-cli.js
@@ -103,10 +103,16 @@ function buildLocalCommands(cli, isLocalSite) {
           alias: `https`,
           type: `boolean`,
           describe: `Use HTTPS. See https://www.gatsbyjs.org/docs/local-https/ for an initial setup guide`,
+        })
+        .option(`output`, {
+          type: `string`,
+          default: `public`,
+          describe: `Set output directory. Defaults to public`,
         }),
     handler: handlerP(
       getCommandHandler(`develop`, (args, cmd) => {
         process.env.NODE_ENV = process.env.NODE_ENV || `development`
+        process.env.GATSBY_OUTPUT_DIR = args.output || `public`
         cmd(args)
         // Return an empty promise to prevent handlerP from exiting early.
         // The development server shouldn't ever exit until the user directly
@@ -124,10 +130,16 @@ function buildLocalCommands(cli, isLocalSite) {
         type: `boolean`,
         default: false,
         describe: `Build site with link paths prefixed (set prefix in your config).`,
+      })
+      .option(`output`, {
+        type: `string`,
+        default: `public`,
+        describe: `Set output directory. Defaults to public`,
       }),
     handler: handlerP(
       getCommandHandler(`build`, (args, cmd) => {
         process.env.NODE_ENV = `production`
+        process.env.GATSBY_OUTPUT_DIR = args.output || `public`
         return cmd(args)
       })
     ),
diff --git a/packages/gatsby-plugin-feed/src/gatsby-node.js b/packages/gatsby-plugin-feed/src/gatsby-node.js
@@ -3,7 +3,7 @@ import RSS from "rss"
 import merge from "lodash.merge"
 import { defaultOptions, runQuery, writeFile } from "./internals"
 
-const publicPath = `./public`
+const publicPath = `./${process.env.GATSBY_OUTPUT_DIR}`
 
 // A default function to transform query data into feed entries.
 const serialize = ({ query: { site, allMarkdownRemark } }) =>
diff --git a/packages/gatsby-plugin-manifest/src/gatsby-node.js b/packages/gatsby-plugin-manifest/src/gatsby-node.js
@@ -5,6 +5,6 @@ exports.onPostBuild = (args, pluginOptions) =>
   new Promise(resolve => {
     const manifest = { ...pluginOptions }
     delete manifest.plugins
-    fs.writeFileSync(`./public/manifest.json`, JSON.stringify(manifest))
+    fs.writeFileSync(`./${process.env.GATSBY_OUTPUT_DIR}/manifest.json`, JSON.stringify(manifest))
     resolve()
   })
diff --git a/packages/gatsby-plugin-netlify/src/plugin-data.js b/packages/gatsby-plugin-netlify/src/plugin-data.js
@@ -31,7 +31,7 @@ function applyLayouts(pages, layouts) {
 // hashed filenames and ensure we pull in the componentChunkName and layoutComponentChunkName.
 export default function makePluginData(store, assetsManifest, pathPrefix) {
   const { program, layouts, pages: storePages } = store.getState()
-  const publicFolder = buildPrefixer(program.directory, `public`)
+  const publicFolder = buildPrefixer(program.directory, process.env.GATSBY_OUTPUT_DIR)
   const stats = require(publicFolder(`stats.json`))
   const chunkManifest = normalizeStats(stats)
   const pages = applyLayouts(storePages, layouts)
diff --git a/packages/gatsby-plugin-offline/src/gatsby-node.js b/packages/gatsby-plugin-offline/src/gatsby-node.js
@@ -14,7 +14,7 @@ exports.createPages = ({ boundActionCreators }) => {
 }
 
 exports.onPostBuild = (args, pluginOptions) => {
-  const rootDir = `public`
+  const rootDir = process.env.GATSBY_OUTPUT_DIR
 
   const options = {
     staticFileGlobs: [
@@ -27,7 +27,7 @@ exports.onPostBuild = (args, pluginOptions) => {
     ],
     stripPrefix: rootDir,
     // If `pathPrefix` is configured by user, we should replace
-    // the `public` prefix with `pathPrefix`.
+    // the output directory (default: `public`) prefix with `pathPrefix`.
     // See more at:
     // https://github.com/GoogleChrome/sw-precache#replaceprefix-string
     replacePrefix: args.pathPrefix || ``,
@@ -56,5 +56,5 @@ exports.onPostBuild = (args, pluginOptions) => {
 
   const combinedOptions = _.defaults(pluginOptions, options)
 
-  return precache.write(`public/sw.js`, combinedOptions)
+  return precache.write(`${process.env.GATSBY_OUTPUT_DIR}/sw.js`, combinedOptions)
 }
diff --git a/packages/gatsby-plugin-sharp/src/index.js b/packages/gatsby-plugin-sharp/src/index.js
@@ -304,7 +304,7 @@ function queueImageResizing({ file, args = {}, reporter }) {
   const imgSrc = `/${file.name}-${
     file.internal.contentDigest
   }-${argsDigestShort}.${fileExtension}`
-  const filePath = path.join(process.cwd(), `public`, `static`, imgSrc)
+  const filePath = path.join(process.cwd(), process.env.GATSBY_OUTPUT_DIR, `static`, imgSrc)
 
   // Create function to call when the image is finished.
   let outsideResolve, outsideReject
diff --git a/packages/gatsby-plugin-sitemap/src/gatsby-node.js b/packages/gatsby-plugin-sitemap/src/gatsby-node.js
@@ -2,7 +2,7 @@ import path from "path"
 import sitemap from "sitemap"
 import { defaultOptions, runQuery, writeFile } from "./internals"
 
-const publicPath = `./public`
+const publicPath = `./${process.env.GATSBY_OUTPUT_DIR}`
 
 exports.onPostBuild = async ({ graphql }, pluginOptions) => {
   const options = { ...pluginOptions }
diff --git a/packages/gatsby-remark-autolink-headers/src/gatsby-ssr.js b/packages/gatsby-remark-autolink-headers/src/gatsby-ssr.js
@@ -25,13 +25,7 @@ exports.onRenderBody = ({ setHeadComponents }, pluginOptions) => {
     h3:hover .anchor svg,
     h4:hover .anchor svg,
     h5:hover .anchor svg,
-    h6:hover .anchor svg,
-    h1 .anchor:focus svg,
-    h2 .anchor:focus svg,
-    h3 .anchor:focus svg,
-    h4 .anchor:focus svg,
-    h5 .anchor:focus svg,
-    h6 .anchor:focus svg {
+    h6:hover .anchor svg {
       visibility: visible;
     }
   `
diff --git a/packages/gatsby-remark-copy-linked-files/src/__tests__/index.js b/packages/gatsby-remark-copy-linked-files/src/__tests__/index.js
@@ -172,7 +172,7 @@ describe(`gatsby-remark-copy-linked-files`, () => {
   describe(`options.destinationDir`, () => {
     const imagePath = `images/sample-image.gif`
 
-    it(`throws an error if the destination directory is not within 'public'`, async () => {
+    it(`throws an error if the destination directory is not within '${process.env.GATSBY_OUTPUT_DIR}'`, async () => {
       const markdownAST = remark.parse(`![some absolute image](${imagePath})`)
       const invalidDestinationDir = `../destination`
       expect.assertions(2)
@@ -192,7 +192,7 @@ describe(`gatsby-remark-copy-linked-files`, () => {
       const validDestinationDir = `path/to/dir`
       const expectedNewPath = path.posix.join(
         process.cwd(),
-        `public`,
+        process.env.GATSBY_OUTPUT_DIR,
         validDestinationDir,
         `/undefined-undefined.gif`
       )
@@ -215,7 +215,7 @@ describe(`gatsby-remark-copy-linked-files`, () => {
       const markdownAST = remark.parse(`![some absolute image](${imagePath})`)
       const expectedNewPath = path.posix.join(
         process.cwd(),
-        `public`,
+        process.env.GATSBY_OUTPUT_DIR,
         `/undefined-undefined.gif`
       )
       expect.assertions(3)
diff --git a/packages/gatsby-remark-copy-linked-files/src/index.js b/packages/gatsby-remark-copy-linked-files/src/index.js
@@ -7,8 +7,6 @@ const _ = require(`lodash`)
 const cheerio = require(`cheerio`)
 const imageSize = require(`probe-image-size`)
 
-const DEPLOY_DIR = `public`
-
 const invalidDestinationDirMessage = dir =>
   `[gatsby-remark-copy-linked-files You have supplied an invalid destination directory. The destination directory must be a child but was: ${dir}`
 
@@ -25,12 +23,12 @@ const newPath = (linkNode, destinationDir) => {
   if (destinationDir) {
     return path.posix.join(
       process.cwd(),
-      DEPLOY_DIR,
+      process.env.GATSBY_OUTPUT_DIR,
       destinationDir,
       newFileName(linkNode)
     )
   }
-  return path.posix.join(process.cwd(), DEPLOY_DIR, newFileName(linkNode))
+  return path.posix.join(process.cwd(), process.env.GATSBY_OUTPUT_DIR, newFileName(linkNode))
 }
 
 const newLinkURL = (linkNode, destinationDir) => {
diff --git a/packages/gatsby-source-filesystem/src/extend-file-node.js b/packages/gatsby-source-filesystem/src/extend-file-node.js
@@ -11,7 +11,7 @@ module.exports = ({ type, getNodeAndSavePathDependency, pathPrefix = `` }) => {
     publicURL: {
       type: GraphQLString,
       args: {},
-      description: `Copy file to static directory and return public url to it`,
+      description: `Copy file to static directory and return ${process.env.GATSBY_OUTPUT_DIR} url to it`,
       resolve: (file, fieldArgs, context) => {
         const details = getNodeAndSavePathDependency(file.id, context.path)
         const fileName = `${file.name}-${file.internal.contentDigest}${
@@ -20,7 +20,7 @@ module.exports = ({ type, getNodeAndSavePathDependency, pathPrefix = `` }) => {
 
         const publicPath = path.join(
           process.cwd(),
-          `public`,
+          process.env.GATSBY_OUTPUT_DIR,
           `static`,
           fileName
         )
diff --git a/packages/gatsby-transformer-sharp/src/extend-node-type.js b/packages/gatsby-transformer-sharp/src/extend-node-type.js
@@ -138,7 +138,7 @@ module.exports = ({
         }`
         const publicPath = path.join(
           process.cwd(),
-          `public`,
+          process.env.GATSBY_OUTPUT_DIR,
           `static`,
           imageName
         )
diff --git a/packages/gatsby/cache-dir/default-html.js b/packages/gatsby/cache-dir/default-html.js
@@ -3,7 +3,7 @@ import React from "react"
 let stylesStr
 if (process.env.NODE_ENV === `production`) {
   try {
-    stylesStr = require(`!raw-loader!../public/styles.css`)
+    stylesStr = require(`!raw-loader!../${process.env.GATSBY_OUTPUT_DIR}/styles.css`)
   } catch (e) {
     console.log(e)
   }
diff --git a/packages/gatsby/cache-dir/static-entry.js b/packages/gatsby/cache-dir/static-entry.js
@@ -139,7 +139,7 @@ module.exports = (locals, callback) => {
 
   let stats
   try {
-    stats = require(`../public/stats.json`)
+    stats = require(`../${process.env.GATSBY_OUTPUT_DIR}/stats.json`)
   } catch (e) {
     // ignore
   }
@@ -184,7 +184,7 @@ module.exports = (locals, callback) => {
   })
 
   // Add the chunk-manifest at the end of body element.
-  const chunkManifest = require(`!raw!../public/chunk-manifest.json`)
+  const chunkManifest = require(`!raw!../${process.env.GATSBY_OUTPUT_DIR}/chunk-manifest.json`)
   postBodyComponents.unshift(
     <script
       id="webpack-manifest"
diff --git a/packages/gatsby/src/bootstrap/index.js b/packages/gatsby/src/bootstrap/index.js
@@ -57,17 +57,17 @@ module.exports = async (args: BootstrapArgs) => {
     payload: program,
   })
 
-  // Delete html and css files from the public directory as we don't want
+  // Delete html and css files from the output directory (default: public) as we don't want
   // deleted pages and styles from previous builds to stick around.
   let activity = report.activityTimer(
     `delete html and css files from previous builds`
   )
   activity.start()
   await del([
-    `public/*.{html,css}`,
-    `public/**/*.{html,css}`,
-    `!public/static`,
-    `!public/static/**/*.{html,css}`,
+    `${process.env.GATSBY_OUTPUT_DIR}/*.{html,css}`,
+    `${process.env.GATSBY_OUTPUT_DIR}/**/*.{html,css}`,
+    `!${process.env.GATSBY_OUTPUT_DIR}/static`,
+    `!${process.env.GATSBY_OUTPUT_DIR}/static/**/*.{html,css}`,
   ])
   activity.end()
 
@@ -149,7 +149,7 @@ module.exports = async (args: BootstrapArgs) => {
   initCache()
 
   // Ensure the public/static directory is created.
-  await fs.ensureDirSync(`${program.directory}/public/static`)
+  await fs.ensureDirSync(`${program.directory}/${process.env.GATSBY_OUTPUT_DIR}/static`)
 
   // Copy our site files to the root of the site.
   activity = report.activityTimer(`copy gatsby files`)
diff --git a/packages/gatsby/src/commands/build-css.js b/packages/gatsby/src/commands/build-css.js
@@ -16,14 +16,14 @@ module.exports = async (program: any) => {
 
       // We don't want any javascript produced by this step in the process.
       try {
-        fs.unlinkSync(`${directory}/public/bundle-for-css.js`)
+        fs.unlinkSync(`${directory}/${process.env.GATSBY_OUTPUT_DIR}/bundle-for-css.js`)
       } catch (e) {
         // ignore.
       }
 
-      // Ensure there's a styles.css file in public so tools that expect it
+      // Ensure there's a styles.css file in output directory (default: public) so tools that expect it
       // can find it.
-      fs.ensureFile(`${directory}/public/styles.css`, err => {
+      fs.ensureFile(`${directory}/${process.env.GATSBY_OUTPUT_DIR}/styles.css`, err => {
         resolve(err)
       })
     })
diff --git a/packages/gatsby/src/commands/build-html.js b/packages/gatsby/src/commands/build-html.js
@@ -28,7 +28,7 @@ module.exports = async (program: any) => {
       if (e) {
         return reject(e)
       }
-      const outputFile = `${directory}/public/render-page.js`
+      const outputFile = `${directory}/${process.env.GATSBY_OUTPUT_DIR}/render-page.js`
       if (stats.hasErrors()) {
         let webpackErrors = stats.toJson().errors.filter(Boolean)
         return reject(
diff --git a/packages/gatsby/src/commands/build.js b/packages/gatsby/src/commands/build.js
@@ -26,7 +26,7 @@ module.exports = async function build(program: BuildArgs) {
   await apiRunnerNode(`onPreBuild`, { graphql: graphqlRunner })
 
   // Copy files from the static directory to
-  // an equivalent static directory within public.
+  // an equivalent static directory within output directory (default: public).
   copyStaticDirectory()
 
   let activity
diff --git a/packages/gatsby/src/commands/develop-html.js b/packages/gatsby/src/commands/develop-html.js
@@ -24,7 +24,7 @@ module.exports = async (program: any) => {
       if (e) {
         return reject(e)
       }
-      const outputFile = `${directory}/public/render-page.js`
+      const outputFile = `${directory}/${process.env.GATSBY_OUTPUT_DIR}/render-page.js`
       if (stats.hasErrors()) {
         let webpackErrors = stats.toJson().errors
         return reject(
diff --git a/packages/gatsby/src/commands/develop.js b/packages/gatsby/src/commands/develop.js
diff --git a/packages/gatsby/src/commands/serve.js b/packages/gatsby/src/commands/serve.js
diff --git a/packages/gatsby/src/utils/copy-static-directory.js b/packages/gatsby/src/utils/copy-static-directory.js
diff --git a/packages/gatsby/src/utils/webpack.config.js b/packages/gatsby/src/utils/webpack.config.js
diff --git a/www/gatsby-node.js b/www/gatsby-node.js
diff --git a/www/src/html.js b/www/src/html.js
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -163,7 +163,7 @@ import favicon from "./favicon.png";`
`163`	`163`	`let inlinedStyles = "";`
`164`	`164`	`if (process.env.NODE_ENV === "production") {`
`165`	`165`	`try {`
`166`		`- inlinedStyles = require("!raw-loader!../public/styles.css");`
	`166`	+ inlinedStyles = require(`!raw-loader!../${process.env.GATSBY_OUTPUT_DIR}/styles.css`);
`167`	`167`	`} catch (e) {`
`168`	`168`	`console.log(e);`
`169`	`169`	`}`
Original file line number	Diff line number	Diff line change
`@@ -71,3 +71,4 @@ Reserved environment variables:`
`71`	`71`
`72`	`72`	* `NODE_ENV`
`73`	`73`	* `PUBLIC_DIR`
	`74`	+* `GATSBY_OUTPUT_DIR`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ import typography from "./utils/typography"`
`6`	`6`	`let stylesStr`
`7`	`7`	if (process.env.NODE_ENV === `production`) {
`8`	`8`	`try {`
`9`		- stylesStr = require(`!raw-loader!../public/styles.css`)
	`9`	+ stylesStr = require(`!raw-loader!../${process.env.OUTPUT_DIRECTORY}/styles.css`)
`10`	`10`	`} catch (e) {`
`11`	`11`	`console.log(e)`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ const typography = new Typography()`
`8`	`8`	`let stylesStr`
`9`	`9`	if (process.env.NODE_ENV === `production`) {
`10`	`10`	`try {`
`11`		- stylesStr = require(`!raw-loader!../public/styles.css`)
	`11`	+ stylesStr = require(`!raw-loader!../${process.env.GATSBY_OUTPUT_DIR}/styles.css`)
`12`	`12`	`} catch (e) {`
`13`	`13`	`console.log(e)`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ import * as React from "react";`
`7`	`7`	`let styles: string;`
`8`	`8`	if (process.env.NODE_ENV === `production`) {
`9`	`9`	`try {`
`10`		`- styles = require("!raw-loader!../public/styles.css");`
	`10`	`+ styles = require("!raw-loader!../${process.env.GATSBY_OUTPUT_DIR}/styles.css");`
`11`	`11`	`} catch (err) {`
`12`	`12`	`console.log(err);`
`13`	`13`	`}`