npm

Need private packages and team management tools?Check out npm Orgs. »

nest-ts-code-gen

1.0.2 • Public • Published

what it is

nest-ts-gen is a code generator to generate back-end nest template code(controller, service, module) and front-end ts type, see in the demo demo/

requirement

  1. contract/: write back-end type and controller mapping configuration in the contract folder
  2. setup codeGen in your code: setup mapping, output folder and output file name
  3. mkdir all your output folder, make sure it exist

notification

  1. nest-ts-gen will replace controller output file and module output file, and as you know nest.service is not a template file, so the service file will be keep if exist, and only replace service method and related type :)

mapping config

write the key _config in the mapping config like this:

export default {
  _config: {
    // specify Controller promised common response type, it should be a generic type, so response type will be generated as CommonRes or CommonRes<SomeDto>
    promiseGenericRes: "CommonRes"
  },
  // controller, service, entity => we name it as model name
  model1: {
      // method name
      getStr: {
          // request dto type, you should define it in your contract folder first
          req: 'GetStrRequest'
          // response dto type, define before you write
          res: 'GetStrResponse'
      }
  },
  model2: {
      _config: {
          // stop to generate controller file
          disableController: true,
          // stop to generate entity (in service imports and module imports)
          disableEntity: true
      }
      getStr: {
          // if you don't write req and res, default req: any and res: _config.promiseGenericRes will be generated
      }
  }
 

and see props in the file src/type/global.ts

install

npm i nest-ts-code-gen

Downloadsweekly downloads

7

version

1.0.2

license

ISC

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability