Skip to content

Commit 6bca8b9

Browse files
kamilmysliwieckamilmysliwiec
authored
Merge pull request #2006 from Delapouite/tslint
docs: replace remaining tslint mentions by eslint equivalents
2 parents 20d7e5d + a75cead commit 6bca8b9

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

‎content/cli/overview.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,15 @@ Aside from a few specific considerations around how the **build** process works
4444

4545
You can use either mode to manage multiple projects. Here's a quick summary of the differences:
4646

47-
| Feature | Standard Mode | Monorepo Mode |
48-
| ---------------------------------------------------- | ------------------------------------------------------------------ | ---------------------------------------------------------- |
49-
| Multiple projects | Separate file system structure | Single file system structure |
50-
| `node_modules` & `package.json` | Separate instances | Shared across monorepo |
51-
| Default compiler | `tsc` | webpack |
52-
| Compiler settings | Specified separately | Monorepo defaults that can be overridden per project |
53-
| Config files like `tslint.json`, `.prettierrc`, etc. | Specified separately | Shared across monorepo |
54-
| `nest build` and `nest start` commands | Target defaults automatically to the (only) project in the context | Target defaults to the **default project** in the monorepo |
55-
| Libraries | Managed manually, usually via npm packaging | Built-in support, including path management and bundling |
47+
| Feature | Standard Mode | Monorepo Mode |
48+
| ----------------------------------------------------- | ------------------------------------------------------------------ | ---------------------------------------------------------- |
49+
| Multiple projects | Separate file system structure | Single file system structure |
50+
| `node_modules` & `package.json` | Separate instances | Shared across monorepo |
51+
| Default compiler | `tsc` | webpack |
52+
| Compiler settings | Specified separately | Monorepo defaults that can be overridden per project |
53+
| Config files like `.eslintrc.js`, `.prettierrc`, etc. | Specified separately | Shared across monorepo |
54+
| `nest build` and `nest start` commands | Target defaults automatically to the (only) project in the context | Target defaults to the **default project** in the monorepo |
55+
| Libraries | Managed manually, usually via npm packaging | Built-in support, including path management and bundling |
5656

5757
Read the sections on [Workspaces](/cli/monorepo) and [Libraries](/cli/libraries) for more detailed information to help you decide which mode is most suitable for you.
5858

‎content/cli/workspaces.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Nest has two modes for organizing code:
44

55
- **standard mode**: useful for building individual project-focused applications that have their own dependencies and settings, and don't need to optimize for sharing modules, or optimizing complex builds. This is the default mode.
6-
- **monorepo mode**: this mode treats code artifacts as part of a lightweight **monorepo**, and may be more appropriate for teams of developers and/or multi-project environments. It automates parts of the build process to make it easy to create and compose modular components, promotes code re-use, makes integration testing easier, makes it easy to share project-wide artifacts like `tslint` rules and other configuration policies, and is easier to use than alternatives like github submodules. Monorepo mode employs the concept of a **workspace**, represented in the `nest-cli.json` file, to coordinate the relationship between the components of the monorepo.
6+
- **monorepo mode**: this mode treats code artifacts as part of a lightweight **monorepo**, and may be more appropriate for teams of developers and/or multi-project environments. It automates parts of the build process to make it easy to create and compose modular components, promotes code re-use, makes integration testing easier, makes it easy to share project-wide artifacts like `eslint` rules and other configuration policies, and is easier to use than alternatives like github submodules. Monorepo mode employs the concept of a **workspace**, represented in the `nest-cli.json` file, to coordinate the relationship between the components of the monorepo.
77

88
It's important to note that virtually all of Nest's features are independent of your code organization mode. The **only** affect of this choice is how your projects are composed and how build artifacts are generated. All other functionality, from the CLI to core modules to add-on modules work the same in either mode.
99

@@ -43,7 +43,7 @@ We've constructed a _standard mode_ structure, with a folder structure that look
4343
<div class="item">nest-cli.json</div>
4444
<div class="item">package.json</div>
4545
<div class="item">tsconfig.json</div>
46-
<div class="item">tslint.json</div>
46+
<div class="item">.eslintrc.js</div>
4747
</div>
4848

4949
We can convert this to a monorepo mode structure as follows:
@@ -84,7 +84,7 @@ At this point, `nest` converts the existing structure to a **monorepo mode** str
8484
<div class="item">nest-cli.json</div>
8585
<div class="item">package.json</div>
8686
<div class="item">tsconfig.json</div>
87-
<div class="item">tslint.json</div>
87+
<div class="item">.eslintrc.js</div>
8888
</div>
8989

9090
The `generate app` schematic has reorganized the code - moving each **application** project under the `apps` folder, and adding a project-specific `tsconfig.app.json` file in each project's root folder. Our original `my-project` app has become the **default project** for the monorepo, and is now a peer with the just-added `my-app`, located under the `apps` folder. We'll cover default projects below.
@@ -118,7 +118,7 @@ $ nest start my-app
118118

119119
Application-type projects, or what we might informally refer to as just "applications", are complete Nest applications that you can run and deploy. You generate an application-type project with `nest generate app`.
120120

121-
This command automatically generates a project skeleton, including the standard `src` and `test` folders from the [typescript starter](https://github.com/nestjs/typescript-starter). Unlike standard mode, an application project in a monorepo does not have any of the package dependency (`package.json`) or other project configuration artifacts like `.prettierrc` and `tslint.json`. Instead, the monorepo-wide dependencies and config files are used.
121+
This command automatically generates a project skeleton, including the standard `src` and `test` folders from the [typescript starter](https://github.com/nestjs/typescript-starter). Unlike standard mode, an application project in a monorepo does not have any of the package dependency (`package.json`) or other project configuration artifacts like `.prettierrc` and `.eslintrc.js`. Instead, the monorepo-wide dependencies and config files are used.
122122

123123
However, the schematic does generate a project-specific `tsconfig.app.json` file in the root folder of the project. This config file automatically sets appropriate build options, including setting the compilation output folder properly. The file extends the top-level (monorepo) `tsconfig.json` file, so you can manage global settings monorepo-wide, but override them if needed at the project level.
124124

0 commit comments

Comments
 (0)