Skip to content

Commit ffc5a61

Browse files
lucacomelucacome
committed
Initial commit
0 parents  commit ffc5a61

29 files changed

+25412
-0
lines changed

‎.eslintignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
dist/
2+
lib/
3+
node_modules/
4+
jest.config.js

‎.eslintrc.json

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
{
2+
"plugins": [
3+
"jest",
4+
"@typescript-eslint"
5+
],
6+
"extends": [
7+
"eslint:recommended",
8+
"plugin:@typescript-eslint/recommended",
9+
"prettier"
10+
],
11+
"parser": "@typescript-eslint/parser",
12+
"parserOptions": {
13+
"ecmaVersion": 9,
14+
"sourceType": "module",
15+
"project": "./tsconfig.json"
16+
},
17+
"rules": {
18+
"i18n-text/no-en": "off",
19+
"eslint-comments/no-use": "off",
20+
"import/no-namespace": "off",
21+
"no-unused-vars": "off",
22+
"@typescript-eslint/no-unused-vars": "error",
23+
"@typescript-eslint/explicit-member-accessibility": [
24+
"error",
25+
{
26+
"accessibility": "no-public"
27+
}
28+
],
29+
"@typescript-eslint/no-require-imports": "error",
30+
"@typescript-eslint/array-type": "error",
31+
"@typescript-eslint/await-thenable": "error",
32+
"@typescript-eslint/ban-ts-comment": "error",
33+
"camelcase": "off",
34+
"@typescript-eslint/consistent-type-assertions": "error",
35+
"@typescript-eslint/explicit-function-return-type": [
36+
"error",
37+
{
38+
"allowExpressions": true
39+
}
40+
],
41+
"@typescript-eslint/func-call-spacing": [
42+
"error",
43+
"never"
44+
],
45+
"@typescript-eslint/no-array-constructor": "error",
46+
"@typescript-eslint/no-empty-interface": "error",
47+
"@typescript-eslint/no-explicit-any": "error",
48+
"@typescript-eslint/no-extraneous-class": "error",
49+
"@typescript-eslint/no-for-in-array": "error",
50+
"@typescript-eslint/no-inferrable-types": "error",
51+
"@typescript-eslint/no-misused-new": "error",
52+
"@typescript-eslint/no-namespace": "error",
53+
"@typescript-eslint/no-non-null-assertion": "warn",
54+
"@typescript-eslint/no-unnecessary-qualifier": "error",
55+
"@typescript-eslint/no-unnecessary-type-assertion": "error",
56+
"@typescript-eslint/no-useless-constructor": "error",
57+
"@typescript-eslint/no-var-requires": "error",
58+
"@typescript-eslint/prefer-for-of": "warn",
59+
"@typescript-eslint/prefer-function-type": "warn",
60+
"@typescript-eslint/prefer-includes": "error",
61+
"@typescript-eslint/prefer-string-starts-ends-with": "error",
62+
"@typescript-eslint/promise-function-async": "error",
63+
"@typescript-eslint/require-array-sort-compare": "error",
64+
"@typescript-eslint/restrict-plus-operands": "error",
65+
"semi": "off",
66+
"@typescript-eslint/semi": "off",
67+
"@typescript-eslint/type-annotation-spacing": "error",
68+
"@typescript-eslint/unbound-method": "error"
69+
},
70+
"env": {
71+
"node": true,
72+
"es6": true,
73+
"jest/globals": true
74+
}
75+
}

