VirtualLiveLab · sushichan044 · Apr 21, 2024 · Apr 21, 2024 · Apr 21, 2024 · Apr 21, 2024
diff --git a/.changeset/witty-eyes-care.md → .changeset/silly-years-behave.md b/.changeset/witty-eyes-care.md → .changeset/silly-years-behave.md
@@ -2,7 +2,6 @@
 "@virtual-live-lab/stylelint-config": patch
 "@virtual-live-lab/prettier-config": patch
 "@virtual-live-lab/eslint-config": patch
-"@virtual-live-lab/tsconfig": patch
 ---
 
-Add experimental support for Astro
+Add install doc
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -1,2 +1,2 @@
 //@ts-check
-export { ts as default } from "@virtual-live-lab/eslint-config/ts"
+export { default } from "@virtual-live-lab/eslint-config/ts"
diff --git a/package.json b/package.json
@@ -20,7 +20,9 @@
     "@virtual-live-lab/prettier-config": "workspace:^",
     "@virtual-live-lab/stylelint-config": "workspace:^",
     "@virtual-live-lab/tsconfig": "workspace:^",
+    "eslint": "^8.57.0",
     "prettier": "^3.2.5",
+    "stylelint": "^16.3.1",
     "typescript": "^5.4.5"
   },
   "engines": {

diff --git a/packages/eslint-config/CHANGELOG.md b/packages/eslint-config/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @virtual-live-lab/eslint-config
 
+## 1.0.2
+
+### Patch Changes
+
+- [#16](https://github.com/VirtualLiveLab/js-config/pull/16) [`b5b3a04`](https://github.com/VirtualLiveLab/js-config/commit/b5b3a044301048e3958c9b6c6fffa244b8ee7af1) Thanks [@sushi-chaaaan](https://github.com/sushi-chaaaan)! - Add experimental support for Astro
+
 ## 1.0.1
 
 ### Patch Changes

diff --git a/packages/eslint-config/README.md b/packages/eslint-config/README.md
@@ -0,0 +1,105 @@
+
+# @virtual-live-lab/eslint-config
+
+![NPM Version](https://img.shields.io/npm/v/%40virtual-live-lab%2Feslint-config)
+
+ESLint configuration for Virtual Live Lab, with various presets and addons.
+
+> [!NOTE]
+> This package has not compatibility with ESLint v9 yet.
+
+> [!WARNING]
+> This package is only compatible with Flat Config.
+> Do not use for classic `.eslintrc` style.
+
+## Installation
+
+### Use for JavaScript
+
+```bash
+npm install eslint \
+  @virtual-live-lab/eslint-config \
+  --save-dev
+```
+
+### Use for TypeScript
+
+```bash
+npm install eslint \
+  @virtual-live-lab/eslint-config \
+  typescript \
+  --save-dev
+```
+
+## presets
+
+This package has some presets to zero-config use.
+
+> [!WARNING]
+> Next.js is not supported by the preset because each version of the framework has a different version of the ESLint package.
+
+### JavaScript Preset
+
+```js
+// eslint.config.mjs
+export { default } from "@virtual-live-lab/eslint-config/js"
+```
+
+### TypeScript Preset
+
+Extends `js` preset.
+
+```js
+// eslint.config.mjs
+export { default } from "@virtual-live-lab/eslint-config/ts"
+```
+
+### React Preset
+
+Extends `ts` preset.
+
+```js
+// eslint.config.mjs
+export { default } from "@virtual-live-lab/eslint-config/react"
+```
+
+### Astro Preset
+
+Extends `ts` and `react` presets.
+
+```js
+// eslint.config.mjs
+export { default } from "@virtual-live-lab/eslint-config/astro"
+```
+
+## Addons
+
+This package has some addon configurations.
+
+### jsx a11y
+
+```js
+// eslint.config.mjs
+import jsxA11y from "@virtual-live-lab/eslint-config/addons/jsxA11y"
+import ts from "@virtual-live-lab/eslint-config/ts"
+
+const config = [...ts, ...jsxA11y]
+
+export default config
+```
+
+### Tailwind CSS
+
+```js
+// eslint.config.mjs
+import tailwind from "@virtual-live-lab/eslint-config/addons/tailwind"
+import ts from "@virtual-live-lab/eslint-config/ts"
+
+const config = [...ts, ...jsxA11y]
+
+export default config
+```
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)
diff --git a/packages/eslint-config/eslint.config.mjs b/packages/eslint-config/eslint.config.mjs
@@ -1,2 +1,2 @@
 //@ts-check
-export { ts as default } from "@virtual-live-lab/eslint-config/ts"
+export { default } from "@virtual-live-lab/eslint-config/ts"
diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@virtual-live-lab/eslint-config",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "ESLint configuration for Virtual Live Lab",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

diff --git a/packages/eslint-config/src/addons/jsxA11y.ts b/packages/eslint-config/src/addons/jsxA11y.ts
@@ -1,5 +1,5 @@
 import { compat } from "../../lib/compat"
 
-const jsxA11yConfig = compat.extends("plugin:jsx-a11y/strict")
+const jsxA11y = compat.extends("plugin:jsx-a11y/strict")
 
-export { jsxA11yConfig }
+export default jsxA11y
diff --git a/packages/eslint-config/src/addons/tailwind.ts b/packages/eslint-config/src/addons/tailwind.ts
@@ -1,6 +1,6 @@
 import { compat } from "../../lib/compat"
 
-const config = [
+const tailwind = [
   ...compat.extends("plugin:tailwindcss/recommended"),
   ...compat.config({
     rules: {
@@ -18,4 +18,4 @@ const config = [
   }),
 ]
 
-export default config
+export default tailwind
diff --git a/packages/eslint-config/src/astro.ts b/packages/eslint-config/src/astro.ts
@@ -4,12 +4,12 @@ import tseslint from "typescript-eslint"
 
 import { astroConfig } from "./bases/astro"
 import { reactConfig } from "./bases/react"
-import { ts } from "./ts"
+import ts from "./ts"
 
 const astro: TSESLint.FlatConfig.ConfigArray = tseslint.config(
   ...ts,
   ...astroConfig,
   ...reactConfig,
 )
 
-export { astro }
+export default astro
diff --git a/packages/eslint-config/src/js.ts b/packages/eslint-config/src/js.ts
@@ -3,4 +3,4 @@ import { stylisticConfig } from "./bases/stylistic"
 
 const js = [...jsConfig, ...stylisticConfig]
 
-export { js }
+export default js
diff --git a/packages/eslint-config/src/react.ts b/packages/eslint-config/src/react.ts
@@ -3,11 +3,11 @@ import type { TSESLint } from "@typescript-eslint/utils"
 import tseslint from "typescript-eslint"
 
 import { reactConfig } from "./bases/react"
-import { ts } from "./ts"
+import ts from "./ts"
 
 const react: TSESLint.FlatConfig.ConfigArray = tseslint.config(
   ...ts,
   ...reactConfig,
 )
 
-export { react }
+export default react
diff --git a/packages/eslint-config/src/ts.ts b/packages/eslint-config/src/ts.ts
@@ -3,9 +3,9 @@ import type { TSESLint } from "@typescript-eslint/utils"
 import tseslint from "typescript-eslint"
 
 import { tsConfig } from "./bases/typescript"
-import { js } from "./js"
+import js from "./js"
 
 // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
 const ts: TSESLint.FlatConfig.ConfigArray = tseslint.config(...js, ...tsConfig)
 
-export { ts }
+export default ts
diff --git a/packages/prettier-config/CHANGELOG.md b/packages/prettier-config/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @virtual-live-lab/prettier-config
 
+## 1.0.2
+
+### Patch Changes
+
+- [#16](https://github.com/VirtualLiveLab/js-config/pull/16) [`b5b3a04`](https://github.com/VirtualLiveLab/js-config/commit/b5b3a044301048e3958c9b6c6fffa244b8ee7af1) Thanks [@sushi-chaaaan](https://github.com/sushi-chaaaan)! - Add experimental support for Astro
+
 ## 1.0.1
 
 ### Patch Changes

diff --git a/packages/prettier-config/README.md b/packages/prettier-config/README.md
@@ -0,0 +1,39 @@
+
+# @virtual-live-lab/prettier-config
+
+![NPM Version](https://img.shields.io/npm/v/%40virtual-live-lab%2Fprettier-config)
+
+Prettier configuration for Virtual Live Lab.
+
+## Installation
+
+### Use for normal
+
+```bash
+npm install prettier \
+  @virtual-live-lab/prettier-config \
+  --save-dev
+```
+
+```js
+// prettier.config.mjs
+export { default } from "@virtual-live-lab/prettier-config"
+```
+
+### Use for Astro
+
+```bash
+npm install prettier \
+  prettier-plugin-astro \
+  @virtual-live-lab/prettier-config \
+  --save-dev
+```
+
+```js
+// prettier.config.mjs
+export { default } from "@virtual-live-lab/prettier-config/astro"
+```
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)
diff --git a/packages/prettier-config/eslint.config.mjs b/packages/prettier-config/eslint.config.mjs
@@ -1,2 +1 @@
-//@ts-check
-export { ts as default } from "@virtual-live-lab/eslint-config/ts"
+export { default } from "@virtual-live-lab/eslint-config/ts"
diff --git a/packages/prettier-config/package.json b/packages/prettier-config/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@virtual-live-lab/prettier-config",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Prettier configuration for Virtual Live Lab",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

diff --git a/packages/prettier-config/tsup.config.ts b/packages/prettier-config/tsup.config.ts
@@ -6,6 +6,7 @@ export default defineConfig({
   entry: ["./index.ts", "./astro.ts"], // バンドルするファイルを指定
   format: ["cjs", "esm"], // 出力する形式を指定
   minify: process.env.NODE_ENV === "production",
+  outDir: "dist",
   sourcemap: false, // soucemapを出力するか
   splitting: false, // バンドルしないで分割するか
   treeshake: true,

diff --git a/packages/stylelint-config/CHANGELOG.md b/packages/stylelint-config/CHANGELOG.md
@@ -1,5 +1,23 @@
 # @virtual-live-lab/stylelint-config
 
+## 1.0.4
+
+### Patch Changes
+
+- [#20](https://github.com/VirtualLiveLab/js-config/pull/20) [`335a4ab`](https://github.com/VirtualLiveLab/js-config/commit/335a4ab42fe9a08d2b94a525138c9b7355673263) Thanks [@sushi-chaaaan](https://github.com/sushi-chaaaan)! - Fix rules, add docs for installation
+
+## 1.0.3
+
+### Patch Changes
+
+- [#18](https://github.com/VirtualLiveLab/js-config/pull/18) [`01ee0df`](https://github.com/VirtualLiveLab/js-config/commit/01ee0df29e1718206fd18c164a8e365e68b79b16) Thanks [@sushi-chaaaan](https://github.com/sushi-chaaaan)! - Mark stylelint rules as dependency
+
+## 1.0.2
+
+### Patch Changes
+
+- [#16](https://github.com/VirtualLiveLab/js-config/pull/16) [`b5b3a04`](https://github.com/VirtualLiveLab/js-config/commit/b5b3a044301048e3958c9b6c6fffa244b8ee7af1) Thanks [@sushi-chaaaan](https://github.com/sushi-chaaaan)! - Add experimental support for Astro
+
 ## 1.0.1
 
 ### Patch Changes

diff --git a/packages/stylelint-config/README.md b/packages/stylelint-config/README.md
@@ -0,0 +1,59 @@
+
+# @virtual-live-lab/stylelint-config
+
+![NPM Version](https://img.shields.io/npm/v/%40virtual-live-lab%2Fstylelint-config)
+
+Stylelint configuration for Virtual Live Lab.
+
+## Installation
+
+### Use for css
+
+```bash
+npm install stylelint \
+  @virtual-live-lab/stylelint-config \
+  @double-great/stylelint-a11y \
+  stylelint-declaration-block-no-ignored-properties \
+  stylelint-value-no-unknown-custom-properties \
+  stylelint-config-recommended \
+  stylelint-config-standard \
+  stylelint-config-recess-order \
+  --save-dev
+```
+
+### Use for scss
+
+```bash
+npm install stylelint \
+  @virtual-live-lab/stylelint-config \
+  @double-great/stylelint-a11y \
+  stylelint-declaration-block-no-ignored-properties \
+  stylelint-value-no-unknown-custom-properties \
+  stylelint-config-recommended \
+  stylelint-config-standard \
+  stylelint-config-recess-order \
+  stylelint-config-standard-scss \
+  stylelint-config-sass-guidelines \
+  --save-dev
+```
+
+### Use for Astro
+
+```bash
+npm install stylelint \
+  @virtual-live-lab/stylelint-config \
+  @double-great/stylelint-a11y \
+  stylelint-declaration-block-no-ignored-properties \
+  stylelint-value-no-unknown-custom-properties \
+  stylelint-config-recommended \
+  stylelint-config-standard \
+  stylelint-config-recess-order \
+  stylelint-config-standard-scss \
+  stylelint-config-sass-guidelines \
+  stylelint-config-html \
+  --save-dev
+```
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)
diff --git a/packages/stylelint-config/eslint.config.mjs b/packages/stylelint-config/eslint.config.mjs
@@ -1 +1 @@
-export { ts as default } from "@virtual-live-lab/eslint-config/ts"
+export { default } from "@virtual-live-lab/eslint-config/ts"
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,4 +3,4 @@ import { stylisticConfig } from "./bases/stylistic"

		const js = [...jsConfig, ...stylisticConfig]

		export { js }
		export default js
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		export { ts as default } from "@virtual-live-lab/eslint-config/ts"
		export { default } from "@virtual-live-lab/eslint-config/ts"