Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Success message of "msw init" contains a misleading API example

See original GitHub issue

Current behavior

Current success message of running msw init command is:

https://github.com/open-draft/msw/blob/1fc124726f2d6b1e76e5cb7bfe306d94b3061acd/cli/init.js#L29-L34

The API example illustrated in the message is misleading, as the library does not export the msw namespace, neither that namespace has the start() method.

Expected behavior

The message of successfully running the msw init command should link the developer to the documentation.

Issue Analytics

State:
Created 4 years ago
Comments:5 (5 by maintainers)

Top GitHub Comments

1reaction

kettanaitocommented, Mar 13, 2020

Fixed by #63. Released in 0.8.1.

Thank you, @hehehai! Your contributions are highly appreciated.

1reaction

hehehaicommented, Mar 11, 2020

@kettanaito Yes this is a good idea

What do you think of demandCommand and example below, which can give developers some feedback on their use.

now cli，No feedback

$ npx msw

command check

yargs
	// ......
	.help()
	.demandCommand().argv

$ npx msw

command example

(yargs) => {
      // builder
      yargs
        .positional('publicDir', {
          type: 'string',
          description: 'Relative path to server public directory',
          required: true,
          normalize: true,
        },
        .example('init', 'msw init public')
        .help()
    },