@agilebot/eslint-plugin 0.2.0 → 0.2.1

package/lib/rules/tss/unused-classes.js

@@ -1,108 +1,108 @@
-const { getBasicIdentifier, getStyesObj } = require('../../util/tss');
-
-module.exports = {
-  meta: {
-    type: 'problem'
-  },
-  create: function rule(context) {
-    const usedClasses = {};
-    const definedClasses = {};
-
-    return {
-      CallExpression(node) {
-        const stylesObj = getStyesObj(node);
-
-        if (stylesObj === undefined) {
-          return;
-        }
-
-        stylesObj.properties.forEach(property => {
-          if (property.computed) {
-            // Skip over computed properties for now.
-            // e.g. `{ [foo]: { ... } }`
-            return;
-          }
-
-          if (
-            property.type === 'ExperimentalSpreadProperty' ||
-            property.type === 'SpreadElement'
-          ) {
-            // Skip over object spread for now.
-            // e.g. `{ ...foo }`
-            return;
-          }
-          definedClasses[property.key.value || property.key.name] = property;
-        });
-      },
-
-      MemberExpression(node) {
-        if (
-          node.object.type === 'Identifier' &&
-          node.object.name === 'classes'
-        ) {
-          const whichClass = getBasicIdentifier(node.property);
-          if (whichClass) {
-            usedClasses[whichClass] = true;
-          }
-          return;
-        }
-
-        const classIdentifier = getBasicIdentifier(node.property);
-        if (!classIdentifier) {
-          // props['foo' + bar].baz
-          return;
-        }
-
-        if (classIdentifier !== 'classes') {
-          // props.foo.bar
-          return;
-        }
-
-        const { parent } = node;
-
-        if (parent.type !== 'MemberExpression') {
-          // foo.styles
-          return;
-        }
-
-        if (
-          node.object.object &&
-          node.object.object.type !== 'ThisExpression'
-        ) {
-          // foo.foo.styles
-          return;
-        }
-
-        const propsIdentifier = getBasicIdentifier(parent.object);
-        if (propsIdentifier && propsIdentifier !== 'props') {
-          return;
-        }
-        if (!propsIdentifier && parent.object.type !== 'MemberExpression') {
-          return;
-        }
-
-        if (parent.parent.type === 'MemberExpression') {
-          // this.props.props.styles
-          return;
-        }
-
-        const parentClassIdentifier = getBasicIdentifier(parent.property);
-        if (parentClassIdentifier) {
-          usedClasses[parentClassIdentifier] = true;
-        }
-      },
-      'Program:exit': () => {
-        // Now we know all of the defined classes and used classes, so we can
-        // see if there are any defined classes that are not used.
-        Object.keys(definedClasses).forEach(definedClassKey => {
-          if (!usedClasses[definedClassKey]) {
-            context.report(
-              definedClasses[definedClassKey],
-              `Class \`${definedClassKey}\` is unused`
-            );
-          }
-        });
-      }
-    };
-  }
-};
+const { getBasicIdentifier, getStyesObj } = require('../../util/tss');
+
+module.exports = {
+  meta: {
+    type: 'problem'
+  },
+  create: function rule(context) {
+    const usedClasses = {};
+    const definedClasses = {};
+
+    return {
+      CallExpression(node) {
+        const stylesObj = getStyesObj(node);
+
+        if (stylesObj === undefined) {
+          return;
+        }
+
+        stylesObj.properties.forEach(property => {
+          if (property.computed) {
+            // Skip over computed properties for now.
+            // e.g. `{ [foo]: { ... } }`
+            return;
+          }
+
+          if (
+            property.type === 'ExperimentalSpreadProperty' ||
+            property.type === 'SpreadElement'
+          ) {
+            // Skip over object spread for now.
+            // e.g. `{ ...foo }`
+            return;
+          }
+          definedClasses[property.key.value || property.key.name] = property;
+        });
+      },
+
+      MemberExpression(node) {
+        if (
+          node.object.type === 'Identifier' &&
+          node.object.name === 'classes'
+        ) {
+          const whichClass = getBasicIdentifier(node.property);
+          if (whichClass) {
+            usedClasses[whichClass] = true;
+          }
+          return;
+        }
+
+        const classIdentifier = getBasicIdentifier(node.property);
+        if (!classIdentifier) {
+          // props['foo' + bar].baz
+          return;
+        }
+
+        if (classIdentifier !== 'classes') {
+          // props.foo.bar
+          return;
+        }
+
+        const { parent } = node;
+
+        if (parent.type !== 'MemberExpression') {
+          // foo.styles
+          return;
+        }
+
+        if (
+          node.object.object &&
+          node.object.object.type !== 'ThisExpression'
+        ) {
+          // foo.foo.styles
+          return;
+        }
+
+        const propsIdentifier = getBasicIdentifier(parent.object);
+        if (propsIdentifier && propsIdentifier !== 'props') {
+          return;
+        }
+        if (!propsIdentifier && parent.object.type !== 'MemberExpression') {
+          return;
+        }
+
+        if (parent.parent.type === 'MemberExpression') {
+          // this.props.props.styles
+          return;
+        }
+
+        const parentClassIdentifier = getBasicIdentifier(parent.property);
+        if (parentClassIdentifier) {
+          usedClasses[parentClassIdentifier] = true;
+        }
+      },
+      'Program:exit': () => {
+        // Now we know all of the defined classes and used classes, so we can
+        // see if there are any defined classes that are not used.
+        Object.keys(definedClasses).forEach(definedClassKey => {
+          if (!usedClasses[definedClassKey]) {
+            context.report(
+              definedClasses[definedClassKey],
+              `Class \`${definedClassKey}\` is unused`
+            );
+          }
+        });
+      }
+    };
+  }
+};

