Yeoman Generator @superset-ui/superset Fails with Environment Compatibility Error

NurramoX commented 10 months ago

When attempting to use the Yeoman generator @superset-ui/superset for creating a custom Superset plugin, an error occurs stating that the current environment does not provide some necessary feature that the generator needs. The error message doesn't tell exactly which feature it needs... This issue arises after following the steps provided in the Preset blog for building custom visualization plugins in Superset. The expected behavior is to receive a prompt from the generator asking a few questions, but instead, an error is encountered.

How to reproduce the bug

npm i -g yo
cd superset-frontend/packages/generator-superset
npm i && npm link
mkdir /tmp/superset-plugin-chart-hello-world
cd /tmp/superset-plugin-chart-hello-world
yo @superset-ui/superset

Expected results

The generator should prompt the user with questions to set up the new Superset plugin.

Actual results

An error message is displayed: Error @superset-ui/superset Current environment doesn't provide some necessary feature this generator needs.

Environment

Debian Version: Debian 12
superset version: 3.0.2
node.js version: 16.20.2

Checklist

[ ] I have checked the superset logs for python stacktraces and included it here as text if there are any.
[ ] I have reproduced the issue with at least the latest released version of superset.
[x] I have checked the issue tracker for the same issue and I haven't found one similar.

Additional context

Downgrading Yeoman to version 4 (npm i -g yo@4) resolves the issue. It seems that the current version of @superset-ui/superset generator may not be compatible with Yeoman version ^5.0.0.

gaogaoinvincible commented 10 months ago

Same error, anybody relove this problem?

visharavana commented 10 months ago

@gaogaoinvincible I am also facing this error. Try this command; it's working for me. -> npm i -g yo -> npm i -g @superset-ui/generator-superset

Stefan781 commented 9 months ago

I ran into the same issue. Downgrading to the latest 4.x.x version was a workaround.

srlee056 commented 9 months ago

@visharavana I faced same error and npm i -g @superset-ui/generator-superset worked for me. Thanks!

loretoparisi commented 8 months ago

npm i -g @superset-ui/generator-superset

amazing it worked in that way:

Install Plugin Generator (Yo)

npm i -g yo
npm i -g @superset-ui/generator-superset

cd superset-frontend/packages/generator-superset
npm i && npm link

Create Example Plugin

mkdir /tmp/superset-plugin-chart-hello-world
cd /tmp/superset-plugin-chart-hello-world
yo @superset-ui/superset

rusackas commented 8 months ago

Happy to update blogs/docs if better instructions would help others. Let me know what you think on that front.

Also open to PRs that will make things work better with Yeoman 5... it's probably time to make that upgrade.

I'm kind of on the fence about whether the yeoman generator is even the right approach here anymore (it's difficult to maintain). There are other ways, like maybe (1) a template repository, (2) a zip file in the repo with a demo plugin, maybe including a little script to add it to Superset, or (3) just a "hello world" plugin sitting there in the monorepo, with tests and storybook running against it as if it were a production plugin (but not installed in Superset).

I've been meaning to have this conversation with @villebro but he's a busy guy ;)

rusackas commented 2 weeks ago

Just stopping by to acknowledge that this is still an issue, but I'm planning to get rid of Yeoman. Holler if anyone has preferences between • A disabled "vanilla" plugin in the Superset codebase, to riff on. • A template GitHub repo to spin up a new plugin (with CI to maintain it).

I feel the first option might be easier for devs AND easier to maintain, but I'm not at all certain.

apache / superset