# nx-loopback-next

> Loopback 4 builder and schematics for Nx monorepos.

Latest version **0.0.4** (published 2020-01-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install nx-loopback-next
pnpm add nx-loopback-next
yarn add nx-loopback-next
bun add nx-loopback-next
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2020-01-10 |
| First published | 2020-01-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 36 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Martin Raymond |
| Maintainers | codephobia |

## Links

- npm: https://www.npmjs.com/package/nx-loopback-next
- Repository: https://github.com/codephobia/nx-loopback-next
- Homepage: https://github.com/codephobia/nx-loopback-next#readme
- Issues: https://github.com/codephobia/nx-loopback-next/issues
- npm.io page: https://npm.io/package/nx-loopback-next

## Dependencies (5)

- [shelljs](https://npm.io/package/shelljs.md) ^0.8.3
- [@nrwl/workspace](https://npm.io/package/@nrwl/workspace.md) ^8.9.0
- [@angular-devkit/core](https://npm.io/package/@angular-devkit/core.md) 8.3.14
- [@angular-devkit/architect](https://npm.io/package/@angular-devkit/architect.md) ^0.803.21
- [@angular-devkit/schematics](https://npm.io/package/@angular-devkit/schematics.md) 8.3.14

## Recent versions

- 0.0.4 (latest) — 2020-01-10
- 0.0.3 — 2020-01-09
- 0.0.2 — 2020-01-09
- 0.0.1 — 2020-01-09

## README

# nx-loopback-next

Create a [Loopback 4](https://loopback.io) application within your [Nx Monorepo](https://nrwl.io). This is more of a proof of concept, and may not be production ready. My hope is that Nrwl adds official support for Loopback within Nx. Pull requests are more than welcome.

## Install package

With Yarn:

`yarn add nx-loopback-next`

With NPM:

`npm i nx-loopback-next --save`

Github:

`npm i https://github.com/codephobia/nx-loopback-next.git --save`

And then you must build the contents in your node_modules/nx-loopback-next with `yarn build`.

## Create a new application

With Nrwl CLI:

`nx g nx-loopback-next:app`

With Angular CLI:

`ng g nx-loopback-next:app`

## Schematics

### Init

Initializes the Nx monorepo to have dependencies for Loopback 4. This is a hidden schematic and should not ever need to be called.

#### Schema

| Name       | Type    | Required | Description                           |
|------------|---------|:--------:|---------------------------------------|
| skipFormat | boolean | false    | Not actually being used yet           |

### Application

Generates a new Loopback 4 application.

#### Schema

| Name       | Type    | Required | Description                           |
|------------|---------|:--------:|---------------------------------------|
| name       | string  | yes      | Name of the new application           |
| tags       | string  | no       | Comma separated tags used for linting |
| skipFormat | boolean | false    | Not actually being used yet           |

## Builders

### Build

Builds the application using lb-tsc.

#### Schema

| Name       | Type    | Default | Required | Description                                 |
|------------|---------|---------|:--------:|---------------------------------------------|
| appPath    | string  |         | yes      | Path the application. ie. apps/backend      |
| tsConfig   | string  |         | yes      | Path to the tsConfig.json file for Loopback |
| clean      | boolean | false   | no       | Delete dist files prior to build            |

### Execute

Runs the build application with Node.js.

#### Schema

| Name        | Type     | Default     | Required | Description                                  |
|-------------|----------|-------------|:--------:|----------------------------------------------|
| appPath     | string   |             | yes      | Path the application. ie. apps/backend       |
| NODE_ENV    | string   | development | no       | Node environment for the application         |
| args        | string[] | []          | no       | Arguments to add to the command              |
| buildTarget | string   |             | yes      | The Nx build command for the new application |
| runOnly     | boolean  | true        | no       | Skip the build before running                |
| clean       | boolean  | false       | no       | Delete dist files prior to build             |

## Features still missing

I would like to see the following features added to the project.

- Build with watch
- Linting
- Unit tests

## Shoutouts and Credit

I couldn't have built this without the following resources and wanted to make sure to note them:

- The official Nx github is a great resource for seeing how the team at Nrwl are building schematics and builders for Nx. [https://github.com/nrwl/nx](https://github.com/nrwl/nx)

- Abdooly wrote a custom builder for using ts-node. That repo was a massive help in understanding how to make a builder without using webpack. [https://github.com/abdoolly/ts-node-builder](https://github.com/abdoolly/ts-node-builder)

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