# @iamsimonsmale/nestjs-complete-module

> A schematic to generate a NestJS module with a service, controller, TypeORM model.

Latest version **1.0.0** (published 2020-11-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @iamsimonsmale/nestjs-complete-module
pnpm add @iamsimonsmale/nestjs-complete-module
yarn add @iamsimonsmale/nestjs-complete-module
bun add @iamsimonsmale/nestjs-complete-module
```

## 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 | 1.0.0 |
| Published | 2020-11-20 |
| First published | 2020-11-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 15.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Simon Smale |
| Maintainers | iamsimonsmale |
| Keywords | schematics |

## Links

- npm: https://www.npmjs.com/package/@iamsimonsmale/nestjs-complete-module
- Repository: https://github.com/SSmale/nestjs-complete-module
- Homepage: https://github.com/SSmale/nestjs-complete-module#readme
- Issues: https://github.com/SSmale/nestjs-complete-module/issues
- npm.io page: https://npm.io/package/@iamsimonsmale/nestjs-complete-module

## Dependencies (4)

- [typescript](https://npm.io/package/typescript.md) ~4.0.2
- [@schematics/angular](https://npm.io/package/@schematics/angular.md) ^11.0.2
- [@angular-devkit/core](https://npm.io/package/@angular-devkit/core.md) ^11.0.2
- [@angular-devkit/schematics](https://npm.io/package/@angular-devkit/schematics.md) ^11.0.2

## Alternatives

- [@regle/core](https://npm.io/package/@regle/core.md) — 47.0K weekly downloads
- [typeof-arguments](https://npm.io/package/typeof-arguments.md) — 12.5K weekly downloads
- [@lokalise/projects-engine-contracts](https://npm.io/package/@lokalise/projects-engine-contracts.md) — 978 weekly downloads
- [@osjwnpm/nam-laboriosam-quibusdam](https://npm.io/package/@osjwnpm/nam-laboriosam-quibusdam.md) — 70 weekly downloads
- [@oridune/validator](https://npm.io/package/@oridune/validator.md) — 16 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2020-11-20

## README

# NestJS Complete Module Schematic

I could not find a schematic that created a CRUD module in NestJS. So I build this.

The file structure looks like :

```typescript
app/
├─ controller/
│  ├─ <g>.controller.spec.ts
│  ├─ <g>.controller.ts
├─ models/
│  ├─ <g>.entity.ts
│  ├─ <g>.model.ts
├─ service/
│  ├─ <g>.service.spec.ts
│  ├─ <g>.service.ts
├─ <g>.module.ts

```

# Schema Aims

```
{
  "$schema": "http://json-schema.org/schema",
  "id": "nestjs-complete-module",
  "title": "Generates NestJS Module",
  "description": "A schematic to generate a NestJS module with a service, controller, TypeORM model.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the module.",
      "$default": {
        "$source": "argv",
        "index": 0
      },
      "x-prompt": "What is the name of the module?"
    },
    "path": {
      "type": "string",
      "format": "path",
      "description": "The path to create the module.",
      "visible": false
    },
    "project": {
      "type": "string",
      "description": "The name of the project.",
      "$default": {
        "$source": "projectName"
      }
    },
    "module": {
      "type": "string",
      "description": "Allows specification of the declaring module.",
      "alias": "m"
    },
    "flat": {
      "type": "boolean",
      "default": false,
      "description": "Flag to indicate if a dir is created."
    },
    "spec": {
      "type": "boolean",
      "default": true,
      "description": "Specifies if a spec file is generated."
    },
    "lintFix": {
      "type": "boolean",
      "default": false,
      "description": "Specifies whether to apply lint fixes after generating the model."
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}
```

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