From 5a0b2c41eaf1ac7f158655a7cafa92cb93ea027e Mon Sep 17 00:00:00 2001
From: CubLion <alex.ghiu@ing.com>
Date: Wed, 19 Feb 2020 14:32:01 +0100
Subject: [PATCH] chore: todo cleanup

---
 packages/ajax/src/AjaxClass.js                        |  2 --
 packages/button/test/lion-button.test.js              |  1 -
 packages/calendar/src/utils/dayTemplate.js            |  1 -
 packages/field/README.md                              |  5 -----
 packages/field/docs/FormFundaments.md                 |  5 -----
 packages/field/src/FormControlMixin.js                |  5 ++---
 packages/field/src/FormRegistrarPortalMixin.js        |  1 -
 packages/field/src/FormatMixin.js                     |  2 +-
 packages/field/src/LionField.js                       | 10 +++-------
 packages/field/src/formRegistrarManager.js            |  1 -
 packages/field/test-suites/FormatMixin.suite.js       |  6 ------
 packages/field/test/lion-field.test.js                |  6 ++----
 packages/fieldset/src/LionFieldset.js                 | 11 ++++-------
 .../stories/20-System-Overview.stories.mdx            |  3 ---
 packages/input-amount/test/formatters.test.js         |  2 --
 packages/input/src/LionInput.js                       |  1 +
 16 files changed, 13 insertions(+), 49 deletions(-)

