From be08e4535c52a369ea51491b71e251569efd1f30 Mon Sep 17 00:00:00 2001 From: takuma-ru Date: Wed, 24 Jan 2024 13:28:41 +0900 Subject: [PATCH 1/4] =?UTF-8?q?=F0=9F=94=A7=20type=20check=20=E7=94=A8?= =?UTF-8?q?=E3=81=AE=E8=A8=AD=E5=AE=9A=E3=82=92=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages/auto-story-generator/.eslintignore | 2 ++ packages/auto-story-generator/package.json | 2 +- packages/auto-story-generator/tsconfig.json | 3 ++- 3 files changed, 5 insertions(+), 2 deletions(-) create mode 100644 packages/auto-story-generator/.eslintignore diff --git a/packages/auto-story-generator/.eslintignore b/packages/auto-story-generator/.eslintignore new file mode 100644 index 0000000..5d1ae1f --- /dev/null +++ b/packages/auto-story-generator/.eslintignore @@ -0,0 +1,2 @@ +dist/* +node_modules \ No newline at end of file diff --git a/packages/auto-story-generator/package.json b/packages/auto-story-generator/package.json index 5416bfd..39e4916 100644 --- a/packages/auto-story-generator/package.json +++ b/packages/auto-story-generator/package.json @@ -24,7 +24,7 @@ "registry": "https://registry.npmjs.org/" }, "scripts": { - "build": "tsup", + "build": "tsup --dts", "build:watch": "tsup --watch", "lint": "eslint --ext .ts,.js .", "lint:fix": "eslint --ext .ts,.js . --fix", diff --git a/packages/auto-story-generator/tsconfig.json b/packages/auto-story-generator/tsconfig.json index cd8fe35..034d438 100644 --- a/packages/auto-story-generator/tsconfig.json +++ b/packages/auto-story-generator/tsconfig.json @@ -8,6 +8,7 @@ "strict": true, "strictNullChecks": true, "esModuleInterop": true, + "skipLibCheck": true, "paths": { "~/*": ["./*"] } @@ -16,5 +17,5 @@ "esm": true, "experimentalSpecifierResolution": "node" }, - "exclude": ["dist", "eslint.config.js"] + "exclude": ["dist", "eslint.config.js", "../../node_modules"] } From 5fd95b02b27bd882c94b9640403878d6fc401a1f Mon Sep 17 00:00:00 2001 From: takuma-ru Date: Wed, 24 Jan 2024 13:31:17 +0900 Subject: [PATCH 2/4] =?UTF-8?q?=F0=9F=90=9B=20=E3=83=AF=E3=83=BC=E3=82=AF?= =?UTF-8?q?=E3=83=95=E3=83=AD=E3=83=BC=E3=82=A8=E3=83=A9=E3=83=BC=E4=BF=AE?= =?UTF-8?q?=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/pr-check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pr-check.yml b/.github/workflows/pr-check.yml index 1e6453f..e1e359e 100644 --- a/.github/workflows/pr-check.yml +++ b/.github/workflows/pr-check.yml @@ -28,7 +28,7 @@ jobs: name: Install pnpm id: pnpm-install with: - version: 8.9.2 + version: 8.14.1 run_install: false - name: Get pnpm store directory From 2e5122f639ebcc1cec4c076d99e229cf44f0ee2c Mon Sep 17 00:00:00 2001 From: takuma-ru Date: Wed, 24 Jan 2024 13:33:52 +0900 Subject: [PATCH 3/4] =?UTF-8?q?=F0=9F=90=9B=20=E3=83=AF=E3=83=BC=E3=82=AF?= =?UTF-8?q?=E3=83=95=E3=83=AD=E3=83=BC=E3=82=A8=E3=83=A9=E3=83=BC=E4=BF=AE?= =?UTF-8?q?=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- package.json | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/package.json b/package.json index 8c8977d..dd10091 100644 --- a/package.json +++ b/package.json @@ -9,6 +9,12 @@ }, "author": "takuma-ru (https://github.com/takuma-ru/)", "license": "MIT", + "packageManager": "pnpm@8.14.1", + "engines": { + "npm": "use pnpm please!", + "yarn": "use pnpm please!", + "pnpm": ">=8.14.1" + }, "volta": { "node": "20.11.0", "pnpm": "8.14.1" From 8caaf33ae8a7fa1f58cdd299a5743e19444921f3 Mon Sep 17 00:00:00 2001 From: takuma-ru Date: Wed, 24 Jan 2024 16:15:55 +0900 Subject: [PATCH 4/4] Add auto-story-generator configuration for React and update package keywords --- README.md | 42 +++++++++++++++++++++- packages/auto-story-generator/package.json | 14 ++++++-- 2 files changed, 53 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c2b0393..1051792 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,47 @@ Automatic real-time story file generation from React, Vue, and Lit component files ## Getting Started -1. Install the package +### 1. Install the package ```bash npm i @takuma-ru/auto-story-generator ``` + +### 2. Add config +Add settings to main.ts in Storybook (`./storybook/main.ts`) + +For `React`, `Vite` +```ts +import type { StorybookConfig } from "@storybook/react-vite"; + +import { mergeConfig } from "vite"; + +import autoStoryGenerator from "@takuma-ru/auto-story-generator"; + +const config: StorybookConfig = { + viteFinal: async (config) => + mergeConfig(config, { + plugins: [ + autoStoryGenerator.vite({ + preset: "react", + imports: ["**/src/components/**/*.tsx"], + }), + ], + }), +}; + +export default config; +``` + +## Supported Frameworks +> ✅: Supported +> 🚧: Work in progress +> ❌: Not supported +> 📝: Not yet implemented + +| Framework | Supported | +| --------- | --------- | +| React | ✅ | +| Vue | 🚧 | +| Lit | ✅ | +| Angular | ❌ | +| Svelte | 📝 | \ No newline at end of file diff --git a/packages/auto-story-generator/package.json b/packages/auto-story-generator/package.json index 39e4916..e029f5b 100644 --- a/packages/auto-story-generator/package.json +++ b/packages/auto-story-generator/package.json @@ -39,7 +39,17 @@ "publish:patch-beta": "pnpm build && pnpm dlx release-it patch --preRelease=beta --ci", "publish:prerelease": "pnpm build && pnpm dlx release-it prerelease --ci" }, - "keywords": [], + "keywords": [ + "storybook", + "generator", + "auto", + "react", + "vue", + "lit", + "storybook-addon", + "storybook-addon-generator", + "storybook-addon-auto-story-generator" + ], "author": "takuma-ru (https://github.com/takuma-ru/)", "license": "MIT", "repository": { @@ -50,7 +60,7 @@ "url": "https://github.com/takuma-ru/auto-story-generator/issues", "email": "kcattdev@gmail.com" }, - "homepage": "", + "homepage": "https://auto-story-generator.takumaru.dev", "dependencies": { "consola": "^3.2.3", "magicast": "^0.3.2",