jsdoc ts

[nicholasio]

Description of the Change

Alternate Designs

Benefits

Possible Drawbacks

Verification Process

Checklist:

• [ ] My code follows the code style of this project.
• [ ] My change requires a change to the documentation.
• [ ] I have updated the documentation accordingly.
• [ ] All new and existing tests passed.

Applicable Issues

[github-actions[bot]]

ESLint Summary View Full Report

Annotations are provided inline on the Files Changed tab. You can also see all annotations that were generated on the annotations page.

Type	Occurrences	Fixable
Errors	10	2
Warnings	3	0
Ignored	0	N/A

• Result: :x: failure

• Annotations: 10 total

  ---

[failure] @typescript-eslint/no-unused-vars

• packages/accordion/types/index.d.ts Line 1 - Definition for rule '@typescript-eslint/no-unused-vars' was not found.

---

[failure] no-use-before-define

disallow the use of variables before they are defined

• packages/accordion/types/index.d.ts Line 1 - 'Accordion' was used before it was defined.
• packages/accordion/types/index.d.ts Line 2 - 'Accordion' was used before it was defined.

---

[failure] import/first

• packages/accordion/types/index.d.ts Line 3 - Import in body of module; reorder to top.

---

[failure] prettier/prettier

• packages/accordion/types/index.d.ts Line 3 - Replace "./accordion" with './accordion'

---

[failure] import/extensions

• packages/accordion/types/index.d.ts Line 3 - Missing file extension for "./accordion"

---

[failure] import/no-unresolved

• packages/accordion/types/index.d.ts Line 3 - Unable to resolve path to module './accordion'.

---

[warning] jsdoc/valid-types

Requires all types to be valid JSDoc or Closure compiler types without syntax errors.

• packages/accordion/src/accordion.js Line 2 - Syntax error in type: import('./types').AccordionOptions
• packages/accordion/src/accordion.js Line 3 - Syntax error in type: import('./types').AccordionElements

---

[warning] jsdoc/no-undefined-types

Checks that types in jsdoc comments are defined.

• packages/accordion/src/accordion.js Line 119 - The type 'EventListenerOrEventListenerObject' is undefined.

---

^{Report generated by eslint-plus-action}

[codecov-io]

Codecov Report

Merging #42 (faa2bcc) into develop (bb9b413) will decrease coverage by 0.26%. The diff coverage is 10.00%.

@@             Coverage Diff             @@
##           develop      #42      +/-   ##
===========================================
- Coverage    69.26%   68.99%   -0.27%     
===========================================
  Files           10       10              
  Lines          771      774       +3     
  Branches       176      177       +1     
===========================================
  Hits           534      534              
- Misses         195      197       +2     
- Partials        42       43       +1     

Impacted Files	Coverage Δ
packages/accordion/src/accordion.js	64.61% <10.00%> (-1.53%)	:arrow_down:

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update bb9b413...faa2bcc. Read the comment docs.

[joesnellpdx]

@nicholasio

We should get this into baseline.. but it's been a while since you created this PR and your updates might be stale.

When you get a chance, will you take a look? Expecting sometime in 2022.

[nicholasio]

@joesnellpdx Yeah this would be great. I ran into some issue setting up TS but I can revisit this in 2022.