@lism-css/cli

Lism UI のコンポーネントソースをプロジェクトに追加する CLI ツールです。

前提条件

• Node.js 18 以上
• lism-css がインストール済みであること

npm install lism-css
# or
pnpm add lism-css

使い方

コンポーネントの追加

pnpm dlx @lism-css/cli add accordion

lism-ui.json が存在しない場合、対話形式でセットアップが始まります。

? フレームワークを選択してください: React
? コンポーネントの出力先ディレクトリ: src/components/ui
? helper の出力先ディレクトリ: src/components/ui/_helper
✔ lism-ui.json を作成しました。

accordion を展開中...
  作成: src/components/ui/Accordion/_style.css
  作成: src/components/ui/Accordion/getProps.js
  ...

複数コンポーネントを追加

pnpm dlx @lism-css/cli add accordion modal tabs

全コンポーネントを追加

pnpm dlx @lism-css/cli add --all

コンポーネント一覧の確認

pnpm dlx @lism-css/cli list

初期設定（init）

lism-ui.json を対話形式で生成します。フレームワーク（React / Astro）や出力先ディレクトリを設定できます。

pnpm dlx @lism-css/cli init

init を実行しなくても、add コマンドの初回実行時に lism-ui.json がなければ自動でセットアップが始まります。事前に設定だけ済ませたい場合に使ってください。

オプション

| オプション | 説明 | |-----------|------| | -o, --overwrite | 既存ファイルを確認なしで上書き | | -a, --all | 全コンポーネントを追加 |

生成されるファイル構成

src/components/ui/
├── _helper/
│   ├── animation.ts
│   └── uuid.js
├── Accordion/
│   ├── _style.css
│   ├── getProps.js
│   ├── setAccordion.js
│   ├── script.js
│   └── react/
│       ├── Accordion.jsx
│       ├── AccIcon.jsx
│       └── index.js
└── Modal/
    ├── _style.css
    ├── ...
    └── react/

lism-ui.json

init 時に生成される設定ファイルです。

{
  "framework": "react",
  "componentsDir": "src/components/ui",
  "helperDir": "src/components/ui/_helper"
}

| フィールド | 説明 | |-----------|------| | framework | "react" または "astro" | | componentsDir | コンポーネントの出力先ディレクトリ | | helperDir | helper ファイルの出力先ディレクトリ |

パッケージが見つからないエラーが出る場合

npm / pnpm の Safe Supply Chain 機能により、公開から間もないパッケージがブロックされる場合があります。

No versions available for @lism-css/cli
ℹ Safe-chain: Some package versions were suppressed due to minimum age requirement.

--safe-chain-skip-minimum-package-age フラグで回避できます。

# npx の場合
npx --safe-chain-skip-minimum-package-age @lism-css/cli add accordion

# pnpm dlx の場合
pnpm --safe-chain-skip-minimum-package-age dlx @lism-css/cli add accordion

この制限はパッケージ公開から一定期間が経過すると自動的に解除されます。

License

MIT