Skip to content

Commit

Permalink
docs: fix instructions for verifying TypeScript setup
Browse files Browse the repository at this point in the history
  • Loading branch information
bajtos committed Jan 31, 2019
1 parent 066d525 commit 4c6b176
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 9 deletions.
6 changes: 1 addition & 5 deletions docs/site/DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -466,7 +466,7 @@ configuration, it's important to verify that all usage scenarios keep working.

### Verify TypeScript setup

1. Open any existing TypeScript file, e.g. `packages/src/index.ts`
1. Open any existing TypeScript file, e.g. `packages/core/src/index.ts`

2. Add a small bit of code to break TypeScript's type checks, for example:

Expand All @@ -479,10 +479,6 @@ configuration, it's important to verify that all usage scenarios keep working.
4. Verify that the build failed and the compiler error message shows a path
relative to monorepo root, e.g. `packages/src/index.ts`.

_(This is does not work now, `tsc` is reporting paths relative to individual
package directories. See
<https://github.com/strongloop/loopback-next/issues/1010>)_

5. Test integration with supported IDEs:
- [VS Code](./VSCODE.md#how-to-verify-typescript-setup)

Expand Down
6 changes: 2 additions & 4 deletions docs/site/VSCODE.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Our monorepo comes with few preconfigured

### Compilation errors

1. Open any existing TypeScript file, e.g. `packages/src/index.ts`
1. Open any existing TypeScript file, e.g. `packages/core/src/index.ts`

2. Add a small bit of code to break TypeScript's type checks, for example:

Expand Down Expand Up @@ -51,9 +51,7 @@ Our monorepo comes with few preconfigured
VSCode.

8. Verify that compilation errors are correctly associated with the problematic
source code line. _(This is does not work now, `tsc` is reporting paths
relative to individual package directories. See
<https://github.com/strongloop/loopback-next/issues/1010>)_
source code line.

### Navigation in VS Code

Expand Down

0 comments on commit 4c6b176

Please sign in to comment.