[Feedback] How to show that extension needs configuration?

[hiaux0]

Background

For me, #151 triggered this question.

On one side, I want to show a new user, how to setup the extension.

On the other side, it might become annoying (insert scenario).

Notes

When I use other extension, I would always go to the Repo and look for instructions.
Though, I always thought how nice it would be, if I get some setup instructions.

Options

• A welcome page might be the solution?
• Status Bar

[zewa666]

I like that one. Alternatively you could also make the link open a tab with a webview embedding the readme from the repo. Similar like gitlens has

[pkkummermo]

I use VSCode on several projects, also ones where aurelia is not present. The extension follows VSCode and not only the workspace. Perhaps we could detect if aurelia is actually present (searching package.json) before we show error/warnings/start pages?

[hiaux0]

Thanks for the proposals, which are

1. Link should open in webview (cf. gitlens)
2. Auto-detect Aurelia project

I started on 2.

Strategy:

• Detect if any Aurelia-related files are open
  • Yes? -> Start component collection
  • No? -> Do nothing
    • And wait until Aurelia-related file is being opened -> Start component collection