package/lib/util/intl.js

@@ -1,127 +1,127 @@
-/**
- * Finds an attribute in formatMessage using attribute name.
- *
- * @param {Object} node - parent formatMessage node
- * @param {string} attrName - attribute name.
- * @returns {Object} node - returns node if it finds the attribute.
- */
-function findFormatMessageAttrNode(node, attrName) {
-  // Find formatMessage usages
-  if (
-    node.type === 'CallExpression' &&
-    (node.callee.name === 'formatMessage' || node.callee.name === '$t') &&
-    node.arguments.length > 0 &&
-    node.arguments[0].properties
-  ) {
-    return node.arguments[0].properties.find(
-      a => a.key && a.key.name === attrName
-    );
-  }
-
-  // Find intl.formatMessage usages
-  if (
-    node.type === 'CallExpression' &&
-    node.callee.type === 'MemberExpression' &&
-    (node.callee.object.name === 'intl' ||
-      (node.callee.object.name && node.callee.object.name.endsWith('Intl'))) &&
-    (node.callee.property.name === 'formatMessage' ||
-      node.callee.property.name === '$t')
-  ) {
-    return node.arguments[0].properties.find(
-      a => a.key && a.key.name === attrName
-    );
-  }
-}
-
-/**
- * Finds an attribute in FormattedMessage using attribute name.
- *
- * @param {Object} node - parent FormattedMessage node
- * @param {string} attrName - attribute name.
- * @returns {Object} node - returns node if it finds the attribute.
- */
-function findFormattedMessageAttrNode(node, attrName) {
-  if (
-    node.type === 'JSXIdentifier' &&
-    node.name === 'FormattedMessage' &&
-    node.parent &&
-    node.parent.type === 'JSXOpeningElement'
-  ) {
-    return node.parent.attributes.find(a => a.name && a.name.name === attrName);
-  }
-}
-
-/**
- * Finds an attribute in defineMessages using attribute name.
- *
- * @param {Object} node - parent defineMessages node
- * @param {string} attrName - attribute name.
- * @returns {Object} node - returns node if it finds the attribute.
- */
-function findAttrNodeInDefineMessages(node, attrName) {
-  if (
-    node.type === 'Property' &&
-    node.key.name === attrName &&
-    node.parent &&
-    node.parent.parent &&
-    node.parent.parent.parent &&
-    node.parent.parent.parent.parent &&
-    node.parent.parent.parent.parent.type === 'CallExpression' &&
-    node.parent.parent.parent.parent.callee.name === 'defineMessages'
-  ) {
-    return node;
-  }
-}
-
-/**
- * Finds an attribute in defineMessages using attribute name.
- *
- * @param {Object} node - parent defineMessages node
- * @param {string} attrName - attribute name.
- * @returns {Object} node - returns node if it finds the attribute.
- */
-function findAttrNodeInDefineMessage(node, attrName) {
-  if (
-    node.type === 'Property' &&
-    node.key.name === attrName &&
-    node.parent &&
-    node.parent.parent &&
-    node.parent.parent.type === 'CallExpression' &&
-    node.parent.parent.callee.name === 'defineMessage'
-  ) {
-    return node;
-  }
-}
-
-/**
- * Returns a sorted array of nodes, based on their starting posting in the locale id.
- *
- * @param {Object} node - parent node containing the locale id.
- * @returns {Array} child nodes - sorted list.
- */
-function sortedTemplateElements(node) {
-  return [...node.quasis, ...node.expressions].sort(
-    (a, b) => a.range[0] - b.range[0]
-  );
-}
-
-/**
- * Replaces place holders with asterisk and returns the resulting id.
- *
- * @param {Object} node - parent node containing the locale id.
- * @returns {string} id - fixed id.
- */
-function templateLiteralDisplayStr(node) {
-  return sortedTemplateElements(node)
-    .map(e => (!e.value ? '*' : e.value.raw))
-    .join('');
-}
-
-module.exports = {
-  findFormatMessageAttrNode,
-  findFormattedMessageAttrNode,
-  findAttrNodeInDefineMessages,
-  findAttrNodeInDefineMessage,
-  sortedTemplateElements,
-  templateLiteralDisplayStr
-};
+/**
+ * Finds an attribute in formatMessage using attribute name.
+ *
+ * @param {Object} node - parent formatMessage node
+ * @param {string} attrName - attribute name.
+ * @returns {Object} node - returns node if it finds the attribute.
+ */
+function findFormatMessageAttrNode(node, attrName) {
+  // Find formatMessage usages
+  if (
+    node.type === 'CallExpression' &&
+    (node.callee.name === 'formatMessage' || node.callee.name === '$t') &&
+    node.arguments.length > 0 &&
+    node.arguments[0].properties
+  ) {
+    return node.arguments[0].properties.find(
+      a => a.key && a.key.name === attrName
+    );
+  }
+
+  // Find intl.formatMessage usages
+  if (
+    node.type === 'CallExpression' &&
+    node.callee.type === 'MemberExpression' &&
+    (node.callee.object.name === 'intl' ||
+      (node.callee.object.name && node.callee.object.name.endsWith('Intl'))) &&
+    (node.callee.property.name === 'formatMessage' ||
+      node.callee.property.name === '$t')
+  ) {
+    return node.arguments[0].properties.find(
+      a => a.key && a.key.name === attrName
+    );
+  }
+}
+
+/**
+ * Finds an attribute in FormattedMessage using attribute name.
+ *
+ * @param {Object} node - parent FormattedMessage node
+ * @param {string} attrName - attribute name.
+ * @returns {Object} node - returns node if it finds the attribute.
+ */
+function findFormattedMessageAttrNode(node, attrName) {
+  if (
+    node.type === 'JSXIdentifier' &&
+    node.name === 'FormattedMessage' &&
+    node.parent &&
+    node.parent.type === 'JSXOpeningElement'
+  ) {
+    return node.parent.attributes.find(a => a.name && a.name.name === attrName);
+  }
+}
+
+/**
+ * Finds an attribute in defineMessages using attribute name.
+ *
+ * @param {Object} node - parent defineMessages node
+ * @param {string} attrName - attribute name.
+ * @returns {Object} node - returns node if it finds the attribute.
+ */
+function findAttrNodeInDefineMessages(node, attrName) {
+  if (
+    node.type === 'Property' &&
+    node.key.name === attrName &&
+    node.parent &&
+    node.parent.parent &&
+    node.parent.parent.parent &&
+    node.parent.parent.parent.parent &&
+    node.parent.parent.parent.parent.type === 'CallExpression' &&
+    node.parent.parent.parent.parent.callee.name === 'defineMessages'
+  ) {
+    return node;
+  }
+}
+
+/**
+ * Finds an attribute in defineMessages using attribute name.
+ *
+ * @param {Object} node - parent defineMessages node
+ * @param {string} attrName - attribute name.
+ * @returns {Object} node - returns node if it finds the attribute.
+ */
+function findAttrNodeInDefineMessage(node, attrName) {
+  if (
+    node.type === 'Property' &&
+    node.key.name === attrName &&
+    node.parent &&
+    node.parent.parent &&
+    node.parent.parent.type === 'CallExpression' &&
+    node.parent.parent.callee.name === 'defineMessage'
+  ) {
+    return node;
+  }
+}
+
+/**
+ * Returns a sorted array of nodes, based on their starting posting in the locale id.
+ *
+ * @param {Object} node - parent node containing the locale id.
+ * @returns {Array} child nodes - sorted list.
+ */
+function sortedTemplateElements(node) {
+  return [...node.quasis, ...node.expressions].sort(
+    (a, b) => a.range[0] - b.range[0]
+  );
+}
+
+/**
+ * Replaces place holders with asterisk and returns the resulting id.
+ *
+ * @param {Object} node - parent node containing the locale id.
+ * @returns {string} id - fixed id.
+ */
+function templateLiteralDisplayStr(node) {
+  return sortedTemplateElements(node)
+    .map(e => (!e.value ? '*' : e.value.raw))
+    .join('');
+}
+
+module.exports = {
+  findFormatMessageAttrNode,
+  findFormattedMessageAttrNode,
+  findAttrNodeInDefineMessages,
+  findAttrNodeInDefineMessage,
+  sortedTemplateElements,
+  templateLiteralDisplayStr
+};

