Package detail

@loopback/build

loopbackio105.3kMIT11.0.12

A set of common scripts and default configurations to build LoopBack 4 or other TypeScript modules

readme

LoopBack makes it easy to build modern applications that require complex integrations.

Fast, small, powerful, extensible core
Generate real APIs with a single command
Define your data and endpoints with OpenAPI
No maintenance of generated code

Status: General Availability

LoopBack 4 GA (General Availability) has been released in October 2018, read more in the announcement post.

The documentation website is https://loopback.io/doc/en/lb4/.

Learn about the latest and greatest features and technologies in LoopBack 4 by using it for your next project. Start by having a look at Getting Started.

Check the API documentation for all the API usages in each package.

Long Term Support

We don't provide any LTS version for LoopBack 4 yet. Please join the discussion in loopback-next#4398 if you are interested in a version that's less frequently changed.

Version	Status	Published	EOL
LoopBack 4	Current	Oct 2018	Apr 2026 (minimum)
LoopBack 3	End-of-Life	Dec 2016	Dec 2020
LoopBack 2	End-of-Life	Jul 2014	Apr 2019

Please refer to our Long Term Support Policy for more details.

Installation

Make sure you have the following installed:

Package	Version/-s	Link	Note
Node.js	Maintenance LTS (v16) Active LTS (v18) Current (v20)	https://nodejs.org/en/about/releases/	The use of the current version for production is not recommended.

You can generate a project with our generator or with the CLI as follows:

npm create loopback
npx -p @loopback/cli lb app

To create your first LoopBack 4 application, see Getting Started.

Documentation

Contributing

See the following resources to get you started:

You can join the team by posting a comment to issue #110.

Security

If you think you have discovered a new security issue with any LoopBack package, please do not report it on GitHub. Instead, send an email to security@loopback.io with a full description and steps to reproduce.

See SECURITY.md for more details.

Team

Project Architect

Raymond Feng

Technical Steering Committee

Raymond Feng	Diana Lau	Mario Estrada	Rifa Achrinza	Francisco Buceta	Samarpan Bhattacharya

Other Project Maintainers

Nora Abdelgadir	Matthew Schnee	Hage Yaapa

Agnes Lin	Madaky	Hugo Da Roit

Nico Flaig	Denny Bartelt	Douglas McConnachie

Samarpan Bhattacharya	Muhammad Aaqil

See all contributors.

Alumni

License

MIT

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

11.0.12 (2025-05-13)

Note: Version bump only for package @loopback/build

11.0.11 (2025-04-17)

Note: Version bump only for package @loopback/build

11.0.10 (2025-02-13)

Note: Version bump only for package @loopback/build

11.0.9 (2025-01-15)

Note: Version bump only for package @loopback/build

11.0.8 (2024-12-12)

Note: Version bump only for package @loopback/build

11.0.7 (2024-11-18)

Note: Version bump only for package @loopback/build

11.0.6 (2024-09-12)

Note: Version bump only for package @loopback/build

11.0.5 (2024-08-14)

Note: Version bump only for package @loopback/build

11.0.4 (2024-07-09)

Note: Version bump only for package @loopback/build

11.0.3 (2024-06-10)

Note: Version bump only for package @loopback/build

11.0.2 (2024-05-17)

Bug Fixes

build: correctly join file paths on windows when copying resources (71d5657)

11.0.1 (2024-04-09)

Note: Version bump only for package @loopback/build

11.0.0 (2024-03-04)

chore

drop Node.js 16 support (b9efcb4)

BREAKING CHANGES

Drop Node.js 16 support in all LB4 modules and extensions

Signed-off-by: dhmlau dhmlau@ca.ibm.com

10.1.5 (2024-01-11)

Note: Version bump only for package @loopback/build

10.1.4 (2023-12-12)

Note: Version bump only for package @loopback/build

10.1.3 (2023-09-12)

Note: Version bump only for package @loopback/build

10.1.2 (2023-08-15)

Bug Fixes

changes to adapt to prettier's major version (8093f29)

10.1.1 (2023-07-17)

Note: Version bump only for package @loopback/build

10.1.0 (2023-06-28)

Features

update dependency @types/node to ^16 (2af42b7)

10.0.0 (2023-05-15)

