chore: correct linting

Author: calebdwilliams

.eslintignore

@@ -12,4 +12,7 @@ _site/
 _site-dev
 docs/_merged_assets/
 docs/_merged_data/
-docs/_merged_includes/
+docs/_merged_includes/
+**/tests/*
+*.js
+*.d.ts

.eslintrc.js

@@ -1,21 +1,17 @@
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
-  parserOptions: {
-    tsconfigRootDir: __dirname,
-    project: ['./tsconfig.json', './packages/**/tsconfig.json']
-  },
   plugins: ['simple-import-sort', '@typescript-eslint'],
+  // extends: [ require.resolve('@open-wc/eslint-config'), require.resolve('eslint-config-prettier')],
   extends: [
-    require.resolve('@open-wc/eslint-config'),
-    require.resolve('eslint-config-prettier'),
-  ],
-  extends: [
-    'plugin:@typescript-eslint/recommended', 'prettier', '@open-wc/eslint-config', 'eslint-config-prettier'
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended'
   ],
   rules: {
     'lit/no-useless-template-literals': 'off',
     'consistent-return': 'off',
     'max-classes-per-file': 'off',
+    'no-prototype-builtins': 'off'
   }
-};
+};

package.json

@@ -25,7 +25,8 @@
     "@open-wc/eslint-config": "^7.0.0",
     "@open-wc/testing": "^3.0.3",
     "@types/sinon": "^10.0.6",
-    "@typescript-eslint/parser": "^5.7.0",
+    "@typescript-eslint/eslint-plugin": "^5.9.1",
+    "@typescript-eslint/parser": "^5.9.1",
     "@web/dev-server": "^0.1.28",
     "@web/dev-server-esbuild": "^0.2.16",
     "@web/test-runner": "^0.13.22",
@@ -34,6 +35,8 @@
     "construct-style-sheets-polyfill": "^3.0.5",
     "element-internals-polyfill": "^0.1.49",
     "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-simple-import-sort": "^7.0.0",
     "husky": "^7.0.4",
     "lerna": "^4.0.0",
     "lint-staged": "^12.1.2",

packages/form-control/src/FormControlMixin.ts

@@ -1,7 +1,9 @@
 import { IElementInternals } from 'element-internals-polyfill';
 import { Constructor, FormControlInterface, FormValue, IControlHost, Validator } from './types';
 
