Skip to content

Commit

Permalink
Migrate to ESM, tabs
Browse files Browse the repository at this point in the history
  • Loading branch information
Gerrit0 committed Jan 14, 2024
1 parent 48c6589 commit 6c3265f
Show file tree
Hide file tree
Showing 21 changed files with 968 additions and 797 deletions.
4 changes: 2 additions & 2 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ root = true

[*]
charset = utf-8
indent_style = space
indent_size = 4
indent_style = tab
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[package.json]
indent_style = space
indent_size = 2
50 changes: 25 additions & 25 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
name: CI
on: [push, pull_request]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
node: ["16", "18", "20"]
name: Node ${{ matrix.node }}
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Set up Node
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node }}
- name: Install
run: yarn
- name: Build
run: yarn build
- name: Test
run: yarn test
- name: Lint
run: yarn prettier --check .
- name: Circular dependency check
uses: gerrit0/circular-dependency-check@v1
with:
entry: index.js
build:
runs-on: ubuntu-latest
strategy:
matrix:
node: ["16", "18", "20"]
name: Node ${{ matrix.node }}
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Set up Node
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node }}
- name: Install
run: yarn
- name: Build
run: yarn build
- name: Test
run: yarn test
- name: Lint
run: yarn prettier --check .
- name: Circular dependency check
uses: gerrit0/circular-dependency-check@v1
with:
entry: index.js
80 changes: 40 additions & 40 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -1,43 +1,43 @@
name: Publish
on:
push:
branches:
- main
push:
branches:
- main
jobs:
npm-publish:
name: npm-publish
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2
with:
fetch-depth: 0
- id: check
uses: EndBug/version-check@v1
with:
diff-search: true
- name: Set up Node
if: steps.check.outputs.changed == 'true'
uses: actions/setup-node@v1
with:
node-version: "16"
- name: Install
if: steps.check.outputs.changed == 'true'
run: yarn
- name: Build
if: steps.check.outputs.changed == 'true'
run: yarn build
- name: Test
if: steps.check.outputs.changed == 'true'
run: yarn test
- name: Setup publish token
if: steps.check.outputs.changed == 'true'
run: echo "//registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}" > .npmrc
env:
NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
- name: Publish
if: steps.check.outputs.changed == 'true'
run: |
yarn publish --non-interactive
git tag v$(jq '.version' package.json -r)
git push --tags
npm-publish:
name: npm-publish
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2
with:
fetch-depth: 0
- id: check
uses: EndBug/version-check@v1
with:
diff-search: true
- name: Set up Node
if: steps.check.outputs.changed == 'true'
uses: actions/setup-node@v1
with:
node-version: "16"
- name: Install
if: steps.check.outputs.changed == 'true'
run: yarn
- name: Build
if: steps.check.outputs.changed == 'true'
run: yarn build
- name: Test
if: steps.check.outputs.changed == 'true'
run: yarn test
- name: Setup publish token
if: steps.check.outputs.changed == 'true'
run: echo "//registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}" > .npmrc
env:
NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
- name: Publish
if: steps.check.outputs.changed == 'true'
run: |
yarn publish --non-interactive
git tag v$(jq '.version' package.json -r)
git push --tags
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
**/*.js
!scripts/*.js
yarn.lock
10 changes: 5 additions & 5 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"files.exclude": {
"*.js": true,
"test/*.js": true,
"**/*.js.map": true
}
"files.exclude": {
"*.js": true,
"test/*.js": true,
"**/*.js.map": true
}
}
26 changes: 13 additions & 13 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,45 @@
### 2.1.0 (2023-08-25)

- Added support for TypeDoc 0.25.x
- Added support for TypeDoc 0.25.x

### 2.0.1 (2023-07-29)

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

### 2.0.0 (2023-04-15)

- BREAKING: Drop support for TypeDoc 0.22 and 0.23
- BREAKING: Drop support for TypeDoc 0.22 and 0.23

### 1.0.0 (2022-08-12)

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

### 0.23.0 (2022-06-26)

- Add support for TypeDoc 0.23.x
- Dropped support for Node 12.
- Add support for TypeDoc 0.23.x
- Dropped support for Node 12.

### 0.22.6 (2021-11-24)

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

### 0.22.5 (2021-11-24)

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

### 0.22.4 (2021-11-6)

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

### 0.22.3 (2021-09-15)

- Fix broken published package again.
- Fix broken published package again.

### 0.22.2 (2021-09-15)

- Fix broken published package.
- Fix broken published package.

### 0.22.1 (2021-09-15)

- Add repo info for linking to plugin from npm.
- Add repo info for linking to plugin from npm.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ npx typedoc --plugin typedoc-plugin-missing-exports

### Options

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

### Additional Reading

- https://github.com/TypeStrong/typedoc/issues/1657
- https://github.com/TypeStrong/typedoc/issues/1657
Loading

0 comments on commit 6c3265f

Please sign in to comment.