Features

add support for node v20 (e23cefa)
remove support for node v14 (5425762)
remove support for node v19 (e26a2ac)

BREAKING CHANGES

End of life of Node v14

Signed-off-by: Francisco Buceta frbuceta@gmail.com

9.0.10 (2023-04-13)

Bug Fixes

refresh package lock files (9979eb1), closes #9351
rimraf must be configured to accept patterns (8ba04ab)
use glob named import (7daf6fb)
use rimraf named import (1417f7b)

9.0.9 (2023-03-09)

Note: Version bump only for package @loopback/build

9.0.8 (2023-02-07)

Reverts

"chore: update dependency rimraf to v4" (c516d5e)

9.0.7 (2023-01-09)

Note: Version bump only for package @loopback/build

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

9.0.6 (2022-12-14)

Note: Version bump only for package @loopback/build

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

9.0.5 (2022-11-24)

Note: Version bump only for package @loopback/build

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

9.0.4 (2022-10-13)

Note: Version bump only for package @loopback/build

9.0.3 (2022-08-25)

Note: Version bump only for package @loopback/build

9.0.2 (2022-07-14)

Bug Fixes

docs: documentation update from availalbe to available (f3550ac)
docs: update build documentation for spelling mistake (0f1cc69)

9.0.1 (2022-06-13)

Note: Version bump only for package @loopback/build

9.0.0 (2022-05-05)

⚠ BREAKING CHANGES

remove node v12 support

Features

add support for node v18 (ccb4c61)
remove node v12 support (5f66e5b)

8.1.2 (2022-03-29)

Note: Version bump only for package @loopback/build

8.1.1 (2022-02-28)

Note: Version bump only for package @loopback/build

8.1.0 (2022-02-14)

Features

update @types/node to v12 (65a09a4)

8.0.1 (2022-01-11)

Note: Version bump only for package @loopback/build

8.0.0 (2021-11-18)

Features

drop support for Node.js v10 (9bcbbb3)
support Node.js v17 (8d86c03)
upgrade to TypeScript 4.5.2 (72ece91)

BREAKING CHANGES

drop support for Node.js v10

Co-authored-by: Francisco Buceta frbuceta@gmail.com Signed-off-by: Rifa Achrinza 25147899+achrinza@users.noreply.github.com

7.0.2 (2021-10-18)

Note: Version bump only for package @loopback/build

7.0.1 (2021-09-16)

Note: Version bump only for package @loopback/build

7.0.0 (2021-07-15)

Features

rest: upgrade to ajv@8.x (d3b20ed)

BREAKING CHANGES

rest: We upgrade to ajv@8.x, which contains breaking changes for validations. See https://github.com/ajv-validator/ajv/blob/master/docs/v6-to-v8-migration.md.

Signed-off-by: Raymond Feng enjoyjava@gmail.com

6.4.1 (2021-06-10)

Note: Version bump only for package @loopback/build

6.4.0 (2021-05-03)

Features

support node v16 (ac99415)

6.3.1 (2021-04-06)

Note: Version bump only for package @loopback/build

6.3.0 (2021-03-18)

Features

update package-lock.json to v2 consistently (dfc3fbd)
upgrade to TypeScript 4.2.x (05930bc)

6.2.9 (2021-01-21)

Note: Version bump only for package @loopback/build

6.2.8 (2020-12-07)

Note: Version bump only for package @loopback/build

6.2.7 (2020-11-18)

Note: Version bump only for package @loopback/build

6.2.6 (2020-11-05)

Note: Version bump only for package @loopback/build

6.2.5 (2020-10-07)

Note: Version bump only for package @loopback/build

6.2.4 (2020-09-17)

Note: Version bump only for package @loopback/build

6.2.3 (2020-09-15)

Note: Version bump only for package @loopback/build

6.2.2 (2020-08-27)

Note: Version bump only for package @loopback/build

6.2.1 (2020-08-19)

Note: Version bump only for package @loopback/build

6.2.0 (2020-08-05)

Bug Fixes

docs: fix minor typo (9b06ccc)

Features

rework fail-on-console-logs to support parallel test execution (ba580de)

6.1.1 (2020-07-20)

Note: Version bump only for package @loopback/build

