@dialpad/eslint-plugin-dialtone 1.0.0

package/.eslintrc.js

@@ -0,0 +1,19 @@
+"use strict";
+
+module.exports = {
+  root: true,
+  extends: [
+    "eslint:recommended",
+    "plugin:eslint-plugin/recommended",
+    "plugin:node/recommended",
+  ],
+  env: {
+    node: true,
+  },
+  overrides: [
+    {
+      files: ["tests/**/*.js"],
+      env: { mocha: true },
+    },
+  ],
+};

package/README.md

@@ -0,0 +1,46 @@
+# eslint-plugin-dialtone
+
+dialtone eslint plugin
+
+## Installation
+
+You'll first need to install [ESLint](https://eslint.org/):
+
+```sh
+npm i eslint --save-dev
+```
+
+Next, install `@dialpad/eslint-plugin-dialtone`:
+
+```sh
+npm install @dialpad/eslint-plugin-dialtone --save-dev
+```
+
+## Usage
+
+Add `@dialpad/dialtone` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
+
+```json
+{
+    "plugins": [
+        "@dialpad/dialtone"
+    ]
+}
+```
+
+
+Then configure the rules you want to use under the rules section.
+
+```json
+{
+    "rules": {
+        "@dialpad/dialtone/rule-name": 2
+    }
+}
+```
+
+## Supported Rules
+
+* Fill in provided rules here
+
+

package/docs/rules/old-dialtone-icons.md

@@ -0,0 +1,35 @@
+# Finds and warns about old dialtone icons usage (old-dialtone-icons)
+
+Please describe the origin of the rule here.
+
+## Rule Details
+
+This rule aims to...
+
+Examples of **incorrect** code for this rule:
+
+```js
+
+// fill me in
+
+```
+
+Examples of **correct** code for this rule:
+
+```js
+
+// fill me in
+
+```
+
+### Options
+
+If there are any options, describe them here. Otherwise, delete this section.
+
+## When Not To Use It
+
+Give a short description of when it would be appropriate to turn off this rule.
+
+## Further Reading
+
+If there are other links that describe the issue this rule addresses, please include them here in a bulleted list.

package/lib/index.js

@@ -0,0 +1,22 @@
+/**
+ * @fileoverview dialtone eslint plugin
+ * @author julio ortega
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const requireIndex = require("requireindex");
+
+//------------------------------------------------------------------------------
+// Plugin Definition
+//------------------------------------------------------------------------------
+
+
+// import all rules in lib/rules
+module.exports.rules = requireIndex(__dirname + "/rules");
+
+
+

package/lib/rules/old-dialtone-icons.js

@@ -0,0 +1,50 @@
+/**
+ * @fileoverview Finds and warns about old dialtone icons usage
+ * @author julio ortega
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+    meta: {
+        type: 'suggestion', // `problem`, `suggestion`, or `layout`
+        docs: {
+            description: "Finds and warns about old dialtone icons usage",
+            recommended: false,
+            url: null, // URL to the documentation page for this rule
+        },
+        fixable: null, // Or `code` or `whitespace`
+        schema: [], // Add a schema if the rule has options
+        messages: {
+            avoidImport: "Avoid usage of old dialtone icons [deprecated]. Check https://dialpad.design",
+        },
+    },
+    create(context) {
+        // variables should be defined here
+
+        //----------------------------------------------------------------------
+        // Helpers
+        //----------------------------------------------------------------------
+
+        // any helper functions should go here or else delete this section
+
+        //----------------------------------------------------------------------
+        // Public
+        //----------------------------------------------------------------------
+
+        return {
+            ImportDeclaration(node) {
+                if (node.source.value.includes('@dialpad/dialtone/lib/build')) {
+                    context.report({
+                        node: node,
+                        messageId: "avoidImport",
+                    });
+                }
+            }
+        };
+    },
+};

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@dialpad/eslint-plugin-dialtone",
+  "version": "1.0.0",
+  "description": "dialtone eslint plugin",
+  "keywords": [
+    "Dialpad",
+    "Dialtone",
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin"
+  ],
+  "contributors": [
+    {
+      "name": "Brad Paugh",
+      "email": "brad.paugh@dialpad.com",
+      "url": "https://github.com/braddialpad"
+    },
+    {
+      "name": "Francis Rupert",
+      "email": "francis.rupert@dialpad.com",
+      "url": "https://github.com/francisrupert"
+    },
+    {
+      "name": "Julio Ortega",
+      "email": "julio.ortega@dialpad.com",
+      "url": "https://github.com/juliodialpad"
+    },
+    {
+      "name": "Jose Silva",
+      "email": "jose.silva@dialpad.com",
+      "url": "https://github.com/josedialpad"
+    }
+  ],
+  "repository": "git@github.com:dialpad/eslint-plugin-dialtone.git",
+  "bugs": {
+    "email": "dialtone@dialpad.com"
+  },
+  "license": "MIT",
+  "main": "./lib/index.js",
+  "exports": "./lib/index.js",
+  "scripts": {
+    "lint": "eslint .",
+    "test": "mocha tests --recursive"
+  },
+  "dependencies": {
+    "requireindex": "^1.2.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.19.0",
+    "eslint-plugin-eslint-plugin": "^5.0.0",
+    "eslint-plugin-node": "^11.1.0",
+    "mocha": "^10.0.0"
+  },
+  "engines": {
+    "node": "^14.17.0 || ^16.0.0 || >= 18.0.0"
+  },
+  "peerDependencies": {
+    "eslint": ">=7"
+  }
+}

package/tests/lib/rules/old-dialtone-icons.js

@@ -0,0 +1,31 @@
+/**
+ * @fileoverview Finds and warns about old dialtone icons usage
+ * @author julio ortega
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const rule = require("../../../lib/rules/old-dialtone-icons"),
+  RuleTester = require("eslint").RuleTester;
+
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+const ruleTester = new RuleTester();
+ruleTester.run("old-dialtone-icons", rule, {
+  valid: [
+    // give me some code that won't trigger a warning
+  ],
+
+  invalid: [
+    {
+      code: "import svgLockIcon from '@dialpad/dialtone/lib/build/svg/system/lock.svg';",
+      errors: [{ message: "Fill me in.", type: "Me too" }],
+    },
+  ],
+});