Skip to content

Commit d957b80

Browse files
ehmickyehmicky
committed
Initial commit
0 parents  commit d957b80

24 files changed

+32774
-0
lines changed

‎.all-contributorsrc

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"projectName": "template-name",
3+
"projectOwner": "ehmicky",
4+
"repoType": "github",
5+
"repoHost": "https://github.com",
6+
"files": [
7+
"README.md"
8+
],
9+
"imageSize": 100,
10+
"commit": true,
11+
"contributors": [
12+
{
13+
"login": "ehmicky",
14+
"name": "ehmicky",
15+
"avatar_url": "https://avatars2.githubusercontent.com/u/8136211?v=4",
16+
"profile": "https://twitter.com/ehmicky",
17+
"contributions": [
18+
"code",
19+
"design",
20+
"ideas",
21+
"doc"
22+
]
23+
}
24+
],
25+
"contributorsPerLine": 7
26+
}

‎.editorconfig

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
end_of_line = lf
7+
charset = utf-8
8+
max_line_length = 80
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true

‎.eslintrc.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
extends: '@ehmicky/eslint-config/.eslintrc.yml'

‎.gitattributes

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text=auto eol=lf

‎.github/ISSUE_TEMPLATE/bug_report.yml

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Bug report
2+
description: Create a report to help us improve
3+
title: Please replace with a clear and descriptive title
4+
labels: [bug]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Thanks for reporting this bug!
9+
- type: checkboxes
10+
attributes:
11+
label: Guidelines
12+
options:
13+
- label:
14+
Please search other issues to make sure this bug has not already
15+
been reported.
16+
required: true
17+
- label:
18+
If this is related to a typo or the documentation being unclear,
19+
please click on the relevant page's `Edit` button (pencil icon) and
20+
suggest a correction instead.
21+
required: true
22+
- type: textarea
23+
attributes:
24+
label: Describe the bug
25+
placeholder: A clear and concise description of what the bug is.
26+
validations:
27+
required: true
28+
- type: textarea
29+
attributes:
30+
label: Steps to reproduce
31+
placeholder: |
32+
Step-by-step instructions on how to reproduce the behavior.
33+
Example:
34+
1. Type the following command: [...]
35+
2. etc.
36+
validations:
37+
required: true
38+
- type: textarea
39+
attributes:
40+
label: Configuration
41+
placeholder: Command line options and/or configuration file, if any.
42+
validations:
43+
required: true
44+
- type: textarea
45+
attributes:
46+
label: Environment
47+
description: |
48+
Enter the following command in a terminal and copy/paste its output:
49+
```bash
50+
npx envinfo --system --binaries --browsers --npmPackages template-name
51+
```
52+
validations:
53+
required: true
54+
- type: checkboxes
55+
attributes:
56+
label: Pull request (optional)
57+
description:
58+
Pull requests are welcome! If you would like to help us fix this bug,
59+
please check our [contributions
60+
guidelines](../blob/main/CONTRIBUTING.md).
61+
options:
62+
- label: I can submit a pull request.
63+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yml

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
title: Please replace with a clear and descriptive title
4+
labels: [enhancement]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Thanks for suggesting a new feature!
9+
- type: checkboxes
10+
attributes:
11+
label: Guidelines
12+
options:
13+
- label:
14+
Please search other issues to make sure this feature has not already
15+
been requested.
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: Which problem is this feature request solving?
20+
placeholder: I'm always frustrated when [...]
21+
validations:
22+
required: true
23+
- type: textarea
24+
attributes:
25+
label: Describe the solution you'd like
26+
placeholder: This could be fixed by [...]
27+
validations:
28+
required: true
29+
- type: checkboxes
30+
attributes:
31+
label: Pull request (optional)
32+
description:
33+
Pull requests are welcome! If you would like to help us fix this bug,
34+
please check our [contributions
35+
guidelines](../blob/main/CONTRIBUTING.md).
36+
options:
37+
- label: I can submit a pull request.
38+
required: false

