Skip to content

Commit 9b4d457

Browse files
committed
fix: format
1 parent 81cec9a commit 9b4d457

9 files changed

+1271
-806
lines changed

.github/dependabot.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
version: 2
22
updates:
3-
- package-ecosystem: "npm"
4-
directory: "/"
3+
- package-ecosystem: 'npm'
4+
directory: '/'
55
schedule:
6-
interval: "daily"
7-
target-branch: "develop"
6+
interval: 'daily'
7+
target-branch: 'develop'
88
labels:
9-
- "dependencies"
9+
- 'dependencies'

.github/pull_request_template.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,11 @@ Please describe the tests that you ran to verify your changes. Provide instructi
2121
- [ ] Test B
2222

2323
**Test Configuration**:
24-
* Firmware version:
25-
* Hardware:
26-
* Toolchain:
27-
* SDK:
24+
25+
- Firmware version:
26+
- Hardware:
27+
- Toolchain:
28+
- SDK:
2829

2930
# Checklist:
3031

@@ -35,4 +36,4 @@ Please describe the tests that you ran to verify your changes. Provide instructi
3536
- [ ] My changes generate no new warnings
3637
- [ ] I have added tests that prove my fix is effective or that my feature works
3738
- [ ] New and existing unit tests pass locally with my changes
38-
- [ ] Any dependent changes have been merged and published in downstream modules
39+
- [ ] Any dependent changes have been merged and published in downstream modules

.github/workflows/cleanup.yml

+8-8
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,29 @@ on:
33
workflow_dispatch:
44
inputs:
55
days:
6-
description: "Number of days."
6+
description: 'Number of days.'
77
required: true
88
default: 0
99
minimum_runs:
10-
description: "The minimum runs to keep for each workflow."
10+
description: 'The minimum runs to keep for each workflow.'
1111
required: true
1212
default: 0
1313
delete_workflow_pattern:
14-
description: "The name or filename of the workflow. if not set then it will target all workflows."
14+
description: 'The name or filename of the workflow. if not set then it will target all workflows.'
1515
required: false
1616
delete_workflow_by_state_pattern:
17-
description: "Remove workflow by state: active, deleted, disabled_fork, disabled_inactivity, disabled_manually"
17+
description: 'Remove workflow by state: active, deleted, disabled_fork, disabled_inactivity, disabled_manually'
1818
required: true
19-
default: "All"
19+
default: 'All'
2020
type: choice
2121
options:
22-
- "All"
22+
- 'All'
2323
- active
2424
- deleted
2525
- disabled_inactivity
2626
- disabled_manually
2727
dry_run:
28-
description: "Only log actions, do not perform any delete operations."
28+
description: 'Only log actions, do not perform any delete operations.'
2929
required: false
3030

3131
jobs:
@@ -41,4 +41,4 @@ jobs:
4141
keep_minimum_runs: ${{ github.event.inputs.minimum_runs }}
4242
delete_workflow_pattern: ${{ github.event.inputs.delete_workflow_pattern }}
4343
delete_workflow_by_state_pattern: ${{ github.event.inputs.delete_workflow_by_state_pattern }}
44-
dry_run: ${{ github.event.inputs.dry_run }}
44+
dry_run: ${{ github.event.inputs.dry_run }}

.github/workflows/coverage.yml

+2-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
name: Running Code Coverage
22

3-
on: [
4-
push,
5-
pull_request
6-
]
3+
on: [push, pull_request]
74

85
jobs:
96
build:
@@ -50,4 +47,4 @@ jobs:
5047
run: pnpm test
5148

5249
- name: Build bundle
53-
run: pnpm build
50+
run: pnpm build

.github/workflows/publish.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,4 @@ jobs:
5959
run: pnpm build
6060

6161
- name: Publish dependencies
62-
run: echo todo
62+
run: echo todo

LICENSE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1818
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
21+
SOFTWARE.

README.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,59 @@
11
![logo](./.github/tnmt-logo.png)
22

33
Sample node module template by Tib0. Shipped with:
4+
45
- [x] Github's actions
56
- [x] VSCode config
67
- [x] Node config
78
- [x] TypeScript
89
- [x] Prettier
910
- [x] Eslint
1011
- [x] Pnpm
11-
- [x] Tsup
12+
- [x] Tsup
1213
- [x] Jest
1314

1415
# USE
16+
1517
Follow these steps to make it yours :
1618

1719
1. Clone the repository :
20+
1821
```sh
1922
git clone https://github.com/tib0/typescript-node-module-template.git
2023
```
2124

2225
2. Update package.json entries (author, name...)
26+
2327
```sh
2428
code typescript-node-module-template\package.json
2529
```
2630

2731
3. Rename folder `typescript-node-module-template` to whatever suit your needs.
32+
2833
```sh
2934
mv typescript-node-module-template\ <target name>\
3035
```
3136

3237
4. Remove git history :
38+
3339
```sh
3440
rm -rf .git && git init && git add . && git commit -m "Initial commit"
3541
```
3642

3743
5. Push :
44+
3845
```sh
3946
git push
4047
```
4148

4249
# WARNING
43-
Warning triggered when using eslint in version 9.1.1 due to unmet dependency, I had to downgrade to [email protected]. It avoids using two versions of the same dependency.
50+
51+
Warning triggered when using eslint in version 9.1.1 due to unmet dependency, I had to downgrade to [email protected]. It avoids using two versions of the same dependency.
4452

4553
Warning seen:
54+
4655
> "eslint": "^9.1.1" cause WARN  Issues with peer dependencies found
56+
4757
```txt
4858
.
4959
├─┬ @typescript-eslint/eslint-plugin 7.7.1
@@ -54,4 +64,4 @@ Warning seen:
5464
│ └── ✕ unmet peer eslint@^8.56.0: found 9.1.1
5565
└─┬ @typescript-eslint/parser 7.7.1
5666
└── ✕ unmet peer eslint@^8.56.0: found 9.1.1
57-
```
67+
```

package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
"author": "Tib0",
44
"license": "MIT",
55
"version": "0.0.1",
6-
"description":
7-
"Typescript Node Module Template (tnmt) by Tib0, featuring jest, tsup, vscode, pnpm, eslint and prettier.",
6+
"description": "Typescript Node Module Template (tnmt) by Tib0, featuring jest, tsup, vscode, pnpm, eslint and prettier.",
87
"repository": {
98
"type": "git",
109
"url": "https://github.com/tib0/typescript-node-module-template.git"

0 commit comments

Comments
 (0)