Skip to content

Commit 355077d

Browse files
committed
Merge remote-tracking branch 'origin/main' into docs/README-add-toss-logo
# Conflicts: # README.md
2 parents e6fee59 + 2b5f92c commit 355077d

572 files changed

Lines changed: 25085 additions & 774 deletions

File tree

Some content is hidden

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

.changeset/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@
77
"access": "public",
88
"baseBranch": "main",
99
"updateInternalDependencies": "patch",
10-
"ignore": []
10+
"ignore": ["with-vite", "with-nextjs", "@examples/shared"]
1111
}

.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
* @kimyouknow
1+
* @kimyouknow @zztnrudzz13

.github/CONTRIBUTING.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,45 @@
1-
# CONTRIBUTING
1+
# Contributing to react-simplikit
2+
3+
Welcome! We appreciate your interest in contributing to react-simplikit. This document provides an overview of how to contribute. For detailed guidelines, please refer to the package-specific contributing guides linked below.
4+
5+
## Contributing Guide
6+
7+
Each contribution requires:
8+
9+
- **Implementation** — following our [Design Principles](https://react-simplikit.slash.page/core/design-principles.html)
10+
- **Test Code** — 100% coverage required
11+
- **JSDoc** — documentation is auto-generated from JSDoc, so no separate docs needed
12+
13+
For detailed instructions, see the package-specific guides:
14+
15+
- [Core Package Contributing Guide](../docs/core/contributing.md)
16+
- [Mobile Package Contributing Guide](../docs/mobile/contributing.md)
17+
18+
## Scaffolding
19+
20+
Use the scaffold command to create a basic structure for new implementations:
21+
22+
```bash
23+
yarn run scaffold <name> --type <type>
24+
```
25+
26+
- `type`: `component`, `hook`, or `util` (shortcuts: `c`, `h`, `u`)
27+
- `name`: Name of the implementation
28+
29+
## Creating a Changeset
30+
31+
When your changes affect a package, create a changeset:
32+
33+
```bash
34+
yarn changeset
35+
```
36+
37+
Select the version bump type (`patch`, `minor`, or `major`).
38+
39+
> **Note:** Both packages are currently in the `0.0.x` stage. During this phase, most changes should use `patch`. If you're unsure about the version type, please discuss with the maintainers.
40+
41+
## Useful Links
42+
43+
- [Documentation Site](https://react-simplikit.slash.page)
44+
- [Design Principles](https://react-simplikit.slash.page/core/design-principles.html)
45+
- [Discord](https://discord.gg/vGXbVjP2nY)

.github/dependabot.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: 'github-actions'
4+
directory: '/'
5+
schedule:
6+
interval: 'weekly'
7+
groups:
8+
github-actions:
9+
patterns:
10+
- '*'

.github/workflows/compressed-size.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,20 @@ jobs:
77
runs-on: ubuntu-latest
88
steps:
99
- name: Checkout code
10-
uses: actions/checkout@v4
10+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
1111

1212
- name: Enable Corepack
1313
run: corepack enable
1414

1515
- name: Set up Node.js
16-
uses: actions/setup-node@v4
16+
uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
1717
with:
1818
node-version-file: '.nvmrc'
1919
cache: 'yarn'
2020

2121
- name: Check bundle size
22-
uses: preactjs/compressed-size-action@v2
22+
uses: preactjs/compressed-size-action@8518045ed95e94e971b83333085e1cb99aa18aa8 # v2.9.0
2323
with:
24+
repo-token: ${{ secrets.GITHUB_TOKEN }}
2425
build-script: 'prepack'
2526
pattern: './{dist,esm}/**/*.{js,cjs}'

.github/workflows/integration.yml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ jobs:
1717
command: ['format', 'lint', 'type', 'spec']
1818
steps:
1919
- name: Checkout code
20-
uses: actions/checkout@v4
20+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
2121

2222
- name: Enable Corepack
2323
run: corepack enable
2424

2525
- name: Set up Node.js
26-
uses: actions/setup-node@v4
26+
uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
2727
with:
2828
node-version-file: '.nvmrc'
2929
cache: 'yarn'
@@ -41,20 +41,20 @@ jobs:
4141
changed_files: ${{ steps.filter.outputs.changed_files }}
4242
steps:
4343
- name: Checkout code
44-
uses: actions/checkout@v4
44+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
4545

4646
- name: Enable Corepack
4747
run: corepack enable
4848

4949
- name: Set up Node.js
50-
uses: actions/setup-node@v4
50+
uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
5151
with:
5252
node-version-file: '.nvmrc'
5353
cache: 'yarn'
5454

5555
- name: Check for changes in .ts and .tsx files
5656
id: filter
57-
uses: dorny/paths-filter@v3
57+
uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
5858
with:
5959
list-files: shell
6060
filters: |
@@ -73,13 +73,13 @@ jobs:
7373
if: ${{ needs.check-changes.outputs.changed == 'true' }}
7474
steps:
7575
- name: Checkout code
76-
uses: actions/checkout@v4
76+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
7777

7878
- name: Enable Corepack
7979
run: corepack enable
8080

8181
- name: Set up Node.js
82-
uses: actions/setup-node@v4
82+
uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
8383
with:
8484
node-version-file: '.nvmrc'
8585
cache: 'yarn'
@@ -91,7 +91,7 @@ jobs:
9191
run: yarn run test:coverage
9292

9393
- name: Upload coverage reports to Codecov
94-
uses: codecov/codecov-action@v5
94+
uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5.5.2
9595
with:
9696
token: ${{ secrets.CODECOV_TOKEN }}
9797

@@ -156,7 +156,7 @@ jobs:
156156
if: ${{ needs.check-changes.outputs.changed == 'true' }}
157157
steps:
158158
- name: Checkout code
159-
uses: actions/checkout@v4
159+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
160160

161161
- name: Check for JSDoc comments
162162
run: |
@@ -196,13 +196,13 @@ jobs:
196196
if: ${{ needs.check-changes.outputs.changed == 'true' }}
197197
steps:
198198
- name: Checkout code
199-
uses: actions/checkout@v4
199+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
200200

201201
- name: Enable Corepack
202202
run: corepack enable
203203

204204
- name: Set up Node.js
205-
uses: actions/setup-node@v4
205+
uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
206206
with:
207207
node-version-file: '.nvmrc'
208208
cache: 'yarn'
@@ -265,7 +265,7 @@ jobs:
265265
runs-on: ubuntu-latest
266266
steps:
267267
- name: Checkout code
268-
uses: actions/checkout@v4
268+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
269269

270270
- name: Check exports
271271
run: |

.github/workflows/release.yml

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,35 +15,44 @@ jobs:
1515
id-token: write
1616
steps:
1717
- name: Checkout Repository
18-
uses: actions/checkout@v5
18+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
1919

2020
- name: Enable Corepack
2121
run: corepack enable
2222

2323
- name: Install Node.js
24-
uses: actions/setup-node@v5
24+
uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
2525
with:
2626
node-version-file: '.nvmrc'
2727
cache: 'yarn'
28+
registry-url: 'https://registry.npmjs.org'
29+
30+
- name: Update npm for OIDC trusted publishing
31+
run: npm install -g npm@latest
2832

2933
- name: Install Dependencies
3034
run: yarn install
3135

3236
- name: Build
33-
run: yarn prepack
37+
run: yarn run prepack
3438

3539
- name: Type Check
36-
run: yarn test:type
40+
run: yarn run test:type
3741

38-
- name: Create Release Pull Request or Publish to npm
39-
uses: changesets/action@v1
42+
- name: Create Release Pull Request
43+
id: changesets
44+
uses: changesets/action@6a0a831ff30acef54f2c6aa1cbbc1096b066edaf # v1.7.0
4045
with:
4146
title: 'chore: version packages'
4247
commit: 'chore: version packages'
43-
version: yarn changeset:version
44-
publish: yarn changeset:publish
48+
version: yarn run changeset:version
4549
env:
4650
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
51+
52+
- name: Publish to npm
53+
if: steps.changesets.outputs.hasChangesets == 'false'
54+
run: yarn run changeset:publish
55+
env:
4756
NPM_CONFIG_PROVENANCE: true
4857

4958
get-diffs:
@@ -52,7 +61,7 @@ jobs:
5261
result: ${{ steps.diffs.outputs.result }}
5362
steps:
5463
- name: Checkout code
55-
uses: actions/checkout@v5
64+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
5665
with:
5766
fetch-depth: 0
5867

@@ -71,13 +80,13 @@ jobs:
7180
if: ${{ needs.get-diffs.outputs.result != '' }}
7281
steps:
7382
- name: Checkout code
74-
uses: actions/checkout@v5
83+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
7584

7685
- name: Enable Corepack
7786
run: corepack enable
7887

7988
- name: Set up Node.js
80-
uses: actions/setup-node@v5
89+
uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
8190
with:
8291
node-version-file: '.nvmrc'
8392
cache: 'yarn'
@@ -93,12 +102,12 @@ jobs:
93102
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
94103

95104
- name: Create Pull Request
96-
uses: peter-evans/create-pull-request@v7
105+
uses: peter-evans/create-pull-request@c0f553fe549906ede9cf27b5156039d195d2ece0 # v8.1.0
97106
with:
98107
token: ${{ secrets.GITHUB_TOKEN }}
99108
branch: new-docgen-branch-${{ github.run_id }}
100109
title: 'docs(${{ needs.get-diffs.outputs.result }}): auto-generated docs'
101110
body: 'This PR includes documentation updates for: ${{ needs.get-diffs.outputs.result }}'
102111
author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
103-
reviewers: kimyouknow
112+
reviewers: kimyouknow,zztnrudzz13
104113
commit-message: 'Generate docs for ${{ needs.get-diffs.outputs.result }}'

.gitignore

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77
!.yarn/sdks
88
!.yarn/versions
99

10+
# large yarn cache files (exceed GitHub 100MB limit)
11+
.yarn/cache/@next-swc-*.zip
12+
.yarn/cache/next-npm-*.zip
13+
1014
# build
1115
dist
1216
esm
@@ -24,6 +28,21 @@ coverage
2428
.vitepress/cache
2529
.vitepress/dist
2630

31+
# next
32+
.next
33+
2734
.env
2835

2936
.DS_Store
37+
38+
# Claude Code - public files are committed (.claude/skills/, .claude/agents/, CLAUDE.md)
39+
# Private/personal files:
40+
.claude/settings.local.json
41+
.claude/memory/
42+
.claude/plans/
43+
.claude/skills/project-decisions/
44+
# Session notes (contain internal references)
45+
.claude/*.md
46+
47+
# context files (session notes, etc.)
48+
context/

.npmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
registry=https://registry.npmjs.org/

.nvmrc

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1 @@
1-
lts/iron
2-
3-
# 'iron' is the 20.x node release line
4-
# ESLint requires Node.js >=18.18.0, >=20.9.0, or >=21.1.0 — ensure 20.9.0+ if using iron
5-
# See: https://eslint.org/docs/latest/use/getting-started#prerequisites
1+
v22.18.0

0 commit comments

Comments
 (0)