package/lib/util/settings.js

@@ -1,14 +1,14 @@
-/**
- * Get a setting from eslint config
- *
- * @param {object} context - Context
- * @param {string} name - Name
- * @returns {any} result
- */
-function getSetting(context, name) {
-  return context.settings[`agilebot/${name}`];
-}
-
-module.exports = {
-  getSetting
-};
+/**
+ * Get a setting from eslint config
+ *
+ * @param {object} context - Context
+ * @param {string} name - Name
+ * @returns {any} result
+ */
+function getSetting(context, name) {
+  return context.settings[`agilebot/${name}`];
+}
+
+module.exports = {
+  getSetting
+};

package/lib/util/translations.js

@@ -1,66 +1,66 @@
-const fs = require('node:fs');
-const path = require('node:path');
-const { tsImport } = require('@agilebot/eslint-utils');
-const { getSetting } = require('./settings');
-
-/**
- * Map of locale file paths to keys and modified time
- *
- * @type {{string: {keys: Array, mtime: number}}}
- */
-const localeFilesKeys = {};
-
-/**
- * Get a list of ids keys from reading locale files
- * Keeps track of modified times and reloads if changed,; useful for realtime eslint in-editor
- *
- * @param {object} context - Context
- * @returns {string[]} results - Array of ids
- */
-function getIntlIds(context) {
-  const projectRoot = getSetting(context, 'project-root');
-  const localeFiles = getSetting(context, 'locale-files');
-
-  if (!localeFiles) {
-    throw new Error('localeFiles not in settings');
-  }
-
-  const results = [];
-  localeFiles.forEach(f => {
-    const fullPath = projectRoot ? path.join(projectRoot, f) : f;
-    const mtime = fs.lstatSync(fullPath).mtime.getTime();
-    if (
-      !localeFilesKeys[fullPath] ||
-      mtime !== localeFilesKeys[fullPath].mtime
-    ) {
-      let json;
-      if (fullPath.endsWith('.json')) {
-        json = JSON.parse(fs.readFileSync(fullPath));
-      } else if (fullPath.endsWith('.ts')) {
-        json = tsImport(fullPath);
-        if (typeof json === 'object' && json.default) {
-          json = json.default;
-        }
-      } else if (fullPath.endsWith('.js')) {
-        json = require(fullPath);
-        if (typeof json === 'object' && json.default) {
-          json = json.default;
-        }
-      } else {
-        throw new Error('unsupported file extension');
-      }
-
-      localeFilesKeys[fullPath] = {
-        keys: Object.keys(json),
-        mtime: mtime
-      };
-    }
-    results.push(...localeFilesKeys[fullPath].keys);
-  });
-
-  return results;
-}
-
-module.exports = {
-  getIntlIds
-};
+const fs = require('node:fs');
+const path = require('node:path');
+const { tsImport } = require('@agilebot/eslint-utils');
+const { getSetting } = require('./settings');
+
+/**
+ * Map of locale file paths to keys and modified time
+ *
+ * @type {{string: {keys: Array, mtime: number}}}
+ */
+const localeFilesKeys = {};
+
+/**
+ * Get a list of ids keys from reading locale files
+ * Keeps track of modified times and reloads if changed,; useful for realtime eslint in-editor
+ *
+ * @param {object} context - Context
+ * @returns {string[]} results - Array of ids
+ */
+function getIntlIds(context) {
+  const projectRoot = getSetting(context, 'project-root');
+  const localeFiles = getSetting(context, 'locale-files');
+
+  if (!localeFiles) {
+    throw new Error('localeFiles not in settings');
+  }
+
+  const results = [];
+  localeFiles.forEach(f => {
+    const fullPath = projectRoot ? path.join(projectRoot, f) : f;
+    const mtime = fs.lstatSync(fullPath).mtime.getTime();
+    if (
+      !localeFilesKeys[fullPath] ||
+      mtime !== localeFilesKeys[fullPath].mtime
+    ) {
+      let json;
+      if (fullPath.endsWith('.json')) {
+        json = JSON.parse(fs.readFileSync(fullPath));
+      } else if (fullPath.endsWith('.ts')) {
+        json = tsImport(fullPath);
+        if (typeof json === 'object' && json.default) {
+          json = json.default;
+        }
+      } else if (fullPath.endsWith('.js')) {
+        json = require(fullPath);
+        if (typeof json === 'object' && json.default) {
+          json = json.default;
+        }
+      } else {
+        throw new Error('unsupported file extension');
+      }
+
+      localeFilesKeys[fullPath] = {
+        keys: Object.keys(json),
+        mtime: mtime
+      };
+    }
+    results.push(...localeFilesKeys[fullPath].keys);
+  });
+
+  return results;
+}
+
+module.exports = {
+  getIntlIds
+};