Skip to content

Commit c3eca3e

Browse files
authored
docs: remove ts command docs (#1083)
The `aegir ts` command has been removed in favour of doing everything during `aegir build` so remove the references to it in the docs. closes #1077
1 parent dc41048 commit c3eca3e

File tree

3 files changed

+15
-37
lines changed

3 files changed

+15
-37
lines changed

README.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@ Commands:
5151
aegir release Release your code onto the world
5252
aegir test-dependant [repo] Run the tests of an module that depends on this module to see if the current changes have caused a regression
5353
aegir test Test your code in different environments
54-
aegir ts Typescript command with presets for specific tasks.
5554
aegir dependency-check [input...] Run `dependency-check` cli with aegir defaults. [aliases: dep-check, dep]
5655
aegir lint-package-json Lint package.json with aegir defaults. [aliases: lint-package, lpj]
5756
aegir completion generate completion script
@@ -120,19 +119,7 @@ Check the [documentation](https://ipfs.github.io/aegir/)
120119
121120
## Typescript
122121
123-
### JSDoc Typescript support
124-
125-
```bash
126-
aegir ts --help
127-
```
128-
More documentation [here](https://github.com/ipfs/aegir/blob/master/md/ts-jsdoc.md)
129-
130-
### Native Typescript support
131-
For native typescript add `--ts-repo` to any command.
132-
```bash
133-
aegir build --ts-repo
134-
aegir test --ts-repo
135-
```
122+
Aegir will detect the presence of `tsconfig.json` files and build typescript as appropriate.
136123
137124
## Release steps
138125

md/github-actions.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,6 @@ jobs:
1717
- uses: actions/checkout@v2
1818
- run: npm install
1919
- run: npx aegir lint
20-
- run: npx aegir ts -p check
21-
# or
22-
# - uses: gozala/[email protected]
2320
- run: npx aegir build
2421
- run: npx aegir dep-check
2522
- uses: ipfs/aegir/actions/bundle-size@master

md/ts-jsdoc.md

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
# TS with JSDoc <!-- omit in toc -->
22

3-
43
## Table of Contents <!-- omit in toc -->
54
- [Getting Started](#getting-started)
6-
- [CLI `ts` command](#cli-ts-command)
75
- [Github Action](#github-action)
86
- [Installing package from a git url](#installing-package-from-a-git-url)
97
- [Adding types with JSDoc](#adding-types-with-jsdoc)
@@ -19,12 +17,22 @@
1917
- [Must read references](#must-read-references)
2018
- [Resources](#resources)
2119

22-
2320
## Getting Started
2421

25-
Add a `tsconfig.json` to your repo:
26-
```bash
27-
aegir ts -p config > tsconfig.json
22+
Add a `tsconfig.json` to your repo that extends the default aegir ts config:
23+
24+
```json
25+
{
26+
"extends": "aegir/src/config/tsconfig.aegir.json",
27+
"compilerOptions": {
28+
"outDir": "dist",
29+
"emitDeclarationOnly": true
30+
},
31+
"include": [
32+
"src",
33+
"test"
34+
]
35+
}
2836
```
2937

3038
Add types configuration to your package.json:
@@ -51,20 +59,6 @@ When a packages needs to allow type imports other than the entry point, you can
5159

5260
> Use this hack only if you really need it, this might change from the TS side at any time and break type checks.
5361
54-
55-
## CLI `ts` command
56-
57-
> The `ts` command follows aegir folder conventions, source code inside `./src`, test inside `./test` and documentation inside `./docs`.
58-
59-
Run `aegir ts --help` and check the help text. There's presets for common TS use cases.
60-
61-
```md
62-
Presets:
63-
`check` Runs the type checker with your local config and doesn't not emit output.
64-
`types` Emits type declarations to `dist` folder.
65-
`docs` Generates documentation based on type declarations to the `docs` folder.
66-
`config` Prints base config to stdout.
67-
```
6862
## Github Action
6963

7064
To run the typechecker in the CI you can use this action https://github.com/Gozala/typescript-error-reporter-action and you will get the errors reported inline with the code.

0 commit comments

Comments
 (0)