Skip to content

Commit e2b0272

Browse files
committed
Fresh TypeScript library as of 2021-09-21
1 parent 1aaca19 commit e2b0272

File tree

4 files changed

+41
-5
lines changed

4 files changed

+41
-5
lines changed

.github/workflows/ci.yml

+20-2
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,30 @@ jobs:
1616
run: pnpm install
1717
- name: Build the library
1818
run: pnpm run build
19-
- name: Run tests
20-
run: pnpm run test
2119
- name: Generate API documentation
2220
run: pnpm run docs
2321
- name: Publish API report and documentation
2422
uses: stefanzweifel/git-auto-commit-action@v4
2523
with:
2624
commit_message: Update generated files as of ${{ github.sha }}
2725
file_pattern: docs/api etc
26+
- name: Format code using Prettier
27+
run: pnpx prettier --write .
28+
- name: Update formatted code
29+
uses: stefanzweifel/git-auto-commit-action@v4
30+
with:
31+
commit_message: Update generated files as of ${{ github.sha }}
32+
file_pattern: .
33+
test:
34+
runs-on: ubuntu-20.04
35+
steps:
36+
- uses: actions/checkout@v2
37+
- uses: actions/setup-node@v1
38+
with:
39+
node-version: 14.x
40+
- name: Install pnpm
41+
run: npm install --global pnpm
42+
- name: Install dependencies
43+
run: pnpm install
44+
- name: Run tests
45+
run: pnpm run test

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# TypeScript Library Template
2+
3+
This repository is generated automatically by [dtinth/create-typescript-library-template](https://github.com/dtinth/create-typescript-library-template). It uses the [Heft](https://rushstack.io/pages/heft/overview/) build toolchain.
4+
5+
TODO: Add description of the library here.
6+
7+
## API
8+
9+
[API documentation](./docs/api/index.md)

package.json

+4-3
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,15 @@
1212
],
1313
"scripts": {
1414
"build": "heft build",
15-
"test": "heft test",
15+
"docs": "api-documenter markdown --input temp --output docs/api",
1616
"prepare": "heft build",
17-
"docs": "api-documenter markdown --input temp --output docs/api"
17+
"test": "heft test"
1818
},
1919
"devDependencies": {
2020
"@microsoft/api-documenter": "^7.13.52",
2121
"@rushstack/heft": "^0.39.0",
2222
"@rushstack/heft-web-rig": "^0.4.15",
23-
"@types/heft-jest": "^1.0.2"
23+
"@types/heft-jest": "^1.0.2",
24+
"prettier": "^2.4.1"
2425
}
2526
}

pnpm-lock.yaml

+8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)