Gravity UI templates generator

[ogonkov]

Objective

Generate new Gravity UI stack projects easy

Solution Proposal

Create @gravity-ui/create package, that would include some templates, for example for app-builder, next.js.

Definition of done

We should be able to call npm create @gravity-ui, select project name, select how we want to build it and what additional parts we need (we need to decide)

[ogonkov]

Docs for npm create command https://docs.npmjs.com/cli/v11/commands/npm-init

Package should include bin in package.json

{
  "main": "./bin/index.js",
  "bin": {
    "create-gravity-project": "./bin/index.js"
  }
}

Code itself should be a series of user prompts, to get answers for those questions:

1. Project name
2. Should we include nvm to generated code (optional)
3. Should we setup styles lint (optional)
4. How we want to build our project (app-builder, next.js, etc)

To generate this code we could have Handlebars templates that will generate required files (for example basic package.json, some configs).

`- templates
   `- app-builder
      |- package.json.handlebars
      `- app-builder.config.ts.handlebars

[ogonkov]

Probably we could think further and add here utilities for adding new routes to nodekit, for example?

[SeqviriouM]

@amje @korvin89 what do you think about proposal?

[korvin89]

@amje @korvin89 what do you think about proposal?

This is a good idea! It would be more convenient to have one tool for all templates managing

[SeqviriouM]

@ogonkov are you ready to help with the implementation?

[ogonkov]

Yes, sure

[SeqviriouM]

@ogonkov what is the current status? Can we change the status of the issue to "In Progress"?

[ogonkov]

Yes, lets change it to in progress

[ogonkov]

I was thinking about chain of this prompts

stateDiagram-v2
  dest: Destination folder (prompt)
  registry: Custom registry (prompt)
  nvm: NVM (select supported node version)
  language: TS or JS (select)
  tsconfig: Adding @gravity-ui/tsconfig
  frontend: Does project has frontend? (select)
  styles: Does project has styles? (select)
  stylelint: Adding stylelint packages
  nodekit: Adding nodekit packages, setup base "Hello, world" server
  react: Does your project has React? (select)
  reactSetup: Setup new JSX transformations
  server: Does your project has backend? (select)
  baseLinters: Adding @gravity-ui/eslint-config, @gravity-ui/prettier-config

  [*] --> dest
  dest --> registry
  registry --> nvm
  nvm --> language
  language --> tsconfig : TS
  language --> frontend : JS
  tsconfig --> frontend
  frontend --> styles : Yes
  frontend --> server : No
  styles --> stylelint : Yes
  styles --> react : No
  stylelint --> react
  react --> reactSetup : Yes
  react --> server : No
  reactSetup --> server
  server --> baseLinters : No
  server --> nodekit : Yes
  nodekit --> baseLinters

Loading

[SeqviriouM]

@amje @korvin89 what do you think?

[korvin89]

@SeqviriouM @ogonkov I would not use nvm, node and npm can be used without it, I think this step can be removed, otherwise everything is great!