eslint-plugin-turmag-special-rules 0.0.1

package/README.md

@@ -0,0 +1,81 @@
+# eslint-plugin-turmag-special-rules
+
+Special eslint rules for your awesome projects
+
+## Installation
+
+You'll first need to install [ESLint](https://eslint.org/):
+
+```sh
+npm i eslint --save-dev
+```
+
+Next, install `eslint-plugin-turmag-special-rules`:
+
+```sh
+npm install eslint-plugin-turmag-special-rules --save-dev
+
+# Or run this to use yarn
+yarn add eslint-plugin-turmag-special-rules --dev
+
+# Or run this to use pnpm
+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:
+
+```js
+import turmag-eslint-special-rules from "eslint-plugin-turmag-special-rules";
+
+export default [
+    {
+        plugins: {
+            turmag-eslint-special-rules
+        }
+    }
+];
+```
+
+
+Then configure the rules you want to use under the `rules` key.
+
+```js
+import turmag-eslint-special-rules from "eslint-plugin-turmag-special-rules";
+
+export default [
+    {
+        plugins: {
+            turmag-eslint-special-rules
+        },
+        rules: {
+            "turmag-eslint-special-rules/rule-name": "warn"
+        }
+    }
+];
+```
+
+
+
+## Configurations
+
+<!-- begin auto-generated configs list -->
+TODO: Run eslint-doc-generator to generate the configs list (or delete this section if no configs are offered).
+<!-- end auto-generated configs list -->
+
+
+
+## Rules
+
+<!-- begin auto-generated rules list -->
+
+🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
+
+| Name                                                                             | Description                                                    | 🔧 |
+| :------------------------------------------------------------------------------- | :------------------------------------------------------------- | :- |
+| [prefer-true-attribute-shorthand](docs/rules/prefer-true-attribute-shorthand.md) | require shorthand form attribute when `v-bind` value is `true` | 🔧 |
+
+<!-- end auto-generated rules list -->
+
+

package/lib/index.js

@@ -0,0 +1,22 @@
+/**
+ * @fileoverview Special eslint rules for your awesome projects
+ * @author Pavel
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const requireIndex = require("requireindex");
+
+//------------------------------------------------------------------------------
+// Plugin Definition
+//------------------------------------------------------------------------------
+
+
+// import all rules in lib/rules
+module.exports.rules = requireIndex(__dirname + "/rules");
+
+
+

package/lib/rules/prefer-true-attribute-shorthand.js

@@ -0,0 +1,49 @@
+module.exports = {
+    meta: {
+        fixable: 'code',
+        type: 'problem',
+        docs: {
+            description:
+            'require shorthand form attribute when `v-bind` value is `true`',
+        },
+        messages: {
+            shortHand: 'Boolean prop with \'true\' value should be written in shorthand form',
+            longHand: 'Boolean prop with \'true\' value should be written in longhand form',
+        },
+        schema: [{ enum: ['always', 'never'] }],
+    },
+    create(context) {
+        const sourceCode = context.getSourceCode();
+        return sourceCode.parserServices?.defineTemplateBodyVisitor
+            ? sourceCode.parserServices.defineTemplateBodyVisitor({
+                VAttribute(node) {
+                    const option = context.options[0] || 'always';
+
+                    if (option === 'never' && !node.directive && !node.value) {
+                        context.report({
+                            node,
+                            messageId: 'longHand',
+                            fix: fixer => fixer.replaceText(node, `:${node.key.rawName}="true"`),
+                        });
+                    }
+
+                    if (option !== 'always') return;
+
+                    if (node.directive && node.key.name !== 'bind' && node.value?.expression.value && node.value.expression.value === Boolean(node.value.expression.value)) {
+                        const { argument } = node.key;
+                        if (!argument) return;
+
+                        context.report({
+                            node,
+                            messageId: 'shortHand',
+                            fix: fixer => {
+                                const sourceCode = context.getSourceCode();
+                                return fixer.replaceText(node, sourceCode.getText(argument));
+                            },
+                        });
+                    }
+                },
+            })
+            : {};
+    },
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "eslint-plugin-turmag-special-rules",
+  "version": "0.0.1",
+  "description": "Special eslint rules for your awesome projects",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin"
+  ],
+  "author": "Pavel",
+  "main": "./lib/index.js",
+  "exports": "./lib/index.js",
+  "files": [
+    "lib"
+  ],
+  "scripts": {
+    "lint": "npm-run-all \"lint:*\"",
+    "lint:eslint-docs": "npm-run-all \"update:eslint-docs -- --check\"",
+    "lint:js": "eslint .",
+    "test": "mocha tests --recursive",
+    "update:eslint-docs": "eslint-doc-generator"
+  },
+  "dependencies": {
+    "requireindex": "^1.2.0"
+  },
+  "devDependencies": {
+    "eslint": "^9.0.0",
+    "@eslint/js": "^9.0.0",
+    "eslint-doc-generator": "^1.0.0",
+    "eslint-plugin-eslint-plugin": "^6.0.0",
+    "eslint-plugin-n": "^17.0.0",
+    "mocha": "^10.0.0",
+    "npm-run-all2": "^6.1.2"
+  },
+  "engines": {
+    "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
+  },
+  "peerDependencies": {
+    "eslint": ">=8.57.0"
+  },
+  "license": "MIT"
+}