@dineroregnskab/eslint-plugin-custom-rules 1.0.7 → 2.0.0

package/README.md

@@ -0,0 +1,62 @@
+# Dinero custom ESLint rules
+
+Custom extended rules for various Dinero specific standards & conventions.
+
+## Installation
+
+Bundled with dinero.Frontend & dinero.Admin package.json, so a general npm install will include it as default.
+
+Explicit install:
+```bash
+npm install @dineroregnskab/eslint-plugin-eslint-custom-rules@latest --save-dev
+```
+
+## Adding rules
+
+Add the rule here:
+
+`dinero-web-2.0/Dinero.Packages/Dinero.eslintCustomRules/rules`
+
+You can test the rule by adding some code to test it on here.
+
+`dinero-web-2.0/Dinero.Packages/Dinero.eslintCustomRules/example`
+
+And run:
+
+```bash
+npx eslint test.ts
+```
+
+### Publish & install new rule locally
+
+Run:
+
+```bash
+npm patch
+```
+```bash
+npm publish
+```
+
+- In dinero.Frontend and/or dinero.Admin, update the root `package.json` file with the newly published version number.
+- Locate the `eslintrc` file and add the new rule in the rules property (under `"files": ["*.html"]`, `"files": ["*.ts"]` etc. respectively).
+> **Note: The reference here must be in the format of the package name without "eslint-plugin" + rule name**
+
+Example:
+
+`"@dineroregnskab/custom-rules/reducers-should-always-return": ["warn"]`
+
+- Run
+
+```bash
+npm i
+````
+
+> **Note: You might need to restart the IDE for the new rule to apply**
+
+#
+See [ESLint custom rule tutorial](https://eslint.org/docs/latest/extend/custom-rule-tutorial) for more.
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)

package/eslint-plugin-custom-rules.js

@@ -1,5 +1,11 @@
 const returnReducerRule = require('./rules/reducers-should-always-return');
+const camelCaseRule = require('./rules/camel-case');
 
-const customRulesplugin = { rules: { "reducers-should-always-return": returnReducerRule } };
-module.exports = customRulesplugin;
+const customRulesplugin = {
+    rules: {
+        'reducers-should-always-return': returnReducerRule,
+        'attr-camel-case-rule': camelCaseRule,
+    },
+};
 
+module.exports = customRulesplugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dineroregnskab/eslint-plugin-custom-rules",
-  "version": "1.0.7",
+  "version": "2.0.0",
   "description": "ESLint plugin with custom rules for Dineroregnskab",
   "main": "eslint-plugin-custom-rules.js",
   "scripts": {
@@ -18,8 +18,5 @@
   "files": [
     "**/*",
     "!example/**/*"
-  ],
-  "dependencies": {
-    "esquery": "^1.5.0"
-  }
+  ]
 }

package/rules/camel-case-attributes.js

@@ -0,0 +1,30 @@
+module.exports = {
+    meta: {
+      type: 'problem',
+      docs: {
+        description: 'Enforce camel case for data-cy and id attributes',
+        category: 'Possible Errors',
+      },
+      fixable: 'code',
+      schema: [],
+    },
+
+    create(context) {
+      return {
+        'VAttribute[directive=false][key.name="data-cy"], VAttribute[directive=false][key.name="id"]': function (node) {
+          const value = node.value && node.value.value;
+          const camelCasedValue = value.replace(/-([a-z])/g, function (g) { return g[1].toUpperCase(); });
+
+          if (value !== camelCasedValue) {
+            context.report({
+              node,
+              message: 'The value of data-cy and id attributes must be in camelCase.',
+              fix(fixer) {
+                return fixer.replaceText(node.value, `"${camelCasedValue}"`);
+              }
+            });
+          }
+        }
+      };
+    },
+  };