Skip to content

Commit dc49038

Browse files
author
Mark Skelton
committed
Major updates
1 parent d5abb6d commit dc49038

25 files changed

+7115
-14775
lines changed

‎.changeset/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Changesets
2+
3+
Hello and welcome! This folder has been automatically generated by
4+
`@changesets/cli`, a build tool that works with multi-package repos, or
5+
single-package repos to help you version and publish your code. You can find the
6+
full documentation for it
7+
[in our repository](https://github.com/changesets/changesets)
8+
9+
We have a quick list of common questions to get you started engaging with this
10+
project in
11+
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

‎.changeset/config.json

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
3+
"changelog": "@changesets/cli/changelog",
4+
"commit": false,
5+
"linked": [],
6+
"access": "public",
7+
"baseBranch": "main",
8+
"updateInternalDependencies": "patch",
9+
"ignore": []
10+
}

‎.eslintignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
lib/

‎.eslintrc

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"extends": ["widen", "widen/typescript"]
3+
}

‎.github/CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @Widen/frontend-services

‎.github/workflows/build.yml

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Build
2+
on: [push]
3+
jobs:
4+
lint:
5+
runs-on: ubuntu-latest
6+
steps:
7+
- uses: mskelton/setup-yarn@v1
8+
- run: yarn lint
9+
- run: yarn prettier --check .
10+
ts:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: mskelton/setup-yarn@v1
14+
- run: yarn ts
15+
test:
16+
runs-on: ubuntu-latest
17+
strategy:
18+
matrix:
19+
node-version: [14.x, 16.x]
20+
steps:
21+
- uses: mskelton/setup-yarn@v1
22+
with:
23+
node-version: ${{ matrix.node-version }}
24+
- run: yarn lint
25+
- run: yarn prettier --check .
26+
- run: yarn tsc --noEmit
27+
- run: yarn test
28+
release:
29+
needs: [lint, ts, test]
30+
runs-on: ubuntu-latest
31+
if: ${{ github.ref == 'refs/heads/main' }}
32+
steps:
33+
- uses: actions/checkout@v2
34+
with:
35+
fetch-depth: 0
36+
- uses: actions/setup-node@v2
37+
with:
38+
node-version: 16.x
39+
cache: yarn
40+
- run: yarn install --immutable
41+
- name: Create release pull request or publish to npm
42+
uses: changesets/action@v1
43+
with:
44+
publish: yarn release
45+
env:
46+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
47+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

‎.github/workflows/format.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Format
2+
on:
3+
pull_request:
4+
branches: [main]
5+
jobs:
6+
test:
7+
runs-on: ubuntu-latest
8+
if: ${{ github.repository == 'Widen/i18next-print-keys' }}
9+
steps:
10+
- uses: actions/checkout@v2
11+
- uses: actions/setup-node@v1
12+
with:
13+
node-version: 16.x
14+
- run: yarn install --immutable
15+
- run: yarn prettier --write .
16+
- name: Commit changes
17+
uses: stefanzweifel/git-auto-commit-action@v4
18+
with:
19+
commit_message: Apply formatting changes
20+
branch: ${{ github.head_ref }}

‎.gitignore

