Merge branch 'main' into chore/add-cross-tool-ai-configs

Author: kimyouknow

.github/CONTRIBUTING.md

@@ -1 +1,45 @@
-# CONTRIBUTING
+# Contributing to react-simplikit
+
+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.
+
+## Contributing Guide
+
+Each contribution requires:
+
+- **Implementation** — following our [Design Principles](https://react-simplikit.slash.page/core/design-principles.html)
+- **Test Code** — 100% coverage required
+- **JSDoc** — documentation is auto-generated from JSDoc, so no separate docs needed
+
+For detailed instructions, see the package-specific guides:
+
+- [Core Package Contributing Guide](../docs/core/contributing.md)
+- [Mobile Package Contributing Guide](../docs/mobile/contributing.md)
+
+## Scaffolding
+
+Use the scaffold command to create a basic structure for new implementations:
+
+```bash
+yarn run scaffold <name> --type <type>
+```
+
+- `type`: `component`, `hook`, or `util` (shortcuts: `c`, `h`, `u`)
+- `name`: Name of the implementation
+
+## Creating a Changeset
+
+When your changes affect a package, create a changeset:
+
+```bash
+yarn changeset
+```
+
+Select the version bump type (`patch`, `minor`, or `major`).
+
+> **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.
+
+## Useful Links
+
+- [Documentation Site](https://react-simplikit.slash.page)
+- [Design Principles](https://react-simplikit.slash.page/core/design-principles.html)
+- [Discord](https://discord.gg/vGXbVjP2nY)

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'weekly'
+    groups:
+      github-actions:
+        patterns:
+          - '*'

.github/workflows/compressed-size.yml

@@ -7,19 +7,20 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v5
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Enable Corepack
         run: corepack enable
 
       - name: Set up Node.js
-        uses: actions/setup-node@v6
+        uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
         with:
           node-version-file: '.nvmrc'
           cache: 'yarn'
 
       - name: Check bundle size
-        uses: preactjs/compressed-size-action@v2
+        uses: preactjs/compressed-size-action@8518045ed95e94e971b83333085e1cb99aa18aa8 # v2.9.0
         with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
           build-script: 'prepack'
           pattern: './{dist,esm}/**/*.{js,cjs}'

.github/workflows/integration.yml

@@ -17,13 +17,13 @@ jobs:
         command: ['format', 'lint', 'type', 'spec']
     steps:
       - name: Checkout code
-        uses: actions/checkout@v5
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Enable Corepack
         run: corepack enable
 
       - name: Set up Node.js
-        uses: actions/setup-node@v6
+        uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
         with:
           node-version-file: '.nvmrc'
           cache: 'yarn'
@@ -41,20 +41,20 @@ jobs:
       changed_files: ${{ steps.filter.outputs.changed_files }}
     steps:
       - name: Checkout code
-        uses: actions/checkout@v5
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Enable Corepack
         run: corepack enable
 
       - name: Set up Node.js
-        uses: actions/setup-node@v6
+        uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
         with:
           node-version-file: '.nvmrc'
           cache: 'yarn'
 
       - name: Check for changes in .ts and .tsx files
         id: filter
-        uses: dorny/paths-filter@v3
+        uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
         with:
           list-files: shell
           filters: |
@@ -73,13 +73,13 @@ jobs:
     if: ${{ needs.check-changes.outputs.changed == 'true' }}
     steps:
       - name: Checkout code
-        uses: actions/checkout@v5
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Enable Corepack
         run: corepack enable
 
       - name: Set up Node.js
-        uses: actions/setup-node@v6
+        uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
         with:
           node-version-file: '.nvmrc'
           cache: 'yarn'
@@ -91,7 +91,7 @@ jobs:
         run: yarn run test:coverage
 
       - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v5
+        uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5.5.2
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
 
@@ -156,7 +156,7 @@ jobs:
     if: ${{ needs.check-changes.outputs.changed == 'true' }}
     steps:
       - name: Checkout code
-        uses: actions/checkout@v5
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Check for JSDoc comments
         run: |
@@ -196,13 +196,13 @@ jobs:
     if: ${{ needs.check-changes.outputs.changed == 'true' }}
     steps:
       - name: Checkout code
-        uses: actions/checkout@v5
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Enable Corepack
         run: corepack enable
 
       - name: Set up Node.js
-        uses: actions/setup-node@v6
+        uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
         with:
           node-version-file: '.nvmrc'
           cache: 'yarn'
@@ -265,7 +265,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v5
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Check exports
         run: |

.github/workflows/release.yml

@@ -15,13 +15,13 @@ jobs:
       id-token: write
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Enable Corepack
         run: corepack enable
 
       - name: Install Node.js
-        uses: actions/setup-node@v6
+        uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
         with:
           node-version-file: '.nvmrc'
           cache: 'yarn'
@@ -41,7 +41,7 @@ jobs:
 
       - name: Create Release Pull Request
         id: changesets
-        uses: changesets/action@v1
+        uses: changesets/action@6a0a831ff30acef54f2c6aa1cbbc1096b066edaf # v1.7.0
         with:
           title: 'chore: version packages'
           commit: 'chore: version packages'
@@ -61,7 +61,7 @@ jobs:
       result: ${{ steps.diffs.outputs.result }}
     steps:
       - name: Checkout code
-        uses: actions/checkout@v5
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           fetch-depth: 0
 
@@ -80,13 +80,13 @@ jobs:
     if: ${{ needs.get-diffs.outputs.result != '' }}
     steps:
       - name: Checkout code
-        uses: actions/checkout@v5
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Enable Corepack
         run: corepack enable
 
       - name: Set up Node.js
-        uses: actions/setup-node@v6
+        uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
         with:
           node-version-file: '.nvmrc'
           cache: 'yarn'
@@ -102,7 +102,7 @@ jobs:
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
 
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v7
+        uses: peter-evans/create-pull-request@c0f553fe549906ede9cf27b5156039d195d2ece0 # v8.1.0
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           branch: new-docgen-branch-${{ github.run_id }}

.gitignore

@@ -35,9 +35,14 @@ coverage
 
 .DS_Store
 
-# claude
-.claude
-CLAUDE.md
+# Claude Code - public files are committed (.claude/skills/, .claude/agents/, CLAUDE.md)
+# Private/personal files:
+.claude/settings.local.json
+.claude/memory/
+.claude/plans/
+.claude/skills/project-decisions/
+# Session notes (contain internal references)
+.claude/*.md
 
 # context files (session notes, etc.)
 context/

.scripts/commands/generateDocs/index.ts

@@ -40,6 +40,17 @@ export async function generateDocs(names: string[]) {
                     ctx.docSource = docSource;
                   },
                 },
+                {
+                  title: `Write English document`,
+                  task: async ctx => {
+                    const { docSource } = ctx;
+                    const dirname = path.dirname(sourceFilePath);
+
+                    if (docSource != null) {
+                      await fs.writeFile(`${dirname}/${name}.md`, docSource);
+                    }
+                  },
+                },
                 {
                   title: `Translate markdown to Korean`,
                   task: async ctx => {
@@ -48,37 +59,45 @@ export async function generateDocs(names: string[]) {
 
                     let isFileExists = false;
                     try {
-                      await fs.access(`${dirname}/${name}.md`);
                       await fs.access(`${dirname}/ko/${name}.md`);
                       isFileExists = true;
                     } catch {
                       isFileExists = false;
                     }
 
-                    if (isFileExists && (await fs.readFile(`${dirname}/${name}.md`)).toString() === docSource) {
-                      return;
+                    // Skip if Korean file already exists and English file hasn't changed
+                    if (isFileExists) {
+                      try {
+                        const existingEnglish = await fs.readFile(`${dirname}/${name}.md`, 'utf-8');
+                        if (existingEnglish === docSource) {
+                          return;
+                        }
+                      } catch {
+                        // Continue with translation if we can't read existing file
+                      }
                     }
 
                     if (docSource == null) {
                       throw new Error('docSource is not found');
                     }
 
-                    const translatedDoc = await translate(docSource);
-
-                    ctx.translatedDoc = translatedDoc;
+                    try {
+                      const translatedDoc = await translate(docSource);
+                      ctx.translatedDoc = translatedDoc;
+                    } catch (error) {
+                      // Log the error but don't fail the task - English doc is already saved
+                      console.warn(`Translation failed for ${name}: ${error instanceof Error ? error.message : error}`);
+                      ctx.translatedDoc = null;
+                    }
                   },
                 },
                 {
-                  title: `Write document files`,
+                  title: `Write Korean document`,
+                  skip: ctx => ctx.translatedDoc == null,
                   task: async ctx => {
-                    const { docSource, translatedDoc } = ctx;
-
+                    const { translatedDoc } = ctx;
                     const dirname = path.dirname(sourceFilePath);
 
-                    if (docSource != null) {
-                      await fs.writeFile(`${dirname}/${name}.md`, docSource);
-                    }
-
                     if (translatedDoc != null) {
                       await fs.mkdir(`${dirname}/ko`).catch(e => {
                         if (e.code === 'EEXIST') {
@@ -92,7 +111,7 @@ export async function generateDocs(names: string[]) {
                   },
                 },
               ],
-              { concurrent: false, ctx: subCtx }
+              { concurrent: false, ctx: subCtx, exitOnError: false }
             ),
         },
       ]);
@@ -108,7 +127,8 @@ function parseJSDoc(source: string) {
 
   const template = targetComment.tags.find(tag => tag.tag === 'template');
 
-  const description = targetComment.tags.find(tag => tag.tag === 'description')?.description ?? '';
+  const description =
+    targetComment.tags.find(tag => tag.tag === 'description')?.description ?? targetComment.description ?? '';
 
   const params = targetComment.tags.filter(tag => tag.tag === 'param');
 

.scripts/commands/generateDocs/translate.ts

@@ -284,7 +284,7 @@ ${origin}
   `;
 
   const response = await client.chat.completions.create({
-    model: 'gpt-4o',
+    model: 'gpt-3.5-turbo',
     messages: [{ role: 'user', content: prompt }],
     response_format: { type: 'json_object' },
   });

.scripts/index.ts

@@ -1,7 +1,13 @@
-import 'dotenv/config';
+import dotenv from 'dotenv';
+import path from 'path';
 
 import { Command } from 'commander';
 
+import { getRootPath } from './utils/getRootPath.ts';
+
+// Load .env from project root
+dotenv.config({ path: path.join(getRootPath(), '.env') });
+
 import { generateDocs } from './commands/generateDocs/index.ts';
 import { scaffold } from './commands/scaffold/index.ts';
 

.vitepress/config.mts

@@ -51,6 +51,10 @@ export default defineConfig({
     'packages/mobile/src/hooks/:hook/:hook.md': 'mobile/hooks/:hook.md',
     'packages/mobile/src/hooks/:hook/ko/:hook.md': 'ko/mobile/hooks/:hook.md',
 
+    // Mobile utils
+    'packages/mobile/src/utils/:util/:util.md': 'mobile/utils/:util.md',
+    'packages/mobile/src/utils/:util/ko/:util.md': 'ko/mobile/utils/:util.md',
+
     // Mobile keyboardHeight (special case - folder name differs from hook name)
     'packages/mobile/src/hooks/keyboardHeight/useKeyboardHeight.md': 'mobile/hooks/useKeyboardHeight.md',
     'packages/mobile/src/hooks/keyboardHeight/ko/useKeyboardHeight.md': 'ko/mobile/hooks/useKeyboardHeight.md',