‎.github/pull_request_template.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
🎉 Thanks for sending this pull request! 🎉
2+
3+
Please make sure the title is clear and descriptive.
4+
5+
If you are fixing a typo or documentation, please skip these instructions.
6+
7+
Otherwise please fill in the sections below.
8+
9+
**Which problem is this pull request solving?**
10+
11+
Example: I'm always frustrated when [...]
12+
13+
**List other issues or pull requests related to this problem**
14+
15+
Example: This fixes #5012
16+
17+
**Describe the solution you've chosen**
18+
19+
Example: I've fixed this by [...]
20+
21+
**Describe alternatives you've considered**
22+
23+
Example: Another solution would be [...]
24+
25+
**Checklist**
26+
27+
Please add a `x` inside each checkbox:
28+
29+
- [ ] I have read the [contribution guidelines](../blob/main/CONTRIBUTING.md).
30+
- [ ] I have added tests (we are enforcing 100% test coverage).
31+
- [ ] I have added documentation in the `README.md`, the `docs` directory (if
32+
any) and the `examples` directory (if any).
33+
- [ ] The status checks are successful (continuous integration). Those can be
34+
seen below.

‎.github/workflows/workflow.yml

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Build
2+
on: [push, pull_request]
3+
jobs:
4+
combinations:
5+
# git push --tags does not create any commits so should not trigger a new
6+
# workflow. There are no ways to skip workflows, so we skip jobs instead
7+
if: toJson(github.event.commits) != '[]'
8+
strategy:
9+
# Test on Windows/Mac/Linux using latest Node.js.
10+
# Also test on Linux with older Node.js versions.
11+
# We do not run each possible combination to make CI faster.
12+
matrix:
13+
os: [ubuntu-latest, macOS-latest, windows-latest]
14+
node: [18]
15+
include:
16+
- os: ubuntu-latest
17+
node: 14.18.0
18+
fail-fast: false
19+
runs-on: ${{ matrix.os }}
20+
# We do not use @actions/cache because restoring/saving cache currently
21+
# takes more time than the time saved on `npm ci`
22+
steps:
23+
- name: Git checkout
24+
uses: actions/checkout@v3
25+
- name: Node.js ${{ matrix.node }}
26+
uses: actions/setup-node@v3
27+
with:
28+
node-version: ${{ matrix.node }}
29+
cache: npm
30+
# TODO: remove after dropping support for Node <15.0.0, i.e. ensuring
31+
# npm v7 is used. We need npm v7 due to peerDependencies automatic
32+
# installation
33+
- name: Install latest npm
34+
run: npm install -g npm
35+
if: "${{ matrix.node == '14.18.0' }}"
36+
- name: Install dependencies
37+
run: npm ci
38+
- name: Linting
39+
run: npx gulp check
40+
- name: Build
41+
run: npx gulp build
42+
- name: Types
43+
run: npx gulp type
44+
- name: Tests
45+
run: npx gulp unit
46+
- name: Upload test coverage
47+
run: npx gulp uploadCoverage

‎.gitignore

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
*~
2+
*.swp
3+
npm-debug.log
4+
node_modules
5+
/core
6+
.eslintcache
7+
.npmrc
8+
.yarn-error.log
9+
.nyc_output
10+
!.github/
11+
/coverage
12+
/build

‎.prettierrc.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
'@ehmicky/eslint-config'

‎CHANGELOG.md

Whitespace-only changes.

‎CODE_OF_CONDUCT.md

