@xiaohe01/stylelint-config 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-PRESENT xiaohe0601 <https://github.com/xiaohe0601>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,95 @@
+<div align="center">
+  <h1>xiaohe-stylelint-config</h1>
+  <span>🤚 Stylelint config preset for xiaohe</span>
+</div>
+
+<br>
+
+[![github stars][github-stars-src]][github-stars-href]
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![bundle][bundle-src]][bundle-href]
+[![JSDocs][jsdocs-src]][jsdocs-href]
+[![License][license-src]][license-href]
+
+Xiaohe / [github@xiaohe0601](https://github.com/xiaohe0601) / [gitee@xiaohe0601](https://gitee.com/xiaohe0601)
+
+### 🚁 Installation
+
+#### PNPM
+
+``` shell
+pnpm add -D stylelint @xiaohe01/stylelint-config
+```
+
+#### YARN
+
+``` shell
+yarn add --dev stylelint @xiaohe01/stylelint-config
+```
+
+#### NPM
+
+``` shell
+npm install -D stylelint @xiaohe01/stylelint-config
+```
+
+### 🛹 Usage
+
+Create `stylelint.config.js` in your project root
+
+```js
+import defineConfig from "@xiaohe01/stylelint-config";
+
+export default defineConfig();
+```
+
+Add script for `package.json`, for example
+
+```json
+{
+  "scripts": {
+    "stylelint": "stylelint **/*.{css,scss,vue,html}",
+    "stylelint:fix": "stylelint **/*.{css,scss,vue,html} --fix"
+  }
+}
+```
+
+For more information, please refer to [stylelint](https://stylelint.io).
+
+### 🐶 Discussion & Communication
+
+- ❓：For questions or bug feedback, you can submit an [issues](https://github.com/xiaohe0601/xiaohe-stylelint-config/issues)
+  and PRs are welcome~
+- 📫：[xiaohe0601@outlook.com](mailto:xiaohe0601@outlook.com)
+- 🐧：Not yet available
+
+### 🏆 License
+
+- MIT [LICENSE](./LICENSE)
+
+<!-- Badges -->
+
+[github-stars-src]: https://img.shields.io/github/stars/xiaohe0601/xiaohe-stylelint-config?style=flat&colorA=080f12&colorB=1fa669&logo=GitHub
+
+[github-stars-href]: https://github.com/xiaohe0601/xiaohe-stylelint-config
+
+[npm-version-src]: https://img.shields.io/npm/v/@xiaohe01/stylelint-config?style=flat&colorA=080f12&colorB=1fa669
+
+[npm-version-href]: https://npmjs.com/package/@xiaohe01/stylelint-config
+
+[npm-downloads-src]: https://img.shields.io/npm/dm/@xiaohe01/stylelint-config?style=flat&colorA=080f12&colorB=1fa669
+
+[npm-downloads-href]: https://npmjs.com/package/@xiaohe01/stylelint-config
+
+[bundle-src]: https://img.shields.io/bundlephobia/minzip/@xiaohe01/stylelint-config?style=flat&colorA=080f12&colorB=1fa669&label=minzip
+
+[bundle-href]: https://bundlephobia.com/result?p=@xiaohe01/stylelint-config
+
+[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
+
+[jsdocs-href]: https://www.jsdocs.io/package/@xiaohe01/stylelint-config
+
+[license-src]: https://img.shields.io/github/license/xiaohe0601/xiaohe-stylelint-config.svg?style=flat&colorA=080f12&colorB=1fa669
+
+[license-href]: https://github.com/xiaohe0601/xiaohe-stylelint-config/blob/main/LICENSE

package/dist/index.cjs

@@ -0,0 +1,153 @@
+'use strict';
+
+const lodashEs = require('lodash-es');
+const localPkg = require('local-pkg');
+
+const SCSS_PACKAGES = [
+  "sass",
+  "sass-embedded",
+  "node-sass"
+];
+const VUE_PACKAGES = [
+  "vue",
+  "nuxt",
+  "vitepress",
+  "@slidev/cli"
+];
+const UNIAPP_PACKAGE = "@dcloudio/uni-app";
+
+function isPkgExists(pkg) {
+  return lodashEs.castArray(pkg).some((it) => localPkg.isPackageExists(it));
+}
+
+function buildExtends(options) {
+  if (!lodashEs.isEmpty(options.overrideExtends)) {
+    return lodashEs.castArray(options.overrideExtends);
+  }
+  const {
+    scss: enableScss,
+    vue: enableVue
+  } = options.presets;
+  const extendz = [
+    "stylelint-config-standard",
+    "stylelint-config-recommended",
+    "stylelint-config-html",
+    "stylelint-config-recess-order"
+  ];
+  if (enableScss) {
+    extendz.push("stylelint-config-standard-scss");
+  }
+  if (enableVue) {
+    extendz.push("stylelint-config-recommended-vue");
+  }
+  if (!lodashEs.isEmpty(options.extends)) {
+    extendz.push(...lodashEs.castArray(options.extends));
+  }
+  return extendz;
+}
+function buildPlugins(options) {
+  if (!lodashEs.isEmpty(options.overridePlugins)) {
+    return lodashEs.castArray(options.overridePlugins);
+  }
+  const plugins = [
+    "stylelint-order"
+  ];
+  if (!lodashEs.isEmpty(options.plugins)) {
+    plugins.push(...lodashEs.castArray(options.plugins));
+  }
+  return plugins;
+}
+function buildRules(options) {
+  const {
+    scss: enableScss,
+    vue: enableVue,
+    uniapp: enableUniApp
+  } = options.presets;
+  const disables = {
+    "unit-no-unknown": null,
+    "no-empty-source": null,
+    "at-rule-no-unknown": null,
+    "value-keyword-case": null,
+    "selector-not-notation": null,
+    "no-duplicate-selectors": null,
+    "font-family-name-quotes": null,
+    "no-descending-specificity": null,
+    "custom-property-empty-line-before": null,
+    "font-family-no-missing-generic-family-keyword": null
+  };
+  if (enableScss) {
+    lodashEs.merge(disables, {
+      "scss/at-extend-no-missing-placeholder": null
+    });
+  }
+  const rules = {
+    ...disables,
+    "color-hex-length": ["long", {
+      message: "Hexadecimal colors need to use the long format style (#ffffff)"
+    }],
+    "length-zero-no-unit": [true, {
+      ignoreFunctions: ["/^--/", "var", "calc"]
+    }],
+    "alpha-value-notation": "number",
+    "selector-class-pattern": ["^([#a-z][$#{}a-z0-9]*)((-{1,2}|_{2})[$#{}a-z0-9]+)*$", {
+      message: "Class naming should follow the BEM style (block-element[__element][--modifier])"
+    }],
+    "color-function-notation": "legacy",
+    "declaration-block-no-redundant-longhand-properties": [true, {
+      ignoreShorthands: ["inset"]
+    }]
+  };
+  if (enableScss) {
+    lodashEs.merge(rules, {
+      "scss/load-partial-extension": "always"
+    });
+  }
+  if (enableVue) {
+    lodashEs.merge(rules, {
+      "selector-pseudo-class-no-unknown": [true, {
+        ignorePseudoClasses: ["deep"]
+      }]
+    });
+  }
+  if (enableUniApp) {
+    lodashEs.merge(rules, {
+      "selector-type-no-unknown": [true, {
+        ignoreTypes: ["page", "rich-text", "scroll-view"]
+      }]
+    });
+  }
+  if (!lodashEs.isEmpty(options.rules)) {
+    lodashEs.merge(rules, options.rules);
+  }
+  return rules;
+}
+function defineConfig(options = {}) {
+  const presets = lodashEs.merge({
+    scss: isPkgExists(SCSS_PACKAGES),
+    vue: isPkgExists(VUE_PACKAGES),
+    uniapp: isPkgExists(UNIAPP_PACKAGE)
+  }, options.presets);
+  const finalOptions = {
+    ...options,
+    presets
+  };
+  return {
+    allowEmptyInput: true,
+    cache: true,
+    defaultSeverity: "error",
+    extends: buildExtends(finalOptions),
+    plugins: buildPlugins(finalOptions),
+    rules: buildRules(finalOptions),
+    ...lodashEs.omit(options, [
+      "extends",
+      "plugins",
+      "rules"
+    ])
+  };
+}
+
+exports.SCSS_PACKAGES = SCSS_PACKAGES;
+exports.UNIAPP_PACKAGE = UNIAPP_PACKAGE;
+exports.VUE_PACKAGES = VUE_PACKAGES;
+exports.defineConfig = defineConfig;
+exports.isPkgExists = isPkgExists;

package/dist/index.d.cts

@@ -0,0 +1,31 @@
+import { Plugin, ConfigRuleSettings, Config } from 'stylelint';
+
+declare const SCSS_PACKAGES: string[];
+declare const VUE_PACKAGES: string[];
+declare const UNIAPP_PACKAGE = "@dcloudio/uni-app";
+
+type Arrayable<T> = T | T[];
+type ConfigExtend = string;
+type ConfigExtends = ConfigExtend[];
+type ConfigPlugin = string | Plugin;
+type ConfigPlugins = ConfigPlugin[];
+type ConfigRule = ConfigRuleSettings<any, object>;
+interface ConfigRules {
+    [key: string]: ConfigRule;
+}
+interface ConfigPresets {
+    scss?: boolean;
+    vue?: boolean;
+    uniapp?: boolean;
+}
+interface ConfigOptions extends Config {
+    presets?: ConfigPresets;
+    overrideExtends?: Config["extends"];
+    overridePlugins?: Config["plugins"];
+}
+
+declare function defineConfig(options?: ConfigOptions): Config;
+
+declare function isPkgExists(pkg: Arrayable<string>): boolean;
+
+export { type Arrayable, type ConfigExtend, type ConfigExtends, type ConfigOptions, type ConfigPlugin, type ConfigPlugins, type ConfigPresets, type ConfigRule, type ConfigRules, SCSS_PACKAGES, UNIAPP_PACKAGE, VUE_PACKAGES, defineConfig, isPkgExists };

package/dist/index.d.mts

@@ -0,0 +1,31 @@
+import { Plugin, ConfigRuleSettings, Config } from 'stylelint';
+
+declare const SCSS_PACKAGES: string[];
+declare const VUE_PACKAGES: string[];
+declare const UNIAPP_PACKAGE = "@dcloudio/uni-app";
+
+type Arrayable<T> = T | T[];
+type ConfigExtend = string;
+type ConfigExtends = ConfigExtend[];
+type ConfigPlugin = string | Plugin;
+type ConfigPlugins = ConfigPlugin[];
+type ConfigRule = ConfigRuleSettings<any, object>;
+interface ConfigRules {
+    [key: string]: ConfigRule;
+}
+interface ConfigPresets {
+    scss?: boolean;
+    vue?: boolean;
+    uniapp?: boolean;
+}
+interface ConfigOptions extends Config {
+    presets?: ConfigPresets;
+    overrideExtends?: Config["extends"];
+    overridePlugins?: Config["plugins"];
+}
+
+declare function defineConfig(options?: ConfigOptions): Config;
+
+declare function isPkgExists(pkg: Arrayable<string>): boolean;
+
+export { type Arrayable, type ConfigExtend, type ConfigExtends, type ConfigOptions, type ConfigPlugin, type ConfigPlugins, type ConfigPresets, type ConfigRule, type ConfigRules, SCSS_PACKAGES, UNIAPP_PACKAGE, VUE_PACKAGES, defineConfig, isPkgExists };

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+import { Plugin, ConfigRuleSettings, Config } from 'stylelint';
+
+declare const SCSS_PACKAGES: string[];
+declare const VUE_PACKAGES: string[];
+declare const UNIAPP_PACKAGE = "@dcloudio/uni-app";
+
+type Arrayable<T> = T | T[];
+type ConfigExtend = string;
+type ConfigExtends = ConfigExtend[];
+type ConfigPlugin = string | Plugin;
+type ConfigPlugins = ConfigPlugin[];
+type ConfigRule = ConfigRuleSettings<any, object>;
+interface ConfigRules {
+    [key: string]: ConfigRule;
+}
+interface ConfigPresets {
+    scss?: boolean;
+    vue?: boolean;
+    uniapp?: boolean;
+}
+interface ConfigOptions extends Config {
+    presets?: ConfigPresets;
+    overrideExtends?: Config["extends"];
+    overridePlugins?: Config["plugins"];
+}
+
+declare function defineConfig(options?: ConfigOptions): Config;
+
+declare function isPkgExists(pkg: Arrayable<string>): boolean;
+
+export { type Arrayable, type ConfigExtend, type ConfigExtends, type ConfigOptions, type ConfigPlugin, type ConfigPlugins, type ConfigPresets, type ConfigRule, type ConfigRules, SCSS_PACKAGES, UNIAPP_PACKAGE, VUE_PACKAGES, defineConfig, isPkgExists };

package/dist/index.mjs

@@ -0,0 +1,147 @@
+import { castArray, merge, omit, isEmpty } from 'lodash-es';
+import { isPackageExists } from 'local-pkg';
+
+const SCSS_PACKAGES = [
+  "sass",
+  "sass-embedded",
+  "node-sass"
+];
+const VUE_PACKAGES = [
+  "vue",
+  "nuxt",
+  "vitepress",
+  "@slidev/cli"
+];
+const UNIAPP_PACKAGE = "@dcloudio/uni-app";
+
+function isPkgExists(pkg) {
+  return castArray(pkg).some((it) => isPackageExists(it));
+}
+
+function buildExtends(options) {
+  if (!isEmpty(options.overrideExtends)) {
+    return castArray(options.overrideExtends);
+  }
+  const {
+    scss: enableScss,
+    vue: enableVue
+  } = options.presets;
+  const extendz = [
+    "stylelint-config-standard",
+    "stylelint-config-recommended",
+    "stylelint-config-html",
+    "stylelint-config-recess-order"
+  ];
+  if (enableScss) {
+    extendz.push("stylelint-config-standard-scss");
+  }
+  if (enableVue) {
+    extendz.push("stylelint-config-recommended-vue");
+  }
+  if (!isEmpty(options.extends)) {
+    extendz.push(...castArray(options.extends));
+  }
+  return extendz;
+}
+function buildPlugins(options) {
+  if (!isEmpty(options.overridePlugins)) {
+    return castArray(options.overridePlugins);
+  }
+  const plugins = [
+    "stylelint-order"
+  ];
+  if (!isEmpty(options.plugins)) {
+    plugins.push(...castArray(options.plugins));
+  }
+  return plugins;
+}
+function buildRules(options) {
+  const {
+    scss: enableScss,
+    vue: enableVue,
+    uniapp: enableUniApp
+  } = options.presets;
+  const disables = {
+    "unit-no-unknown": null,
+    "no-empty-source": null,
+    "at-rule-no-unknown": null,
+    "value-keyword-case": null,
+    "selector-not-notation": null,
+    "no-duplicate-selectors": null,
+    "font-family-name-quotes": null,
+    "no-descending-specificity": null,
+    "custom-property-empty-line-before": null,
+    "font-family-no-missing-generic-family-keyword": null
+  };
+  if (enableScss) {
+    merge(disables, {
+      "scss/at-extend-no-missing-placeholder": null
+    });
+  }
+  const rules = {
+    ...disables,
+    "color-hex-length": ["long", {
+      message: "Hexadecimal colors need to use the long format style (#ffffff)"
+    }],
+    "length-zero-no-unit": [true, {
+      ignoreFunctions: ["/^--/", "var", "calc"]
+    }],
+    "alpha-value-notation": "number",
+    "selector-class-pattern": ["^([#a-z][$#{}a-z0-9]*)((-{1,2}|_{2})[$#{}a-z0-9]+)*$", {
+      message: "Class naming should follow the BEM style (block-element[__element][--modifier])"
+    }],
+    "color-function-notation": "legacy",
+    "declaration-block-no-redundant-longhand-properties": [true, {
+      ignoreShorthands: ["inset"]
+    }]
+  };
+  if (enableScss) {
+    merge(rules, {
+      "scss/load-partial-extension": "always"
+    });
+  }
+  if (enableVue) {
+    merge(rules, {
+      "selector-pseudo-class-no-unknown": [true, {
+        ignorePseudoClasses: ["deep"]
+      }]
+    });
+  }
+  if (enableUniApp) {
+    merge(rules, {
+      "selector-type-no-unknown": [true, {
+        ignoreTypes: ["page", "rich-text", "scroll-view"]
+      }]
+    });
+  }
+  if (!isEmpty(options.rules)) {
+    merge(rules, options.rules);
+  }
+  return rules;
+}
+function defineConfig(options = {}) {
+  const presets = merge({
+    scss: isPkgExists(SCSS_PACKAGES),
+    vue: isPkgExists(VUE_PACKAGES),
+    uniapp: isPkgExists(UNIAPP_PACKAGE)
+  }, options.presets);
+  const finalOptions = {
+    ...options,
+    presets
+  };
+  return {
+    allowEmptyInput: true,
+    cache: true,
+    defaultSeverity: "error",
+    extends: buildExtends(finalOptions),
+    plugins: buildPlugins(finalOptions),
+    rules: buildRules(finalOptions),
+    ...omit(options, [
+      "extends",
+      "plugins",
+      "rules"
+    ])
+  };
+}
+
+export { SCSS_PACKAGES, UNIAPP_PACKAGE, VUE_PACKAGES, defineConfig, isPkgExists };

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@xiaohe01/stylelint-config",
+  "type": "module",
+  "version": "0.0.1",
+  "description": "🤚 Stylelint config preset for xiaohe",
+  "author": "xiaohe0601 <xiaohe0601@outlook.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/xiaohe0601/xiaohe-stylelint-config#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/xiaohe0601/xiaohe-stylelint-config.git"
+  },
+  "bugs": "https://github.com/xiaohe0601/xiaohe-stylelint-config/issues",
+  "keywords": [
+    "stylelint-config"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    },
+    "./*": "./*"
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./dist/*",
+        "./dist/index.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "local-pkg": "^0.5.0",
+    "lodash-es": "^4.17.21",
+    "stylelint-config-html": "^1.1.0",
+    "stylelint-config-recess-order": "^5.1.1",
+    "stylelint-config-recommended": "^14.0.1",
+    "stylelint-config-recommended-vue": "^1.5.0",
+    "stylelint-config-standard": "^36.0.1",
+    "stylelint-config-standard-scss": "^13.1.0",
+    "stylelint-order": "^6.0.4"
+  },
+  "devDependencies": {
+    "@types/lodash-es": "^4.17.12",
+    "stylelint": "^16.9.0"
+  },
+  "scripts": {
+    "build": "unbuild"
+  }
+}