eslint-plugin-turmag-special-rules 1.0.31 → 1.0.33

package/lib/rules/{add-vue-extension.js → add-vue-extension.ts}

@@ -1,7 +1,9 @@
+import { TSESTree } from '@typescript-eslint/utils';
+
 const path = require('node:path');
 const fs = require('node:fs');
 
-module.exports = {
+export default {
     meta: {
         fixable: 'code',
         type: 'suggestion',
@@ -16,9 +18,9 @@ module.exports = {
             properties: { aliases: { type: 'object' } },
         }],
     },
-    create(context) {
+    create(context: { options: { aliases: { [key: string]: string; } | ArrayLike<string>; }[]; getFilename: () => string; report: (arg0: { node: unknown; messageId: string; fix: (fixer: any) => any; }) => void; }) {
         return {
-            ImportDeclaration(node) {
+            ImportDeclaration(node: TSESTree.ImportDeclaration) {
                 const aliases = Object.entries(context.options[0].aliases);
                 if (!aliases.length) return;
 
@@ -33,7 +35,7 @@ module.exports = {
                 const filePath = path.resolve(basedir, nodeName);
 
                 const vueExt = '.vue';
-                const findRealExtension = filePath => {
+                const findRealExtension = (filePath: string) => {
                     let realExt = fs.existsSync(filePath) ? path.extname(filePath) : null;
                     if (realExt === null) realExt = fs.existsSync(`${filePath}${vueExt}`) ? path.extname(`${filePath}${vueExt}`) : null;
 

package/lib/rules/import-entities-by-column-or-line.ts

@@ -18,7 +18,7 @@ export default {
             properties: { minProperties: { type: 'number' } },
         }],
     },
-    // @ts-expect-error create type
+    // @ts-expect-error context type
     create(context) {
         return {
             ImportDeclaration(node: TSESTree.ImportDeclaration) {

package/lib/rules/index.ts

@@ -0,0 +1,15 @@
+import addVueExtension from './add-vue-extension.js';
+import importEntitesByColumnOrLine from './import-entities-by-column-or-line.js';
+import preferTrueAttributeShorthand from './prefer-true-attribute-shorthand.js';
+import useShortestAlias from './use-shortest-alias.js';
+import variableEntitiesByColumnOrLine from './variable-entities-by-column-or-line.js';
+
+export const rules = {
+  'add-vue-extension': addVueExtension,
+  'import-entities-by-column-or-line': importEntitesByColumnOrLine,
+  'prefer-true-attribute-shorthand': preferTrueAttributeShorthand,
+  'use-shortest-alias': useShortestAlias,
+  'variable-entities-by-column-or-line': variableEntitiesByColumnOrLine,
+};
+
+export default { rules };

package/lib/rules/{use-shortest-alias.js → use-shortest-alias.ts}

@@ -1,4 +1,7 @@
-module.exports = {
+import { TSESTree } from '@typescript-eslint/utils';
+import { Rule } from 'eslint';
+
+export default {
     meta: {
         fixable: 'code',
         type: 'suggestion',
@@ -13,10 +16,11 @@ module.exports = {
             properties: { aliases: { type: 'object' } },
         }],
     },
+    // @ts-expect-error context type
     create(context) {
         return {
-            ImportDeclaration(node) {
-                const aliases = Object.entries(context.options[0].aliases);
+            ImportDeclaration(node: TSESTree.ImportDeclaration) {
+                const aliases = Object.entries(context.options[0].aliases) as unknown as string[];
                 if (!aliases.length) return;
 
                 const nodeName = node.source.value;
@@ -41,12 +45,12 @@ module.exports = {
                     context.report({
                         node,
                         messageId: 'shortest',
-                        fix: fixer => {
+                        fix: (fixer: Rule.RuleFixer) => {
                             let replaceText = '';
                             if (node.specifiers[0].type === 'ImportDefaultSpecifier')
                                 replaceText = `import ${node.specifiers[0].local.name} from '${resultNodeName}';`;
                             else {
-                                const specifiersArr = [];
+                                const specifiersArr: string[] = [];
                                 node.specifiers.forEach(specifier => specifiersArr.push(specifier.local.name));
 
                                 const replaceSign = specifiersArr.length > 2 ? '\n' : ' ';

package/lib/rules/{variable-entities-by-column-or-line.js → variable-entities-by-column-or-line.ts}

@@ -1,3 +1,6 @@
+import { TSESTree } from '@typescript-eslint/utils';
+import { Rule } from 'eslint';
+
 export default {
     meta: {
         fixable: 'code',
@@ -12,15 +15,17 @@ export default {
             properties: { minProperties: { type: 'number' } },
         }],
     },
+    // @ts-expect-error context type
     create(context) {
         return {
-            VariableDeclaration(node) {
+            VariableDeclaration(node: TSESTree.VariableDeclaration) {
                 if (!node.declarations[0]) return;
                 if (node.declarations[0].id.type !== 'ObjectPattern') return;
                 if (!node.declarations[0].init) return;
                 const minProperties = context.options[0].minProperties;
                 const kind = node.kind;
                 const declaration = node.declarations[0];
+                // @ts-expect-error properties type
                 const properties = declaration.id.properties;
                 const sourceCode = context.sourceCode;
                 const rightSideText = sourceCode.getText(declaration.init);
@@ -28,6 +33,7 @@ export default {
                 let areLinesRepeated = false;
 
                 let isObjectDestructured = false;
+                // @ts-expect-error property type
                 properties.forEach(property => {
                     if (property.value?.type === 'ObjectPattern') isObjectDestructured = true;
                 });
@@ -37,15 +43,18 @@ export default {
                 if (properties.length < minProperties) {
                     if (properties[0].loc.start.line !== properties[0].parent.loc.start.line) areSmallAttributesInColumn = true;
                 } else {
-                    properties.every((property, i) => {
+                    // @ts-expect-error property type
+                    properties.every((property, i: number) => {
                         if (i === 0) return true;
                         if (property.loc.start.line === property.loc.end.line && properties[i - 1].loc.start.line === property.loc.start.line) areLinesRepeated = true;
                         else return !areLinesRepeated;
                     });
                 }
 
+                // @ts-expect-error properties type
                 const getPropertiesArr = properties => {
-                    const propertiesArr = [];
+                    const propertiesArr: string[] = [];
+                    // @ts-expect-error property type
                     properties.forEach(property => {
                         if (property.type === 'RestElement') {
                             propertiesArr.push(`...${property.argument.name}`);
@@ -72,9 +81,10 @@ export default {
                     context.report({
                         node,
                         messageId: 'column',
-                        fix: fixer => {
+                        fix: (fixer: Rule.RuleFixer) => {
                             const propertiesArr = getPropertiesArr(properties);
                             const replaceShiftSign = '\n    ';
+                            // @ts-expect-error node type
                             return fixer.replaceText(node, `${kind} {${replaceShiftSign}${propertiesArr.join(`,${replaceShiftSign}`)},\n} = ${rightSideText};`);
                         },
                     });
@@ -82,9 +92,10 @@ export default {
                     context.report({
                         node,
                         messageId: 'line',
-                        fix: fixer => {
+                        fix: (fixer: Rule.RuleFixer) => {
                             const propertiesArr = getPropertiesArr(properties);
                             const replaceShiftSign = ' ';
+                            // @ts-expect-error node type
                             return fixer.replaceText(node, `${kind} {${replaceShiftSign}${propertiesArr.join(`,${replaceShiftSign}`)} } = ${rightSideText};`);
                         },
                     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-turmag-special-rules",
-  "version": "1.0.31",
+  "version": "1.0.33",
   "type": "module",
   "description": "Special eslint rules for your awesome projects",
   "keywords": [
@@ -10,7 +10,7 @@
   ],
   "author": "Pavel",
   "main": "./lib/index.ts",
-  "exports": "./lib/index.ts",
+  "exports": "./dist/index.js",
   "files": [
     "lib"
   ],
@@ -32,6 +32,7 @@
     "eslint-doc-generator": "^1.0.0",
     "eslint-plugin-eslint-plugin": "^6.0.0",
     "eslint-plugin-n": "^17.0.0",
+    "eslint-scope": "^9.1.0",
     "jest": "^30.2.0",
     "mocha": "^10.0.0",
     "npm-run-all2": "^6.1.2",

package/lib/index.ts

@@ -1,17 +0,0 @@
-import addVueExtension from './rules/add-vue-extension.js';
-import importEntitesByColumnOrLine from './rules/import-entities-by-column-or-line';
-import importRightOrder from './rules/import-right-order.js';
-import preferTrueAttributeShorthand from './rules/prefer-true-attribute-shorthand';
-import useShortestAlias from './rules/use-shortest-alias.js';
-import variableEntitiesByColumnOrLine from './rules/variable-entities-by-column-or-line.js';
-
-export const rules = {
-  'add-vue-extension': addVueExtension,
-  'import-entities-by-column-or-line': importEntitesByColumnOrLine,
-  'import-right-order': importRightOrder,
-  'prefer-true-attribute-shorthand': preferTrueAttributeShorthand,
-  'use-shortest-alias': useShortestAlias,
-  'variable-entities-by-column-or-line': variableEntitiesByColumnOrLine,
-};
-
-export default { rules };

package/lib/rules/import-right-order.js

@@ -1,110 +0,0 @@
-/**
- * DEPRECATED!
- * It's better to use rule sort-imports with custom groups from plugin eslint-plugin-perfectionist
- */
-
-const entitiesOrder = ['external', 'vue', 'component', 'composable', 'store', 'mixin', 'type', 'constant', 'method', 'api'];
-const determineEntity = (value, specifiers) => {
-    let entity = 'external';
-    value = value.toLowerCase();
-
-    if (value === 'vue') entity = 'vue';
-    else if (value.includes('mixin')) entity = 'mixin';
-    else if (value.includes('.vue') || value.includes('kit')) entity = 'component';
-    else if (value.includes('composable') || specifiers && specifiers[0]?.local.name.toLowerCase().includes('use')) entity = 'composable';
-    else if (value.includes('store')) entity = 'store';
-    else if (value.includes('type')) entity = 'type';
-    else if (value.includes('constant')) entity = 'constant';
-    else if (value.includes('helper') || value.includes('utils')) entity = 'method';
-    else if (value.includes('api')) entity = 'api';
-
-    return entity;
-};
-
-module.exports = {
-    meta: {
-        fixable: 'code',
-        type: 'suggestion',
-        docs: {
-            description: 'Prefered right import order',
-        },
-        messages: {
-            order: 'Use right import order',
-        },
-         
-        schema: [],
-    },
-    create(context) {
-        let prevNode = null;
-        const nodesArr = [];
-        let isErrorOrderNode = false;
-        let startReplaceRange = 0;
-        let endReplaceRange = 0;
-
-        return {
-            ImportDeclaration(node) {
-                nodesArr.push(node);
-
-                if (prevNode) {
-                    const prevNodeEntity = determineEntity(prevNode.source.value, prevNode.specifiers);
-                    const currentNodeEntity = determineEntity(node.source.value, node.specifiers);
-
-                    const prevNodeIndex = entitiesOrder.indexOf(prevNodeEntity);
-                    const currentNodeIndex = entitiesOrder.indexOf(currentNodeEntity);
-
-                    prevNode.sortIndex = prevNodeIndex;
-                    node.sortIndex = currentNodeIndex;
-
-                    if (prevNodeIndex > currentNodeIndex && !isErrorOrderNode) {
-                        isErrorOrderNode = true;
-                    }
-                }
-
-                prevNode = node;
-
-                if (isErrorOrderNode) {
-                    context.report({
-                        node,
-                        messageId: 'order',
-                        fix: fixer => {
-                            const sortedNodesArr = structuredClone(nodesArr).sort((a, b) => a.sortIndex - b.sortIndex);
-
-                            const replacedNodesArr = [];
-                            sortedNodesArr.forEach((node, i) => {
-                                if (replacedNodesArr.length) replacedNodesArr.push(node);
-                                if (node.source.value !== nodesArr[i].source.value && !replacedNodesArr.length) {
-                                    replacedNodesArr.push(node);
-                                    startReplaceRange = nodesArr[i].range[0];
-                                }
-                                if (i === sortedNodesArr.length - 1) endReplaceRange = nodesArr[i].range[1];
-                            });
-
-                            let replaceText = '';
-
-                            replaceText = '';
-                            replacedNodesArr.forEach((node, i) => {
-                                if (!node.specifiers[0]) {
-                                    replaceText += `import '${node.source.value}';`;
-                                } else if (node.specifiers[0].type === 'ImportDefaultSpecifier') {
-                                    replaceText += `import ${node.specifiers[0].local.name} from '${node.source.value}';`;
-                                } else if (node.specifiers[0].type === 'ImportNamespaceSpecifier') {
-                                    replaceText += `import * as ${node.specifiers[0].local.name} from '${node.source.value}';`;
-                                } else {
-                                    const specifiersArr = [];
-                                    node.specifiers.forEach(specifier => specifiersArr.push(specifier.local.name));
-
-                                    const replaceSign = specifiersArr.length > 2 ? '\n' : ' ';
-                                    const replaceShiftSign = specifiersArr.length > 2 ? '\n    ' : ' ';
-                                    replaceText += `import {${replaceShiftSign}${specifiersArr.join(`,${replaceShiftSign}`)}${specifiersArr.length > 2 ? ',' : ''}${replaceSign}} from '${node.source.value}';`;
-                                }
-                                if (i < replacedNodesArr.length - 1) replaceText += '\n';
-                            });
-
-                            return fixer.replaceTextRange([startReplaceRange, endReplaceRange], replaceText);
-                        },
-                    });
-                }
-            },
-        };
-    },
-}