6.1.0 (2020-06-30)

Features

build: add a helper to merge mocha config objects (3ce9eef)

6.0.0 (2020-06-23)

Bug Fixes

set node version to >=10.16 to support events.once (e39da1c)

Features

build: upgrade to mocha 8.x (c83270d)

BREAKING CHANGES

build: After have upgraded to mocha version 8, which no longer supports --opts and test/mocha.opts. It may break your application if it depends on earlier version of @loopback/build for npm test.

See a list of breaking changes of mocha 8.x at: https://github.com/mochajs/mocha/releases/tag/v8.0.0

5.4.3 (2020-06-11)

Note: Version bump only for package @loopback/build

5.4.2 (2020-05-28)

Note: Version bump only for package @loopback/build

5.4.1 (2020-05-20)

Note: Version bump only for package @loopback/build

5.4.0 (2020-05-19)

Bug Fixes

build: recognize lb-tsc bool options with a value (015df04)

Features

upgrade to TypeScript 3.9.x (3300e45)

5.3.1 (2020-05-07)

Note: Version bump only for package @loopback/build

5.3.0 (2020-04-29)

Features

build: don't flag console logs when tests failed (048e87e)

5.2.0 (2020-04-23)

Features

build: change the default compilation target to ES2018 (Node.js 10.x) (a9df717)
build: enable all ES2020 features in TypeScript lib config (be6f31d)

5.1.0 (2020-04-22)

Features

build: update lb-tsc to support -b or --build (d39b8d9)

5.0.1 (2020-04-08)

Note: Version bump only for package @loopback/build

5.0.0 (2020-03-24)

Features

update dependency prettier to v2 (65bdee7)

BREAKING CHANGES

prettier@2.0.0 introduces breaking changes for certain rules. See https://prettier.io/blog/2020/03/21/2.0.0.html for more details.

To reformat code using prettier, run npm run prettier:fix.

4.0.1 (2020-03-17)

Note: Version bump only for package @loopback/build

4.0.0 (2020-03-05)

chore

remove support for Node.js v8.x (4281d9d)

Features

build: add --lang flag to set LANG env var for lb-mocha (a78bb84)
build: enable importHelpers (e44f084), closes #4676
add tslib as dependency (a6e0b4c), closes #4676

BREAKING CHANGES

build: enable importHelpers on the shared Typescript configuration file which requires tslib to be installed on dependent packages if the shared Typescript configuration is used.

To migrate, run npm install tslib on the dependent package before updating to this version.

Node.js v8.x is now end of life. Please upgrade to version 10 and above. See https://nodejs.org/en/about/releases.

3.1.1 (2020-02-05)

Note: Version bump only for package @loopback/build

3.1.0 (2020-01-27)

Bug Fixes

remove updated debug config for PR (15e8d34)
typos (852f198)

Features

adds MultiMethodDecoratorFactory (bf6c787)

3.0.1 (2020-01-07)

Note: Version bump only for package @loopback/build

3.0.0 (2019-12-09)

Features

build: enable esModuleInterop compiler option (3090073)

BREAKING CHANGES

build: The flag impacts how import is handled by the TypeScript compiler. The new behavior is:
A namespace import (i.e. import * as foo from "foo") is now correctly flagged as uncallable. Calling it will result in an error.
Default imports to CommonJS/AMD/UMD are now allowed (e.g. import fs from "fs"), and should work as expected.

For existing projects, namespace imports (import * as express from "express"; express();) will need to be converted to default imports (import express from "express"; express();).

See https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-7.html#support-for-import-d-from-cjs-from-commonjs-modules-with---esmoduleinterop

2.1.0 (2019-11-25)

Features

build: add an option to control resolution of CLI module from project dependencies (0715a91)

2.0.16 (2019-11-12)

Note: Version bump only for package @loopback/build

2.0.15 (2019-10-24)

Note: Version bump only for package @loopback/build

2.0.14 (2019-10-07)

Note: Version bump only for package @loopback/build

2.0.13 (2019-09-28)

Note: Version bump only for package @loopback/build

2.0.12 (2019-09-27)

Note: Version bump only for package @loopback/build

2.0.11 (2019-09-17)

Note: Version bump only for package @loopback/build

