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

NPM Task Viewer Widget #55

Open
christian-bromann opened this issue Mar 9, 2022 · 6 comments
Open

NPM Task Viewer Widget #55

christian-bromann opened this issue Mar 9, 2022 · 6 comments
Labels
Enhancement 🚀 New feature or request Help Wanted 🙏 Extra attention is needed Idea 💡 Any ideas or feedback you have for Marquee

Comments

@christian-bromann
Copy link
Contributor

Discovering a new project can be challenging, especially if the project specific tasks are unknown. We can help expose these NPM tasks by offering a widget that allows to add descriptions and titles to an NPM task to help developers better understand what they do and when to use that NPM task.

Requirements:

  • by default show an empty list with a "Call to Action" to add a project script
  • when adding a project script a modal is shown that requires title, description and shell command script (multiline script)
  • read defined NPM scripts from package.json and offer to add them to the list
@christian-bromann christian-bromann added Enhancement 🚀 New feature or request Help Wanted 🙏 Extra attention is needed Idea 💡 Any ideas or feedback you have for Marquee labels Mar 9, 2022
@christian-bromann
Copy link
Contributor Author

We should leverage the VSCode task schema for defining them and the widgets basically reads and displays them.

@christian-bromann
Copy link
Contributor Author

Also we should add this as a new section into the tree viewer.

@sourishkrout
Copy link
Member

We should leverage the VSCode task schema for defining them and the widgets basically reads and displays them.
Also we should add this as a new section into the tree viewer.

I like those two requirements, @christian-bromann. So in essence this is widget is actually a generic VS Code task runner showcased based on NPM scripts/tasks?

@christian-bromann
Copy link
Contributor Author

Also we should add this as a new section into the tree viewer.

I kind changed my mind on this one because tree viewer sections need to be defined within package.json and therefor show up also in non NPM projects.

@sourishkrout
Copy link
Member

Also we should add this as a new section into the tree viewer.

I kind changed my mind on this one because tree viewer sections need to be defined within package.json and therefor show up also in non NPM projects.

Not sure I understand. If a tasks.json is defined the treeviewer could be totally agnostic from what context project is loaded, no?

@christian-bromann
Copy link
Contributor Author

If a tasks.json is defined the treeviewer could be totally agnostic from what context project is loaded, no?

Yeah. If a task.json is defined.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement 🚀 New feature or request Help Wanted 🙏 Extra attention is needed Idea 💡 Any ideas or feedback you have for Marquee
Projects
None yet
Development

No branches or pull requests

2 participants