diff --git a/packages/ajax/src/AjaxClass.js b/packages/ajax/src/AjaxClass.js
index 35b9a3fcc..345ed1616 100644
--- a/packages/ajax/src/AjaxClass.js
+++ b/packages/ajax/src/AjaxClass.js
@@ -75,7 +75,6 @@ export class AjaxClass extends LionSingleton {
 
   /**
    * Sets the config for the instance
-   * TODO: rename to 'config', because of conflict with options() request method on axios
    */
   set options(config) {
     this.__config = config;
@@ -130,7 +129,6 @@ export class AjaxClass extends LionSingleton {
    * @param {string} url the endpoint location
    * @param {AxiosRequestConfig} config the config specific for this request
    * @returns {AxiosResponseSchema}
-   * TODO: consider reenable after rename of options to config
    */
   // options(url, config) {
   //   return this.proxy.options.apply(this, [url, { ...this.__config, ...config }]);
diff --git a/packages/button/test/lion-button.test.js b/packages/button/test/lion-button.test.js
index 8c43082d2..cec060e31 100644
--- a/packages/button/test/lion-button.test.js
+++ b/packages/button/test/lion-button.test.js
@@ -47,7 +47,6 @@ describe('lion-button', () => {
   it('hides the native button in the UI', async () => {
     const el = await fixture(`<lion-button>foo</lion-button>`);
     expect(el._nativeButtonNode.getAttribute('tabindex')).to.equal('-1');
-    // TODO: If we abstract to an srOnlyMixin, we should test that the styling equals that of the srOnlyMixin output
     expect(window.getComputedStyle(el._nativeButtonNode).clip).to.equal('rect(0px, 0px, 0px, 0px)');
   });
 
diff --git a/packages/calendar/src/utils/dayTemplate.js b/packages/calendar/src/utils/dayTemplate.js
index a8f7a0b97..d7442744f 100644
--- a/packages/calendar/src/utils/dayTemplate.js
+++ b/packages/calendar/src/utils/dayTemplate.js
@@ -15,7 +15,6 @@ const defaultMonthLabels = [
   'December',
 ];
 
-// TODO: remove as much logic as possible from this template and move to processor
 export function dayTemplate(day, { weekdays, monthsLabels = defaultMonthLabels } = {}) {
   const dayNumber = day.date.getDate();
   const monthName = monthsLabels[day.date.getMonth()];
diff --git a/packages/field/README.md b/packages/field/README.md
index f2080806e..e3031f50b 100644
--- a/packages/field/README.md
+++ b/packages/field/README.md
@@ -53,13 +53,8 @@ Fieldsets are the basis for:
 
 ## Other Resources
 
-<!-- TODO: - [`FormControlMixin`] () -->
-<!-- TODO: - [`LionField`] () -->
-
 - [Model Value](./docs/modelValue.md)
 - [Formatting and parsing](./docs/FormattingAndParsing.md)
 - [Interaction states](./docs/InteractionStates.md)
 - [Validation System](../validate/docs/ValidationSystem.md)
 - [Custom Fields](./docs/CustomFieldsTutorial.md)
-
-<!-- TODO: - [`FocusMixin`] (/FocusMixin.md) -->
diff --git a/packages/field/docs/FormFundaments.md b/packages/field/docs/FormFundaments.md
index b183d173d..3cec7713a 100644
--- a/packages/field/docs/FormFundaments.md
+++ b/packages/field/docs/FormFundaments.md
@@ -50,13 +50,8 @@ Fieldsets are the basis for:
 
 ## Other Resources
 
-<!-- TODO: - [`FormControlMixin`] () -->
-<!-- TODO: - [`LionField`] () -->
-
 - [Model Value](./modelValue.md)
 - [Formatting and parsing](./FormattingAndParsing.md)
 - [Interaction states](./InteractionStates.md)
 - [Validation System](../../validate/docs/ValidationSystem.md)
 - [FieldCustomMixin](./FieldCustomMixin.md)
-
-<!-- TODO: - [`FocusMixin`] (/FocusMixin.md) -->
diff --git a/packages/field/src/FormControlMixin.js b/packages/field/src/FormControlMixin.js
index 8133e6ae3..c58717615 100644
--- a/packages/field/src/FormControlMixin.js
+++ b/packages/field/src/FormControlMixin.js
@@ -393,9 +393,6 @@ export const FormControlMixin = dedupeMixin(
        * with the CSS component.
        * Note that every occurence of '::slotted(*)' can be rewritten to '> *' for use in an other
        * context
-       *
-       * TODO: find best naming convention: https://en.bem.info/methodology/naming-convention/
-       * (react style would align better with JSS)
        */
 
       /**
@@ -418,6 +415,8 @@ export const FormControlMixin = dedupeMixin(
        * - {state} [dirty] whether the value has changed since initial value
        *
        * TODO: update states below
+       * These classes are now attributes. Check them agains the new attribute names inside ValidateMixin
+       * and InteractionStateMixin. Some states got renamed. Make sure to use the correct ones!
        * - {state} .state-focused: when .form-control (<input>, <textarea> etc.) <input> has focus
        * - {state} .state-invalid: when input has error(s) (regardless of whether they should be
        *            shown to the user)
diff --git a/packages/field/src/FormRegistrarPortalMixin.js b/packages/field/src/FormRegistrarPortalMixin.js
index 223eceb8c..e288897df 100644
--- a/packages/field/src/FormRegistrarPortalMixin.js
+++ b/packages/field/src/FormRegistrarPortalMixin.js
@@ -41,7 +41,6 @@ export const FormRegistrarPortalMixin = dedupeMixin(
 
         this.__redispatchEventForFormRegistrarPortalMixin = ev => {
           ev.stopPropagation();
-          // TODO: change ev.target to original registering element
           this.registrationTarget.dispatchEvent(
             new CustomEvent('form-element-register', {
               detail: { element: ev.detail.element },
diff --git a/packages/field/src/FormatMixin.js b/packages/field/src/FormatMixin.js
index b532d0102..79b0b4758 100644
--- a/packages/field/src/FormatMixin.js
+++ b/packages/field/src/FormatMixin.js
@@ -219,7 +219,7 @@ export const FormatMixin = dedupeMixin(
           // For backwards compatibility we return an empty string:
           // - it triggers validation for required validators (see ValidateMixin.validate())
           // - it can be expected by 3rd parties (for instance unit tests)
-          // TODO: In a breaking refactor of the Validation System, this behavior can be corrected.
+          // TODO(@tlouisse): In a breaking refactor of the Validation System, this behavior can be corrected.
           return '';
         }
 
diff --git a/packages/field/src/LionField.js b/packages/field/src/LionField.js
index 39a560026..be80f3476 100644
--- a/packages/field/src/LionField.js
+++ b/packages/field/src/LionField.js
@@ -8,11 +8,7 @@ import { FocusMixin } from './FocusMixin.js';
 
 /* eslint-disable wc/guard-super-call */
 
-// TODO:
-// - Consider exporting as FieldMixin
-// - Add submitted prop to InteractionStateMixin
-// - Find a better way to do value delegation via attr
-
+// TODO: Add submitted prop to InteractionStateMixin.
 /**
  * `LionField`: wraps <input>, <textarea>, <select> and other interactable elements.
  * Also it would follow a nice hierarchy: lion-form -> lion-fieldset -> lion-field
@@ -107,7 +103,8 @@ export class LionField extends FormControlMixin(
   }
 
   connectedCallback() {
-    // TODO: Normally we put super calls on top for predictability,
+    // TODO: Investigate issue below.
+    // Normally we put super calls on top for predictability,
     // here we temporarily need to do attribute delegation before,
     // so the FormatMixin uses the right value. Should be solved
     // when value delegation is part of the calculation loop of
@@ -197,7 +194,6 @@ export class LionField extends FormControlMixin(
   }
 
   /**
-   * Copied from Polymer team. TODO: add license
    * Restores the cursor to its original position after updating the value.
    * @param {string} newValue The value that should be saved.
    */
diff --git a/packages/field/src/formRegistrarManager.js b/packages/field/src/formRegistrarManager.js
index 6d41ea861..563d66cef 100644
--- a/packages/field/src/formRegistrarManager.js
+++ b/packages/field/src/formRegistrarManager.js
@@ -27,7 +27,6 @@ class FormRegistrarManager {
     }
   }
 
-  // TODO: this method has to be removed when EventTarget polyfill is available on IE11
   _fakeExtendsEventTarget() {
     const delegate = document.createDocumentFragment();
     ['addEventListener', 'dispatchEvent', 'removeEventListener'].forEach(funcName => {
diff --git a/packages/field/test-suites/FormatMixin.suite.js b/packages/field/test-suites/FormatMixin.suite.js
index 6068f8c94..88addcc17 100644
--- a/packages/field/test-suites/FormatMixin.suite.js
+++ b/packages/field/test-suites/FormatMixin.suite.js
@@ -11,7 +11,6 @@ function mimicUserInput(formControl, newViewValue) {
 }
 
 export function runFormatMixinSuite(customConfig) {
-  // TODO: Maybe remove suffix
   const cfg = {
     tagString: null,
     modelValueType: String,
@@ -23,11 +22,6 @@ export function runFormatMixinSuite(customConfig) {
    * Mocks a value for you based on the data type
    * Optionally toggles you a different value
    * for needing to mimic a value-change.
-   *
-   * TODO: The FormatMixin can know about platform types like
-   * Date, but not about modelValue of input-iban etc.
-   * Make this concept expandable by allowing 'non standard'
-   * modelValues to hook into this.
    */
   function generateValueBasedOnType(opts = {}) {
     const options = { type: cfg.modelValueType, toggleValue: false, viewValue: false, ...opts };
diff --git a/packages/field/test/lion-field.test.js b/packages/field/test/lion-field.test.js
index c14daaccf..4177e2195 100644
--- a/packages/field/test/lion-field.test.js
+++ b/packages/field/test/lion-field.test.js
@@ -153,8 +153,6 @@ describe('<lion-field>', () => {
     expect(el._inputNode.getAttribute('autocomplete')).to.equal('off');
   });
 
-  // TODO: find out if we could put all listeners on this.value (instead of this._inputNode.value)
-  // and make it act on this.value again
   it('has an attribute filled if this.value is filled', async () => {
     const el = await fixture(html`<${tag} value="filled">${inputSlot}</${tag}>`);
     expect(el.hasAttribute('filled')).to.equal(true);
@@ -178,7 +176,7 @@ describe('<lion-field>', () => {
     expect(el._inputNode.selectionEnd).to.equal(2);
   });
 
-  // TODO: add pointerEvents test for disabled
+  // TODO: Add test that css pointerEvents is none if disabled.
   it('is disabled when disabled property is passed', async () => {
     const el = await fixture(html`<${tag}>${inputSlot}</${tag}>`);
     expect(el._inputNode.hasAttribute('disabled')).to.equal(false);
@@ -241,7 +239,7 @@ describe('<lion-field>', () => {
       );
     });
 
-    // TODO: put this test on FormControlMixin test once there
+    // TODO: Move test below to FormControlMixin.test.js.
     it(`allows to add to aria description or label via addToAriaLabelledBy() and
       addToAriaDescribedBy()`, async () => {
       const wrapper = await fixture(html`
diff --git a/packages/fieldset/src/LionFieldset.js b/packages/fieldset/src/LionFieldset.js
index a40296885..ece64a2a7 100644
--- a/packages/fieldset/src/LionFieldset.js
+++ b/packages/fieldset/src/LionFieldset.js
@@ -19,6 +19,7 @@ export class LionFieldset extends FormRegistrarMixin(
       name: {
         type: String,
       },
+      // TODO: Move property submitted to InteractionStateMixin.
       submitted: {
         type: Boolean,
         reflect: true,
@@ -231,7 +232,6 @@ export class LionFieldset extends FormRegistrarMixin(
   }
 
   resetInteractionState() {
-    // TODO: add submitted prop to InteractionStateMixin
     this.submitted = false;
     this.touched = false;
     this.dirty = false;
@@ -409,6 +409,9 @@ export class LionFieldset extends FormRegistrarMixin(
     child.__parentFormGroup = this;
 
     // aria-describedby of (nested) children
+
+    // TODO: Teardown in removeFormElement
+
     let parent = this;
     while (parent) {
       this.constructor._addDescriptionElementIdsToField(
@@ -465,12 +468,6 @@ export class LionFieldset extends FormRegistrarMixin(
     } else if (this.formElements[name]) {
       delete this.formElements[name];
     }
-
-    // TODO: Clean up aria references of elements that were ancestors of child.
-    // For this, it would be better if LionField._ariaDescribedby would be an element array from
-    // which you can delete all elems that are not child.contains(descriptionEl), so that the
-    // resulting array can be serialized into a string of ids.
-
     this.validate();
   }
 }
diff --git a/packages/form-system/stories/20-System-Overview.stories.mdx b/packages/form-system/stories/20-System-Overview.stories.mdx
index 733eea137..3d9fe11da 100644
--- a/packages/form-system/stories/20-System-Overview.stories.mdx
+++ b/packages/form-system/stories/20-System-Overview.stories.mdx
@@ -87,9 +87,6 @@ Fieldsets are at the base of:
 
 ## Other Resources
 
-<!-- TODO: - [`FormControlMixin`] () -->
-<!-- TODO: - [`LionField`] () -->
-
 - [Model Value](?path=/docs/forms-system-modelvalue--page)
 - [Formatting and parsing](?path=/docs/forms-system-formatting-and-parsing--parser)
 - [Interaction states](?path=/docs/forms-system-interaction-states--interaction-states)
diff --git a/packages/input-amount/test/formatters.test.js b/packages/input-amount/test/formatters.test.js
index dbd03a7db..fb1981633 100644
--- a/packages/input-amount/test/formatters.test.js
+++ b/packages/input-amount/test/formatters.test.js
@@ -9,8 +9,6 @@ describe('formatAmount()', () => {
     localizeTearDown();
   });
 
-  // TODO: Document that maximumFractionDigits >= minimumFractionDigits else a RangeError is thrown by Intl
-
   it('formats number with options', async () => {
     expect(
       formatAmount(12.345678, {
diff --git a/packages/input/src/LionInput.js b/packages/input/src/LionInput.js
index 1140de38a..c00335bcc 100644
--- a/packages/input/src/LionInput.js
+++ b/packages/input/src/LionInput.js
@@ -37,6 +37,7 @@ export class LionInput extends LionField {
     return {
       ...super.slots,
       input: () => {
+        // TODO: Find a better way to do value delegation via attr
         const native = document.createElement('input');
         if (this.__dataInstanceProps && this.__dataInstanceProps.modelValue) {
           native.setAttribute('value', this.__dataInstanceProps.modelValue);