2.0.10 (2019-09-06)

Note: Version bump only for package @loopback/build

2.0.9 (2019-09-03)

Note: Version bump only for package @loopback/build

2.0.8 (2019-08-19)

Note: Version bump only for package @loopback/build

2.0.7 (2019-08-15)

Note: Version bump only for package @loopback/build

2.0.6 (2019-07-31)

Note: Version bump only for package @loopback/build

2.0.5 (2019-07-26)

Note: Version bump only for package @loopback/build

2.0.4 (2019-07-17)

Note: Version bump only for package @loopback/build

2.0.3 (2019-06-28)

Note: Version bump only for package @loopback/build

2.0.2 (2019-06-21)

Note: Version bump only for package @loopback/build

2.0.1 (2019-06-20)

Note: Version bump only for package @loopback/build

2.0.0 (2019-06-17)

Bug Fixes

build: remove lb-tslint from README (be89eb6)

Features

build: add support for dryRun to --copy-resources (f8f078f)
build: enable incremental compilation (2120712)
build: read outDir from tsconfig when copying resources (4f947a3)
build: remove lb-tslint (e9e4bba)
build: remove strong-docs based lb-apidocs helper (871457e)
build: remove support for multi-dist compilation (f6fcfe7)

BREAKING CHANGES

build: We are no longer choosing outDir for you, you have to specify it explicitly. It is no longer possible to specify compilation target via non-option argument like lb-tsc es2017.

Migration guide:

- Modify your `tsconfig.json` file and configure `dist` via `compilerOptions.outDir`

- If you are using target different from `es2017`, then configure it via

compilerOptions.target.

- Remove `es2017` and `--outDir dist` from lb-tsc arguments.

- Ensure that the output directory is listed in `lb-clean` arguments,
  e.g. call `lb-clean dist`.

- When calling `lb-mocha`, replace `DIST` with the actual outDir value,
  typically `dist`.

build: lb-apidocs helper is no longer available. Please switch to Microsoft api-extractor and api-documenter.
build: lb-tslint helper is no longer available. Please install tslint directly as a dependency and invoke tslint instead of lb-tslint.
```
Alternatively, you can migrate from tslint to eslint and use the
recently introduced helper `lb-eslint`.
```

1.7.1 (2019-06-06)

Note: Version bump only for package @loopback/build

1.7.0 (2019-06-03)

Features

replace tslint with eslint (44185a7)

1.6.1 (2019-05-31)

Note: Version bump only for package @loopback/build

1.6.0 (2019-05-30)

Features

build: add eslint scripts and default configs (a6abe86)
tsdocs: add integration with api-extractor/documenter (c8d9572)

1.5.5 (2019-05-23)

Note: Version bump only for package @loopback/build

1.5.4 (2019-05-14)

Note: Version bump only for package @loopback/build

1.5.3 (2019-05-10)

Bug Fixes

build: honor tsconfig compilerOptions.rootDir to copy resources (8a8857d)

1.5.2 (2019-05-09)

Note: Version bump only for package @loopback/build

1.5.1 (2019-05-06)

Note: Version bump only for package @loopback/build

1.5.0 (2019-04-20)

Features

build: add more TypeScript "strict" checks (866aa2f)

1.4.3 (2019-04-11)

Note: Version bump only for package @loopback/build

1.4.2 (2019-04-09)

Note: Version bump only for package @loopback/build

1.4.1 (2019-04-05)

Note: Version bump only for package @loopback/build

1.4.0 (2019-03-22)

Bug Fixes

build: remove "dom" from the list of global libraries (781cd1d)

Features

build: enable TSC option "skipLibCheck" (66bb506)

1.3.2 (2019-03-12)

Note: Version bump only for package @loopback/build

1.3.1 (2019-02-25)

Bug Fixes

update version of nyc (f8db27c)

1.3.0 (2019-02-08)

Features

build: use dist/__tests__ in code examples and tests (a3da024)

1.2.1 (2019-01-28)

Note: Version bump only for package @loopback/build

1.2.0 (2019-01-14)

Bug Fixes

build: fix path lookup in build helpers (16311c5)

Features

always include tslint and typescript in project dev-dependencies (e0df285)

1.1.0 (2018-12-20)

Features

