create-jskim

JSKim プロジェクトを作成する scaffold CLI です。

Package 名は create-jskim です。npm registry で公開済みです。生成されるプロジェクトの engine dependency は @ywal123456/jskim です。

使い方

推奨:

npm create jskim@latest

他の package manager:

pnpm create jskim
yarn create jskim

代替:

npx create-jskim my-project

必要に応じて:

npm install --global create-jskim
create-jskim my-project

ディレクトリ名を省略すると、プロジェクト名を尋ねます。空のまま Enter すると既定値 jskim-project を使います。

生成完了後の案内は、実行した package manager に合わせた install / setup / dev コマンドを表示します。検知できない実行方法では npm コマンドが表示されることがあります。

ヘルプ / バージョン

create-jskim --help
create-jskim --version

生成されるファイル

project/
├─ package.json
├─ jskim.config.js
├─ README.md
├─ .gitignore
├─ src/
│  └─ sample/
│     ├─ pages/
│     │  ├─ index.html.njk
│     │  ├─ dashboard/
│     │  ├─ crud/
│     │  ├─ wizard/
│     │  └─ assets/
│     ├─ layouts/base.njk
│     └─ components/
└─ spec/
   └─ sample/          # Screen Spec 用の初期データ / リソース

生成プロジェクトは次を devDependencies に持ちます。

• @ywal123456/jskim（^0.10.0）
• @ywal123456/jskim-screen-spec（^0.5.0）
• playwright（companion と同じ ^1.52.0）

scripts の実行名は binary jskim のままです。加えて Screen Spec 用の spec:setup / spec:collect / spec:build / spec:dev が入ります。

spec/sample は Screen Spec（画面設計書）用の初期データとリソースです。Chromium は容量が大きいため、install や postinstall では自動ダウンロードしません。初回だけ spec:setup を実行してください。

インストール後の公式ユーザーガイド PDF は、生成 project が入れる @ywal123456/jskim package の docs/ 配下で確認できます（creator package 本体には PDF を含めません）。

標準 sample は公式の静的 UI sample（Portal / Dashboard / CRUD / Wizard）です。application 処理は含みません。pages 配下の .html.njk はレンダリングされ、平文 CSS や画像はそのままコピーされます。

生成後の手順

生成器は 自動で npm install や git init を実行しません。完了案内に表示されたコマンドを実行してください。

例（pnpm で create した場合）:

pnpm create jskim sample-project
cd sample-project
pnpm install
pnpm run spec:setup
pnpm run dev

推奨の開発入口（通常開発 + 画面設計書）:

pnpm run dev

/ が実装画面、/spec/ が画面設計書 Viewer です。Screen Spec 専用の厳密実行は pnpm run spec:dev のまま使えます。

例（npm で create した場合）:

cd my-project
npm install
npm run spec:setup
npm run dev

例（yarn で create した場合）:

cd my-project
yarn install
yarn spec:setup
yarn dev

spec:setup は初回だけ必要です（Chromium のダウンロードが発生します）。 companion が無い既存プロジェクトでは dev は従来どおり通常開発のみです。

pnpm が ignored build scripts を警告した場合のみ、pnpm approve-builds を実行し、Space で必要な package を選んで Enter で確定してください。

既定の開発サーバー URL:

http://127.0.0.1:3000/

制限と代替運用は、インストール後の @ywal123456/jskim に同梱されるユーザーガイドの「制限事項」、またはリポジトリの docs/user-guide/14-limitations.md を参照してください。

安全ポリシー

• 空ではない既存ディレクトリには書き込みません（上書きなし）
• 隠しファイルがある場合も「空ではない」とみなします
• 生成失敗時は、今回作った部分だけを片付けます

リポジトリ

• Repository: https://github.com/ywal123456-collab/jskim/tree/main/create-jskim
• Issues: https://github.com/ywal123456-collab/jskim/issues

ライセンス

create-jskim は MIT License のもとで提供されます。詳細は LICENSE を確認してください。

生成されるユーザープロジェクトの License はユーザー側で決定してください。このツールの MIT License を生成プロジェクトへ強制しません。