‎.gitattributes

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
dist/** -diff linguist-generated=true

‎.github/dependabot.yml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: github-actions
4+
directory: /
5+
schedule:
6+
interval: daily
7+
8+
- package-ecosystem: npm
9+
directory: /
10+
schedule:
11+
interval: weekly

‎.github/release.yml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
changelog:
2+
exclude:
3+
labels:
4+
- skip-changelog
5+
categories:
6+
- title: 🚀 Features
7+
labels:
8+
- enhancement
9+
- title: 💣 Breaking Changes
10+
labels:
11+
- change
12+
- title: 🐛 Bug Fixes
13+
labels:
14+
- bug
15+
- title: 📝 Documentation
16+
labels:
17+
- documentation
18+
- title: 🧪 Tests
19+
labels:
20+
- tests
21+
- title: 🔨 Maintenance
22+
labels:
23+
- chore
24+
- title: ⬆️ Dependencies
25+
labels:
26+
- dependencies
27+
- title: Other Changes
28+
labels:
29+
- "*"

‎.github/workflows/check-dist.yml

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# `dist/index.js` is a special file in Actions.
2+
# When you reference an action with `uses:` in a workflow,
3+
# `index.js` is the code that will run.
4+
# For our project, we generate this file through a build process from other source files.
5+
# We need to make sure the checked-in `index.js` actually matches what we expect it to be.
6+
name: Check dist/
7+
8+
on:
9+
push:
10+
branches:
11+
- main
12+
paths-ignore:
13+
- '**.md'
14+
pull_request:
15+
paths-ignore:
16+
- '**.md'
17+
workflow_dispatch:
18+
19+
jobs:
20+
check-dist:
21+
runs-on: ubuntu-latest
22+
23+
steps:
24+
- uses: actions/checkout@v3
25+
26+
- name: Set Node.js 16.x
27+
uses: actions/[email protected]
28+
with:
29+
node-version: 16.x
30+
31+
- name: Install dependencies
32+
run: npm ci
33+
34+
- name: Rebuild the dist/ directory
35+
run: |
36+
npm run build
37+
npm run package
38+
39+
- name: Compare the expected and actual dist/ directories
40+
run: |
41+
if [ "$(git diff --ignore-space-at-eol dist/ | wc -l)" -gt "0" ]; then
42+
echo "Detected uncommitted changes after build. See status below:"
43+
git diff
44+
exit 1
45+
fi
46+
id: diff
47+
48+
# If index.js was different than expected, upload the expected version as an artifact
49+
- uses: actions/upload-artifact@v3
50+
if: ${{ failure() && steps.diff.conclusion == 'failure' }}
51+
with:
52+
name: dist
53+
path: dist/

‎.github/workflows/test.yml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: 'build-test'
2+
on: # rebuild any PRs and main branch changes
3+
pull_request:
4+
push:
5+
branches:
6+
- main
7+
- 'releases/*'
8+
9+
jobs:
10+
build: # make sure build/ci work properly
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- run: |
15+
npm install
16+
- run: |
17+
npm run all
18+
test: # make sure the action works on a clean machine without building
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/checkout@v3
22+
- uses: ./
23+
id: draft-release
24+
with:
25+
notes-header: |
26+
## Welcome to the %TAG% release of Draft Release
27+
This is some text to welcome you to the release %TAG_STRIPPED%.
28+
notes-footer: |
29+
## Upgrade
30+
- For Docker, use the %TAG% image from Docker Hub.
31+
- For Binaries use the %TAG_STRIPPED% release from GitHub.
32+
33+
- run: |
34+
echo "Version: ${{ steps.draft-release.outputs.version }}"
35+
echo "Release Notes: ${{ steps.draft-release.outputs.release-notes }}"
36+
echo "Release URL: ${{ steps.draft-release.outputs.release-url }}"
37+
echo "Release ID: ${{ steps.draft-release.outputs.release-id }}"

‎.gitignore

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# Dependency directory
2+
node_modules
3+
4+
# Rest pulled from https://github.com/github/gitignore/blob/master/Node.gitignore
5+
# Logs
6+
logs
7+
*.log
8+
npm-debug.log*
9+
yarn-debug.log*
10+
yarn-error.log*
11+
lerna-debug.log*
12+
13+
# Diagnostic reports (https://nodejs.org/api/report.html)
14+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
15+
16+
# Runtime data
17+
pids
18+
*.pid
19+
*.seed
20+
*.pid.lock
21+
22+
# Directory for instrumented libs generated by jscoverage/JSCover
23+
lib-cov
24+
25+
# Coverage directory used by tools like istanbul
26+
coverage
27+
*.lcov
28+
29+
# nyc test coverage
30+
.nyc_output
31+
32+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
33+
.grunt
34+
35+
# Bower dependency directory (https://bower.io/)
36+
bower_components
37+
38+
# node-waf configuration
39+
.lock-wscript
40+
41+
# Compiled binary addons (https://nodejs.org/api/addons.html)
42+
build/Release
43+
44+
# Dependency directories
45+
jspm_packages/
46+
47+
# TypeScript v1 declaration files
48+
typings/
49+
50+
# TypeScript cache
51+
*.tsbuildinfo
52+
53+
# Optional npm cache directory
54+
.npm
55+
56+
# Optional eslint cache
57+
.eslintcache
58+
59+
# Optional REPL history
60+
.node_repl_history
61+
62+
# Output of 'npm pack'
63+
*.tgz
64+
65+
# Yarn Integrity file
66+
.yarn-integrity
67+
68+
# dotenv environment variables file
69+
.env
70+
.env.test
71+
72+
# parcel-bundler cache (https://parceljs.org/)
73+
.cache
74+
75+
# next.js build output
76+
.next
77+
78+
# nuxt.js build output
79+
.nuxt
80+
81+
# vuepress build output
82+
.vuepress/dist
83+
84+
# Serverless directories
85+
.serverless/
86+
87+
# FuseBox cache
88+
.fusebox/
89+
90+
# DynamoDB Local files
91+
.dynamodb/
92+
93+
# OS metadata
94+
.DS_Store
95+
Thumbs.db
96+
97+
# Ignore built ts files
98+
__tests__/runner/*
99+
lib/**/*

‎.prettierignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
dist/
2+
lib/
3+
node_modules/

‎.prettierrc.json

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"printWidth": 140,
3+
"tabWidth": 2,
4+
"useTabs": false,
5+
"semi": false,
6+
"singleQuote": true,
7+
"trailingComma": "all",
8+
"bracketSpacing": false,
9+
"arrowParens": "always"
10+
}

‎CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @lucacome

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 Luca Comellini and contributors
4+
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
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
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.

0 commit comments

Comments
 (0)