Skip to content

Commit d8e222b

Browse files
ahmedali8ahmedali8
committed
chore: update template
1 parent 9687b98 commit d8e222b

32 files changed

+10862
-3969
lines changed

‎.commitlintrc.yml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
extends:
2+
- "@commitlint/config-conventional"

‎.czrc

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

‎.editorconfig

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ end_of_line = lf
77
indent_style = space
88
indent_size = 2
99
insert_final_newline = true
10-
trim_trailing_whitespace = false
10+
trim_trailing_whitespace = true

‎.env.example

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
COVERALLS_REPO_TOKEN="secret repo token"

‎.eslintignore

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# folders
2+
.yarn/
3+
**/.nyc_output
4+
**/artifacts
5+
**/build
6+
**/cache
7+
**/coverage
8+
**/dist
9+
**/node_modules
10+
**/typechain
11+
12+
# files
13+
*.env
14+
*.log
15+
*.tsbuildinfo
16+
.pnp.*
17+
coverage.json
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

‎.eslintrc.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
env:
2+
node: true
3+
es2021: true
4+
parser: "@typescript-eslint/parser"
5+
parserOptions:
6+
project: "tsconfig.json"
7+
ecmaVersion: 12
8+
sourceType: "module"
9+
ignorePatterns: ["node_modules/**/*"]
10+
plugins:
11+
- "@typescript-eslint"
12+
root: true
13+
extends:
14+
- "eslint:recommended"
15+
- "plugin:@typescript-eslint/eslint-recommended"
16+
- "plugin:@typescript-eslint/recommended"
17+
- "prettier"
18+
rules:
19+
"@typescript-eslint/no-floating-promises":
20+
- "warn"
21+
- "ignoreIIFE": true
22+
"ignoreVoid": true
23+
"@typescript-eslint/no-inferrable-types": "off"
24+
"@typescript-eslint/no-unused-vars":
25+
- "warn"
26+
- "argsIgnorePattern": "_"
27+
"varsIgnorePattern": "_"
28+
no-unused-vars: "warn"
29+
no-extra-boolean-cast: "off"
30+
no-constant-condition: "off"
31+
no-async-promise-executor: "off"
32+
no-useless-escape: "warn"

‎.github/workflows/ci.yml

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: "CI"
2+
3+
env:
4+
COVERAGE_GIT_BRANCH: "main"
5+
COVERAGE_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
6+
COVERAGE_SERVICE_NAME: "github-actions-ci"
7+
8+
on:
9+
pull_request:
10+
branches:
11+
- "main"
12+
push:
13+
branches:
14+
- "main"
15+
16+
jobs:
17+
ci:
18+
runs-on: "ubuntu-latest"
19+
steps:
20+
- name: "Check out the repo"
21+
uses: "actions/checkout@v3"
22+
23+
- name: "Install Node.js"
24+
uses: "actions/setup-node@v3"
25+
with:
26+
cache: "yarn"
27+
node-version: "16"
28+
29+
- name: "Install the dependencies"
30+
run: "yarn install --immutable"
31+
32+
- name: "Lint the code"
33+
run: "yarn lint"
34+
35+
- name: "Run the tests and generate coverage report"
36+
run: "yarn coverage"
37+
38+
- name: "Upload the coverage report to Coveralls"
39+
uses: "coverallsapp/github-action@master"
40+
with:
41+
github-token: ${{ secrets.GITHUB_TOKEN }}
42+
path-to-lcov: "./coverage/lcov.info"

‎.gitignore

