Skip to content

Commit 6c3265f

Browse files
committed
Migrate to ESM, tabs
1 parent 48c6589 commit 6c3265f

File tree

21 files changed

+968
-797
lines changed

21 files changed

+968
-797
lines changed

.editorconfig

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ root = true
44

55
[*]
66
charset = utf-8
7-
indent_style = space
8-
indent_size = 4
7+
indent_style = tab
98
end_of_line = lf
109
insert_final_newline = true
1110
trim_trailing_whitespace = true
1211

1312
[package.json]
13+
indent_style = space
1414
indent_size = 2

.github/workflows/ci.yml

+25-25
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
name: CI
22
on: [push, pull_request]
33
jobs:
4-
build:
5-
runs-on: ubuntu-latest
6-
strategy:
7-
matrix:
8-
node: ["16", "18", "20"]
9-
name: Node ${{ matrix.node }}
10-
steps:
11-
- name: Checkout repository
12-
uses: actions/checkout@v2
13-
- name: Set up Node
14-
uses: actions/setup-node@v1
15-
with:
16-
node-version: ${{ matrix.node }}
17-
- name: Install
18-
run: yarn
19-
- name: Build
20-
run: yarn build
21-
- name: Test
22-
run: yarn test
23-
- name: Lint
24-
run: yarn prettier --check .
25-
- name: Circular dependency check
26-
uses: gerrit0/circular-dependency-check@v1
27-
with:
28-
entry: index.js
4+
build:
5+
runs-on: ubuntu-latest
6+
strategy:
7+
matrix:
8+
node: ["16", "18", "20"]
9+
name: Node ${{ matrix.node }}
10+
steps:
11+
- name: Checkout repository
12+
uses: actions/checkout@v2
13+
- name: Set up Node
14+
uses: actions/setup-node@v1
15+
with:
16+
node-version: ${{ matrix.node }}
17+
- name: Install
18+
run: yarn
19+
- name: Build
20+
run: yarn build
21+
- name: Test
22+
run: yarn test
23+
- name: Lint
24+
run: yarn prettier --check .
25+
- name: Circular dependency check
26+
uses: gerrit0/circular-dependency-check@v1
27+
with:
28+
entry: index.js

.github/workflows/publish.yml

+40-40
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,43 @@
11
name: Publish
22
on:
3-
push:
4-
branches:
5-
- main
3+
push:
4+
branches:
5+
- main
66
jobs:
7-
npm-publish:
8-
name: npm-publish
9-
runs-on: ubuntu-latest
10-
steps:
11-
- name: Checkout repository
12-
uses: actions/checkout@v2
13-
with:
14-
fetch-depth: 0
15-
- id: check
16-
uses: EndBug/version-check@v1
17-
with:
18-
diff-search: true
19-
- name: Set up Node
20-
if: steps.check.outputs.changed == 'true'
21-
uses: actions/setup-node@v1
22-
with:
23-
node-version: "16"
24-
- name: Install
25-
if: steps.check.outputs.changed == 'true'
26-
run: yarn
27-
- name: Build
28-
if: steps.check.outputs.changed == 'true'
29-
run: yarn build
30-
- name: Test
31-
if: steps.check.outputs.changed == 'true'
32-
run: yarn test
33-
- name: Setup publish token
34-
if: steps.check.outputs.changed == 'true'
35-
run: echo "//registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}" > .npmrc
36-
env:
37-
NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
38-
- name: Publish
39-
if: steps.check.outputs.changed == 'true'
40-
run: |
41-
yarn publish --non-interactive
42-
git tag v$(jq '.version' package.json -r)
43-
git push --tags
7+
npm-publish:
8+
name: npm-publish
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Checkout repository
12+
uses: actions/checkout@v2
13+
with:
14+
fetch-depth: 0
15+
- id: check
16+
uses: EndBug/version-check@v1
17+
with:
18+
diff-search: true
19+
- name: Set up Node
20+
if: steps.check.outputs.changed == 'true'
21+
uses: actions/setup-node@v1
22+
with:
23+
node-version: "16"
24+
- name: Install
25+
if: steps.check.outputs.changed == 'true'
26+
run: yarn
27+
- name: Build
28+
if: steps.check.outputs.changed == 'true'
29+
run: yarn build
30+
- name: Test
31+
if: steps.check.outputs.changed == 'true'
32+
run: yarn test
33+
- name: Setup publish token
34+
if: steps.check.outputs.changed == 'true'
35+
run: echo "//registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}" > .npmrc
36+
env:
37+
NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
38+
- name: Publish
39+
if: steps.check.outputs.changed == 'true'
40+
run: |
41+
yarn publish --non-interactive
42+
git tag v$(jq '.version' package.json -r)
43+
git push --tags

.prettierignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
**/*.js
22
!scripts/*.js
3+
yarn.lock

.vscode/settings.json

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"files.exclude": {
3-
"*.js": true,
4-
"test/*.js": true,
5-
"**/*.js.map": true
6-
}
2+
"files.exclude": {
3+
"*.js": true,
4+
"test/*.js": true,
5+
"**/*.js.map": true
6+
}
77
}

CHANGELOG.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,45 @@
11
### 2.1.0 (2023-08-25)
22

3-
- Added support for TypeDoc 0.25.x
3+
- Added support for TypeDoc 0.25.x
44

55
### 2.0.1 (2023-07-29)
66

7-
- Fixed memory leak when running in watch mode / packages mode, TypeStrong/typedoc#2339
7+
- Fixed memory leak when running in watch mode / packages mode, TypeStrong/typedoc#2339
88

99
### 2.0.0 (2023-04-15)
1010

11-
- BREAKING: Drop support for TypeDoc 0.22 and 0.23
11+
- BREAKING: Drop support for TypeDoc 0.22 and 0.23
1212

1313
### 1.0.0 (2022-08-12)
1414

15-
- BREAKING: Will now create an `<internals>`**module** rather than a **namespace** to allow support for referenced default exports, #15.
16-
- BREAKING: Renamed `internalNamespace` option to `internalModule`
15+
- BREAKING: Will now create an `<internals>`**module** rather than a **namespace** to allow support for referenced default exports, #15.
16+
- BREAKING: Renamed `internalNamespace` option to `internalModule`
1717

1818
### 0.23.0 (2022-06-26)
1919

20-
- Add support for TypeDoc 0.23.x
21-
- Dropped support for Node 12.
20+
- Add support for TypeDoc 0.23.x
21+
- Dropped support for Node 12.
2222

2323
### 0.22.6 (2021-11-24)
2424

25-
- Fix crash if `@types/node` is installed and `Global` is referenced, #5.
25+
- Fix crash if `@types/node` is installed and `Global` is referenced, #5.
2626

2727
### 0.22.5 (2021-11-24)
2828

29-
- Fix crash if `@types/node` is installed and `Date` is referenced, #5.
29+
- Fix crash if `@types/node` is installed and `Date` is referenced, #5.
3030

3131
### 0.22.4 (2021-11-6)
3232

33-
- Fix crash if a module without types is referenced as a type, #3.
33+
- Fix crash if a module without types is referenced as a type, #3.
3434

3535
### 0.22.3 (2021-09-15)
3636

37-
- Fix broken published package again.
37+
- Fix broken published package again.
3838

3939
### 0.22.2 (2021-09-15)
4040

41-
- Fix broken published package.
41+
- Fix broken published package.
4242

4343
### 0.22.1 (2021-09-15)
4444

45-
- Add repo info for linking to plugin from npm.
45+
- Add repo info for linking to plugin from npm.

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ npx typedoc --plugin typedoc-plugin-missing-exports
1919

2020
### Options
2121

22-
- `internalModule` - Define the name of the module that internal symbols which are not exported should be placed into.
22+
- `internalModule` - Define the name of the module that internal symbols which are not exported should be placed into.
2323

2424
### Additional Reading
2525

26-
- https://github.com/TypeStrong/typedoc/issues/1657
26+
- https://github.com/TypeStrong/typedoc/issues/1657

0 commit comments

Comments
 (0)