eslint-plugin-crisp 1.0.11 → 1.0.15

package/.github/workflows/build.yml

@@ -22,9 +22,6 @@ jobs:
       - name: Verify versions
         run: node --version && npm --version && node -p process.versions.v8
 
-      - name: Install dependencies
-        run: npm install
-
       - name: Release package
         run: npm publish --ignore-scripts
         env:

package/index.js

@@ -28,6 +28,7 @@ module.exports = {
     "two-lines-between-class-members": require("./rules/two-lines-between-class-members"),
     "variable-names": require("./rules/variable-names"),
     "align-consecutive-class-assignements": require("./rules/align-consecutive-class-assignements"),
+    "vue-html-quotes": require("./rules/vue-html-quotes"),
     "vue-props-declaration-order": require("./rules/vue-props-declaration-order")
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-crisp",
-  "version": "1.0.11",
+  "version": "1.0.15",
   "description": "Custom EsLint Rules for Crisp",
   "main": "index.js",
   "author": "Crisp IM SAS",
@@ -12,6 +12,7 @@
   "peerDependencies": {
     "eslint": "8.45.0",
     "eslint-plugin-vue": "8.5.0",
-    "eslint-plugin-vue-pug": "0.6.0"
+    "eslint-plugin-vue-pug": "0.6.0",
+    "vue-eslint-parser": "9.3.1"
   }
 }

package/recommended-vue.js

@@ -105,10 +105,43 @@ module.exports = {
     "crisp/jsdocs-align-params": "error",
 
     // General Vue rules
-    "vue/multi-word-component-names": "error",
+    "vue/no-v-html": "off",
+    "vue/html-quotes": "off",
+    "vue/component-tags-order": [
+      "error",
 
-    "vue/attribute-hyphenation": ["error", "always"],
+      {
+        "order": [ "template", "script", "style" ]
+      }
+    ],
+    "vue/attributes-order": [
+      "error",
 
+      {
+        order: [
+          "RENDER_MODIFIERS",
+          "CONDITIONALS",
+          "OTHER_DIRECTIVES",
+          "LIST_RENDERING",
+          "SLOT",
+          "TWO_WAY_BINDING",
+          "CONTENT",
+          "EVENTS",
+          "DEFINITION",
+          ["GLOBAL", "UNIQUE", "OTHER_ATTR"]
+        ],
+        "alphabetical": false
+      }
+    ],
+    "vue/v-slot-style": [
+      "error",
+
+      {
+        "atComponent": "v-slot",
+        "default": "v-slot",
+        "named": "longform"
+      }
+    ],
 
     // Crisp JS rules
     "crisp/header-check": "error",
@@ -130,6 +163,7 @@ module.exports = {
     ],
 
     // Crisp Vue rules
+    "crisp/vue-html-quotes": "error",
     "crisp/vue-props-declaration-order": "error"
   },
 

package/rules/vue-html-quotes.js

@@ -0,0 +1,76 @@
+module.exports = {
+  meta: {
+    type: "layout",
+    docs: {
+      description: "enforce quotes style of HTML attributes"
+    },
+
+    schema: [
+      { enum: ["double", "single"] },
+      {
+        type: "object",
+        properties: {
+          avoidEscape: {
+            type: "boolean"
+          }
+        },
+        additionalProperties: false
+      }
+    ],
+
+    messages: {
+      expected: "Expected to be enclosed by {{kind}}."
+    }
+  },
+
+  create(context) {
+    const sourceCode = context.getSourceCode()
+    const double = context.options[0] !== "single"
+    const avoidEscape =
+      context.options[1] && context.options[1].avoidEscape === true
+    const quoteChar = double ? '"' : "'"
+    const quoteName = double ? "double quotes" : "single quotes"
+
+    return context.parserServices.defineTemplateBodyVisitor(
+      {
+        "VAttribute[value!=null]"(node) {
+          const text = sourceCode.getText(node.value)
+          const firstChar = text[0]
+
+          if (firstChar !== quoteChar) {
+            const contentText = text.slice(1, -1);
+
+            const quoted = firstChar === "'" || firstChar === '"';
+
+            if (avoidEscape && quoted) {
+              if (contentText.includes(quoteChar)) {
+
+                return
+              }
+            }
+
+            // Attribute value is an object or an array
+            if (firstChar === "[" || firstChar === "{") {
+              // Matching quote in the object
+              if (contentText.includes(quoteChar)) {
+                return
+              }
+
+              // No quotes in the object or array
+              if (!contentText.includes("'") && !contentText.includes('"')) {
+                return
+              }
+            }
+
+            context.report({
+              node: node.value,
+              loc: node.value.loc,
+              messageId: "expected",
+              data: { kind: quoteName }
+            })
+          }
+        }
+      }
+    )
+  }
+}