Merge pull request #145 from deflis/llms-txt

llms.txtの追加とREADMEの更新

Author: deflis

CLAUDE.md

@@ -0,0 +1,78 @@
+# CLAUDE.md
+
+返答が必要な場合は、日本語で回答してください。
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Common Development Commands
+
+### Building and Development
+- `pnpm run build` - Build the TypeScript project using tsup
+- `pnpm run build:tsc` - Run TypeScript compiler directly
+- `pnpm run check` - Run all checks (lint, build, test)
+- `pnpm run check:lint` - Run ESLint on source and test files
+- `pnpm run check:build` - Type check without emitting files
+- `pnpm run format` - Auto-fix linting issues with ESLint
+
+### Testing
+- `pnpm run test` - Run tests with Vitest
+- `pnpm vitest run` - Run tests directly with Vitest
+
+### Documentation
+- `pnpm run docs` - Generate TypeDoc documentation
+- `pnpm run docs:clean` - Clean documentation directory
+- `pnpm run docs:typedoc` - Generate documentation with TypeDoc
+
+### Package Management
+- `pnpm install` - Install dependencies (pnpm >= 8 required)
+- `pnpm dlx <command>` - Execute packages directly (used in docs generation)
+
+## Code Architecture
+
+This is a TypeScript library that provides a fluent interface wrapper for the Narou (小説家になろう) developer APIs. The library supports both Node.js (using fetch) and browser environments (using JSONP).
+
+### Core Architecture Components
+
+**Dual Environment Support:**
+- `src/index.ts` - Node.js entry point using `NarouNovelFetch` (fetch-based)
+- `src/index.browser.ts` - Browser entry point using `NarouNovelJsonp` (JSONP-based)
+- Both share common builder patterns and types through `src/index.common.ts`
+
+**Builder Pattern Implementation:**
+- `SearchBuilderBase` - Abstract base class for all search builders
+- `NovelSearchBuilderBase` - Base class for novel-specific search functionality
+- `SearchBuilder` - Main novel search builder
+- `SearchBuilderR18` - R18 novel search builder  
+- `RankingBuilder` - Ranking API builder
+- `UserSearchBuilder` - User search builder
+
+**API Abstraction:**
+- `NarouNovel` (abstract) - Base class defining API contract
+- `NarouNovelFetch` - Node.js implementation using fetch
+- `NarouNovelJsonp` - Browser implementation using JSONP
+
+**API Endpoints Supported:**
+- Novel Search API (`https://api.syosetu.com/novelapi/api/`)
+- R18 Novel API (`https://api.syosetu.com/novel18api/api/`)
+- Ranking API (`https://api.syosetu.com/rank/rankget/`)
+- Ranking History API (`https://api.syosetu.com/rank/rankin/`)
+- User Search API (`https://api.syosetu.com/userapi/api/`)
+
+### Key Design Patterns
+
+**Fluent Interface:** All builders use method chaining for parameter building (e.g., `search("word").genre(Genre.Fantasy).order(Order.New).execute()`)
+
+**Type Safety:** Extensive use of TypeScript generics to ensure type-safe field selection and results
+
+**Dual Export Strategy:** The package exports different entry points for different environments via package.json exports field
+
+### Testing Strategy
+
+Tests use Vitest with MSW (Mock Service Worker) for API mocking. Tests are organized by feature with corresponding `.test.ts` files in the `test/` directory.
+
+## Build Configuration
+
+- **tsup** - Primary build tool configured to output both CJS and ESM formats
+- **TypeScript** - Targets ES2020 with strict mode enabled
+- **ESLint** - Uses TypeScript ESLint configuration with Prettier integration
+- **Package Manager** - Uses pnpm (required >= 8)

README.md