+131
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
This text is available in
4+
[many other languages](https://www.contributor-covenant.org/translations).
5+
6+
## Our Pledge
7+
8+
We as members, contributors, and leaders pledge to make participation in our
9+
community a harassment-free experience for everyone, regardless of age, body
10+
size, visible or invisible disability, ethnicity, sex characteristics, gender
11+
identity and expression, level of experience, education, socio-economic status,
12+
nationality, personal appearance, race, religion, or sexual identity and
13+
orientation.
14+
15+
We pledge to act and interact in ways that contribute to an open, welcoming,
16+
diverse, inclusive, and healthy community.
17+
18+
## Our Standards
19+
20+
Examples of behavior that contributes to a positive environment for our
21+
community include:
22+
23+
- Demonstrating empathy and kindness toward other people
24+
- Being respectful of differing opinions, viewpoints, and experiences
25+
- Giving and gracefully accepting constructive feedback
26+
- Accepting responsibility and apologizing to those affected by our mistakes,
27+
and learning from the experience
28+
- Focusing on what is best not just for us as individuals, but for the overall
29+
community
30+
31+
Examples of unacceptable behavior include:
32+
33+
- The use of sexualized language or imagery, and sexual attention or advances of
34+
any kind
35+
- Trolling, insulting or derogatory comments, and personal or political attacks
36+
- Public or private harassment
37+
- Publishing others' private information, such as a physical or email address,
38+
without their explicit permission
39+
- Other conduct which could reasonably be considered inappropriate in a
40+
professional setting
41+
42+
## Enforcement Responsibilities
43+
44+
Community leaders are responsible for clarifying and enforcing our standards of
45+
acceptable behavior and will take appropriate and fair corrective action in
46+
response to any behavior that they deem inappropriate, threatening, offensive,
47+
or harmful.
48+
49+
Community leaders have the right and responsibility to remove, edit, or reject
50+
comments, commits, code, wiki edits, issues, and other contributions that are
51+
not aligned to this Code of Conduct, and will communicate reasons for moderation
52+
decisions when appropriate.
53+
54+
## Scope
55+
56+
This Code of Conduct applies within all community spaces, and also applies when
57+
an individual is officially representing the community in public spaces.
58+
Examples of representing our community include using an official e-mail address,
59+
posting via an official social media account, or acting as an appointed
60+
representative at an online or offline event.
61+
62+
## Enforcement
63+
64+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
65+
reported to the community leaders responsible for enforcement at
66+
[email protected] All complaints will be reviewed and investigated
67+
promptly and fairly.
68+
69+
All community leaders are obligated to respect the privacy and security of the
70+
reporter of any incident.
71+
72+
## Enforcement Guidelines
73+
74+
Community leaders will follow these Community Impact Guidelines in determining
75+
the consequences for any action they deem in violation of this Code of Conduct:
76+
77+
### 1. Correction
78+
79+
**Community Impact**: Use of inappropriate language or other behavior deemed
80+
unprofessional or unwelcome in the community.
81+
82+
**Consequence**: A private, written warning from community leaders, providing
83+
clarity around the nature of the violation and an explanation of why the
84+
behavior was inappropriate. A public apology may be requested.
85+
86+
### 2. Warning
87+
88+
**Community Impact**: A violation through a single incident or series of
89+
actions.
90+
91+
**Consequence**: A warning with consequences for continued behavior. No
92+
interaction with the people involved, including unsolicited interaction with
93+
those enforcing the Code of Conduct, for a specified period of time. This
94+
includes avoiding interactions in community spaces as well as external channels
95+
like social media. Violating these terms may lead to a temporary or permanent
96+
ban.
97+
98+
### 3. Temporary Ban
99+
100+
**Community Impact**: A serious violation of community standards, including
101+
sustained inappropriate behavior.
102+
103+
**Consequence**: A temporary ban from any sort of interaction or public
104+
communication with the community for a specified period of time. No public or
105+
private interaction with the people involved, including unsolicited interaction
106+
with those enforcing the Code of Conduct, is allowed during this period.
107+
Violating these terms may lead to a permanent ban.
108+
109+
### 4. Permanent Ban
110+
111+
**Community Impact**: Demonstrating a pattern of violation of community
112+
standards, including sustained inappropriate behavior, harassment of an
113+
individual, or aggression toward or disparagement of classes of individuals.
114+
115+
**Consequence**: A permanent ban from any sort of public interaction within the
116+
community.
117+
118+
## Attribution
119+
120+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
121+
version 2.0, available at
122+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
123+
124+
Community Impact Guidelines were inspired by
125+
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
126+
127+
[homepage]: https://www.contributor-covenant.org
128+
129+
For answers to common questions about this code of conduct, see the FAQ at
130+
https://www.contributor-covenant.org/faq. Translations are available at
131+
https://www.contributor-covenant.org/translations.

0 commit comments

Comments
 (0)