+9-112
Original file line numberDiff line numberDiff line change
@@ -1,113 +1,10 @@
1-
# Created by https://www.gitignore.io/api/osx,node,linux
2-
3-
### Linux ###
4-
*~
5-
6-
# temporary files which can be created if a process still has a handle open of a deleted file
7-
.fuse_hidden*
8-
9-
# KDE directory preferences
10-
.directory
11-
12-
# Linux trash folder which might appear on any partition or disk
13-
.Trash-*
14-
15-
# .nfs files are created when an open file is removed but is still being accessed
16-
.nfs*
17-
18-
### Node ###
19-
# Logs
20-
logs
21-
*.log
22-
npm-debug.log*
23-
yarn-debug.log*
24-
yarn-error.log*
25-
26-
# Runtime data
27-
pids
28-
*.pid
29-
*.seed
30-
*.pid.lock
31-
32-
# Directory for instrumented libs generated by jscoverage/JSCover
33-
lib-cov
34-
35-
# Coverage directory used by tools like istanbul
36-
coverage
37-
38-
# nyc test coverage
39-
.nyc_output
40-
41-
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
42-
.grunt
43-
44-
# Bower dependency directory (https://bower.io/)
45-
bower_components
46-
47-
# node-waf configuration
48-
.lock-wscript
49-
50-
# Compiled binary addons (http://nodejs.org/api/addons.html)
51-
build/Release
52-
53-
# Dependency directories
1+
.vscode/
542
node_modules/
55-
jspm_packages/
56-
57-
# Typescript v1 declaration files
58-
typings/
59-
60-
# Optional npm cache directory
61-
.npm
62-
63-
# Optional eslint cache
64-
.eslintcache
65-
66-
# Optional REPL history
67-
.node_repl_history
68-
69-
# Output of 'npm pack'
70-
*.tgz
71-
72-
# Yarn Integrity file
73-
.yarn-integrity
74-
75-
# dotenv environment variables file
76-
.env
77-
78-
### OSX ###
79-
*.DS_Store
80-
.AppleDouble
81-
.LSOverride
82-
83-
# Icon must end with two \r
84-
Icon
85-
86-
# Thumbnails
87-
._*
88-
89-
# Files that might appear in the root of a volume
90-
.DocumentRevisions-V100
91-
.fseventsd
92-
.Spotlight-V100
93-
.TemporaryItems
94-
.Trashes
95-
.VolumeIcon.icns
96-
.com.apple.timemachine.donotpresent
97-
98-
# Directories potentially created on remote AFP share
99-
.AppleDB
100-
.AppleDesktop
101-
Network Trash Folder
102-
Temporary Items
103-
.apdisk
104-
105-
106-
# End of https://www.gitignore.io/api/osx,node,linux
107-
108-
dist/
109-
build/
110-
.idea
111-
112-
# test output
113-
artifacts/
3+
lib/
4+
5+
# Yarn
6+
.yarn/*
7+
!.yarn/releases
8+
!.yarn/plugins
9+
!.yarn/sdks
10+
!.yarn/versions

‎.npmignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
lib/config/
2+
test/

‎.prettierignore

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Yarn auto-generated files
2+
.yarn/
3+
.yarnrc.yml
4+
5+
# Changelogs are managed by changesets
6+
CHANGELOG.md
7+
8+
# Misc
9+
lib/
10+
test-results/

‎.prettierrc

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"semi": false,
3+
"singleQuote": true
4+
}

‎.prettierrc.js

-7
This file was deleted.

‎.yarn/releases/yarn-3.2.0.cjs

+785
Large diffs are not rendered by default.

‎.yarnrc.yml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
nodeLinker: node-modules
2+
3+
yarnPath: .yarn/releases/yarn-3.2.0.cjs

‎CODE_OF_CONDUCT.md

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

‎CONTRIBUTING.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing
2+
3+
We'd love to accept your patches and contributions to this project. There are
4+
just a few small guidelines you need to follow.
5+
6+
## Code reviews
7+
8+
All submissions, including submissions by project members, require review. We
9+
use GitHub pull requests for this purpose. Consult
10+
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
11+
information on using pull requests.
12+
13+
### Tips
14+
15+
- Smaller changes are easier to review
16+
- Give the PR a meaningful title and description with context surrounding the
17+
changes
18+
- To close an issue automatically after a PR is merged, use keywords "fix",
19+
"close", or "resolve" in the PR description, e.g. fix #1337.
20+
21+
## Changesets
22+
23+
This project uses [changesets](https://github.com/atlassian/changesets) for
24+
versioning and publishing packages. Changesets allows contributors to specify
25+
how changes should be released without having to manually edit changelogs or
26+
package.json files.
27+
28+
When making a change that requires a release, run the `yarn changeset` command
29+
and follow the prompts to specify the semver bump and the change notes.
30+
31+
```sh
32+
yarn changeset
33+
```
34+
35+
After running this command, a new markdown file will be created in the
36+
`.changeset` folder. These files should be pushed to your branch and if you make
37+
a mistake, you can amend them at any time.

0 commit comments

Comments
 (0)