@itcase/lint 1.0.23 → 1.0.24

package/{readme.md → README.md}

@@ -8,9 +8,43 @@ Presets of linter configurations
 $ npm i -D @itcase/lint eslint stylelint prettier
 ```
 
+## Setting up sorting configuration
+
+The sorting configuration is located in the `perfectionist` folder along the path: `eslint/perfectionist`.
+
+Example: Setting up sortJSXProps
+
+Sorting rules are defined in eslint/perfectionist/sortJSXProps.js.
+
+Here's how to set up the order and rules:
+
+1. `groups`:
+
+- This array defines the order in which the props will be sorted.
+- Add the prop names in the order you want them to be.
+
+2. `customRulesForGroups`:
+
+- If the prop sort order depends on the template (rather than the exact name), set up the rule here.
+
+- For example:
+
+```js
+const groups = [
+  'className',
+  'key',
+  // ...
+  'callback',
+]
+
+const customRulesForGroups = {
+  callback: 'on*',
+}
+```
+
 ## Usage
 
-## ESLint
+### ESLint
 
 Create a `eslint.config.mjs` configuration file in the root of your project with the following content:
 
@@ -20,7 +54,7 @@ import eslint from '@itcase/lint/eslint/index.js'
 export default eslint
 ```
 
-## ESLint with MobX
+### ESLint with MobX
 
 Create a `eslint.config.mjs` configuration file in the root of your project with the following content:
 
@@ -31,7 +65,30 @@ import eslintMobx from '@itcase/lint/eslint/mobx/index.js'
 export default [...eslint, ...eslintMobx]
 ```
 
-## Stylelint
+### ESLint with React Native
+
+Create a `eslint.config.mjs` configuration file in the root of your project with the following content:
+
+```js
+import eslint from '@itcase/lint/eslint/index.js'
+import eslintReactNative from '@itcase/lint/eslint/react-native/index.js'
+
+export default [...eslint, ...eslintReactNative]
+```
+
+### ESLint with MobX, React Native
+
+Create a `eslint.config.mjs` configuration file in the root of your project with the following content:
+
+```js
+import eslint from '@itcase/lint/eslint/index.js'
+import eslintMobx from '@itcase/lint/eslint/mobx/index.js'
+import eslintReactNative from '@itcase/lint/eslint/react-native/index.js'
+
+export default [...eslint, ...eslintMobx, ...eslintReactNative]
+```
+
+### Stylelint
 
 Create a `eslint.config.mjs` configuration file in the root of your project with the following content:
 
@@ -41,7 +98,7 @@ export default {
 }
 ```
 
-## Prettier
+### Prettier
 
 Create a `prettier.config.mjs` configuration file in the root of your project with the following content:
 
@@ -51,7 +108,7 @@ import prettier from '@itcase/lint/prettier/index.js'
 export default prettier
 ```
 
-## git-hook
+### git-hook
 
 1. Use `husky` and `lint-staged`
 

package/eslint/eslint.styleObjects.js

@@ -1,4 +1,5 @@
 // In what order they are written, that’s how they will be sorted
+// В каком порядке они записаны, так они и будут отсортированы
 const eslintStyleObjects = [
   // Size and positioning
   // Размер и позиционирование
@@ -118,8 +119,4 @@ const eslintStyleObjects = [
   'cursor',
 ]
 
-const eslintStyleObjectsCustomGroups = {}
-
-eslintStyleObjects.forEach((key) => (eslintStyleObjectsCustomGroups[key] = key))
-
-export { eslintStyleObjects, eslintStyleObjectsCustomGroups }
+export { eslintStyleObjects }

package/eslint/eslint.styleProps.js

@@ -1,4 +1,5 @@
 // In what order they are written, that’s how they will be sorted
+// В каком порядке они записаны, так они и будут отсортированы
 const eslintStyleProps = [
   'width',
   'height',
@@ -61,7 +62,4 @@ const eslintStyleProps = [
   'cursor',
 ]
 
-const eslintStylePropsCustomGroups = {}
-eslintStyleProps.forEach((key) => (eslintStylePropsCustomGroups[key] = key))
-
-export { eslintStyleProps, eslintStylePropsCustomGroups }
+export { eslintStyleProps }

package/eslint/index.js

@@ -23,6 +23,7 @@ import {
 const eslintConfig = [
   eslintJs.configs.recommended,
   ...eslintTypeScript.configs.recommended,
+  ...eslintMarkdown.configs.recommended,
   eslintPluginPrettierRecommended,
 
   {
@@ -36,10 +37,12 @@ const eslintConfig = [
   {
     ignores: ['dist', 'node_modules', 'eslint.config.mjs'],
   },
+
   {
     files: ['**/*.json'],
     ...eslintJson.configs['recommended'],
   },
+
   {
     files: ['**/*.{js,jsx,mjs,cjs,ts,tsx}'],
     rules: {
@@ -69,24 +72,24 @@ const eslintConfig = [
 
       // Class
       'perfectionist/sort-classes': sortClasses,
+      // Enum
+      'perfectionist/sort-enums': sortEnums,
+      // Interfaces
+      'perfectionist/sort-interfaces': sortInterfaces,
+      // Intersection types
+      'perfectionist/sort-intersection-types': sortIntersectionTypes,
+      // JSX props
+      'perfectionist/sort-jsx-props': sortJSXProps,
+      // Maps
+      'perfectionist/sort-maps': sortMaps,
       // Objects
       'perfectionist/sort-objects': sortObjects,
+      // Objects-types
       'perfectionist/sort-object-types': sortObjectTypes,
-      // Props
-      'perfectionist/sort-jsx-props': sortJSXProps,
-      // Interfaces
-      'perfectionist/sort-interfaces': sortInterfaces,
-
       // Union types
       'perfectionist/sort-union-types': sortUnionTypes,
-
-      // Maps, Enum, Intersection types
-      'perfectionist/sort-maps': sortMaps,
-      'perfectionist/sort-enums': sortEnums,
-      'perfectionist/sort-intersection-types': sortIntersectionTypes,
     },
   },
-  ...eslintMarkdown.configs.recommended,
 ]
 
 export default eslintConfig

package/eslint/perfectionist/index.js

@@ -1,21 +1,9 @@
-import { sortClasses } from './sortClasses.js'
-import { sortEnums } from './sortEnums.js'
-import { sortInterfaces } from './sortInterfaces.js'
-import { sortIntersectionTypes } from './sortIntersectionTypes.js'
-import { sortJSXProps } from './sortJSXProps.js'
-import { sortMaps } from './sortMaps.js'
-import { sortObjects } from './sortObjects.js'
-import { sortObjectTypes } from './sortObjectTypes.js'
-import { sortUnionTypes } from './sortUnionTypes.js'
-
-export {
-  sortClasses,
-  sortEnums,
-  sortInterfaces,
-  sortIntersectionTypes,
-  sortJSXProps,
-  sortMaps,
-  sortObjects,
-  sortObjectTypes,
-  sortUnionTypes,
-}
+export { sortClasses } from './sortClasses.js'
+export { sortEnums } from './sortEnums.js'
+export { sortInterfaces } from './sortInterfaces.js'
+export { sortIntersectionTypes } from './sortIntersectionTypes.js'
+export { sortJSXProps } from './sortJSXProps.js'
+export { sortMaps } from './sortMaps.js'
+export { sortObjects } from './sortObjects.js'
+export { sortObjectTypes } from './sortObjectTypes.js'
+export { sortUnionTypes } from './sortUnionTypes.js'

package/eslint/perfectionist/sortInterfaces.js

@@ -1,15 +1,23 @@
+import { generateCustomGroups } from '../utils/generateCustomGroups.js'
+
+// In what order they are written, that’s how they will be sorted
+// В каком порядке они записаны, так они и будут отсортированы
+const groups = ['top', 'unknown', 'is', 'callback', 'set']
+
+const customRulesForGroups = {
+  top: ['id', 'Id'],
+  is: 'is*',
+  callback: 'on*',
+  set: ['set*'],
+}
+
 const sortInterfaces = [
   'error',
   {
     type: 'natural',
     order: 'asc',
-    groups: ['top', 'unknown', 'is', 'callback', 'set'],
-    customGroups: {
-      top: ['id', 'Id'],
-      is: 'is*',
-      callback: 'on*',
-      set: ['set*'],
-    },
+    groups: groups,
+    customGroups: generateCustomGroups(groups, customRulesForGroups),
   },
 ]
 

package/eslint/perfectionist/sortJSXProps.js

@@ -1,33 +1,35 @@
-import { eslintStyleProps, eslintStylePropsCustomGroups } from './../eslint.styleProps.js'
+import { eslintStyleProps } from './../eslint.styleProps.js'
+import { generateCustomGroups } from './../utils/generateCustomGroups.js'
+
+// In what order they are written, that’s how they will be sorted
+// В каком порядке они записаны, так они и будут отсортированы
+const groups = [
+  'className',
+  'key',
+  'ref',
+  'name',
+  ...eslintStyleProps,
+  'shorthand',
+  'unknown',
+  'multiline',
+  'is',
+  'set',
+  'callback',
+]
+
+const customRulesForGroups = {
+  is: 'is*',
+  callback: 'on*',
+  set: ['set*'],
+}
 
 const sortJSXProps = [
   'error',
   {
     type: 'natural',
     order: 'asc',
-    groups: [
-      'className',
-      'key',
-      'ref',
-      'name',
-      ...eslintStyleProps,
-      'shorthand',
-      'unknown',
-      'multiline',
-      'is',
-      'set',
-      'callback',
-    ],
-    customGroups: {
-      className: 'className',
-      key: 'key',
-      ref: 'ref',
-      name: 'name',
-      ...eslintStylePropsCustomGroups,
-      is: 'is*',
-      callback: 'on*',
-      set: ['set*'],
-    },
+    groups: groups,
+    customGroups: generateCustomGroups(groups, customRulesForGroups),
   },
 ]
 

package/eslint/perfectionist/sortObjectTypes.js

@@ -1,10 +1,18 @@
+import { generateCustomGroups } from '../utils/generateCustomGroups.js'
+
+// In what order they are written, that’s how they will be sorted
+// В каком порядке они записаны, так они и будут отсортированы
+const groups = ['id']
+
+const customRulesForGroups = {}
+
 const sortObjectTypes = [
   'error',
   {
     type: 'natural',
     order: 'asc',
-    groups: ['top'],
-    customGroups: { top: 'id' },
+    groups: groups,
+    customGroups: generateCustomGroups(groups, customRulesForGroups),
   },
 ]
 

package/eslint/perfectionist/sortObjects.js

@@ -1,33 +1,36 @@
-import { eslintStyleObjects, eslintStyleObjectsCustomGroups } from './../eslint.styleObjects.js'
+import { generateCustomGroups } from '../utils/generateCustomGroups.js'
+import { eslintStyleObjects } from './../eslint.styleObjects.js'
+
+// In what order they are written, that’s how they will be sorted
+// В каком порядке они записаны, так они и будут отсортированы
+const groups = [
+  'isMobile',
+  'isTablet',
+  'isDesktop',
+  'id',
+  'children',
+  ...eslintStyleObjects,
+  'device',
+  'is',
+  'unknown',
+  'callback',
+]
+
+const customRulesForGroups = {
+  isMobile: 'isMobile*',
+  isTablet: 'isTablet*',
+  isDesktop: 'isDesktop*',
+  is: 'is*',
+  callback: 'on*',
+}
 
 const sortObjects = [
   'error',
   {
     type: 'natural',
     order: 'asc',
-    groups: [
-      'isMobile',
-      'isTablet',
-      'isDesktop',
-      'id',
-      'children',
-      ...eslintStyleObjects,
-      'device',
-      'is',
-      'unknown',
-      'callback',
-    ],
-    customGroups: {
-      id: 'id',
-      children: 'children',
-      isMobile: 'isMobile*',
-      isTablet: 'isTablet*',
-      isDesktop: 'isDesktop*',
-      ...eslintStyleObjectsCustomGroups,
-      device: 'device',
-      is: 'is*',
-      callback: 'on*',
-    },
+    groups: groups,
+    customGroups: generateCustomGroups(groups, customRulesForGroups),
   },
 ]
 

package/eslint/utils/generateCustomGroups.js

@@ -0,0 +1,11 @@
+export const generateCustomGroups = (groups, customRulesForGroups = {}) => {
+  const defaultRulesForGroups = groups.reduce((acc, group) => {
+    acc[group] = group
+    return acc
+  }, {})
+
+  return {
+    ...defaultRulesForGroups,
+    ...customRulesForGroups,
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itcase/lint",
-  "version": "1.0.23",
+  "version": "1.0.24",
   "author": "ITCase",
   "description": "Code style linter configuration presets",
   "engines": {