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

[kettanaito]

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.

[hehehai]

console.log(`
${chalk.green('Service Worker successfully created!')}
Continue by creating a mocking module and starting the Service Worker：

  Define mocks: ${chalk.cyan.bold(
    'https://redd.gitbook.io/msw/getting-started#define-mocks',
  )}
`)

Link to short link should be better, but short links on the Internet may not be very stable.

@kettanaito msw cli can feedback more help information, including information such as examples or documentation

now cli

$ 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()
    },

[kettanaito]

@hehehai, that anchor to #define-mocks is a great idea! Agree, shortlinks take less space, but unless it's self-hosted it won't be reliable. Documentation's link structure may also change, but I see no bulletproof way of binding docs and this message. I'd go with the link you've suggested.

Maybe let's omit the Define mocks: part? The message above already explains what the link has to do.

$ npx msw init

Service Worker successfully created!
Continue by creating a mocking definition module and staring the Service Worker:

<LINK HERE>

What do you think? Also, please, feel free to implement this if you've got time. I'll gladly review and merge. Thank you.

[hehehai]

@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()
    },

[kettanaito]

@hehehai .demandCommand() looks good to me. Would prevent people from accidentally running msw alone. Also great find regarding .example(). Agree with both decisions, thanks for the opinion on this!

[kettanaito]

Fixed by #63. Released in 0.8.1.

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