@itcase/lint 1.0.22 → 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

@@ -8,12 +8,22 @@ import eslintReact from 'eslint-plugin-react'
 import eslintReactHooks from 'eslint-plugin-react-hooks'
 import eslintTypeScript from 'typescript-eslint'
 
-import { eslintStyleObjects, eslintStyleObjectsCustomGroups } from './eslint.styleObjects.js'
-import { eslintStyleProps, eslintStylePropsCustomGroups } from './eslint.styleProps.js'
+import {
+  sortClasses,
+  sortEnums,
+  sortInterfaces,
+  sortIntersectionTypes,
+  sortJSXProps,
+  sortMaps,
+  sortObjects,
+  sortObjectTypes,
+  sortUnionTypes,
+} from './perfectionist/index.js'
 
 const eslintConfig = [
   eslintJs.configs.recommended,
   ...eslintTypeScript.configs.recommended,
+  ...eslintMarkdown.configs.recommended,
   eslintPluginPrettierRecommended,
 
   {
@@ -27,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: {
@@ -42,7 +54,7 @@ const eslintConfig = [
       '@typescript-eslint/no-explicit-any': 'off',
       // Sometimes you need an empty one, for example when extends
       '@typescript-eslint/no-empty-object-type': 'off',
-      "@typescript-eslint/no-unused-expressions": 'off',
+      '@typescript-eslint/no-unused-expressions': 'off',
 
       // react
       // TODO: make rule "react/prop-types" as error only for JS(x) files
@@ -59,154 +71,25 @@ const eslintConfig = [
       'object-shorthand': ['warn', 'consistent'],
 
       // Class
-      'perfectionist/sort-classes': [
-        'error',
-        {
-          type: 'natural',
-          order: 'asc',
-          groups: [
-            'top',
-            'index-signature',
-            'static-property',
-            'private-property',
-            'property',
-            'constructor',
-            'static-method',
-            'private-method',
-            'get-method',
-            'set-method',
-            'method',
-          ],
-          customGroups: [
-            {
-              groupName: 'top',
-              elementNamePattern: 'id',
-            },
-          ],
-        },
-      ],
-
-      // Objects
-      'perfectionist/sort-objects': [
-        '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*',
-          },
-        },
-      ],
-
-      // Props
-      'perfectionist/sort-jsx-props': [
-        '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*'],
-          },
-        },
-      ],
-
-      // Types
-      'perfectionist/sort-object-types': [
-        'error',
-        {
-          type: 'natural',
-          order: 'asc',
-          groups: ['top'],
-          customGroups: { top: 'id' },
-        },
-      ],
-
+      'perfectionist/sort-classes': sortClasses,
+      // Enum
+      'perfectionist/sort-enums': sortEnums,
       // Interfaces
-      'perfectionist/sort-interfaces': [
-        'error',
-        {
-          type: 'natural',
-          order: 'asc',
-          groups: ['top', 'unknown', 'is', 'callback', 'set'],
-          customGroups: {
-            top: ['id', 'Id'],
-            is: 'is*',
-            callback: 'on*',
-            set: ['set*'],
-          },
-        },
-      ],
-
+      '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,
       // Union types
-      'perfectionist/sort-union-types': [
-        'error',
-        {
-          type: 'natural',
-          order: 'asc',
-          groups: [
-            'conditional',
-            'function',
-            'import',
-            'keyword',
-            'literal',
-            'named',
-            'object',
-            'operator',
-            'tuple',
-            'union',
-            'nullish',
-            'unknown',
-          ],
-        },
-      ],
-
-      // Maps, Enum, Intersection types
-      'perfectionist/sort-maps': ['error', { type: 'natural', order: 'asc' }],
-      'perfectionist/sort-enums': ['error', { type: 'natural', order: 'asc' }],
-      'perfectionist/sort-intersection-types': ['error', { type: 'natural', order: 'asc' }],
+      'perfectionist/sort-union-types': sortUnionTypes,
     },
   },
-  ...eslintMarkdown.configs.recommended,
 ]
 
 export default eslintConfig

package/eslint/perfectionist/index.js

@@ -0,0 +1,9 @@
+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/sortClasses.js

@@ -0,0 +1,28 @@
+const sortClasses = [
+  'error',
+  {
+    type: 'natural',
+    order: 'asc',
+    groups: [
+      'top',
+      'index-signature',
+      'static-property',
+      'private-property',
+      'property',
+      'constructor',
+      'static-method',
+      'private-method',
+      'get-method',
+      'set-method',
+      'method',
+    ],
+    customGroups: [
+      {
+        groupName: 'top',
+        elementNamePattern: 'id',
+      },
+    ],
+  },
+]
+
+export { sortClasses }

package/eslint/perfectionist/sortEnums.js

@@ -0,0 +1,3 @@
+const sortEnums = ['error', { type: 'natural', order: 'asc' }]
+
+export { sortEnums }

package/eslint/perfectionist/sortInterfaces.js

@@ -0,0 +1,24 @@
+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: groups,
+    customGroups: generateCustomGroups(groups, customRulesForGroups),
+  },
+]
+
+export { sortInterfaces }

package/eslint/perfectionist/sortIntersectionTypes.js

@@ -0,0 +1,3 @@
+const sortIntersectionTypes = ['error', { type: 'natural', order: 'asc' }]
+
+export { sortIntersectionTypes }

package/eslint/perfectionist/sortJSXProps.js

@@ -0,0 +1,36 @@
+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: groups,
+    customGroups: generateCustomGroups(groups, customRulesForGroups),
+  },
+]
+
+export { sortJSXProps }

package/eslint/perfectionist/sortMaps.js

@@ -0,0 +1,3 @@
+const sortMaps = ['error', { type: 'natural', order: 'asc' }]
+
+export { sortMaps }

package/eslint/perfectionist/sortObjectTypes.js

@@ -0,0 +1,19 @@
+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: groups,
+    customGroups: generateCustomGroups(groups, customRulesForGroups),
+  },
+]
+
+export { sortObjectTypes }

package/eslint/perfectionist/sortObjects.js

@@ -0,0 +1,37 @@
+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: groups,
+    customGroups: generateCustomGroups(groups, customRulesForGroups),
+  },
+]
+
+export { sortObjects }

package/eslint/perfectionist/sortUnionTypes.js

@@ -0,0 +1,22 @@
+const sortUnionTypes = [
+  'error',
+  {
+    type: 'natural',
+    order: 'asc',
+    groups: [
+      'conditional',
+      'function',
+      'import',
+      'keyword',
+      'literal',
+      'named',
+      'object',
+      'operator',
+      'tuple',
+      'union',
+      'nullish',
+      'unknown',
+    ],
+  },
+]
+export { sortUnionTypes }

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.22",
+  "version": "1.0.24",
   "author": "ITCase",
   "description": "Code style linter configuration presets",
   "engines": {
@@ -20,7 +20,10 @@
   "files": [
     "eslint",
     "eslint/mobx",
+    "perfectionist",
     "prettier",
+    "react-native",
+    "storybook",
     "stylelint",
     "README.md"
   ],