Gatsby: Global vs local gatsby-cli --version inconsistency

Created on 3 Apr 2019 · 10Comments · Source: gatsbyjs/gatsby

Description

There is a small inconsistency in getsby-cli. Global installed one shows version of gatsby-cli but local one (from projects node_modules/) shows version of gatsby package instead.

carbon

This is because gatsby-cli uses default yargs --version command implementation which is trying to find out who calls the script and find it's package.json to extract version from. In local installed version it finds node_modules/gatsby/package.json instead of node_modules/gatsby-cli/package.json

Steps to reproduce

Install gatsby-cli globally as Quickstart says - yarn global add gatsby-cli for example
Install hello-world example as gatsby new hello-world https://github.com/gatsbyjs/gatsby-starter-hello-world && cd hello-world
Run gatsby --version
Run yarn gatsby --version

Expected result

Both CLI --version commands returns CLI package version.

Actual result

Global CLI returns gatsby-cli version. Local CLI from hello-world returns version of gatsby package.

Environment

  System:
    OS: macOS 10.14.3
    CPU: (8) x64 Intel(R) Core(TM) i7-7700HQ CPU @ 2.80GHz
    Shell: 3.2.57 - /bin/bash
  Binaries:
    Node: 10.15.3 - ~/.nvm/versions/node/v10.15.3/bin/node
    Yarn: 1.10.1 - /usr/local/bin/yarn
    npm: 6.4.1 - ~/.nvm/versions/node/v10.15.3/bin/npm
  Languages:
    Python: 2.7.15 - /usr/local/bin/python
  Browsers:
    Chrome: 73.0.3683.86
    Firefox: 66.0.2
    Safari: 12.0.3
  npmPackages:
    gatsby: 2.3.3 => 2.3.3 
    gatsby-image: ^2.0.35 => 2.0.36 
    gatsby-plugin-manifest: ^2.0.25 => 2.0.26 
    gatsby-plugin-offline: ^2.0.25 => 2.0.25 
    gatsby-plugin-react-helmet: ^3.0.11 => 3.0.11 
    gatsby-plugin-sharp: ^2.0.32 => 2.0.32 
    gatsby-plugin-typescript: ^2.0.11 => 2.0.11 
    gatsby-source-filesystem: ^2.0.28 => 2.0.28 
    gatsby-source-graphql: ^2.0.15 => 2.0.15 
    gatsby-transformer-sharp: ^2.1.17 => 2.1.17

good first issue help wanted

Source

lexaurin

All 10 comments

what I think would be best is to implement custom --version handler and for both cases report:

global gatsby-cli version (if installed),
local gatsby version (if we are in gatsby project directory)

I'm not sure if there is much value in reporting local gatsby-cli version?

pieh on 3 Apr 2019

Hi, I understand this issue. Would like to work on it but where do we implement the custom version? Thanks!

hassan-motiwala on 3 Apr 2019

I'm not sure if there is much value in reporting local gatsby-cli version?

Disagree. When you have "build": "gatsby build", in your package.json, you are actually using local gatsby-cli package so it would be nice to know what version this CLI is.

lexaurin on 4 Apr 2019

other CLI that I use here,graphql-cli, is consistent:

carbon (1)