-export function FormControlMixin<T extends Constructor<HTMLElement & IControlHost>>(SuperClass: T) {
+export function FormControlMixin<
+  TBase extends Constructor<HTMLElement & IControlHost> & { observedAttributes: string[] }
+>(SuperClass: TBase) {
   class FormControl extends SuperClass {
 
     /** Wires up control instances to be form associated */
@@ -17,6 +19,7 @@ export function FormControlMixin<T extends Constructor<HTMLElement & IControlHos
      * be set to an invalid state.
      */
     declare static formControlValidators: Validator[];
+
     private static get validators(): Validator[] {
       return this.formControlValidators || [];
     }
@@ -30,12 +33,11 @@ export function FormControlMixin<T extends Constructor<HTMLElement & IControlHos
     static get observedAttributes(): string[] {
       const validatorAttributes = this.validators.map((validator) => validator.attribute);
 
-      /** @ts-ignore This exits */
       const observedAttributes = super.observedAttributes || [];
 
       /** Make sure there are no duplicates inside the attributes list */
       const attributeSet = new Set([...observedAttributes, ...validatorAttributes]);
-      return [...attributeSet];
+      return [...attributeSet] as string[];
     }
 
     /**
@@ -130,6 +132,7 @@ export function FormControlMixin<T extends Constructor<HTMLElement & IControlHos
       return this.internals.validity;
     }
 
+    /* eslint-disable  @typescript-eslint/no-explicit-any */
     constructor(...args: any[]) {
       super(...args);
       this.addEventListener('focus', this.#onFocus);
@@ -159,7 +162,9 @@ export function FormControlMixin<T extends Constructor<HTMLElement & IControlHos
       /** Initialize the form control and perform initial validation */
       this.#initFormControl();
       this.#validate(this.value);
-      this.validationMessageCallback('');
+      if (this.validationMessageCallback) {
+        this.validationMessageCallback('');
+      }
     }
 
     disconnectedCallback() {
@@ -181,12 +186,6 @@ export function FormControlMixin<T extends Constructor<HTMLElement & IControlHos
       /** Closed over variable to track value changes */
       let value: FormValue = this.value || '';
 
-      /** Value getter reference within the closure */
-      let set: ((v: FormValue) => void) | undefined;
-
-      /** Value setter reference within the closure */
-      let get: ((v: FormValue) => void) | undefined;
-
       /** Look to see if '`checked'` is on the control's prototype */
       const hasChecked = this.#isCheckedElement;
 
@@ -210,15 +209,15 @@ export function FormControlMixin<T extends Constructor<HTMLElement & IControlHos
       }
 
       /** Make sure to defer to the parent */
-      set = descriptor && descriptor.set;
-      get = descriptor && descriptor.get;
+      const set = descriptor && descriptor.set;
+      const get = descriptor && descriptor.get;
 
       /** Define the FormControl's value property */
       Object.defineProperty(this, 'value', {
         get() {
           /** If a getter already exists, make sure to call it */
           if (get) {
-            return get.call(this, null);
+            return get.call(this);
           }
           return value;
         },
@@ -263,8 +262,8 @@ export function FormControlMixin<T extends Constructor<HTMLElement & IControlHos
         if (this.constructor.prototype.hasOwnProperty('checked')) {
           descriptor = Object.getOwnPropertyDescriptor(this.constructor.prototype, 'checked');
         }
-        let get = descriptor && descriptor.get;
-        let set = descriptor && descriptor.set;
+        const get = descriptor && descriptor.get;
+        const set = descriptor && descriptor.set;
 
         /** Close over the initial value to use in the new getter/setter */
         let checked = this.checked;
@@ -312,7 +311,7 @@ export function FormControlMixin<T extends Constructor<HTMLElement & IControlHos
      * in cases where `checked` is present upon initialization, this will be
      * effectively `this.checked && this.value`.
      */
-    valueChangedCallback(value: FormValue): void {}
+    declare valueChangedCallback: (value: FormValue) => void;
 
     /**
      * Resets a form control to its initial state
@@ -375,7 +374,9 @@ export function FormControlMixin<T extends Constructor<HTMLElement & IControlHos
         this.#forceError = true;
       }
       const showError = this.#shouldShowError();
-      this.validationMessageCallback(showError ? this.validationMessage : '');
+      if (this.validationMessageCallback) {
+        this.validationMessageCallback(showError ? this.validationMessage : '');
+      }
     };
 
     /**
@@ -400,7 +401,9 @@ export function FormControlMixin<T extends Constructor<HTMLElement & IControlHos
       }
       this.#validate(value);
       const showError = this.#shouldShowError();
-      this.validationMessageCallback(showError ? this.validationMessage : '');
+      if (this.validationMessageCallback) {
+        this.validationMessageCallback(showError ? this.validationMessage : '');
+      }
     }
 
     /**
@@ -443,7 +446,7 @@ export function FormControlMixin<T extends Constructor<HTMLElement & IControlHos
            * if a control has a ValidityCallback, it can override the error
            * message for a given validity key.
            */
-          if (this.validityCallback(key)) {
+          if (this.validityCallback && this.validityCallback(key)) {
             messageResult = this.validityCallback(key) as string;
           } else if (message instanceof Function) {
             messageResult = message(this, value);
@@ -508,14 +511,14 @@ export function FormControlMixin<T extends Constructor<HTMLElement & IControlHos
      * The returned value will be used as the validationMessage for the given key.
      * @param validationKey {string} - The key that has returned invalid
      */
-    validityCallback(validationKey: string): string | void {}
+    declare validityCallback: (validationKey: string) => string | void;
 
     /**
      * Called when the control's validationMessage should be changed
      * @param message { string } - The new validation message
      */
-    validationMessageCallback(message: string): void {}
+    declare validationMessageCallback: (message: string) => void;
   }
 
-  return FormControl as Constructor<FormControlInterface> & T;
+  return FormControl as Constructor<FormControlInterface> & TBase;
 }

packages/form-control/src/types.ts

@@ -1,7 +1,8 @@
 import { IElementInternals } from 'element-internals-polyfill';
 
 /** Generic constructor type */
-export type Constructor<T = {}> = new (...args: any[]) => T;
+/* eslint-disable  @typescript-eslint/no-explicit-any */
+export type Constructor<T = Record<string, unknown>> = new (...args: any[]) => T;
 
 /** Union type for form values */
 export type FormValue = File|FormData|string|null;
@@ -10,7 +11,7 @@ export type FormValue = File|FormData|string|null;
 export interface FormControlInterface {
   checked?: boolean;
   validationTarget?: HTMLElement | null;
-  value: any;
+  value: FormValue;
   readonly form: HTMLFormElement;
   readonly internals: IElementInternals;
   readonly showError: boolean;
@@ -20,7 +21,7 @@ export interface FormControlInterface {
   checkValidity(): boolean;
   formResetCallback(): void;
   resetFormControl(): void;
-  valueChangedCallback(value: any): void;
+  valueChangedCallback(value: FormValue): void;
   validityCallback(validationKey: string): string | void;
   validationMessageCallback(message: string): void;
 }
@@ -64,22 +65,22 @@ export interface Validator {
    * ValidityState key as an argument and must return a validationMessage
    * for the given instance.
    */
-  message: string | ((instance: any, value: any) => string);
+  message: string | ((instance: any, value: FormValue) => string);
 
   /**
    * Callback for a given validator. Takes the FormControl instance
    * and the form control value as arguments and returns a
    * boolean to evaluate for that Validator.
    * @param instance {FormControlInterface} - The FormControl instance
-   * @param value {any} - The form control value
+   * @param value {FormValue} - The form control value
    * @returns {boolean} - The validity of a given Validator
    */
-  callback(instance: HTMLElement, value: any): boolean;
+  callback(instance: HTMLElement, value: FormValue): boolean;
 }
 
 /** Generic type to allow usage of HTMLElement lifecycle methods */
 export interface IControlHost {
-  attributeChangedCallback?(name: string, oldValue: any, newValue: any): void;
+  attributeChangedCallback?(name: string, oldValue: string, newValue: string): void;
   connectedCallback?(): void;
   disconnectedCallback?(): void;
   checked?: boolean;

packages/form-control/src/validators.ts

@@ -1,11 +1,11 @@
 import { Validator } from './index';
-import { FormControlInterface } from './types';
+import { FormControlInterface, FormValue } from './types';
 
 export const requiredValidator: Validator = {
   attribute: 'required',
   key: 'valueMissing',
   message: 'Please fill out this field',
-  callback(instance: HTMLElement & { required: boolean }, value: any): boolean {
+  callback(instance: HTMLElement & { required: boolean }, value: FormValue): boolean {
     let valid = true;
 
     if ((instance.hasAttribute('required') || instance.required) && !value) {
@@ -30,9 +30,10 @@ export const minLengthValidator: Validator = {
   attribute: 'minlength',
   key: 'rangeUnderflow',
   message(instance: FormControlInterface & { minLength: number }): string {
-    return `Please use at least ${instance.minLength} characters (you are currently using ${instance.value.length} characters).`;
+    const value = instance.value as string || '';
+    return `Please use at least ${instance.minLength} characters (you are currently using ${value.length} characters).`;
   },
-  callback(instance: HTMLElement & { minLength: number }, value): boolean {
+  callback(instance: HTMLElement & { minLength: number }, value: string): boolean {
     /** If no value is provided, this validator should return true */
     if (!value) {
       return true;
@@ -52,11 +53,12 @@ export const maxLengthValidator: Validator = {
   message(
     instance: FormControlInterface & { maxLength: number }
   ): string {
-    return `Please use no more than ${instance.maxLength} characters (you are currently using ${instance.value.length} characters).`;
+    const value = instance.value as string || '';
+    return `Please use no more than ${instance.maxLength} characters (you are currently using ${value.length} characters).`;
   },
   callback(
     instance: HTMLElement & { maxLength: number },
-    value: any
+    value: string
   ): boolean {
     /** If maxLength isn't set, this is valid */
     if (!instance.maxLength) {
@@ -75,7 +77,7 @@ export const patternValidator: Validator = {
   attribute: 'pattern',
   key: 'patternMismatch',
   message: 'Please match the requested format',
-  callback(instance: HTMLElement & { pattern: string }, value): boolean {
+  callback(instance: HTMLElement & { pattern: string }, value: string): boolean {
     /** If no value is provided, this validator should return true */
     if (!value || !instance.pattern) {
       return true;

packages/form-helpers/src/index.ts

@@ -33,7 +33,7 @@ export const formValues = (form: HTMLFormElement): Record<string, FormValue> =>
   const formData = new FormData(form);
   const values: Record<string, FormValue> = {};
 
-  for (let [key, value] of formData.entries()) {
+  for (const [key, value] of formData.entries()) {
     if (!values.hasOwnProperty(key)) {
       values[key] = value;
     } else if (Array.isArray(values[key])) {
@@ -58,11 +58,11 @@ export const formValues = (form: HTMLFormElement): Record<string, FormValue> =>
  * in declaratively in HTML.
  *
  * @param form {HTMLFormElement} - The form to grab values from
- * @returns {Object<any, any>} - An object representation of the form
+ * @returns {Object<string, FormValue>} - An object representation of the form
  */
 export const parseFormAsObject = (form: HTMLFormElement): Record<string, FormValue> => {
   const data = formValues(form);
-  const output: Record<any, any> = {};
+  const output: Record<string, FormValue> = {};
 
   Object.entries(data).forEach(([key, value]) => {
     /** If the key has a '.', parse it as an object */
@@ -73,8 +73,8 @@ export const parseFormAsObject = (form: HTMLFormElement): Record<string, FormVal
 
       while (path.length) {
         const key = path.shift();
-        pointer[key as string] = pointer[key as string] || {};
-        pointer = pointer[key as string];
+        pointer[key as string] = pointer[key as string] || ({} as FormValue);
+        pointer = pointer[key as string] as unknown as Record<string, FormValue>;
       }
 
       pointer[destination as string] = value;

packages/form-helpers/tests/submit.test.ts

@@ -7,7 +7,7 @@ const submitCallbackPrevented = (event: Event) => {
   event.preventDefault();
   submitted = true;
 };
-const submitCallback = (event: Event) => {
+const submitCallback = () => {
   submitted = true;
 };
 
@@ -19,7 +19,7 @@ describe('The submit form helper', () => {
     form = await fixture<HTMLFormElement>(html`<form @submit="${submitCallback}">
       <input>
     </form>`);
-    formSubmitStub = sinon.stub(form, 'submit').callsFake(() => {});
+    formSubmitStub = sinon.stub(form, 'submit').callsFake(() => { return false; });
     submitted = false;
   });
 
@@ -32,7 +32,6 @@ describe('The submit form helper', () => {
     submit(form);
     await aTimeout(0);
     expect(submitted).to.be.true;
-    // form.submit() is called
     expect(formSubmitStub.callCount).to.equal(1);
   });
 
@@ -56,7 +55,7 @@ describe('The submit form helper', () => {
       <input>
     </form>`);
 
-    formSubmitStub = sinon.stub(form, 'submit').callsFake(() => {});
+    formSubmitStub = sinon.stub(form, 'submit').callsFake(() => { return false; });
 
     submit(form);