eslint-plugin-lit 2.0.0 → 2.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 James Garbutt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -52,6 +52,18 @@ export default [
 ];
 ```
 
+You can also specify settings that will be shared across all the plugin rules.
+
+```json5
+{
+  settings: {
+    lit: {
+      elementBaseClasses: ['ClassExtendingLitElement'] // Recognize `ClassExtendingLitElement` as a sub-class of LitElement
+    }
+  }
+}
+```
+
 ### Custom Configuration
 
 If you want more fine-grained configuration, you can instead add a snippet like this to your ESLint configuration file:
@@ -124,10 +136,7 @@ Then extend the recommended eslint config:
 
 ```json
 {
-  "extends": [
-    "plugin:wc/recommended",
-    "plugin:lit/recommended"
-  ]
+  "extends": ["plugin:wc/recommended", "plugin:lit/recommended"]
 }
 ```
 

package/lib/rules/attribute-names.js

@@ -38,7 +38,7 @@ export const rule = {
         return {
             ClassDeclaration: (node) => {
                 var _a, _b;
-                if (isLitClass(node)) {
+                if (isLitClass(node, context)) {
                     const propertyMap = getPropertyMap(node);
                     for (const [prop, propConfig] of propertyMap.entries()) {
                         if (!propConfig.attribute || propConfig.state) {

package/lib/rules/lifecycle-super.js

@@ -35,7 +35,7 @@ export const rule = {
          * @return {void}
          */
         function classEnter(node) {
-            if (!isLitClass(node)) {
+            if (!isLitClass(node, context)) {
                 return;
             }
             inElement = true;

package/lib/rules/no-classfield-shadowing.js

@@ -22,7 +22,7 @@ export const rule = {
     create(context) {
         return {
             ClassDeclaration: (node) => {
-                if (isLitClass(node)) {
+                if (isLitClass(node, context)) {
                     const propertyMap = getPropertyMap(node);
                     const classMembers = getClassFields(node);
                     for (const [prop, { key }] of propertyMap.entries()) {

package/lib/rules/no-property-change-update.js

@@ -37,7 +37,7 @@ export const rule = {
          * @return {void}
          */
         function classEnter(node) {
-            if (!isLitClass(node)) {
+            if (!isLitClass(node, context)) {
                 return;
             }
             const props = getPropertyMap(node);

package/lib/rules/no-this-assign-in-render.js

@@ -30,7 +30,7 @@ export const rule = {
          * @return {void}
          */
         function classEnter(node) {
-            if (!isLitClass(node)) {
+            if (!isLitClass(node, context)) {
                 return;
             }
             inComponent = true;

package/lib/rules/prefer-static-styles.js

@@ -29,7 +29,7 @@ export const rule = {
         const prefer = context.options[0] !== 'never';
         return {
             'ClassExpression,ClassDeclaration': (node) => {
-                if (!prefer && isLitClass(node)) {
+                if (!prefer && isLitClass(node, context)) {
                     for (const member of node.body.body) {
                         if (member.type === 'MethodDefinition' &&
                             member.kind === 'get' &&

package/lib/util.d.ts

@@ -1,4 +1,5 @@
 import * as ESTree from 'estree';
+import { Rule } from 'eslint';
 export interface BabelDecorator extends ESTree.BaseNode {
     type: 'Decorator';
     expression: ESTree.Expression;
@@ -12,9 +13,10 @@ export type DecoratedNode = ESTree.Node & {
 /**
  * Returns if the given node is a lit class
  * @param {ESTree.Class} clazz
+ * @param {Rule.RuleContext} context
  * @return { boolean }
  */
-export declare function isLitClass(clazz: ESTree.Class): boolean;
+export declare function isLitClass(clazz: ESTree.Class, context: Rule.RuleContext): boolean;
 /**
  * Get the name of a node
  *
@@ -92,3 +94,10 @@ export declare function toSnakeCase(camelCaseStr: string): string;
  * @return {string}
  */
 export declare function toKebabCase(camelCaseStr: string): string;
+/**
+ * Retrieves the configured element base class list
+ *
+ * @param {Rule.RuleContext} context ESLint rule context
+ * @return {string[]}
+ */
+export declare function getElementBaseClasses(context: Rule.RuleContext): Set<string>;

package/lib/util.js

@@ -20,23 +20,25 @@ function hasCustomElementDecorator(node) {
 /**
  * Returns if given node has a lit identifier
  * @param {ESTree.Node} node
+ * @param {Set<string>} customElementBases
  * @return {boolean}
  */
-function hasLitIdentifier(node) {
-    return node.type === 'Identifier' && node.name === 'LitElement';
+function hasLitIdentifier(node, customElementBases) {
+    return node.type === 'Identifier' && customElementBases.has(node.name);
 }
 /**
  * Returns if the given node is a lit element by expression
  * @param {ESTree.Node} node
+ * @param {Set<string>} customElementBases
  * @return {boolean}
  */
-function isLitByExpression(node) {
+function isLitByExpression(node, customElementBases) {
     if (node) {
-        if (hasLitIdentifier(node)) {
+        if (hasLitIdentifier(node, customElementBases)) {
             return true;
         }
         if (node.type === 'CallExpression') {
-            return node.arguments.some(isLitByExpression);
+            return node.arguments.some((n) => isLitByExpression(n, customElementBases));
         }
     }
     return false;
@@ -44,16 +46,19 @@ function isLitByExpression(node) {
 /**
  * Returns if the given node is a lit class
  * @param {ESTree.Class} clazz
+ * @param {Rule.RuleContext} context
  * @return { boolean }
  */
-export function isLitClass(clazz) {
+export function isLitClass(clazz, context) {
     if (hasCustomElementDecorator(clazz)) {
         return true;
     }
+    const customElementBases = getElementBaseClasses(context);
     if (clazz.superClass) {
-        return (hasLitIdentifier(clazz.superClass) || isLitByExpression(clazz.superClass));
+        return (hasLitIdentifier(clazz.superClass, customElementBases) ||
+            isLitByExpression(clazz.superClass, customElementBases));
     }
-    return hasLitIdentifier(clazz);
+    return hasLitIdentifier(clazz, customElementBases);
 }
 /**
  * Get the name of a node
@@ -287,3 +292,20 @@ export function toSnakeCase(camelCaseStr) {
 export function toKebabCase(camelCaseStr) {
     return camelCaseStr.replace(/[A-Z]/g, (m) => '-' + m.toLowerCase());
 }
+/**
+ * Retrieves the configured element base class list
+ *
+ * @param {Rule.RuleContext} context ESLint rule context
+ * @return {string[]}
+ */
+export function getElementBaseClasses(context) {
+    var _a;
+    const bases = new Set(['LitElement']);
+    if (Array.isArray((_a = context.settings.lit) === null || _a === void 0 ? void 0 : _a.elementBaseClasses)) {
+        const configuredBases = context.settings.lit.elementBaseClasses;
+        for (const base of configuredBases) {
+            bases.add(base);
+        }
+    }
+    return bases;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-lit",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "type": "module",
   "description": "lit-html support for ESLint",
   "main": "lib/index.js",