Skip to content

Commit d04f9ca

Browse files
Initial commit
0 parents  commit d04f9ca

Some content is hidden

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

54 files changed

+8362
-0
lines changed

.c8rc.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"all": true,
3+
"include": ["src/**/*"],
4+
"reporter": ["lcov", "text"],
5+
"check-coverage": false,
6+
"watermarks": {
7+
"lines": [80, 95],
8+
"functions": [80, 95],
9+
"branches": [80, 95],
10+
"statements": [80, 95]
11+
}
12+
}

.commitlintrc.cjs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
module.exports = {
2+
extends: ["@commitlint/config-conventional"],
3+
parserPreset: {
4+
parserOpts: {
5+
headerPattern: /^(\w*)(?:\((.*)\))?!?: (.*)$/,
6+
},
7+
},
8+
};

.cspell.json

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
{
2+
"version": "0.2",
3+
"language": "en",
4+
"ignorePaths": [
5+
".github/workflows/**",
6+
"**/*.json",
7+
"**/*.jsonc",
8+
"**/CHANGELOG.md",
9+
"**/coverage/**",
10+
"**/dist/**",
11+
"**/node_modules/**",
12+
"pnpm-lock.yaml"
13+
],
14+
"dictionaries": [
15+
"typescript",
16+
"softwareTerms",
17+
"node",
18+
"en_US",
19+
"npm",
20+
"misc",
21+
"filetypes"
22+
],
23+
"import": ["./node_modules/@cspell/dict-cryptocurrencies/cspell-ext.json"],
24+
"ignoreRegExpList": [
25+
"/```[\\w\\W]*?```/",
26+
"/~~~[\\w\\W]*?~~~/",
27+
"/``[\\w\\W]*?``/",
28+
"/`[^`]*`/",
29+
"/\\STS\\S+/",
30+
"\\(#.+?\\)",
31+
"// @ts-.*",
32+
"/[A-Za-z0-9]{32,}/",
33+
"/[A-Fa-f0-9]{6}/"
34+
],
35+
"words": [
36+
"bar",
37+
"baz",
38+
"corge",
39+
"foo",
40+
"fred",
41+
"garply",
42+
"grault",
43+
"litecoin",
44+
"monero",
45+
"noreply",
46+
"plugh",
47+
"quux",
48+
"qux",
49+
"Rebecca",
50+
"rebeccastevens",
51+
"sonarjs",
52+
"thud",
53+
"waldo",
54+
"xyzzy"
55+
],
56+
"overrides": [
57+
{
58+
"filename": "**/*.{ts,js}",
59+
"ignoreRegExpList": ["/@[a-z]+/", "/#(end)?region/"],
60+
"includeRegExpList": [
61+
"/\\/\\*[\\s\\S]*?\\*\\/|([^\\\\:]|^)\\/\\/.*$/",
62+
"/(\\/\\/[^\\n\\r]*[\\n\\r]+)/"
63+
]
64+
}
65+
]
66+
}

.czrc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"path": "cz-conventional-changelog"
3+
}

.editorconfig

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
root = true
2+
3+
[*]
4+
end_of_line = LF
5+
indent_style = space
6+
indent_size = 2
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true

.eslintrc.json

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{
2+
"root": true,
3+
"env": {
4+
"node": true
5+
},
6+
"plugins": ["prettier"],
7+
"extends": [
8+
"@rebeccastevens/eslint-config/modern",
9+
"@rebeccastevens/eslint-config/typescript",
10+
"@rebeccastevens/eslint-config/common-overrides",
11+
"plugin:prettier/recommended",
12+
"prettier"
13+
],
14+
"parserOptions": {
15+
"project": ["./tsconfig.json"]
16+
},
17+
"ignorePatterns": ["/coverage/", "/dist/"],
18+
"rules": {
19+
"import/no-relative-parent-imports": "off"
20+
},
21+
"overrides": [
22+
{
23+
"files": ["**/*.test.ts"],
24+
"plugins": ["ava"],
25+
"extends": ["plugin:ava/recommended", "plugin:functional/off"],
26+
"rules": {
27+
"@typescript-eslint/no-empty-function": "off",
28+
"@typescript-eslint/no-unsafe-argument": "off",
29+
"@typescript-eslint/no-unsafe-assignment": "off",
30+
"@typescript-eslint/no-unsafe-call": "off",
31+
"@typescript-eslint/no-unsafe-member-access": "off",
32+
"@typescript-eslint/no-unsafe-return": "off"
33+
}
34+
}
35+
]
36+
}

