Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide more intuitive error messages #17

Open
kkeri opened this issue May 27, 2017 · 2 comments
Open

Provide more intuitive error messages #17

kkeri opened this issue May 27, 2017 · 2 comments

Comments

@kkeri
Copy link

kkeri commented May 27, 2017

Several users, including me run into the same issue when attempting to use the extension. We get either command 'extension.generateStandalonePreview' not found or command 'extension.generateSidePreview' not found.

In fact the preconditions to executing these commands are precisely described.

  • Open extension project from the root folder in vscode.
  • Navigate to the manifest file for your extension (package.json for Visual Studio Code extensions and vss-extension.json for Team Services extensions).

In my case the extension project was not the root directory of the workspace. Yet I had hard time to figure out what happened. The error message suggests that there is some problem with the extension itself, hiding the real cause from the unaware user.

It would be very helpful to display more meaningful error messages. I think it would also be effective to place the Usage section in front of the screenshots in the readme file.

@nirmalapemireddy
Copy link
Contributor

Thanks for your feedback about the documentation. We will update it accordingly.
Hope you are not facing issue in executing it now from the root folder

@kkeri
Copy link
Author

kkeri commented May 30, 2017

Thanks. I was facing small issues but I found the right way to use the extension and indeed it is useful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants