eslint-plugin-lit 1.8.3 → 1.9.1

package/README.md

@@ -59,6 +59,7 @@ If you want more fine-grained configuration, you can instead add a snippet like
 - [lit/attribute-value-entities](docs/rules/attribute-value-entities.md)
 - [lit/ban-attributes](docs/rules/ban-attributes.md)
 - [lit/binding-positions](docs/rules/binding-positions.md)
+- [lit/lifecycle-super](docs/rules/lifecycle-super.md)
 - [lit/no-duplicate-template-bindings](docs/rules/no-duplicate-template-bindings.md)
 - [lit/no-invalid-escape-sequences](docs/rules/no-invalid-escape-sequences.md)
 - [lit/no-invalid-html](docs/rules/no-invalid-html.md)

package/docs/rules/lifecycle-super.md

@@ -0,0 +1,40 @@
+# Enforces calling `super` in lifecycle methods (lifecycle-super)
+
+Enforces that `super` is called in lifecycle methods which require it.
+
+For example, the `connectedCallback` should call `super.connectedCallback()` to
+avoid interrupting lit's rendering.
+
+## Rule Details
+
+This rule enforces calling of `super` in the following lifecycle methods:
+
+- `update`
+- `connectedCallback`
+- `disconnectedCallback`
+
+The following patterns are considered warnings:
+
+```ts
+class Foo extends LitElement {
+  connectedCallback() {
+    doSomething();
+  }
+}
+```
+
+The following patterns are not warnings:
+
+```ts
+class Foo extends LitElement {
+  connectedCallback() {
+    super.connectedCallback();
+    doSomething();
+  }
+}
+```
+
+## When Not To Use It
+
+If you want to override lit's default implementation of a lifecycle method,
+you should disable this rule.

package/lib/configs/all.d.ts

@@ -3,16 +3,17 @@ declare const config: {
     rules: {
         'lit/attribute-value-entities': string;
         'lit/binding-positions': string;
+        'lit/lifecycle-super': string;
         'lit/no-duplicate-template-bindings': string;
         'lit/no-invalid-escape-sequences': string;
         'lit/no-invalid-html': string;
         'lit/no-legacy-imports': string;
         'lit/no-legacy-template-syntax': string;
+        'lit/no-native-attributes': string;
         'lit/no-private-properties': string;
         'lit/no-property-change-update': string;
         'lit/no-template-arrow': string;
         'lit/no-template-bind': string;
-        'lit/no-native-attributes': string;
         'lit/no-template-map': string;
         'lit/no-this-assign-in-render': string;
         'lit/no-useless-template-literals': string;

package/lib/configs/all.js

@@ -5,16 +5,17 @@ const config = {
     rules: {
         'lit/attribute-value-entities': 'error',
         'lit/binding-positions': 'error',
+        'lit/lifecycle-super': 'error',
         'lit/no-duplicate-template-bindings': 'error',
         'lit/no-invalid-escape-sequences': 'error',
         'lit/no-invalid-html': 'error',
         'lit/no-legacy-imports': 'error',
         'lit/no-legacy-template-syntax': 'error',
+        'lit/no-native-attributes': 'error',
         'lit/no-private-properties': 'error',
         'lit/no-property-change-update': 'error',
         'lit/no-template-arrow': 'error',
         'lit/no-template-bind': 'error',
-        'lit/no-native-attributes': 'error',
         'lit/no-template-map': 'error',
         'lit/no-this-assign-in-render': 'error',
         'lit/no-useless-template-literals': 'error',

package/lib/index.d.ts

@@ -5,16 +5,17 @@ export declare const configs: {
         rules: {
             'lit/attribute-value-entities': string;
             'lit/binding-positions': string;
+            'lit/lifecycle-super': string;
             'lit/no-duplicate-template-bindings': string;
             'lit/no-invalid-escape-sequences': string;
             'lit/no-invalid-html': string;
             'lit/no-legacy-imports': string;
             'lit/no-legacy-template-syntax': string;
+            'lit/no-native-attributes': string;
             'lit/no-private-properties': string;
             'lit/no-property-change-update': string;
             'lit/no-template-arrow': string;
             'lit/no-template-bind': string;
-            'lit/no-native-attributes': string;
             'lit/no-template-map': string;
             'lit/no-this-assign-in-render': string;
             'lit/no-useless-template-literals': string;

package/lib/rules/lifecycle-super.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @fileoverview Enforces calling `super` in lifecycle methods
+ * @author James Garbutt <https://github.com/43081j>
+ */
+import { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export = rule;

package/lib/rules/lifecycle-super.js

@@ -0,0 +1,118 @@
+"use strict";
+/**
+ * @fileoverview Enforces calling `super` in lifecycle methods
+ * @author James Garbutt <https://github.com/43081j>
+ */
+const methodNames = ['connectedCallback', 'disconnectedCallback', 'update'];
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+const rule = {
+    meta: {
+        docs: {
+            description: 'Enforces calling `super` in lifecycle methods',
+            recommended: false,
+            url: 'https://github.com/43081j/eslint-plugin-lit/blob/master/docs/rules/lifecycle-super.md'
+        },
+        schema: [],
+        messages: {
+            callSuper: 'You must call `super.{{method}}` to avoid interrupting ' +
+                'the lit rendering lifecycle'
+        }
+    },
+    create(context) {
+        // variables should be defined here
+        let inElement = false;
+        let currentMethod = null;
+        let superSeen = false;
+        //----------------------------------------------------------------------
+        // Helpers
+        //----------------------------------------------------------------------
+        /**
+         * Class entered
+         *
+         * @param {ESTree.Class} node Node entered
+         * @return {void}
+         */
+        function classEnter(node) {
+            if (!node.superClass ||
+                node.superClass.type !== 'Identifier' ||
+                node.superClass.name !== 'LitElement') {
+                return;
+            }
+            inElement = true;
+        }
+        /**
+         * Class exited
+         *
+         * @return {void}
+         */
+        function classExit() {
+            inElement = false;
+        }
+        /**
+         * Method entered
+         *
+         * @param {ESTree.MethodDefinition} node Node entered
+         * @return {void}
+         */
+        function methodEnter(node) {
+            if (!inElement ||
+                node.static === true ||
+                node.kind !== 'method' ||
+                node.key.type !== 'Identifier' ||
+                !methodNames.includes(node.key.name)) {
+                return;
+            }
+            currentMethod = node.key.name;
+        }
+        /**
+         * Method exited
+         *
+         * @param {ESTree.MethodDefinition} node Node entered
+         * @return {void}
+         */
+        function methodExit(node) {
+            if (currentMethod !== null && !superSeen) {
+                context.report({
+                    node,
+                    messageId: 'callSuper',
+                    data: {
+                        method: currentMethod
+                    }
+                });
+            }
+            currentMethod = null;
+            superSeen = false;
+        }
+        /**
+         * Call expression entered
+         * @param {ESTree.CallExpression} node Node entered
+         * @return {void}
+         */
+        function callExpressionEnter(node) {
+            if (currentMethod === null) {
+                return;
+            }
+            if (node.callee.type === 'MemberExpression' &&
+                node.callee.object.type === 'Super' &&
+                node.callee.property.type === 'Identifier' &&
+                node.callee.property.name === currentMethod) {
+                superSeen = true;
+            }
+        }
+        //----------------------------------------------------------------------
+        // Public
+        //----------------------------------------------------------------------
+        return {
+            ClassExpression: (node) => classEnter(node),
+            ClassDeclaration: (node) => classEnter(node),
+            'ClassExpression:exit': classExit,
+            'ClassDeclaration:exit': classExit,
+            MethodDefinition: (node) => methodEnter(node),
+            'MethodDefinition:exit': methodExit,
+            CallExpression: (node) => callExpressionEnter(node)
+        };
+    }
+};
+module.exports = rule;

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "eslint-plugin-lit",
-  "version": "1.8.3",
+  "version": "1.9.1",
   "description": "lit-html support for ESLint",
   "main": "lib/index.js",
   "files": [
-    "lib/!(test)",
+    "lib/",
+    "!lib/test",
     "docs",
     "custom_types"
   ],