move tslint config into a standalone package (26f3543)

1.0.2 (2018-12-13)

Note: Version bump only for package @loopback/build

1.0.1 (2018-11-08)

Bug Fixes

cli: exclude json files from tslint (bd9f864)

0.8.0 (2018-10-08)

Features

use resolveJsonModule to load datasource config (73e19ff)
build: rename --ignore-resources to --copy-resources (2958ace)

0.7.6 (2018-10-05)

Bug Fixes

build: preserve --outDir path as relative to CWD (0e72ab9)

0.7.5 (2018-10-03)

Note: Version bump only for package @loopback/build

0.7.4 (2018-09-27)

Note: Version bump only for package @loopback/build

0.7.3 (2018-09-12)

Note: Version bump only for package @loopback/build

0.7.2 (2018-09-08)

Note: Version bump only for package @loopback/build

0.7.1 (2018-08-24)

Note: Version bump only for package @loopback/build

0.7.0 (2018-08-15)

Features

repository: add KVRepository impl using legacy juggler (97a75dc)

0.6.14 (2018-08-08)

Note: Version bump only for package @loopback/build

0.6.13 (2018-07-21)

Note: Version bump only for package @loopback/build

0.6.12 (2018-07-20)

Note: Version bump only for package @loopback/build

0.6.11 (2018-06-28)

Note: Version bump only for package @loopback/build

0.6.10 (2018-06-27)

Bug Fixes

docs: upgrade to strong-docs@3.1.0 and fix links (f91af8f)

0.6.9 (2018-06-20)

Note: Version bump only for package @loopback/build

0.6.8 (2018-06-09)

Note: Version bump only for package @loopback/build

0.6.7 (2018-06-09)

Note: Version bump only for package @loopback/build

0.6.6 (2018-06-08)

Bug Fixes

make the code compatible with TypeScript 2.9.x (37aba50)

0.6.5 (2018-05-20)

Note: Version bump only for package @loopback/build

0.6.4 (2018-05-14)

Note: Version bump only for package @loopback/build

0.6.3 (2018-05-08)

Note: Version bump only for package @loopback/build

0.6.2 (2018-05-03)

Note: Version bump only for package @loopback/build

0.6.1 (2018-05-03)

Note: Version bump only for package @loopback/build

0.6.0 (2018-04-25)

Features

build: add an option to copy non ts files to outDir (49b9a82)

0.5.0 (2018-04-16)

Note: Version bump only for package @loopback/build

0.4.3 (2018-04-11)

Bug Fixes

change file names to fit advocated naming convention (0331df8)
build: update build scripts (2a3f560)

0.4.2 (2018-04-06)

Note: Version bump only for package @loopback/build

0.4.1 (2018-04-02)

Note: Version bump only for package @loopback/build

0.4.0 (2018-03-29)

Note: Version bump only for package @loopback/build

0.3.3 (2018-03-23)

Bug Fixes

build: fix select-dist script (e91e810)
use rimraf to remove files with glob patterns (50d847c)
build: use variable names to reflect the accepted args (c9350b9)

0.3.2 (2018-03-14)

Note: Version bump only for package @loopback/build

0.3.1 (2018-03-13)

Bug Fixes

build: use options for run and disable stdout for tests (0065eab)

0.3.0 (2018-03-08)

Bug Fixes

clean up the app run test (c0d3731)

Features

build: use options to control cli/shell run (c4e8bce)

0.2.0 (2018-03-01)

Note: Version bump only for package @loopback/build

0.1.2 (2018-03-01)

Features

context: add type as a generic parameter to ctx.get() and friends (24b217d)

BREAKING CHANGES

context: ctx.get() and ctx.getSync() require a type now. See the example below for upgrade instructions:

- const c: MyController = await ctx.get('MyController');
+ const c = await ctx.get<MyController>('MyController');

isPromise was renamed to isPromiseLike and acts as a type guard for PromiseLike, not Promise. When upgrading affected code, you need to determine whether the code was accepting any Promise implementation (i.e. PromiseLike) or only native Promises. In the former case, you should use isPromiseLike and potentially convert the userland Promise instance to a native Promise via Promise.resolve(promiseLike). In the latter case, you can replace isPromise(p) with p instanceof Promise.