# @synconset/typeormgen

> Generate typeorm models from your database tables

Latest version **2.1.4** (published 2024-07-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install @synconset/typeormgen
pnpm add @synconset/typeormgen
yarn add @synconset/typeormgen
bun add @synconset/typeormgen
```

Provides the commands `typeg`, `typeormgen`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.4 |
| Published | 2024-07-17 |
| First published | 2019-04-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 21.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Maintainers | epjuribe, mpawar0910, nelson4183, etrangep, bsinhaatep, sivakrishna, kotes-sos, sveeramala, dinesh1312, praveenpalavali, renjith-ep, vijaykumarep, prsingh, kg094467, ddunhamep, nesarahippla, kkeshmiri, rpowers11, attilivenkat |

## Links

- npm: https://www.npmjs.com/package/@synconset/typeormgen
- Repository: https://github.com/wymsee/typeormgen
- Homepage: https://github.com/wymsee/typeormgen#readme
- Issues: https://github.com/wymsee/typeormgen/issues
- npm.io page: https://npm.io/package/@synconset/typeormgen

## Dependencies (7)

- [knex](https://npm.io/package/knex.md) ^3.1.0
- [mysql](https://npm.io/package/mysql.md) 2.18.1
- [nconf](https://npm.io/package/nconf.md) ^0.12.1
- [dotenv](https://npm.io/package/dotenv.md) ^16.4.5
- [sqlite3](https://npm.io/package/sqlite3.md) ^5.1.7
- [fs-extra](https://npm.io/package/fs-extra.md) ^11.2.0
- [pluralize](https://npm.io/package/pluralize.md) ^8.0.0

## Recent versions

- 2.1.4 (latest) — 2024-07-17
- 2.1.3 — 2023-09-11
- 2.1.2 — 2023-09-09
- 2.1.1 — 2021-02-16
- 2.1.0 — 2019-06-05
- 2.0.3 — 2019-04-12
- 2.0.2 — 2019-04-11
- 2.0.1 — 2019-04-11
- 2.0.0 — 2019-04-11
- 1.1.0 — 2019-04-11
- 1.0.0 — 2019-04-10

## README

# typeormgen
Generate typeorm models from your database tables

### Command Line Usage

```
Options:
--base, -b                    Path to a file containing a class for the model
                              to exend.  The class should be the default
                              export
--host, -h                    Database host url
--port, -p                    Port the database is exposed on
--user, -u                    Database username
--password                    Database password
--configFile                  Path to json config file
--envFile                     Path to env file to be parsed by dotenv
--database, -d                Database name
--table, -t                   Table name to generate a model for    [required]
--model, -m                   Model class name.  Will default to converting
                              snake case table name to PascalCase
--moment                      Use Date | Moment for the type for dates instead
                              of just Date                           [boolean]
--rules, -r                   Output a static rules function that returns
                              basic joi validation rules             [boolean]
--toJSON                      Output a toJSON function that returns the
                              model's properties
--pluralization               Whether the name of the model should be plural
                              e.g., table users to model Users or User
--out, -o                     Path to where model file will be written
                                                                    [required]
--tabs                        Use tabs instead of spaces             [boolean]
--tabSize                     Number of spaces to indent lines
--primaryGeneratedColumn      Column to decorate with
                              @PrimaryGeneratedColumn()
--primaryGeneratedColumnUUID  Column to decorate with
                              @PrimaryGeneratedColumn('uuid')
--primaryColumn               Column to decorate with @PrimaryColumn()
--createDateColumn            Column to decorate with @CreateDateColumn()
--updateDateColumn            Column to decorate with @UpdateDateColumn()
--versionColumn               Column to decorate with @VersionColumn()
--help                        Show help                              [boolean]
```

### Config File Example

```
{
    "host": "localhost",
    "port": 3306,
    "user": "user",
    "password": "password",
    "database": "database",
    "rules": true,
    "toJSON": true,
    "pluralization": false,
    "moment": true,
    "tabSize": 2
}
```

### Environment Variable Configuration

```
MYSQL_HOST=localhost
MYSQL_PORT=3306
MYSQL_DATABASE=database
MYSQL_USER=user
MYSQL_PASSWORD=password

TYPEORMGEN_HOST=localhost
TYPEORMGEN_CONFIG_FILE=/home/user/config.json
TYPEORMGEN_ANY_OPTION
```

---
_Source: https://npm.io/package/@synconset/typeormgen · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._