nest-cli
A progressive Node.js framework for building efficient and scalable server-side applications 🚀
.nestcli.json.nest-cli.jsonnest-cli.jsonnest.json
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
.nestcli.json and it validates in your browser — nothing is uploaded.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
language | string | — default: "ts" |
collection | string | Points at the collection of schematics used to generate components. you generally should not change this value. default: "@nestjs/schematics" |
sourceRoot | string | Points at the root of the source code for the single project in standard mode structures, or the default project in monorepo mode structures. default: "src" |
entryFile | string | The entry file where 'nest start' work with. Default to 'main'. default: "main" |
monorepo | boolean | (monorepo only) For a monorepo mode structure, this value is always true. default: false |
root | string | (monorepo only) Points at the project root of the default project. default: "" |
compilerOptions | object | A map with keys specifying compiler options and values specifying the option setting. See https://docs.nestjs.com/cli/monorepo#global-compiler-options for details default: {} |
compilerOptions.tsConfigPath | string | (monorepo only) Points at the file containing the tsconfig.json settings that will be used when nest build or nest start is called without a project option (e.g., when the default project is built or started). 'nest build' will not work as default: "tsconfig.build.json" |
compilerOptions.builder | anyOf | — |
compilerOptions.typeCheck | boolean | If true, enable type checking (when SWC is used). See https://docs.nestjs.com/recipes/swc#type-checking for details. default: false |
compilerOptions.webpack | boolean | If true, use webpack compiler (deprecated option, use `builder` instead). If false or not present, use tsc. In monorepo mode, the default is true (use webpack), in standard mode, the default is false (use tsc). See default: false |
compilerOptions.webpackConfigPath | string | Points at a webpack options file. If not specified, Nest looks for the file webpack.config.js. default: "webpack.config.js" |
compilerOptions.plugins | array | — default: [] |
compilerOptions.assets | array | Enables automatically distributing non-TypeScript assets whenever a compilation step begins (asset distribution does not happen on incremental compiles in --watch mode). Accept glob-like string and object. See default: [] |
compilerOptions.watchAssets | boolean | If true, run in watch-mode, watching all non-TypeScript assets. Setting watchAssets in a top-level compilerOptions property overrides any watchAssets settings within the assets property. default: false |
compilerOptions.deleteOutDir | boolean | If true, whenever the compiler is invoked, it will first remove the compilation output directory (as configured in tsconfig.json, where the default is ./dist). default: false |
compilerOptions.manualRestart | boolean | If true, enables the shortcut `rs` to manually restart the server. default: false |
generateOptions | object | A map with keys specifying global generate options and values specifying the option setting. See https://docs.nestjs.com/cli/monorepo#global-generate-options for details default: {} |
generateOptions.spec | boolean | object | If the value is boolean, a value of true enables spec generation by default and a value of false disables it. A flag passed on the CLI command line overrides this setting, as does a project-specific generateOptions setting (more below). If |
generateOptions.spec.application | boolean | Generate spec file for application schematics or not. |
generateOptions.spec.class | boolean | Disable spec file generation for class schematics. |
generateOptions.spec.cl | boolean | Alias for class |
generateOptions.spec.configuration | boolean | Generate spec file for configuration schematics or not. |
generateOptions.spec.config | boolean | Alias for configuration |
generateOptions.spec.controller | boolean | Generate spec file for controller schematics or not. |
generateOptions.spec.co | boolean | Alias for controller |
generateOptions.spec.decorator | boolean | Generate spec file for decorator schematics or not. |
generateOptions.spec.d | boolean | Alias for decorator |
generateOptions.spec.filter | boolean | Generate spec file for filter schematics or not. |
generateOptions.spec.f | boolean | Alias for filter |
generateOptions.spec.gateway | boolean | Generate spec file for gateway schematics or not. |
generateOptions.spec.ga | boolean | Alias for gateway |
generateOptions.spec.guard | boolean | Generate spec file for guard schematics or not. |
generateOptions.spec.gu | boolean | Alias for guard |
generateOptions.spec.interceptor | boolean | Generate spec file for interceptor schematics or not. |
generateOptions.spec.in | boolean | Alias for interceptor |
generateOptions.spec.interface | boolean | Generate spec file for interface schematics or not. |
generateOptions.spec.middleware | boolean | Generate spec file for middleware schematics or not. |
generateOptions.spec.mi | boolean | Alias for middleware |
generateOptions.spec.module | boolean | Generate spec file for module schematics or not. |
generateOptions.spec.mo | boolean | Alias for module |
generateOptions.spec.pipe | boolean | Generate spec file for pipe schematics or not. |
generateOptions.spec.pi | boolean | Alias for pipe |
generateOptions.spec.provider | boolean | Generate spec file for provider schematics or not. |
generateOptions.spec.pr | boolean | Alias for provider |
generateOptions.spec.resolver | boolean | Generate spec file for resolver schematics or not. |
generateOptions.spec.r | boolean | Alias for resolver |
generateOptions.spec.service | boolean | Generate spec file for service schematics or not. |
generateOptions.spec.s | boolean | Alias for resolver |
generateOptions.spec.library | boolean | Generate spec file for library schematics or not. |
generateOptions.spec.lib | boolean | Alias for library |
generateOptions.spec.sub-app | boolean | Generate spec file for sub-app schematics or not. |
generateOptions.spec.app | boolean | Alias for sub-app |
generateOptions.spec.resource | boolean | Generate spec file for resource schematics or not. |
generateOptions.spec.res | boolean | Alias for resource |
generateOptions.flat | boolean | If true, all generate commands will generate a flat structure default: false |
generateOptions.baseDir | string | Base directory default: "" |
projects | object | — default: {} |
defaultLibraryPrefix | string | Default import prefix for newly generated libraries. default: "@app" |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- 89 properties, 81% carrying a description, max nesting depth 12.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$comment | JSON Schema Core, draft 2020-12 | §8.3 — Comments With "$comment" |
$id | JSON Schema Core, draft 2020-12 | §8.2.1 — The "$id" Keyword |
$ref | JSON Schema Core, draft 2020-12 | §8.2.3.1 — Direct References with "$ref" |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
additionalProperties | JSON Schema Core, draft 2020-12 | §10.3.2.3 — "additionalProperties" |
anyOf | JSON Schema Core, draft 2020-12 | §10.2.1.2 — "anyOf" |
default | JSON Schema Validation, draft 2020-12 | §9.2 — "default" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
enum | JSON Schema Validation, draft 2020-12 | §6.1.2 — "enum" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
Attribution
This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.