Skip to content

Commit b94b7d6

Browse files
committed
chore: 🔧 bunch of boilerplate
1 parent 1aad547 commit b94b7d6

25 files changed

+10411
-0
lines changed

.commitlintrc.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"extends": ["@commitlint/config-conventional"]
3+
}

.eslintrc.js

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
module.exports = {
2+
parser: '@typescript-eslint/parser',
3+
parserOptions: {
4+
project: 'tsconfig.json',
5+
tsconfigRootDir: __dirname,
6+
sourceType: 'module',
7+
},
8+
plugins: ['@typescript-eslint/eslint-plugin'],
9+
extends: [
10+
'plugin:@typescript-eslint/recommended',
11+
'plugin:prettier/recommended',
12+
],
13+
root: true,
14+
env: {
15+
node: true,
16+
jest: true,
17+
},
18+
ignorePatterns: ['.eslintrc.js'],
19+
rules: {
20+
'@typescript-eslint/interface-name-prefix': 'off',
21+
'@typescript-eslint/explicit-function-return-type': 'off',
22+
'@typescript-eslint/explicit-module-boundary-types': 'off',
23+
'@typescript-eslint/no-explicit-any': 'off',
24+
},
25+
};

.github/CODE_OF_CONDUCT.md

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

.github/CONTRIBUTING.md

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

.github/ISSUE_TEMPLATE/BUG_REPORT.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug in the project
4+
title: '[BUG]'
5+
labels: 'needs confirmation'
6+
assignees: ''
7+
---
8+
9+
#### Expected Behavior
10+
11+
<!-- Concisely describe the behavior you expected -->
12+
13+
#### Observed Behavior
14+
15+
<!-- Concisely describe the behavior you observed -->
16+
17+
#### Steps to Reproduce
18+
19+
<!-- Provide a link to a live example, or an unambiguous set of steps to reproduce this bug. Include code to reproduce, if relevant -->
20+
21+
#### Environment
22+
23+
<!-- Please provide the following information -->
24+
25+
- LemLink Version: <!-- (e.g. 0.4.5) -->
26+
- Registry Version: <!-- (e.g. 0.4.5) -->
27+
28+
#### Additional Information
29+
30+
<!-- Add any other relevant information about the problem here -->
31+
<!-- This includes screenshots, code snippets, videos, anything you think is relevant -->
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for the project
4+
title: '[FEATURE]'
5+
labels: 'enhancement'
6+
assignees: ''
7+
---
8+
9+
#### Requested Feature
10+
11+
<!-- Concisely describe the behavior you are requesting here -->
12+
13+
<!-- Describe any details in point form here -->
14+
15+
- a
16+
- b
17+
- c
18+
19+
#### Current Implementation
20+
21+
<!-- Describe the current implementation here -->
22+
23+
#### Motivation
24+
25+
<!-- Explain why this feature would benefit users and/or maintainers -->
26+
27+
#### (Optional) Possible Implementations and Alternatives
28+
29+
<!-- Describe any possible implementations or alternatives you have considered -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#### Summary
2+
3+
<!-- Provide a brief summary on the pull request -->
4+
5+
#### Motivation
6+
7+
<!-- Why are you making this pull request? -->
8+
9+
#### Test Plan
10+
11+
<!-- How did you test / plan to test this pull request? -->
12+
13+
#### Additional Notes
14+
15+
<!-- Add any other information you think is relevant -->

.github/workflows/ci.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: ci
2+
on:
3+
pull_request:
4+
branches: '*'
5+
push:
6+
branches: '*'
7+
8+
workflow_dispatch:
9+
10+
jobs:
11+
build:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Copy repository
15+
uses: actions/checkout@v4
16+
17+
- name: Use Node.js
18+
uses: actions/setup-node@v4
19+
with:
20+
node-version: 20
21+
cache: 'npm'
22+
23+
- name: Install dependencies
24+
run: npm i
25+
26+
- name: Lint
27+
run: npm run check-lint
28+
29+
- name: Check formatting
30+
run: npm run check-format
31+
32+
- name: Build
33+
run: npm run build
34+
35+
- name: Test
36+
run: npm test

.gitignore

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# compiled output
2+
/dist
3+
/node_modules
4+
5+
# Logs
6+
logs
7+
*.log
8+
npm-debug.log*
9+
pnpm-debug.log*
10+
yarn-debug.log*
11+
yarn-error.log*
12+
lerna-debug.log*
13+
14+
# OS
15+
.DS_Store
16+
17+
# Tests
18+
/coverage
19+
/.nyc_output
20+
21+
# IDEs and editors
22+
/.idea
23+
.project
24+
.classpath
25+
.c9/
26+
*.launch
27+
.settings/
28+
*.sublime-workspace
29+
30+
# IDE - VSCode
31+
.vscode/*
32+
!.vscode/settings.json
33+
!.vscode/tasks.json
34+
!.vscode/launch.json
35+
!.vscode/extensions.json

.husky/commit-msg

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/usr/bin/env sh
2+
. "$(dirname -- "$0")/_/husky.sh"
3+
4+
npx --no -- commitlint --edit ${1}

0 commit comments

Comments
 (0)