Skip to content

Commit dd7bd06

Browse files
committed
Rewrote doxdox with TypeScript in npm workspaces.
1 parent 3f8d633 commit dd7bd06

File tree

143 files changed

+2975
-1663
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

143 files changed

+2975
-1663
lines changed

.eslintignore

Lines changed: 0 additions & 3 deletions
This file was deleted.

.eslintrc

Lines changed: 0 additions & 14 deletions
This file was deleted.

.github/workflows/test.workflow.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Tests
2+
on:
3+
push:
4+
branches:
5+
- main
6+
pull_request:
7+
types: [opened, synchronize, reopened, ready_for_review]
8+
branches:
9+
- main
10+
11+
jobs:
12+
tests:
13+
runs-on: ${{ matrix.os }}
14+
if: github.event.pull_request.draft == false
15+
16+
strategy:
17+
matrix:
18+
os: [ubuntu-latest]
19+
node: [12.20.0, 14.13.1, 16.0.0]
20+
21+
steps:
22+
- name: Check out repository
23+
uses: actions/checkout@v2
24+
25+
- uses: actions/setup-node@v2
26+
with:
27+
node-version: ${{ matrix.node }}
28+
29+
- name: Update NPM to latest
30+
run: npm install npm@latest -g
31+
32+
- name: Print Node.js and NPM version
33+
run: |
34+
node -v
35+
npm -v
36+
37+
- name: Install dependencies for all packages
38+
run: npm install
39+
40+
- name: Run tests on all packages
41+
timeout-minutes: 5
42+
run: |
43+
npm run build
44+
npm test

.gitignore

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
node_modules/
22

3-
coverage/
4-
5-
package-lock.json
3+
/package-lock.json

.npmignore

Lines changed: 0 additions & 10 deletions
This file was deleted.

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
dist/

.prettierrc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"arrowParens": "avoid",
3+
"singleQuote": true,
4+
"tabWidth": 4,
5+
"trailingComma": "none",
6+
"overrides": [
7+
{
8+
"files": ["*.json", ".*rc", "*.md", "*.yml"],
9+
"options": {
10+
"tabWidth": 2
11+
}
12+
}
13+
]
14+
}

.travis.yml

Lines changed: 0 additions & 13 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 0 additions & 229 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,21 @@
44

55
If you have found a bug in `doxdox` please consider the following when submitting an issue:
66

7-
- **Search existing [GitHub Issues](https://github.com/neogeek/doxdox/issues)** - The bug you are experiencing might have already been reported or even fixed in an unreleased version of `doxdox` so be sure to review both [open](https://github.com/neogeek/doxdox/issues?state=open) and [closed](https://github.com/neogeek/doxdox/issues?state=closed) issues.
7+
- **Search existing [GitHub Issues](https://github.com/docsbydoxdox/doxdox/issues)** - The bug you are experiencing might have already been reported or even fixed in an unreleased version of `doxdox` so be sure to review both [open](https://github.com/docsbydoxdox/doxdox/issues?state=open) and [closed](https://github.com/docsbydoxdox/doxdox/issues?state=closed) issues.
88
- **Create a reproducible test case** - To make it easier for maintainers to validate the issue please include a [gist](https://gist.github.com/) containing files used to reproduce the issue.
99
- **Include relevant information** - Include clear steps to reproduce the issue.
1010

1111
## Pull Requests
1212

13-
Before submitting a pull request, be sure that the following requirements are meet:
13+
Before submitting a pull request, be sure that the following requirements are met:
1414

1515
- Additional tests have been added to validate the changes.
1616
- Relevant documentation has been added.
1717
- The build passes.
18-
- There are no `eslint` errors using the included `.eslintrc` configuration.
1918

2019
## Code Style
2120

22-
- Use semicolons.
23-
- Soft indent with 4 spaces.
24-
- Always use camelCase.
25-
- Prefer `'` over `"`.
26-
- `'use strict';`
27-
- Prefer strict equals `===` unless type coercion is needed.
28-
- No trailing whitespace.
29-
- Maintain newline at EOF.
21+
Either use the [Prettier plugin](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) in editor or run `npm run prettier-check` and `npm run prettier-fix`.
3022

3123
## License
3224

0 commit comments

Comments
 (0)