Skip to content

fix: format #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
- package-ecosystem: 'npm'
directory: '/'
schedule:
interval: "daily"
target-branch: "develop"
interval: 'daily'
target-branch: 'develop'
labels:
- "dependencies"
- 'dependencies'
11 changes: 6 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@ Please describe the tests that you ran to verify your changes. Provide instructi
- [ ] Test B

**Test Configuration**:
* Firmware version:
* Hardware:
* Toolchain:
* SDK:

- Firmware version:
- Hardware:
- Toolchain:
- SDK:

# Checklist:

Expand All @@ -35,4 +36,4 @@ Please describe the tests that you ran to verify your changes. Provide instructi
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules
- [ ] Any dependent changes have been merged and published in downstream modules
16 changes: 8 additions & 8 deletions .github/workflows/cleanup.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,29 @@ on:
workflow_dispatch:
inputs:
days:
description: "Number of days."
description: 'Number of days.'
required: true
default: 0
minimum_runs:
description: "The minimum runs to keep for each workflow."
description: 'The minimum runs to keep for each workflow.'
required: true
default: 0
delete_workflow_pattern:
description: "The name or filename of the workflow. if not set then it will target all workflows."
description: 'The name or filename of the workflow. if not set then it will target all workflows.'
required: false
delete_workflow_by_state_pattern:
description: "Remove workflow by state: active, deleted, disabled_fork, disabled_inactivity, disabled_manually"
description: 'Remove workflow by state: active, deleted, disabled_fork, disabled_inactivity, disabled_manually'
required: true
default: "All"
default: 'All'
type: choice
options:
- "All"
- 'All'
- active
- deleted
- disabled_inactivity
- disabled_manually
dry_run:
description: "Only log actions, do not perform any delete operations."
description: 'Only log actions, do not perform any delete operations.'
required: false

jobs:
Expand All @@ -41,4 +41,4 @@ jobs:
keep_minimum_runs: ${{ github.event.inputs.minimum_runs }}
delete_workflow_pattern: ${{ github.event.inputs.delete_workflow_pattern }}
delete_workflow_by_state_pattern: ${{ github.event.inputs.delete_workflow_by_state_pattern }}
dry_run: ${{ github.event.inputs.dry_run }}
dry_run: ${{ github.event.inputs.dry_run }}
7 changes: 2 additions & 5 deletions .github/workflows/coverage.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
name: Running Code Coverage

on: [
push,
pull_request
]
on: [push, pull_request]

jobs:
build:
Expand Down Expand Up @@ -50,4 +47,4 @@ jobs:
run: pnpm test

- name: Build bundle
run: pnpm build
run: pnpm build
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ jobs:
run: pnpm build

- name: Publish dependencies
run: echo todo
run: echo todo
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,59 @@
![logo](./.github/tnmt-logo.png)

Sample node module template by Tib0. Shipped with:

- [x] Github's actions
- [x] VSCode config
- [x] Node config
- [x] TypeScript
- [x] Prettier
- [x] Eslint
- [x] Pnpm
- [x] Tsup
- [x] Tsup
- [x] Jest

# USE

Follow these steps to make it yours :

1. Clone the repository :

```sh
git clone https://github.com/tib0/typescript-node-module-template.git
```

2. Update package.json entries (author, name...)

```sh
code typescript-node-module-template\package.json
```

3. Rename folder `typescript-node-module-template` to whatever suit your needs.

```sh
mv typescript-node-module-template\ <target name>\
```

4. Remove git history :

```sh
rm -rf .git && git init && git add . && git commit -m "Initial commit"
```

5. Push :

```sh
git push
```

# WARNING
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.

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.

Warning seen:

> "eslint": "^9.1.1" cause WARN  Issues with peer dependencies found

```txt
.
├─┬ @typescript-eslint/eslint-plugin 7.7.1
Expand All @@ -54,4 +64,4 @@ Warning seen:
│ └── ✕ unmet peer eslint@^8.56.0: found 9.1.1
└─┬ @typescript-eslint/parser 7.7.1
└── ✕ unmet peer eslint@^8.56.0: found 9.1.1
```
```
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
"author": "Tib0",
"license": "MIT",
"version": "0.0.1",
"description":
"Typescript Node Module Template (tnmt) by Tib0, featuring jest, tsup, vscode, pnpm, eslint and prettier.",
"description": "Typescript Node Module Template (tnmt) by Tib0, featuring jest, tsup, vscode, pnpm, eslint and prettier.",
"repository": {
"type": "git",
"url": "https://github.com/tib0/typescript-node-module-template.git"
Expand Down
Loading