Skip to content

Commit 22bddc7

Browse files
andrewdyerandrewdyer
committed
chore: 🔧 update project with template files
1 parent 7aa98e6 commit 22bddc7

19 files changed

Lines changed: 10959 additions & 10292 deletions

‎.github/workflows/ci.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Continuous Integration
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
11+
jobs:
12+
build:
13+
uses: andrewdyer/github-workflows/.github/workflows/build.yml@main
14+
15+
test:
16+
uses: andrewdyer/github-workflows/.github/workflows/test.yml@main
17+
needs: build
18+
19+
typecheck:
20+
uses: andrewdyer/github-workflows/.github/workflows/type-check.yml@main
21+
needs: build

‎.github/workflows/publish.yml‎

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,23 @@
11
name: Publish Package to npmjs
22

33
on:
4-
release:
5-
types: [published]
4+
release:
5+
types: [published]
66

77
jobs:
8-
build:
9-
runs-on: ubuntu-latest
10-
permissions:
11-
contents: read
12-
id-token: write
13-
steps:
14-
- name: Checkout code
15-
uses: actions/checkout@v4
8+
build:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
contents: read
12+
id-token: write
13+
steps:
14+
- name: Checkout code
15+
uses: actions/checkout@v4
1616

17-
- name: Set up Node.js
18-
uses: actions/setup-node@v4
19-
with:
20-
node-version: '18'
21-
registry-url: 'https://registry.npmjs.org/'
17+
- name: Prepare repository
18+
uses: andrewdyer/github-workflows/.github/actions/prepare-node@main
2219

23-
- name: Install dependencies
24-
run: npm ci
25-
26-
- name: Publish package
27-
run: npm publish --provenance --access public
28-
env:
29-
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
20+
- name: Publish package
21+
run: npm publish --provenance --access public
22+
env:
23+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

‎.gitignore‎

Lines changed: 53 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,58 @@
1+
# compiled output
2+
/dist
13
/node_modules
4+
/build
5+
/storybook-static
6+
7+
# Logs
8+
logs
9+
*.log
10+
npm-debug.log*
11+
pnpm-debug.log*
12+
yarn-debug.log*
13+
yarn-error.log*
14+
lerna-debug.log*
15+
*storybook.log
216

17+
# OS
18+
.DS_Store
19+
20+
# Tests
321
/coverage
22+
/.nyc_output
423

5-
/dist
24+
# IDEs and editors
25+
/.idea
26+
.project
27+
.classpath
28+
.c9/
29+
*.launch
30+
.settings/
31+
*.sublime-workspace
32+
33+
# IDE - VSCode
34+
.vscode/*
35+
!.vscode/settings.json
36+
!.vscode/tasks.json
37+
!.vscode/launch.json
38+
!.vscode/extensions.json
39+
40+
# dotenv environment variable files
41+
.env
42+
.env.development.local
43+
.env.test.local
44+
.env.production.local
45+
.env.local
46+
47+
# temp directory
48+
.temp
49+
.tmp
50+
51+
# Runtime data
52+
pids
53+
*.pid
54+
*.seed
55+
*.pid.lock
656

7-
*storybook.log
57+
# Diagnostic reports (https://nodejs.org/api/report.html)
58+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

‎.husky/pre-commit‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
npm run format && npm run type-check && npm test

‎.nvmrc‎

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

‎.storybook/main.ts‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
import type { StorybookConfig } from '@storybook/react-webpack5';
22

33
const config: StorybookConfig = {
4-
stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
5-
addons: [
6-
'@storybook/addon-webpack5-compiler-swc',
7-
'@storybook/addon-onboarding',
8-
'@storybook/addon-links',
9-
'@storybook/addon-essentials',
10-
'@chromatic-com/storybook',
11-
'@storybook/addon-interactions'
12-
],
13-
framework: {
14-
name: '@storybook/react-webpack5',
15-
options: {}
16-
}
4+
stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
5+
addons: [
6+
'@storybook/addon-webpack5-compiler-swc',
7+
'@storybook/addon-onboarding',
8+
'@storybook/addon-links',
9+
'@storybook/addon-essentials',
10+
'@chromatic-com/storybook',
11+
'@storybook/addon-interactions',
12+
],
13+
framework: {
14+
name: '@storybook/react-webpack5',
15+
options: {},
16+
},
1717
};
1818
export default config;

‎.storybook/preview.ts‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
import type { Preview } from '@storybook/react';
2+
23
import 'bootstrap/dist/css/bootstrap.min.css';
34

45
const preview: Preview = {
5-
parameters: {
6-
controls: {
7-
matchers: {
8-
color: /(background|color)$/i,
9-
date: /Date$/i
10-
}
11-
}
12-
}
6+
parameters: {
7+
controls: {
8+
matchers: {
9+
color: /(background|color)$/i,
10+
date: /Date$/i,
11+
},
12+
},
13+
},
1314
};
1415

1516
export default preview;

‎CODE_OF_CONDUCT.md‎

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

0 commit comments

Comments
 (0)