fix(jsdocs): solve all lint warnings in project

change/@vonage-nx-vivid-7d169e0e-bacc-4ea2-bc7d-99ce63ec14b2.json

@@ -0,0 +1,7 @@
+{
+ "comment": "solve lint warnings",
+ "type": "none",
+ "packageName": "@vonage/nx-vivid",
+ "email": "rina.oksman@vonage.com",
+ "dependentChangeType": "none"
+}

libs/components/.eslintrc.json

@@ -6,16 +6,16 @@
  "env": {
  "browser": true
  },
- "plugins": ["@typescript-eslint", "import", "jsdoc"],
+ "plugins": ["@typescript-eslint", "import", "eslint-plugin-tsdoc"],
  "extends": [
  "../../.eslintrc.json",
  "@microsoft/eslint-config-fast-dna",
- "plugin:compat/recommended",
- "plugin:jsdoc/recommended"
+ "plugin:compat/recommended"
  ],
  "rules": {
  // lint
  "@nrwl/nx/workspace/no-attribute-default-value": "error",
+ "@typescript-eslint/no-non-null-assertion": "off",
  "indent": "off",
  "@typescript-eslint/indent": [
  "error",
@@ -51,7 +51,8 @@
  {
  "accessibility": "no-public"
  }
- ]
+ ],
+ "tsdoc/syntax": "warn"
  },
  "overrides": [
  {

libs/components/rollup.config.prod.ts

@@ -3,6 +3,12 @@ const path = require('path');
 const replace = require('@rollup/plugin-replace');
 const postcss = require('rollup-plugin-postcss');
 
+/**
+ *
+ *
+ * @param {string} [workingFolder='./src/lib/'] src
+ * @returns {*} folders
+ */
 function getFoldersInAFolder(workingFolder = './src/lib/') {
  const folders = [];
  const testsFolder = path.join(__dirname, workingFolder);
@@ -16,6 +22,7 @@ function getFoldersInAFolder(workingFolder = './src/lib/') {
  return folders;
 }
 
+/** @type {*} */
 const components = getFoldersInAFolder();
 const input = components.reduce((inputObject, componentName) => {
  inputObject[`${componentName}/index`] = path.join(

libs/components/src/lib/accordion-item/accordion-item.template.ts

@@ -21,6 +21,11 @@ const getClasses = ({
  ['no-indicator', noIndicator],
 );
 
+/**
+ * 
+ * @param {ElementDefinitionContext} context element definition
+ * @returns {HTMLElement} template
+ */
 export const AccordionItemTemplate: (
  context: ElementDefinitionContext,
  definition: FoundationElementDefinition
@@ -33,6 +38,13 @@ export const AccordionItemTemplate: (
  </div>
 `;
 
+/**
+ *
+ *
+ * @param {ElementDefinitionContext} context element definition
+ * @param {(number | string | undefined)} headingLevel - heading level
+ * @returns {HTMLElement} template
+ */
 const renderPanelHeader = (context: ElementDefinitionContext, headingLevel: number | string | undefined) => {
  const header: string = headingLevel ? 'h' + headingLevel : 'h3';
  return html<AccordionItem>`
@@ -42,6 +54,12 @@ const renderPanelHeader = (context: ElementDefinitionContext, headingLevel: numb
  `;
 };
 
+/**
+ *
+ *
+ * @param {ElementDefinitionContext} context element definition
+ * @returns {HTMLElement} template
+ */
 const renderHeaderButton = (context: ElementDefinitionContext) => {
  const affixIconTemplate = affixIconTemplateFactory(context);
  const focusTemplate = focusTemplateFactory(context);

libs/components/src/lib/accordion-item/accordion-item.ts

@@ -4,38 +4,40 @@ import { attr } from '@microsoft/fast-element';
 import { AffixIconWithTrailing } from '../../shared/patterns/affix';
 
 /**
- * Base class for accordion-item
  *
- * @public
+ * Base class for accordion-item
+ * 
+ * @class AccordionItem
+ * @augments {FoundationElement}
  */
 export class AccordionItem extends FoundationElement {
  /**
  *
  *
- * @public
+ * 
  *
  * HTML Attribute: heading
  */
  @attr heading?: string;
 
  /**
  *
- * @public
+ * 
  * HTML Attribute: heading-level
  */
  @attr({ attribute: 'heading-level' }) headingLevel?: 2 | 3 | 4 | 5 | 6;
 
  /**
  * Indicates whether the accordion-item has indicator
  *
- * @public
+ * 
  * HTML Attribute: no-indicator
  */
  @attr({ mode: 'boolean', attribute: 'no-indicator' }) noIndicator = false;
 
  /**
  *
- * @public
+ * 
  *
  * HTML Attribute: meta
  */
@@ -44,7 +46,7 @@ export class AccordionItem extends FoundationElement {
  /**
  * Indicates whether the accordion-item is open
  *
- * @public
+ * 
  * HTML Attribute: open
  */
  @attr({ mode: 'boolean' }) open = false;

libs/components/src/lib/accordion/accordion.template.ts

@@ -11,8 +11,7 @@ const getClasses = (_: Accordion) => classNames('base');
 
 /**
  *
- * @param context
- * @public
+ * @returns {HTMLElement} template
  */
 export const AccordionTemplate: (
  context: ElementDefinitionContext,

libs/components/src/lib/accordion/accordion.ts

@@ -5,14 +5,14 @@ import type { AccordionItem } from '../accordion-item/accordion-item';
 /**
  * Base class for accordion
  *
- * @public
+ * 
  */
 export class Accordion extends FoundationElement {
  private accordionItems: HTMLCollectionOf<AccordionItem> | undefined = undefined;
 
  /**
  *
- * @public
+ * 
  * HTML Attribute: multi
  */
  @attr({

libs/components/src/lib/action-group/action-group.template.ts

@@ -20,8 +20,7 @@ const getClasses = ({
 /**
  * The template for the {@link @microsoft/fast-foundation#action-group} component.
  *
- * @param context
- * @public
+ * @returns {HTMLElement} template
  */
 export const ActionGroupTemplate: (
  context: ElementDefinitionContext,

libs/components/src/lib/action-group/action-group.ts

@@ -12,47 +12,47 @@ import type {
 /**
  * Types of button appearance.
  *
- * @public
+ * 
  */
 export type ActionGroupAppearance = Extract<Appearance,
 Appearance.Filled | Appearance.Outlined | Appearance.Ghost>;
 
 /**
  * Types of button shape.
  *
- * @public
+ * 
  */
 type ActionGroupShape = Extract<Shape, Shape.Rounded | Shape.Pill>;
 
 /**
  * Base class for action-group
  *
- * @public
+ * 
  */
 export class ActionGroup extends FoundationElement {
  /**
  * The shape the ActionGroup should have.
  *
- * @public
- * @remarks
+ * 
+ * 
  * HTML Attribute: shape
  */
  @attr shape?: ActionGroupShape;
 
  /**
  * The appearance the ActionGroup should have.
  *
- * @public
- * @remarks
+ * 
+ * 
  * HTML Attribute: appearance
  */
  @attr appearance?: ActionGroupAppearance;
 
  /**
  * Indicates whether action group should have padding.
  *
- * @public
- * @remarks
+ * 
+ * 
  * HTML Attribute: tight
  */
  @attr({

libs/components/src/lib/action-group/ui.test.ts

@@ -9,6 +9,11 @@ import {
 
 const components = ['action-group', 'button', 'text-field', 'layout', 'popup', 'divider'];
 
+/**
+ *
+ *
+ * @returns {*} HTMLElement
+ */
 function runActionGroupTest() {
  return async ({page}: { page: Page }) => {
  const template = extractHTMLBlocksFromReadme(

libs/components/src/lib/avatar/avatar.template.ts

@@ -17,7 +17,9 @@ const getClasses = ({appearance, connotation, shape, size}: Avatar) => className
 );
 
 /**
- avatar icon
+ * avatar icon
+ * 
+ * @returns {HTMLElement} template
  */
 function renderIcon(iconTag: string) {
  return html<Avatar>`
@@ -29,19 +31,19 @@ function renderIcon(iconTag: string) {
 
 
 /**
- avatar initials
+ * avatar initials
+ * 
+ * @returns {HTMLElement} template
  */
 function renderInitials() {
  return html<Avatar>`
- <span class="initials">${ ({ name }) => name!.substring(0, 2) }</span>
- `;
+ <span class="initials">${ ({ name }) => name!.substring(0, 2) }</span>`;
 }
 
 /**
  * The template for the {@link @microsoft/fast-foundation#Avatar} component.
  *
- * @param context
- * @public
+ * @returns {HTMLElement} template
  */
 export const AvatarTemplate: (
  context: ElementDefinitionContext,

libs/components/src/lib/avatar/avatar.ts

@@ -9,7 +9,7 @@ import type {
 /**
  * Types of avatar connotation.
  *
- * @public
+ * 
  */
 export type AvatarConnotation = Extract<Connotation,
 | Connotation.Accent
@@ -18,27 +18,27 @@ export type AvatarConnotation = Extract<Connotation,
 /**
  * Types of avatar appearance.
  *
- * @public
+ * 
  */
 export type AvatarAppearance = Extract<Appearance,
 Appearance.Filled | Appearance.Outlined>;
 
 /**
  * Types of avatar shape.
  *
- * @public
+ * 
  */
 type AvatarShape = Extract<Shape, Shape.Rounded | Shape.Pill>;
 /**
  * Base class for avatar
  *
- * @public
+ * 
  */
 
 /**
  * Types of avatar size.
  *
- * @public
+ * 
  */
 type AvatarSize = Extract<Size, Size.Condensed | Size.Normal | Size.Expanded>;
 
@@ -47,26 +47,26 @@ export class Avatar extends FoundationElement {
  /**
  * The connotation the avatar should have.
  *
- * @public
- * @remarks
+ * 
+ * 
  * HTML Attribute: connotation
  */
  @attr connotation?: AvatarConnotation;
 
  /**
  * The shape the avatar should have.
  *
- * @public
- * @remarks
+ * 
+ * 
  * HTML Attribute: shape
  */
  @attr shape?: AvatarShape;
 
  /**
  * The appearance the avatar should have.
  *
- * @public
- * @remarks
+ * 
+ * 
  * HTML Attribute: appearance
  */
  @attr appearance?: AvatarAppearance;
@@ -75,8 +75,8 @@ export class Avatar extends FoundationElement {
  /**
  * The size the avatar should have.
  *
- * @public
- * @remarks
+ * 
+ * 
  * HTML Attribute: size
  */
  @attr size?: AvatarSize;
@@ -85,14 +85,14 @@ export class Avatar extends FoundationElement {
  /**
  * avatar header icon
  *
- * @public
+ * 
  */
  @attr icon?: string;
 
  /**
  * avatar name
  *
- * @public
+ * 
  */
  @attr name?: string;
 }