Scaffolding

Midway has written the create-midway package. Through the npx command, you can easily use the npm init midway command to create scaffolding.

$ npm init midway@latest -y

astuce

If you don’t add the @latest tag, you may not be updated to the latest version.

Create scaffolding via CLI

Default behavior

Without passing parameters, you can list the currently most commonly used templates.

For example, execute

$ npm init midway@latest -y

will output

➜ ~ npm init midway
? Hello, traveler.
   Which template do you like? …

  ⊙ v3
❯ koa-v3 - A web application boilerplate with midway v3(koa)
   egg-v3 - A web application boilerplate with midway v3(egg 2.0)
   faas-v3 - A serverless application boilerplate with midway v3(faas)
   component-v3 - A midway component boilerplate for v3
   quick-start - A midway quickstart exmaple for v3

  ⊙ v3-esm
   koa-v3-esm - A web application boilerplate with midway v3(koa)

  ⊙ v2
   web - A web application boilerplate with midway and Egg.js
   koa - A web application boilerplate with midway and koa

In this mode, templates will be created according to user selections and guidelines.

About parameter passing

Since npm init midway is equivalent to npm exec create-midway, the format of passing parameters depends on different npm versions. different.

For example, in the latest npm, use additional -- to pass parameters.

for example

$ npm init midway -- -h

The -h parameter makes all available options explicit.

All parameter examples below will be displayed in this mode.

Show all templates

Templates that are not the current version will be hidden by default. All built-in templates can be displayed through the -a parameter.

$ npm init midway -- -a

Specify template name

Each template has a template name and template description. For example, the template name of koa-v3 - A web application boilerplate with midway v3(koa) is koa-v3.

The template name can be specified via the --type parameter.

$ npm init midway -- --type=koa-v3

Specify template package name

When the custom template is published on npm, we can use -t or --template to specify the package name.

$ npm init midway -- -t=custom-template

If the package is still being developed locally, you can also specify a relative path or an absolute path.

$ npm init midway -- -t=./custom-template

Specify the creation target directory

The directory to be created can be specified through the --target parameter, which must be used together with the type or template parameter.

For example, the following command specifies the koa-v3 template and generates it into the current abc directory. If the directory does not exist, it will be created.

$ npm init midway -- --type=koa-v3 --target=abc

Generally, target can be omitted and the path can be placed as the last parameter.

$ npm init midway -- --type=koa-v3 abc

Specify npm client

If you have a private client, you can use --npm to specify the client.

$ npm init midway -- --npm=tnpm

Specify registry

If you have a private source, you can use --registry to specify the private source.

$ npm init midway -- --registry=https://registry.npmmirror.com

Scaffolding parameters

If the scaffold contains user-passable parameters, they can also be passed through the command line.

$ npm init midway -- --bbb=ccc

If the parameter name is the same as the parameter of the tool, you can use the parameter of t_, which will be automatically processed when the tool is passed to the scaffold.

$ npm init midway -- --type=koa-v3 --t_type=ccc

Write scaffolding

Midway scaffolding uses the self-developed light-generator tool. For specific usage, please refer to https://github.com/midwayjs/light-generator.

You can also refer to Midway's own template project.