eslint-plugin-turmag-special-rules 0.0.1 → 0.0.3

package/README.md

@@ -24,15 +24,15 @@ pnpm add eslint-plugin-turmag-special-rules --save-dev
 
 ## Usage
 
-In your [configuration file](https://eslint.org/docs/latest/use/configure/configuration-files#configuration-file), import the plugin `eslint-plugin-turmag-special-rules` and add `turmag-eslint-special-rules` to the `plugins` key:
+In your [configuration file](https://eslint.org/docs/latest/use/configure/configuration-files#configuration-file), import the plugin `eslint-plugin-turmag-special-rules` and add `turmagEslintSpecialRules` to the `plugins` key:
 
 ```js
-import turmag-eslint-special-rules from "eslint-plugin-turmag-special-rules";
+import turmagEslintSpecialRules from "eslint-plugin-turmag-special-rules";
 
 export default [
     {
         plugins: {
-            turmag-eslint-special-rules
+            turmagEslintSpecialRules
         }
     }
 ];
@@ -42,15 +42,15 @@ export default [
 Then configure the rules you want to use under the `rules` key.
 
 ```js
-import turmag-eslint-special-rules from "eslint-plugin-turmag-special-rules";
+import turmagEslintSpecialRules from "eslint-plugin-turmag-special-rules";
 
 export default [
     {
         plugins: {
-            turmag-eslint-special-rules
+            turmagEslintSpecialRules
         },
         rules: {
-            "turmag-eslint-special-rules/rule-name": "warn"
+            "turmagEslintSpecialRules/rule-name": "warn"
         }
     }
 ];
@@ -74,7 +74,9 @@ TODO: Run eslint-doc-generator to generate the configs list (or delete this sect
 
 | Name                                                                             | Description                                                    | 🔧 |
 | :------------------------------------------------------------------------------- | :------------------------------------------------------------- | :- |
-| [prefer-true-attribute-shorthand](docs/rules/prefer-true-attribute-shorthand.md) | require shorthand form attribute when `v-bind` value is `true` | 🔧 |
+| [add-vue-extension](docs/rules/add-vue-extension.md)                             | require .vue in vue files                                      | 🔧 |
+| [prefer-true-attribute-shorthand](docs/rules/prefer-true-attribute-shorthand.md) | require shorthand form attribute when `v-bind` value is `true` | 🔧 |
+| [use-shortest-alias](docs/rules/use-shortest-alias.md)                           | There are can be used shortest alias                           | 🔧 |
 
 <!-- end auto-generated rules list -->
 

package/lib/rules/add-vue-extension.js

@@ -0,0 +1,56 @@
+const path = require('node:path');
+const fs = require('node:fs');
+
+module.exports = {
+    meta: {
+        fixable: 'code',
+        type: 'suggestion',
+        docs: {
+            description: 'require .vue in vue files',
+        },
+        messages: {
+            proper: 'Use proper import of vue files',
+        },
+        schema: [{
+            type: 'object',
+            properties: { aliases: { type: 'object' } },
+        }],
+    },
+    create(context) {
+        return {
+            ImportDeclaration(node) {
+                const aliases = Object.entries(context.options[0].aliases);
+                if (!aliases.length) return;
+
+                const basedir = path.dirname(path.resolve(context.getFilename()));
+                let nodeName = node.source.value;
+
+                aliases.every(([key, value]) => {
+                    if (nodeName.includes(key)) nodeName = nodeName.replace(key, value);
+                    else return nodeName === node.source.value;
+                });
+
+                const filePath = path.resolve(basedir, nodeName);
+
+                const vueExt = '.vue';
+                const findRealExtension = filePath => {
+                    let realExt = fs.existsSync(filePath) ? path.extname(filePath) : null;
+                    if (realExt === null) realExt = fs.existsSync(`${filePath}${vueExt}`) ? path.extname(`${filePath}${vueExt}`) : null;
+
+                    return realExt;
+                };
+
+                const nodeNameExt = path.extname(nodeName);
+                const realExt = findRealExtension(filePath);
+
+                if (realExt === vueExt && realExt !== nodeNameExt) {
+                    context.report({
+                        node,
+                        messageId: 'proper',
+                        fix: fixer => fixer.replaceText(node, node.specifiers.map(specifier => `import ${specifier.local.name} from '${node.source.value}${realExt}';`).join('\n')),
+                    });
+                }
+            },
+        };
+    },
+}

package/lib/rules/use-shortest-alias.js

@@ -0,0 +1,64 @@
+module.exports = {
+    meta: {
+        fixable: 'code',
+        type: 'suggestion',
+        docs: {
+            description: 'There are can be used shortest alias',
+        },
+        messages: {
+            shortest: 'Use shortest alias',
+        },
+        schema: [{
+            type: 'object',
+            properties: { aliases: { type: 'object' } },
+        }],
+    },
+    create(context) {
+        return {
+            ImportDeclaration(node) {
+                const aliases = Object.entries(context.options[0].aliases);
+                if (!aliases.length) return;
+
+                const nodeName = node.source.value;
+                let nodeNameWithoutAlias = nodeName;
+                let resultNodeName = nodeName;
+
+                aliases.every(([key, value]) => {
+                    if (nodeNameWithoutAlias.includes(key)) nodeNameWithoutAlias = nodeNameWithoutAlias.replace(key, value);
+                    else return nodeNameWithoutAlias === nodeName;
+                });
+
+                nodeNameWithoutAlias = nodeNameWithoutAlias.replace(/\\/ig, '/');
+
+                aliases.every(([key, value]) => {
+                    value = value.replace(/\\/ig, '/');
+                    if (nodeNameWithoutAlias.includes(value))
+                        resultNodeName = nodeNameWithoutAlias.replace(value, key).replace(/\\/ig, '/');
+                    else return resultNodeName === nodeName;
+                });
+
+                if (nodeName !== resultNodeName) {
+                    context.report({
+                        node,
+                        messageId: 'shortest',
+                        fix: fixer => {
+                            let replaceText = '';
+                            if (node.specifiers[0].type === 'ImportDefaultSpecifier')
+                                replaceText = `import ${node.specifiers[0].local.name} from '${resultNodeName}';`;
+                            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 '${resultNodeName}';`;
+                            }
+
+                            return fixer.replaceText(node, replaceText);
+                        },
+                    });
+                }
+            },
+        };
+    },
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-turmag-special-rules",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Special eslint rules for your awesome projects",
   "keywords": [
     "eslint",
@@ -24,8 +24,8 @@
     "requireindex": "^1.2.0"
   },
   "devDependencies": {
-    "eslint": "^9.0.0",
     "@eslint/js": "^9.0.0",
+    "eslint": "^9.0.0",
     "eslint-doc-generator": "^1.0.0",
     "eslint-plugin-eslint-plugin": "^6.0.0",
     "eslint-plugin-n": "^17.0.0",