search

Shopify / shopify-app-template-node

MIT License
889 stars 400 forks source link

Incorrect Documentation in README.md #1317

Closed tawanda-profuse closed 9 months ago

tawanda-profuse commented 9 months ago

Issue summary

The command for installing the shopify-app-template-node using npm is incorrect. This command can be found under the heading that says Installing the template.

The error in the console:

npm error: no such flag -- --template=node

Expected behavior

After running this command, it is expected that all the dependencies will be installed.

Actual behavior

An error is displayed in the console and no dependencies are installed.

Steps to reproduce the problem

  1. Clone this repository
  2. Run the command: npm init @shopify/app@latest -- --template=node

Correction

The command that works is npm init @shopify/app@latest --template=node.

matteodepalo commented 9 months ago

Hi @tawanda-profuse, thank you for opening this issue. Unfortunately I cannot reproduce it. What version of node do you have and what operating system are you using?

tawanda-profuse commented 9 months ago

My node version is 18.16.0 and my operating system is Windows 11.

On Thu, 08 Feb, 2024, 10:10 Matteo Depalo, @.***> wrote:

Hi @tawanda-profuse https://github.com/tawanda-profuse, I cannot reproduce this issue. What version of node do you have and what operating system are you using?

— Reply to this email directly, view it on GitHub https://github.com/Shopify/shopify-app-template-node/issues/1317#issuecomment-1933556516, or unsubscribe https://github.com/notifications/unsubscribe-auth/AGBLNUFHIF3LMYPG2PZ4GO3YSSB7PAVCNFSM6AAAAABC5GHP36VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSMZTGU2TMNJRGY . You are receiving this because you were mentioned.Message ID: @.***>

matteodepalo commented 9 months ago

What terminal program are you using? I cannot reproduce this with PowerShell, windows 11 and node 18.

tawanda-profuse commented 9 months ago

VS Code terminal

On Fri, 09 Feb, 2024, 04:05 Matteo Depalo, @.***> wrote:

What terminal program are you using? I cannot reproduce this with PowerShell, windows 11 and node 18.

— Reply to this email directly, view it on GitHub https://github.com/Shopify/shopify-app-template-node/issues/1317#issuecomment-1935229283, or unsubscribe https://github.com/notifications/unsubscribe-auth/AGBLNUD6K7QB4GNIRJVXQJLYSV767AVCNFSM6AAAAABC5GHP36VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSMZVGIZDSMRYGM . You are receiving this because you were mentioned.Message ID: @.***>

matteodepalo commented 9 months ago

Hi @tawanda-profuse, I cannot reproduce this, I have a feeling the error you're facing has to do with your personal setup, maybe you're aliasing npm? The docs clearly state that in order to pass additional arguments to the command, the arguments need to be separated by --.

tawanda-profuse commented 9 months ago

Thanks for your explanation.

On Mon, 12 Feb, 2024, 06:54 Matteo Depalo, @.***> wrote:

Hi @tawanda-profuse https://github.com/tawanda-profuse, I cannot reproduce this, I have a feeling the error you're facing has to do with your personal setup, maybe you're aliasing npm? The docs clearly state https://docs.npmjs.com/cli/v10/commands/npm-init#forwarding-additional-options that in order to pass additional arguments to the command, the arguments need to be separated by --.

— Reply to this email directly, view it on GitHub https://github.com/Shopify/shopify-app-template-node/issues/1317#issuecomment-1938064640, or unsubscribe https://github.com/notifications/unsubscribe-auth/AGBLNUFIIWPO4VYUWP2VVALYTGN6PAVCNFSM6AAAAABC5GHP36VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSMZYGA3DINRUGA . You are receiving this because you were mentioned.Message ID: @.***>