From 917f1c963d856edbaa3b29666cb06a6c74c8fb2e Mon Sep 17 00:00:00 2001 From: Kyle Mathews Date: Wed, 19 Apr 2017 08:28:23 -0700 Subject: [PATCH 1/2] Updates to gatsby-dev-cli README --- packages/gatsby-dev-cli/README.md | 42 +++++++++++++------------------ 1 file changed, 18 insertions(+), 24 deletions(-) diff --git a/packages/gatsby-dev-cli/README.md b/packages/gatsby-dev-cli/README.md index f8ec58ce64a89..38aee56c2f16d 100644 --- a/packages/gatsby-dev-cli/README.md +++ b/packages/gatsby-dev-cli/README.md @@ -1,42 +1,36 @@ # gatsby-dev-cli -A commandline tool for local Gatsby development. When doing development work on the Gatsby core this tool allows you to easily update any project that has depencies on packages from Gatsby, like a site you are working on. - +A command-line tool for local Gatsby development. When doing development work +on Gatsby core, this tool allows you to easily copy the changes to the various +Gatsby packages to Gatsby sites that you're testing your changes on. ## Install -```bash -$ npm install -g gatsby-dev-cli@canary -``` +`npm install -g gatsby-dev-cli@canary` or -```bash -$ yarn global add gatsby-dev-cli@canary -``` +`yarn global add gatsby-dev-cli@canary` ## Configuration / First time setup -The gatsby-dev-cli tool needs to know where your cloned Gatsby repository is located. You typically only need to configure this once. +The gatsby-dev-cli tool needs to know where your cloned Gatsby repository is +located. You typically only need to configure this once. -``` -$ gatsby-dev --set-path-to-repo /path/to/my/cloned/version/gatsby -``` +`gatsby-dev --set-path-to-repo /path/to/my/cloned/version/gatsby` ## How to use -Navigate to the project you want to link to your forked Gatsby repository and run: - -```bash -$ gatsby-dev -``` - -The tool will then scan your project's package.json to find any Gatsby dependencies and copy them into your project's node_modules folder. A watch task is then created to re-copy any modules that might change while you're working on the code, so you can leave this program running. +Navigate to the project you want to link to your forked Gatsby repository and +run: -### Repo without gatby dependencies +`gatsby-dev` -You can prevent the automatic depencencies scan and instead specify a list of packages you want to link by using the `--packages` option: +The tool will then scan your project's package.json to find its Gatsby +dependencies and copy the latest source from your cloned version of Gatsby into +your project's node_modules folder. A watch task is then created to re-copy any +modules that might change while you're working on the code, so you can leave +this program running. -```bash -$ gatsby-dev --packages gatsby gatsby-typegen-remark -``` +Typically you'll also want to run `npm run watch` in the Gatsby repo to set up +watchers to build Gatsby source code. From 3ddf3b64c0a94ed1a1b417a6a06418a21982c35b Mon Sep 17 00:00:00 2001 From: Kyle Mathews Date: Wed, 19 Apr 2017 08:33:02 -0700 Subject: [PATCH 2/2] Document commands --- packages/gatsby-dev-cli/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/packages/gatsby-dev-cli/README.md b/packages/gatsby-dev-cli/README.md index 38aee56c2f16d..c5a34c9b5adc1 100644 --- a/packages/gatsby-dev-cli/README.md +++ b/packages/gatsby-dev-cli/README.md @@ -34,3 +34,19 @@ this program running. Typically you'll also want to run `npm run watch` in the Gatsby repo to set up watchers to build Gatsby source code. + +### Other commands + +#### `--packages` + +You can prevent the automatic dependencies scan and instead specify a list of +packages you want to link by using the `--packages` option: + +`gatsby-dev --packages gatsby gatsby-typegen-remark` + +#### `--scan-once` + +With this flag, the tool will do an initial scan and copy and then quit. This +is useful for setting up automated testing/builds of Gatsby sites from the latest +code. Gatsby's main website (and example websites) are built from HEAD using this +flag, see https://github.com/gatsbyjs/gatsby/blob/1.0/scripts/publish-site.sh.