.gitattributes

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
* text=auto eol=lf
2+
3+
*.js linguist-detectable=false
4+
*.mjs linguist-detectable=false
5+
*.cjs linguist-detectable=false
6+
/.husky/** linguist-detectable=false
7+
8+
**/tsconfig.json linguist-language=jsonc
9+
**/tsconfig.*.json linguist-language=jsonc
10+
/.lintstagedrc linguist-language=json
11+
/.vscode/*.json linguist-language=jsonc
12+
13+
/CHANGELOG.md linguist-generated
14+
15+
/docs/** linguist-documentation

.github/FUNDING.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
issuehunt: RebeccaStevens/template-typescript-node-package
2+
ko_fi: rebeccastevens
3+
custom: https://github.com/RebeccaStevens/template-typescript-node-package/blob/main/DONATIONS.md

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: "\U0001F41B Bug Report"
3+
about: Report a bug to help us fix it
4+
title: ''
5+
labels: 'Type: Bug, Status: Triage'
6+
assignees: ''
7+
---
8+
9+
## Bug Report
10+
11+
<!-- Why the issue was filed? -->
12+
13+
### Expected behavior
14+
15+
<!-- What you expected to happen? -->
16+
17+
### Actual behavior
18+
19+
<!-- What actually happened? -->
20+
21+
### Steps to reproduce
22+
23+
<!-- How can someone else make/see it happen -->
24+
25+
### Proposed changes
26+
27+
<!-- If you have a proposed change, workaround or fix, describe it here -->

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
name: "\U0001F680 Feature Request"
3+
about: Suggest an idea
4+
title: ''
5+
labels: 'Type: Idea, Status: Triage'
6+
assignees: ''
7+
---
8+
9+
## Suggestion

.github/actions/prepare/action.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Prepare
2+
description: Prepares the repo for a typical CI job
3+
4+
inputs:
5+
node-version:
6+
required: false
7+
description: "`node-version` passed to `actions/setup-node`."
8+
default: latest
9+
10+
runs:
11+
using: "composite"
12+
steps:
13+
- name: Configure Git
14+
run: |
15+
git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
16+
git config --global user.name ${GITHUB_ACTOR}
17+
shell: bash
18+
- uses: pnpm/action-setup@v2
19+
- uses: actions/setup-node@v3
20+
with:
21+
node-version: ${{ inputs.node-version }}
22+
cache: "pnpm"
23+
- run: pnpm install --frozen-lockfile --ignore-scripts
24+
shell: bash

.github/codecov.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
coverage:
2+
status:
3+
project:
4+
default:
5+
informational: true
6+
patch:
7+
default:
8+
informational: true

.github/labels.yml

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
# Priority labels
2+
- name: "Priority: Critical"
3+
color: ee0701
4+
description: "This should be dealt with ASAP. Not fixing this issue would be a serious error."
5+
- name: "Priority: High"
6+
color: b60205
7+
description: "After critical issues are fixed, these should be dealt with before any further issues."
8+
- name: "Priority: Medium"
9+
color: 0e8a16
10+
description: "This issue may be useful, and needs some attention."
11+
- name: "Priority: Low"
12+
color: e4ea8a
13+
description: "Nice addition, maybe... someday..."
14+
15+
# Type labels
16+
- name: "Type: Bug"
17+
color: ee0701
18+
description: "Inconsistencies or issues which will cause a problem for users or implementors."
19+
- name: "Type: Documentation"
20+
color: 0052cc
21+
description: "Solely about the documentation of the project."
22+
- name: "Type: Enhancement"
23+
color: 1d76db
24+
description: "Enhancement of the code, not introducing new features."
25+
- name: "Type: Idea"
26+
color: fef2c0
27+
description: "Marks an idea, which might be accepted and implemented."
28+
- name: "Type: Feature"
29+
color: 0e8a16
30+
description: "New features or options."
31+
- name: "Type: Maintenance"
32+
color: 2af79e
33+
description: "Generic maintenance tasks, e.g., package updates."
34+
35+
# Additional markers
36+
- name: "Security"
37+
color: ee0701
38+
description: "Marks an security issues that needs to be resolved asap."
39+
- name: "Accepted"
40+
color: c2e0c6
41+
description: "This issue or PR has been accepted."
42+
- name: "Declined"
43+
color: f9d0c4
44+
description: "This issue or PR has been declined."
45+
- name: "Breaking Change"
46+
color: a80016
47+
description: "This change will require a new major release."
48+
- name: "Feature Removal"
49+
color: a80016
50+
description: "A feature is no longer wanted/needed (remove/deprecate it)"
51+
52+
# Ongoing Status labels
53+
- name: "Status: Triage"
54+
color: fbca04
55+
description: "This issue needs to be triaged."
56+
- name: "Status: Investigation Needed"
57+
color: fef2c0
58+
description: "Issue need to be investigated further."
59+
- name: "Status: On Hold"
60+
color: cccccc
61+
description: "Issue or PR that has been placed on hold for now."
62+
- name: "Status: In Progress"
63+
color: fbca04
64+
description: "Issue is currently being resolved by a developer."
65+
- name: "Status: Stale"
66+
color: fef2c0
67+
description: "There has not been activity on this issue or PR for quite some time."
68+
- name: "Status: Awaiting Response"
69+
color: fef2c0
70+
description: "Issue or PR awaits response from the creator."
71+
- name: "Status: Awaiting Feedback"
72+
color: fef2c0
73+
description: "Issue or PR awaits feedback from the community."
74+
- name: "Status: Blocked"
75+
color: fef2c0
76+
description: "Progress on this issue is currently not possible."
77+
78+
# Resolution Status labels
79+
- name: "Resolution: By Design"
80+
color: e6e6e6
81+
description: "The behavior reported in the issue is actually correct."
82+
- name: "Resolution: Duplicate"
83+
color: e6e6e6
84+
description: "This issue or pull request already exists"
85+
- name: "Resolution: External"
86+
color: e6e6e6
87+
description: "It was a real bug, but not in the code in this repo."
88+
- name: "Resolution: Invalid"
89+
color: e6e6e6
90+
description: ""
91+
- name: "Resolution: Not Applicable"
92+
color: e6e6e6
93+
description: "The issue is not relevant to code in this repo and is not an external issue. (Out of scope)"
94+
- name: "Resolution: Not Reproducible"
95+
color: e6e6e6
96+
description: "The bug could not be reproduced."
97+
- name: "Resolution: Won't Fix"
98+
color: e6e6e6
99+
description: "A real bug or issue, but the issue is not impactful enough to spend time on."
100+
- name: "Resolution: Fixed"
101+
color: c2e0c6
102+
description: "The issue has been fixed."
103+
- name: "Resolution: Added"
104+
color: c2e0c6
105+
description: "This has been added to the project."
106+
107+
# Bots
108+
- name: ":blue_heart:"
109+
color: ffffff
110+
description: "Renovate"
111+
- name: "Status: Released"
112+
color: c2e0c6
113+
description: "It's now live."

0 commit comments

Comments
 (0)