From 88a8841d46354bc2bcbd175ed2f4d30e88cf27a4 Mon Sep 17 00:00:00 2001 From: sushi-chaaaan Date: Mon, 22 Apr 2024 15:41:24 +0900 Subject: [PATCH 1/4] refactor: use default export --- packages/stylelint-config/package.json | 10 ++++++++ packages/stylelint-config/src/astro.ts | 8 +++--- .../stylelint-config/src/{ => bases}/base.ts | 0 .../src/{ => bases}/extend.ts | 0 packages/stylelint-config/src/css.ts | 22 ---------------- packages/stylelint-config/src/index.ts | 25 ++++++++++++++++--- packages/stylelint-config/src/scss.ts | 8 +++--- packages/stylelint-config/tsup.config.ts | 2 +- 8 files changed, 41 insertions(+), 34 deletions(-) rename packages/stylelint-config/src/{ => bases}/base.ts (100%) rename packages/stylelint-config/src/{ => bases}/extend.ts (100%) delete mode 100644 packages/stylelint-config/src/css.ts diff --git a/packages/stylelint-config/package.json b/packages/stylelint-config/package.json index f693f86d..4561d975 100644 --- a/packages/stylelint-config/package.json +++ b/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": [ diff --git a/packages/stylelint-config/src/astro.ts b/packages/stylelint-config/src/astro.ts index 2eaac386..1b68cc95 100644 --- a/packages/stylelint-config/src/astro.ts +++ b/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 diff --git a/packages/stylelint-config/src/base.ts b/packages/stylelint-config/src/bases/base.ts similarity index 100% rename from packages/stylelint-config/src/base.ts rename to packages/stylelint-config/src/bases/base.ts diff --git a/packages/stylelint-config/src/extend.ts b/packages/stylelint-config/src/bases/extend.ts similarity index 100% rename from packages/stylelint-config/src/extend.ts rename to packages/stylelint-config/src/bases/extend.ts diff --git a/packages/stylelint-config/src/css.ts b/packages/stylelint-config/src/css.ts deleted file mode 100644 index 05c90e3e..00000000 --- a/packages/stylelint-config/src/css.ts +++ /dev/null @@ -1,22 +0,0 @@ -import type { Config } from "stylelint" - -import { baseConfig } from "./base" -import { cssExtend } from "./extend" - -const { rules: baseRules, ...base } = baseConfig - -const cssConfig: Config = { - ...base, - extends: cssExtend, - rules: { - ...baseRules, - "at-rule-no-unknown": [ - true, - { - ignoreAtRules: ["tailwind"], - }, - ], - }, -} - -export default cssConfig diff --git a/packages/stylelint-config/src/index.ts b/packages/stylelint-config/src/index.ts index 6b5f7435..38956666 100644 --- a/packages/stylelint-config/src/index.ts +++ b/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 diff --git a/packages/stylelint-config/src/scss.ts b/packages/stylelint-config/src/scss.ts index 0f059651..8e98f3c3 100644 --- a/packages/stylelint-config/src/scss.ts +++ b/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 diff --git a/packages/stylelint-config/tsup.config.ts b/packages/stylelint-config/tsup.config.ts index ba5a8b39..a546ad97 100644 --- a/packages/stylelint-config/tsup.config.ts +++ b/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", From 675b5d200cabadc8dd08170c1898ce3514271070 Mon Sep 17 00:00:00 2001 From: sushi-chaaaan Date: Mon, 22 Apr 2024 15:41:42 +0900 Subject: [PATCH 2/4] fix: use default export in config --- stylelint.config.mjs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/stylelint.config.mjs b/stylelint.config.mjs index 56cac2a3..8ed2630c 100644 --- a/stylelint.config.mjs +++ b/stylelint.config.mjs @@ -1 +1 @@ -export { css as default } from "@virtual-live-lab/stylelint-config" +export { default } from "@virtual-live-lab/stylelint-config" From db2c213ad1cdc1f49fa9558dfe858cd4d3222e3e Mon Sep 17 00:00:00 2001 From: sushi-chaaaan Date: Mon, 22 Apr 2024 15:41:59 +0900 Subject: [PATCH 3/4] docs: add config file example --- packages/stylelint-config/README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/packages/stylelint-config/README.md b/packages/stylelint-config/README.md index cab5e3b3..afa29487 100644 --- a/packages/stylelint-config/README.md +++ b/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/) From 80914b9b00d6f50b4a2012e9fb77aad93cb80075 Mon Sep 17 00:00:00 2001 From: sushi-chaaaan Date: Mon, 22 Apr 2024 15:42:25 +0900 Subject: [PATCH 4/4] chore: changeset --- .changeset/rich-mirrors-doubt.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/rich-mirrors-doubt.md diff --git a/.changeset/rich-mirrors-doubt.md b/.changeset/rich-mirrors-doubt.md new file mode 100644 index 00000000..bc850531 --- /dev/null +++ b/.changeset/rich-mirrors-doubt.md @@ -0,0 +1,5 @@ +--- +"@virtual-live-lab/stylelint-config": patch +--- + +Use default export, improve install doc