@alexlit/config-stylelint 44.0.3 → 45.0.0

package/README.md

@@ -8,22 +8,44 @@ npm i @alexlit/config-stylelint -D
 
 ## Connection
 
-```js
-// stylelint.config.js
-import config from '@alexlit/config-stylelint';
-
-export default {
-  extends: [
-    '@alexlit/config-stylelint',
-
-    /* optional */
-    '@alexlit/config-stylelint/plugins/optional/gamut',
-    '@alexlit/config-stylelint/plugins/optional/no-indistinguishable-colors',
-    '@alexlit/config-stylelint/plugins/optional/logical-css',
-  ],
-  ignoreFiles: [...config.ignoreFiles],
-};
-```
+- Default
+  ([see plugins enabled by default](https://github.com/alex-lit/lint-kit/blob/master/packages/config-stylelint/index.js#L62))
+
+  ```js
+  // stylelint.config.js
+  import { createConfig } from '@alexlit/config-stylelint';
+
+  export default createConfig();
+  ```
+
+- Custom
+
+  ```js
+  // stylelint.config.js
+  import { createConfig } from '@alexlit/config-stylelint';
+
+  export default createConfig(
+    {
+      // disable some default plugins
+      'no-nested-media': false,
+
+      // enable some optional plugins
+      gamut: true,
+      'logical-css': true,
+    },
+    {
+      // add custom rules
+      rules: {
+        'custom-property-empty-line-before': [
+          'always',
+          {
+            except: ['after-comment', 'after-custom-property', 'first-nested'],
+          },
+        ],
+      },
+    },
+  );
+  ```
 
 ## Development
 

package/index.js

@@ -1,150 +1,112 @@
-/* eslint-disable sonarjs/no-duplicate-string, unicorn/no-null */
-export default {
+/* eslint-disable no-console, import/extensions */
+
+import { config } from './config.js';
+
+const ADDITIONAL_PLUGINS = {
+  /** @see [stylelint-a11y](https://github.com/double-great/stylelint-a11y) */
+  a11y: true,
+
+  /** @see [stylelint-at-rule-no-children](https://github.com/adityavm/stylelint-at-rule-no-children) */
+  'at-rule-no-children': true,
+
+  /** @see [stylelint-color-format](https://github.com/filipekiss/stylelint-color-format) */
+  'color-format': true,
+
+  /** @see [stylelint-declaration-block-no-ignored-properties](https://github.com/kristerkari/stylelint-declaration-block-no-ignored-properties) */
+  'declaration-block-no-ignored-properties': true,
+
+  /** @see [stylelint-high-performance-animation](https://github.com/kristerkari/stylelint-high-performance-animation) */
+  'high-performance-animation': true,
+
+  /** @see [stylelint-no-nested-media](https://github.com/dkrnl/stylelint-no-nested-media) */
+  'no-nested-media': true,
+
+  /** @see [stylelint-no-unresolved-module](https://github.com/niksy/stylelint-no-unresolved-module) */
+  'no-unresolved-module': true,
+
+  /** @see [stylelint-no-unsupported-browser-features](https://github.com/ismay/stylelint-no-unsupported-browser-features) */
+  'no-unsupported-browser-features': true,
+
+  /** @see [stylelint-order](https://github.com/hudochenkov/stylelint-order) */
+  order: true,
+
+  /** @see [stylelint-scss](https://github.com/kristerkari/stylelint-scss) */
+  scss: true,
+
+  /** @see [stylelint-selector-no-empty](https://github.com/ssivanatarajan/stylelint-selector-no-empty) */
+  'selector-no-empty': true,
+
+  /** @see [stylelint-use-nesting](https://github.com/csstools/stylelint-use-nesting) */
+  'use-nesting': true,
+
+  /** @see [stylelint-config-recommended-vue](https://github.com/ota-meshi/stylelint-config-recommended-vue) */
+  vue: true,
+};
+
+const OPTIONAL_PLUGINS = {
+  /** @see [stylelint-gamut](https://github.com/fpetrakov/stylelint-gamut) */
+  gamut: false,
+
+  /** @see [stylelint-plugin-logical-css](https://github.com/yuschick/stylelint-plugin-logical-css) */
+  'logical-css': false,
+
+  /** @see [stylelint-no-indistinguishable-colors](https://github.com/ierhyna/stylelint-no-indistinguishable-colors) */
+  'no-indistinguishable-colors': false,
+};
+
+const PRETTIER_PLUGINS = {
+  /** @see [stylelint-prettier](https://github.com/prettier/stylelint-prettier) */
+  prettier: true,
+};
+
+const PLUGINS = {
+  ...ADDITIONAL_PLUGINS,
+  ...OPTIONAL_PLUGINS,
+  ...PRETTIER_PLUGINS,
+};
+
+/**
+ * Create "extends" field
+ *
+ * @param {PLUGINS} incomingPlugins Plugins
+ */
+const connectPlugins = (incomingPlugins = {}) => {
+  const extendsPlugins = [];
+
+  Object.entries({ ...PLUGINS, ...incomingPlugins })?.forEach(
+    ([name, isActive]) => {
+      if (isActive) {
+        extendsPlugins.push(`@alexlit/config-stylelint/plugins/${name}`);
+      }
+    },
+  );
+
+  return extendsPlugins;
+};
+
+/**
+ * Create stylelint config
+ *
+ * @param {PLUGINS} incomingPlugins Plugins
+ * @param {import('stylelint').Config} incomingConfig Stylelint config
+ */
+const createConfig = (incomingPlugins = {}, incomingConfig = {}) => ({
+  ...incomingConfig,
+
   extends: [
     'stylelint-config-standard',
-
-    './plugins/a11y',
-    './plugins/at-rule-no-children',
-    './plugins/color-format',
-    './plugins/declaration-block-no-ignored-properties',
-    './plugins/high-performance-animation',
-    './plugins/no-nested-media',
-    './plugins/no-unresolved-module',
-    './plugins/no-unsupported-browser-features',
-    './plugins/order',
-    './plugins/scss',
-    './plugins/selector-no-empty',
-    // './plugins/use-nesting',
-    './plugins/vue',
-
-    './plugins/prettier',
-
-    // optional
-    // './plugins/optional/gamut',
-    // './plugins/optional/no-indistinguishable-colors',
-    // './plugins/optional/logical-css',
+    ...connectPlugins(incomingPlugins),
+    ...(incomingConfig.extends ?? []),
   ],
 
   ignoreFiles: [
-    '.*/**',
-    'build/**',
-    'dist/**',
-    'docs/**',
-    'node_modules/**',
-    'storybook-*/**',
+    ...(config.ignoreFiles ?? []),
+    ...(incomingConfig.ignoreFiles ?? []),
   ],
 
-  rules: {
-    'alpha-value-notation': 'number',
-    'annotation-no-unknown': [true, { ignoreAnnotations: ['default'] }],
-    'at-rule-disallowed-list': ['debug'],
-
-    'at-rule-empty-line-before': [
-      'always',
-      {
-        except: ['blockless-after-same-name-blockless', 'first-nested'],
-        ignoreAtRules: ['else'],
-      },
-    ],
-
-    'at-rule-no-unknown': null,
-    'at-rule-no-vendor-prefix': true,
-    'block-no-empty': null,
-    'color-function-notation': 'modern',
-    'color-hex-length': 'short',
-    'color-no-hex': true,
-    'color-no-invalid-hex': true,
-
-    'custom-property-empty-line-before': [
-      'always',
-      {
-        except: ['after-comment', 'after-custom-property', 'first-nested'],
-      },
-    ],
-
-    'custom-property-pattern': '^_?[a-z]+([a-z0-9-]+[a-z0-9]+)?$',
-    'declaration-block-no-redundant-longhand-properties': null,
-
-    'declaration-property-value-no-unknown': [
-      true,
-      {
-        ignoreProperties: {
-          '/.+/': /^(v-(bind|deep|global|slotted)|theme|view)|\$/,
-        },
-      },
-    ],
-
-    'font-family-name-quotes': 'always-unless-keyword',
-    'function-no-unknown': null, // delegate to scss/function-no-unknown
-    'function-url-quotes': 'always',
-    'function-url-scheme-disallowed-list': ['/^data/', 'ftp', '/^http/'],
-    'hue-degree-notation': 'angle',
-    'keyframes-name-pattern': '^[a-z]+(-[a-z]+)*$',
-
-    'max-nesting-depth': [
-      6,
-      {
-        ignoreAtRules: ['each', 'media', 'supports', 'include'],
-      },
-    ],
-
-    'media-feature-name-no-unknown': [
-      true,
-      { ignoreMediaFeatureNames: ['screen'] },
-    ],
-
-    'media-feature-name-no-vendor-prefix': true,
-    'no-descending-specificity': null,
-    'no-empty-source': null,
-    'no-unknown-animations': true,
-    'number-max-precision': 3,
-
-    'property-no-unknown': [
-      true,
-      { ignoreProperties: ['align-tracks', 'animation-timeline'] },
-    ],
-
-    'property-no-vendor-prefix': true,
-
-    'rule-empty-line-before': [
-      'always',
-      {
-        except: ['first-nested'],
-        ignore: [],
-      },
-    ],
-
-    'selector-class-pattern': [
-      '^[a-z]([a-z0-9-]+)?(__([a-z0-9]+-?)+)?(--([a-z0-9]+-?)+){0,2}$',
-      {
-        message:
-          'Selector should be written as BEM "block__element--modifier--value" (selector-class-pattern)',
-      },
-    ],
-
-    'selector-combinator-disallowed-list': ['>>>', '/deep/'],
-
-    'selector-max-compound-selectors': 6,
-    'selector-max-id': 0,
-    'selector-no-qualifying-type': null,
-    'selector-no-vendor-prefix': true,
-    'selector-pseudo-element-disallowed-list': ['shadow'],
-
-    'selector-pseudo-element-no-unknown': [
-      true,
-      { ignorePseudoElements: ['v-deep', 'file-selector-button'] },
-    ],
-
-    'selector-type-no-unknown': [true, { ignoreTypes: ['ymaps'] }],
-    'shorthand-property-no-redundant-values': true,
-    'string-no-newline': null,
-    'time-min-milliseconds': 16,
-
-    'value-keyword-case': [
-      'lower',
-      { camelCaseSvgKeywords: true, ignoreFunctions: ['v-bind'] },
-    ],
-
-    'value-no-vendor-prefix': true,
-  },
-};
+  plugins: [...(config.plugins ?? []), ...(incomingConfig.plugins ?? [])],
+
+  rules: { ...config.rules, ...incomingConfig.rules },
+});
+
+export { createConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alexlit/config-stylelint",
-  "version": "44.0.3",
+  "version": "45.0.0",
   "private": false,
   "description": "Stylelint config",
   "keywords": [

package/plugins/a11y.js

@@ -1,4 +1,3 @@
-/** @see [stylelint-a11y](https://github.com/double-great/stylelint-a11y) */
 export default {
   plugins: ['@double-great/stylelint-a11y'],
 

package/plugins/at-rule-no-children.js

@@ -1,4 +1,3 @@
-/** @see [stylelint-at-rule-no-children](https://github.com/adityavm/stylelint-at-rule-no-children) */
 export default {
   plugins: ['stylelint-at-rule-no-children'],
 

package/plugins/color-format.js

@@ -1,4 +1,3 @@
-/** @see [stylelint-color-format](https://github.com/filipekiss/stylelint-color-format) */
 export default {
   plugins: ['stylelint-color-format'],
 

package/plugins/declaration-block-no-ignored-properties.js

@@ -1,4 +1,3 @@
-/** @see [stylelint-declaration-block-no-ignored-properties](https://github.com/kristerkari/stylelint-declaration-block-no-ignored-properties) */
 export default {
   plugins: ['stylelint-declaration-block-no-ignored-properties'],
 

package/plugins/{optional/gamut.js → gamut.js}

@@ -1,4 +1,3 @@
-/** @see [stylelint-gamut](https://github.com/fpetrakov/stylelint-gamut) */
 export default {
   plugins: ['stylelint-gamut'],
 

package/plugins/high-performance-animation.js

@@ -1,4 +1,3 @@
-/** @see [stylelint-high-performance-animation](https://github.com/kristerkari/stylelint-high-performance-animation) */
 export default {
   plugins: ['stylelint-high-performance-animation'],
 

package/plugins/{optional/logical-css.js → logical-css.js}

@@ -1,4 +1,3 @@
-/** @see [stylelint-plugin-logical-css](https://github.com/yuschick/stylelint-plugin-logical-css) */
 export default {
   plugins: ['stylelint-plugin-logical-css'],
 

package/plugins/{optional/no-indistinguishable-colors.js → no-indistinguishable-colors.js}

@@ -1,4 +1,3 @@
-/** @see [stylelint-no-indistinguishable-colors](https://github.com/ierhyna/stylelint-no-indistinguishable-colors) */
 export default {
   plugins: ['stylelint-no-indistinguishable-colors'],
 

package/plugins/no-nested-media.js

@@ -1,4 +1,3 @@
-/** @see [stylelint-no-nested-media](https://github.com/dkrnl/stylelint-no-nested-media) */
 export default {
   plugins: ['stylelint-no-nested-media'],
 

package/plugins/no-unresolved-module.js

@@ -1,4 +1,3 @@
-/** @see [stylelint-no-unresolved-module](https://github.com/niksy/stylelint-no-unresolved-module) */
 export default {
   plugins: ['stylelint-no-unresolved-module'],
 

package/plugins/no-unsupported-browser-features.js

@@ -1,4 +1,3 @@
-/** @see [stylelint-no-unsupported-browser-features](https://github.com/ismay/stylelint-no-unsupported-browser-features) */
 export default {
   plugins: ['stylelint-no-unsupported-browser-features'],
 

package/plugins/order.js

@@ -1,4 +1,3 @@
-/** @see [stylelint-order](https://github.com/hudochenkov/stylelint-order) */
 export default {
   plugins: ['stylelint-order'],
 

package/plugins/prettier.js

@@ -1,4 +1,3 @@
-/** @see [stylelint-prettier](https://github.com/prettier/stylelint-prettier) */
 export default {
   plugins: ['stylelint-prettier'],
 

package/plugins/scss.js

@@ -1,7 +1,6 @@
 /* eslint-disable unicorn/no-null */
 const KEBAB_CASE_PATTERN = '^[a-z]+([a-z0-9-]+[a-z0-9]+)?$';
 
-/** @see [stylelint-scss](https://github.com/kristerkari/stylelint-scss) */
 export default {
   extends: ['stylelint-config-standard-scss'],
 

package/plugins/selector-no-empty.js

@@ -1,4 +1,3 @@
-/** @see [stylelint-selector-no-empty](https://github.com/ssivanatarajan/stylelint-selector-no-empty) */
 export default {
   plugins: ['stylelint-selector-no-empty'],
 

package/plugins/use-nesting.js

@@ -1,4 +1,3 @@
-/** @see [stylelint-use-nesting](https://github.com/csstools/stylelint-use-nesting) */
 export default {
   plugins: ['stylelint-use-nesting'],
 

package/plugins/vue.js

@@ -1,5 +1,3 @@
-/** @see [stylelint-config-recommended-vue](https://github.com/ota-meshi/stylelint-config-recommended-vue) */
-
 export default {
   extends: 'stylelint-config-recommended-vue',
 };