@@ -1,39 +1,74 @@
-# node-narou
+# 📚 node-narou
 
 [![npm version](https://badge.fury.io/js/narou.svg)](https://badge.fury.io/js/narou)
 [![Node.js CI](https://github.com/deflis/node-narou/actions/workflows/nodejs-test.yml/badge.svg)](https://github.com/deflis/node-narou/actions/workflows/nodejs-test.yml)
-
 [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/deflis/node-narou)
 
-[なろうデベロッパー](https://dev.syosetu.com/)の API を fluent interface で利用できるラッパーライブラリです。
-ブラウザでの JSONP の利用も可能です。
+[なろうデベロッパー](https://dev.syosetu.com/)の API を fluent interface で利用できる TypeScript ライブラリです。  
+A TypeScript wrapper library for Narou Developer APIs with fluent interface.
 
-以下の API をラップしています。
+## ✨ 特徴
 
-- [なろう小説 API](https://dev.syosetu.com/man/api/)
-- [なろう小説ランキング API](https://dev.syosetu.com/man/rankapi/)
-- [なろう殿堂入り API](https://dev.syosetu.com/man/rankinapi/)
-- [なろう R18 小説 API](https://dev.syosetu.com/xman/api/)
+- 🔗 **メソッドチェーン対応**: 直感的な fluent interface で API を操作
+- 🌐 **マルチ環境対応**: Node.js とブラウザの両方で動作
+- 📝 **TypeScript 完全対応**: 型安全性と IntelliSense サポート
+- 🔀 **デュアル実装**: fetch (Node.js) と JSONP (ブラウザ) を自動選択
+- 📚 **全 API カバー**: なろうデベロッパーの全 API に対応
 
-## Installation
+## 🚀 対応 API
 
-以下のコマンドでインストールできます。
+| API | 説明 | 関数 |
+|-----|------|------|
+| [なろう小説 API](https://dev.syosetu.com/man/api/) | 小説の検索・絞り込み | `search()` |
+| [なろう小説ランキング API](https://dev.syosetu.com/man/rankapi/) | ランキング取得 | `ranking()` |
+| [なろう殿堂入り API](https://dev.syosetu.com/man/rankinapi/) | ランキング履歴取得 | `rankingHistory()` |
+| [なろう R18 小説 API](https://dev.syosetu.com/xman/api/) | 18禁小説検索 | `searchR18()` |
+| [なろうユーザ検索 API](https://dev.syosetu.com/man/userapi/) | ユーザー検索 | `searchUser()` |
 
-```
+## 📦 インストール
+
+```bash
+# 推奨: pnpm
+pnpm add narou
+
+# または
 npm install narou
+yarn add narou
+```
+
+## 🚀 クイックスタート
+
+### Node.js での使用
+
+```typescript
+import { search, ranking } from "narou";
+import { Genre, Order, RankingType } from "narou";
+
+// 異世界恋愛小説を検索
+const result = await search("異世界")
+  .genre(Genre.RenaiIsekai)
+  .order(Order.FavoriteNovelCount)
+  .limit(10)
+  .execute();
+
+console.log(`${result.allcount}件の小説が見つかりました`);
 ```
 
-## Usage - API
+### ブラウザでの使用
 
-https://deflis.github.io/node-narou/ を参照してください。
+```typescript
+// ブラウザでは専用のインポートを使用（JSONP対応）
+import { search } from "narou/browser";
 
-ブラウザで利用したい場合 `narou/browser` をimportしてください。こちらを利用することで自動的にfetch(nodejs)への依存がなくなり、JSONPを利用するようになります。
+const result = await search("魔法").execute();
+```
 
-すでにサポート終了していますがfetchをサポートしないNode.jsバージョンで利用する場合は 、 `NarouNovelFetch` にfetchのNode.js実装を渡してください。
-なお、その場合の動作は確認していないので動かなければIssueを立ててください。
+## 📖 詳細な API ドキュメント
 
+- **🔗 [完全な API ドキュメント](https://deflis.github.io/node-narou/)** - TypeDoc で生成された詳細なドキュメント
+- **🤖 [LLM 向けドキュメント](https://deflis.github.io/node-narou/llms.txt)** - AI/LLM が理解しやすい形式のドキュメント（TypeDoc JSON から自動生成）
 
-## Example
+## 📝 使用例
 
 ```typescript
 import { search, ranking, rankingHistory, searchR18 } from "narou";
@@ -113,32 +148,35 @@ for (const novel of searchR18Result.values) {
 }
 ```
 
-## Development
-
-```
-
-# watch
+## 🛠️ 開発
 
-npm run watch
+このプロジェクトでは pnpm を使用しています。
 
-# build
+```bash
+# 依存関係のインストール
+pnpm install
 
-npm run build
+# ビルド
+pnpm run build
 
-# test
+# テスト実行
+pnpm run test
 
-npm run test
+# 型チェック
+pnpm run check
 
+# ドキュメント生成（TypeDoc + llms.txt）
+pnpm run docs
 ```
 
-## Contributing
+## 🤝 コントリビューション
 
-1. Fork it!
-2. Create your feature branch: `git checkout -b my-new-feature`
-3. Commit your changes: `git commit -am 'Add some feature'`
-4. Push to the branch: `git push origin my-new-feature`
-5. Submit a pull request :D
+1. このリポジトリをフォーク
+2. フィーチャーブランチを作成: `git checkout -b my-new-feature`
+3. 変更をコミット: `git commit -am 'Add some feature'`
+4. ブランチにプッシュ: `git push origin my-new-feature`
+5. プルリクエストを作成
 
-## License
+## 📄 ライセンス
 
-MIT
+MIT License - 詳細は [LICENSE](LICENSE) ファイルを参照してください。

package.json

@@ -59,9 +59,11 @@
     "prepack": "run-z format build",
     "format": "eslint --fix src/** test/**",
     "test": "vitest run",
-    "docs": "run-z docs:clean docs:typedoc",
+    "docs": "run-z docs:clean docs:typedoc docs:json docs:llms",
     "docs:clean": "pnpm dlx rimraf docs",
-    "docs:typedoc": "pnpm dlx typedoc --out ./docs src/index.ts"
+    "docs:typedoc": "pnpm dlx typedoc --out ./docs src/index.ts",
+    "docs:json": "pnpm dlx typedoc --json docs/api.json src/index.ts",
+    "docs:llms": "node scripts/generate-llms-txt.js"
   },
   "devDependencies": {
     "@swc/core": "^1.11.29",