refactor/stylelint export and docs

.changeset/rich-mirrors-doubt.md

@@ -0,0 +1,5 @@
+---
+"@virtual-live-lab/stylelint-config": patch
+---
+
+Use default export, improve install doc

packages/stylelint-config/README.md

@@ -21,6 +21,11 @@ npm install stylelint \
   --save-dev
 ```
 
+```js
+// stylelint.config.mjs
+export { default } from "@virtual-live-lab/stylelint-config"
+```
+
 ### Use for scss
 
 ```bash
@@ -37,8 +42,20 @@ npm install stylelint \
   --save-dev
 ```
 
+```js
+// stylelint.config.mjs
+export { default } from "@virtual-live-lab/stylelint-config/scss"
+```
+
 ### Use for Astro
 
+> [!TIP]
+> If some syntax error occurred in Astro, you should install `postcss-html`.
+>
+> ```bash
+> npm install postcss-html --save-dev
+> ```
+
 ```bash
 npm install stylelint \
   @virtual-live-lab/stylelint-config \
@@ -54,6 +71,11 @@ npm install stylelint \
   --save-dev
 ```
 
+```js
+// stylelint.config.mjs
+export { default } from "@virtual-live-lab/stylelint-config/astro"
+```
+
 ## License
 
 [MIT](https://choosealicense.com/licenses/mit/)

packages/stylelint-config/package.json

@@ -10,6 +10,16 @@
       "require": "./dist/index.js",
       "import": "./dist/index.mjs",
       "types": "./dist/index.d.ts"
+    },
+    "./scss": {
+      "require": "./dist/scss.js",
+      "import": "./dist/scss.mjs",
+      "types": "./dist/scss.d.ts"
+    },
+    "./astro": {
+      "require": "./dist/astro.js",
+      "import": "./dist/astro.mjs",
+      "types": "./dist/astro.d.ts"
     }
   },
   "files": [

packages/stylelint-config/src/astro.ts

@@ -1,11 +1,11 @@
 import type { Config } from "stylelint"
 
-import { baseConfig } from "./base"
-import { astroExtend } from "./extend"
+import { baseConfig } from "./bases/base"
+import { astroExtend } from "./bases/extend"
 
 const { rules: baseRules, ...base } = baseConfig
 
-const astroConfig: Config = {
+const astro: Config = {
   ...base,
   extends: astroExtend,
   rules: {
@@ -19,4 +19,4 @@ const astroConfig: Config = {
   },
 }
 
-export default astroConfig
+export default astro

packages/stylelint-config/src/index.ts

@@ -1,3 +1,22 @@
-export { default as astro } from "./astro"
-export { default as css } from "./css"
-export { default as scss } from "./scss"
+import type { Config } from "stylelint"
+
+import { baseConfig } from "./bases/base"
+import { cssExtend } from "./bases/extend"
+
+const { rules: baseRules, ...base } = baseConfig
+
+const css: Config = {
+  ...base,
+  extends: cssExtend,
+  rules: {
+    ...baseRules,
+    "at-rule-no-unknown": [
+      true,
+      {
+        ignoreAtRules: ["tailwind"],
+      },
+    ],
+  },
+}
+
+export default css

packages/stylelint-config/src/scss.ts

@@ -1,11 +1,11 @@
 import type { Config } from "stylelint"
 
-import { baseConfig } from "./base"
-import { scssExtend } from "./extend"
+import { baseConfig } from "./bases/base"
+import { scssExtend } from "./bases/extend"
 
 const { rules: baseRules, ...base } = baseConfig
 
-const scssConfig: Config = {
+const scss: Config = {
   ...base,
   extends: scssExtend,
   rules: {
@@ -25,4 +25,4 @@ const scssConfig: Config = {
   },
 }
 
-export default scssConfig
+export default scss

packages/stylelint-config/tsup.config.ts

@@ -3,7 +3,7 @@ import { defineConfig } from "tsup"
 export default defineConfig({
   clean: true, // build前にディレクトリ内を削除するか
   dts: true,
-  entry: ["./src/index.ts"], // バンドルするファイルを指定
+  entry: ["./src/*.ts"], // バンドルするファイルを指定
   format: ["cjs", "esm"], // 出力する形式を指定
   minify: process.env.NODE_ENV === "production",
   outDir: "dist",

stylelint.config.mjs

@@ -1 +1 @@
-export { css as default } from "@virtual-live-lab/stylelint-config"
+export { default } from "@virtual-live-lab/stylelint-config"