+21-59
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,25 @@
1-
/dist
2-
3-
# Logs
4-
logs
1+
# folders
2+
.yarn/*
3+
!.yarn/patches
4+
!.yarn/releases
5+
!.yarn/plugins
6+
!.yarn/sdks
7+
!.yarn/versions
8+
**/.nyc_output
9+
**/artifacts
10+
**/build
11+
**/cache
12+
**/coverage
13+
**/dist
14+
**/node_modules
15+
**/typechain
16+
17+
# files
18+
*.env
519
*.log
20+
*.tsbuildinfo
21+
.pnp.*
22+
coverage.json
623
npm-debug.log*
724
yarn-debug.log*
825
yarn-error.log*
9-
10-
# Runtime data
11-
pids
12-
*.pid
13-
*.seed
14-
*.pid.lock
15-
16-
# Directory for instrumented libs generated by jscoverage/JSCover
17-
lib-cov
18-
19-
# Coverage directory used by tools like istanbul
20-
coverage
21-
22-
# nyc test coverage
23-
.nyc_output
24-
25-
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
26-
.grunt
27-
28-
# Bower dependency directory (https://bower.io/)
29-
bower_components
30-
31-
# node-waf configuration
32-
.lock-wscript
33-
34-
# Compiled binary addons (https://nodejs.org/api/addons.html)
35-
build/Release
36-
37-
# Dependency directories
38-
node_modules/
39-
jspm_packages/
40-
41-
# TypeScript v1 declaration files
42-
typings/
43-
44-
# Optional npm cache directory
45-
.npm
46-
47-
# Optional eslint cache
48-
.eslintcache
49-
50-
# Optional REPL history
51-
.node_repl_history
52-
53-
# Output of 'npm pack'
54-
*.tgz
55-
56-
# Yarn Integrity file
57-
.yarn-integrity
58-
59-
# next.js build output
60-
.next
61-
62-
# environment variables
63-
.env

‎.husky/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_

‎.husky/commit-msg

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#!/bin/sh
2+
. "$(dirname "$0")/_/husky.sh"
3+
4+
yarn dlx commitlint --edit $1
5+

‎.husky/pre-commit

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/bin/sh
2+
. "$(dirname "$0")/_/husky.sh"
3+
4+
yarn dlx lint-staged

‎.lintstagedrc.yml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
"*.{js,json,md,sol,ts,yml}":
2+
- prettier --config ""./.prettierrc.yml" --write

‎.mocharc.json

-5
This file was deleted.

‎.mocharc.yml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
extension: "ts"
2+
recursive: true
3+
require:
4+
- "earljs/mocha"
5+
- "ts-node/register/transpile-only"
6+
- "source-map-support/register"
7+
spec: "test/**/*.test.ts"
8+
timeout: 30000
9+
watchExtension: "ts"

‎.nycrc.yml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
check-coverage: false
2+
extends: "@istanbuljs/nyc-config-typescript"
3+
include: "src/**/*"
4+
report-dir: "coverage"
5+
reporter:
6+
- "html"
7+
- "lcov"

‎.prettierignore

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# folders
2+
.yarn/
3+
**/.nyc_output
4+
**/artifacts
5+
**/build
6+
**/cache
7+
**/coverage
8+
**/dist
9+
**/node_modules
10+
**/typechain
11+
12+
# files
13+
*.env
14+
*.log
15+
*.tsbuildinfo
16+
.pnp.*
17+
coverage.json
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

‎.prettierrc.yml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
bracketSpacing: true
2+
endOfLine: "auto"
3+
importOrder: ["<THIRD_PARTY_MODULES>", "^[./]"]
4+
importOrderParserPlugins: ["typescript"]
5+
importOrderSeparation: true
6+
importOrderSortSpecifiers: true
7+
printWidth: 100
8+
proseWrap: "always"
9+
singleQuote: false
10+
tabWidth: 2
11+
trailingComma: "all"

‎.travis.yml

-19
This file was deleted.

‎.yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs

+541
Large diffs are not rendered by default.

‎.yarn/releases/yarn-3.2.2.cjs

+783
Large diffs are not rendered by default.

‎.yarnrc.yml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
nodeLinker: "node-modules"
2+
3+
plugins:
4+
- path: ".yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs"
5+
spec: "@yarnpkg/plugin-interactive-tools"
6+
7+
yarnPath: ".yarn/releases/yarn-3.2.2.cjs"

‎CHANGELOG.md

Whitespace-only changes.

‎LICENSE

+12-15
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
11
MIT License
22

3-
Copyright (c) 2019 Nomic Labs LLC
3+
Copyright (c) 2022 Ahmed Ali
44

5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
6+
associated documentation files (the "Software"), to deal in the Software without restriction,
7+
including without limitation the rights to use, copy, modify, merge, publish, distribute,
8+
sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
109
furnished to do so, subject to the following conditions:
1110

12-
The above copyright notice and this permission notice shall be included in all
13-
copies or substantial portions of the Software.
11+
The above copyright notice and this permission notice shall be included in all copies or substantial
12+
portions of the Software.
1413

15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
15+
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
16+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
17+
OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
18+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)