Have ideas to improve npm?Join in the discussion! »

entity-cli

1.1.12 • Public • Published

Entity CLI

What's new ?

  • fix js support
  • create interfaces for mongoose ts

Features

  • support typeorm (ts), sequelize (ts) and mongoose (js, ts)
  • Generate entity
  • support OneToMany relation (typeorm, sequelize)
  • support OneToOne relation (typeorm)
  • support string, number, boolean type
  • additionally supports Buffer, ObjectId type for mongoose
  • support config file
  • mode module
  • you can specify the folder where are located your entities inside the module dir
  • autocomplete feature in your entities research
  • you can manage many entities by module
  • works properly with nest resource
  • make relations in mongoose

How to install

npm i entity-cli or yarn add entity-cli

Add to scripts key to package.json

"scripts" {
    ...
    "entity-cli": "node ./node_modules/entity-cli/index.js"
}

Install the ORM

for configuration go to Configuration section

Sequelize

typeorm

Mongoose

  • Typescript / Javascript

Configuration

create an entity-cli.json file in your project root directory

put this content

{
  "src": "put_entities_directory",
  "orm": "type" //typeorm or mongoose or sequelize,
  "lang": "language" // js or ts
}

Module mode (recommended for nestJs users)

What's module mode ?

a module is a directory that encompasses the logics that revolve around a well-defined entity it permits to organize the application structure.

how to activate ?

add "mode": "module" to entity-cli.json

add "modulesDir": "path to module dir" to change the modules directory

when the module mode is activate, the src key in entity-cli.json represents the folder where are entities inside the module

{
  "mode": "module",
  "modulesDir": "path to module dir"
}

the default directory is : src/entities

default orm : typeorm

default language : ts

default modules directory : src/modules

Install

npm i entity-cli

DownloadsWeekly Downloads

95

Version

1.1.12

License

ISC

Unpacked Size

56.7 kB

Total Files

51

Last publish

Collaborators

  • avatar