Add generator-superset

[kristw]

🏆 Enhancements

• Add generator-superset package for scaffolding.
• This package will be published as @superset-ui/generator-superset.
• Update build script to skip babel tasks for generator-superset, as it is a node application.
• Use jest project configuration to separate generator-superset from others and run in testEnvironment: "node". (Although that was not the real issue that demolished CI in the early attempts.)

Note about yeoman testing and interference with other packages

The key thing to add to yeoman tests, which are not normally included even from official yeoman generator-generator, is to change working directory back to original working directory after the test has completed. yeoman tests switch to tmp directory and write files there. Usually this is fine for solo package. However, for a monorepo like this one, it made jest confuses with current directory (being in tmp directory instead of superset-ui root) and interferes with other tests in sibling packages that are run after the yeoman tests.

By adding the directory switch in afterAll() block. Everything works fine again! 🍾

Many yaks were shaved in the making of this pull request.

[codecov]

Codecov Report

Merging #21 into master will not change coverage.
The diff coverage is 100%.

@@          Coverage Diff          @@
##           master    #21   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          37     39    +2     
  Lines         325    339   +14     
=====================================
+ Hits          325    339   +14

Impacted Files	Coverage Δ
...ges/generator-superset/generators/package/index.js	100% <100%> (ø)
...ackages/generator-superset/generators/app/index.js	100% <100%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3196ab1...c66fdf1. Read the comment docs.

[williaster]

LGTM! thanks for all the yak shaving and build debugging for this! had a couple of small comments, could fix the README post-merge if you're anxious to get it in.

👯

[williaster]

can you tell if this gets added to the ones generated beemo?

[kristw]

The jest.config.js generated by beemo doesn't have this field by default.
This was added to avoid running the generator tests twice.

[williaster]

sorry I wasn't clear, just wanted to see if this ignore pattern is added to or over-writes the testPathIgnorePatterns generated by beemo

[kristw]

I tested removing the field from package.json and jest.config.js remove the field completely. Probably doesn't have that in base.

I tried adding something to package.json's testMatch yesterday and that gets added to the jest.config.js along with the one coming from beemo

[williaster]

is this line correct? not @superset-ui/generator-superset?

[kristw]

Yes, it is correct. yo xxx looks for global npm packages (or npm link'ed package) named generator-xxx.

You will notice all yeoman generator package names start with generator-

This is why I am tempted to name this package generator-superset without @superset-ui so we can call yo superset, but that will not published under the npm org.

[williaster]

ah got it, thanks for the explanation 👍

I think using the @superset-ui namespace would still be good.

[williaster]

1. is this recommended vs adding yo as a dep and getting it when you install this package?
2. also wondering if we should suggest they just run npm run bootstrap in the root, and then @superset-ui/generator-superset + its deps will be installed?
3. if we do keep the separate installs, do we need them to be global packages?

[kristw]

1/3) This is the recommended way as there should be single yo client. and yo looks for generator in the global scope.
http://yeoman.io/learning/index.html

2. This README was written in a way that this packaged can be used independent from this repo. I envision this generator can be extended to have multiple subgenerator for scaffolding independent chart plugin repo, etc. It will be more convenient to install the generator package alone without cloning this monorepo only to npm link the generator.