Skip to content

Commit f6e727f

Browse files
npalmnpalm
committed
feat: action docs
0 parents  commit f6e727f

Some content is hidden

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

46 files changed

+22569
-0
lines changed

‎.eslintignore‎

Lines changed: 4 additions & 0 deletions
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‎

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

‎.github/dependabot.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
version: 2
2+
updates:
3+
# Enable version updates for npm
4+
- package-ecosystem: 'npm'
5+
# Look for `package.json` and `lock` files in the `root` directory
6+
directory: '/'
7+
# Check the npm registry for updates every day (weekdays)
8+
schedule:
9+
interval: 'daily'

‎.github/settings.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
repository:
2+
private: true
3+
has_issues: true
4+
has_wiki: false
5+
has_downloads: true
6+
default_branch: main
7+
allow_squash_merge: true
8+
allow_merge_commit: true
9+
allow_rebase_merge: false
10+
11+
12+
branches:
13+
- name: main
14+
protection:
15+
required_pull_request_reviews:
16+
required_approving_review_count: 1
17+
dismiss_stale_reviews: true
18+
require_code_owner_reviews: true
19+
# Required. Require status checks to pass before merging. Set to null to disable
20+
required_status_checks:
21+
# Required. Require branches to be up to date before merging.
22+
strict: true
23+
# Required. The list of status checks to require in order to merge into this branch
24+
contexts: []
25+
# Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.
26+
enforce_admins: false
27+
# Required. Restrict who can push to this branch. Team and user restrictions are only available for organization-owned repositories. Set to null to disable.
28+
restrictions:
29+
apps: []
30+
users: []
31+
teams: []

‎.github/workflows/ci.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: 'build-test'
2+
on:
3+
push:
4+
branches:
5+
- main
6+
pull_request:
7+
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
strategy:
13+
matrix:
14+
node-version: ["10", "12", "14"]
15+
steps:
16+
- uses: actions/checkout@v2
17+
18+
- uses: actions/setup-node@v2
19+
with:
20+
node-version: ${{ matrix.node-version }}
21+
22+
- name: Install dependencies
23+
run: npm install
24+
25+
- name: Check format and lint
26+
run: npm run format-check && npm run lint
27+
28+
- name: Run tests
29+
run: npm test
30+
31+
- name: Build and package
32+
run: npm build
33+
34+
# - name: Publish
35+
# if: ${{ github.event_name != 'pull_request' && matrix.node-version == 14 }}
36+
# env:
37+
# NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
38+
# run: npm publish

‎.gitignore‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
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+
.npmrc

‎.nvmrc‎

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

‎.prettierignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
dist/
2+
lib/
3+
node_modules/

‎.releaserc.yml‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
branches:
3+
- "main"
4+
- name: "alfa"
5+
prerelease: true
6+
- name: "beta"
7+
prerelease: true
8+
- name: "develop"
9+
prerelease: true
10+
11+
tagFormat: v${version}
12+
13+
plugins:
14+
- "@semantic-release/commit-analyzer"
15+
- "@semantic-release/release-notes-generator"
16+
- "@semantic-release/exec"
17+
- "@semantic-release/changelog"
18+
- "@semantic-release/git"
19+
- "@semantic-release/github"
20+
21+
verifyConditions:
22+
- '@semantic-release/git'
23+
analyzeCommits:
24+
- path: "@semantic-release/commit-analyzer"
25+
preset: "conventionalcommits"
26+
27+
releaseRules:
28+
- type: "docs"
29+
release: "patch"
30+
- type: "feat"
31+
release: "minor"
32+
- type: "fix"
33+
release: "patch"
34+
# - type: "fix"
35+
# release: "patch"
36+
# - type: "patch"
37+
# release: "patch"
38+
# - type: "minor"
39+
# release: "minor"
40+
# - type: "breaking"
41+
# release: "major"
42+
generateNotes:
43+
- path: "@semantic-release/release-notes-generator"
44+
preset: "conventionalcommits"
45+
# linkCompare: true
46+
# linkReferences: true
47+
# parserOpts
48+
# noteKeywords
49+
# - feat
50+
# - fix
51+
# - doc
52+
# writerOpts:
53+
# groupBy: "type"
54+
# commitGroupsSort:
55+
# - "feat"
56+
# - "fix"
57+
# - "docs"
58+
# commitsSort: "header"
59+
# types:
60+
# - type: "feat"
61+
# - section: "Features"
62+
# # Tracked bug fix with a hotfix branch
63+
# - type: "hotfix"
64+
# - section: "Bug Fixes"
65+
# # Uninmportent fix (CI testing, etc)
66+
# - type: "fix"
67+
# - hidden: true
68+
# - type: "chore"
69+
# - hidden: true
70+
# - type: "docs"
71+
# - section: "Documentation"
72+
# - type: "doc"
73+
# - hidden: true
74+
# - type: "style"
75+
# - hidden: true
76+
# - type: "refactor"
77+
# - hidden: true
78+
# - type: "perf"
79+
# - hidden: true
80+
# - type: "test"
81+
# - hidden: true
82+
# presetConfig: true
83+
84+
prepare:
85+
- path: "@semantic-release/changelog"
86+
changelogFile: "CHANGELOG.md"
87+
88+
- path: "@semantic-release/git"
89+
assets: "CHANGELOG.md"
90+
publish:
91+
- path: "@semantic-release/github"
92+
assets: "CHANGELOG.md"
93+
- path: "@semantic-release/exec"
94+
publishCmd: "echo ${nextRelease.version} > VERSION.txt"

‎CODE_OF_CONDUCT.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

0 commit comments

Comments
 (0)