feat: stricter jsdoc eslint rules

angular/bootstrap/src/components/modal/modal.service.ts

@@ -3,10 +3,6 @@ import type {Subscription} from 'rxjs';
 import {ModalComponent} from './modal.component';
 import type {ModalProps} from './modal.gen';
 
-interface ModalServiceOpenOptions {
-	injector?: Injector;
-}
-
 /**
  * Service to handle the opening and management of modal components.
  */
@@ -15,7 +11,15 @@ export class ModalService {
 	private readonly _injector = inject(Injector);
 	private readonly _applicationRef = inject(ApplicationRef);
 
-	async open<Data>(options: Partial<ModalProps<Data>>, {injector = this._injector}: ModalServiceOpenOptions = {}): Promise<any> {
+	/**
+	 * Opens a modal dialog with the specified options.
+	 *
+	 * @template Data - The type of data that the modal will handle.
+	 * @param options - The options to configure the modal.
+	 * @param injector - The injector to use when creating the modal component
+	 * @returns A promise that resolves when the modal is closed.
+	 */
+	async open<Data>(options: Partial<ModalProps<Data>>, injector = this._injector): Promise<any> {
 		const component = createComponent(ModalComponent, {
 			environmentInjector: injector.get(EnvironmentInjector),
 			elementInjector: injector,

angular/headless/src/types.ts

@@ -106,9 +106,14 @@ export interface AngularWidget<W extends Widget> extends Pick<W, 'api' | 'direct
 	updateSlots: () => void;
 }
 
+/**
+ * Represents the context for a widget slot, providing access to the widget and its state.
+ *
+ * @template W - The type of the widget.
+ */
 export interface WidgetSlotContext<W extends Widget> extends Pick<W, 'api' | 'directives'> {
 	/**
-	 * the state of the widget
+	 * The state of the widget. Each property of the state is exposed through an Angular {@link https://angular.dev/api/core/Signal | Signal}
 	 */
 	state: AngularState<W>;
 }

angular/headless/src/utils/widget.ts

@@ -142,7 +142,7 @@ export abstract class BaseWidgetDirective<W extends Widget> implements OnChanges
 	}
 
 	/**
-	 * Retrieves the widget state as an Angular {@link https://angular.dev/api/core/Signal | Signal}
+	 * Retrieves the widget state. Each property of the state is exposed through an Angular {@link https://angular.dev/api/core/Signal | Signal}
 	 * @returns the widget state
 	 */
 	get state(): AngularState<W> {

core/src/components/components.spec-utils.ts

@@ -16,6 +16,8 @@ export function getAttributes(node: HTMLElement) {
 
 /**
  * Utility method to register a directive to a fake dom element and send an event.
+ *
+ * @template T - The type of the directive parameters
  * @param directive - the directive to attach
  * @param args - the args of the directive
  * @param sendEvent - the event dispatcher function
@@ -59,6 +61,7 @@ export function attachDirectiveAndClick<T = void>(directive: Directive<T>, args:
 /**
  * Utility method to register a directive to a fake button and click on it.
  *
+ * @template T - The type of the directive parameters
  * @param directive - the directive to attach
  * @param args - the args of the directive
  */

core/src/components/select/select.ts

@@ -87,6 +87,8 @@ interface SelectCommonPropsAndState<Item> extends WidgetsCommonPropsAndState {
 
 /**
  * Props for the Select component.
+ *
+ * @template Item - The type of the Select Items
  */
 export interface SelectProps<Item> extends SelectCommonPropsAndState<Item> {
 	/**
@@ -167,6 +169,8 @@ export interface SelectProps<Item> extends SelectCommonPropsAndState<Item> {
 
 /**
  * Item representation built from the items provided in parameters
+ *
+ * @template T - The type of the Select Items
  */
 export interface ItemContext<T> {
 	/**
@@ -187,6 +191,8 @@ export interface ItemContext<T> {
 
 /**
  * Represents the state of a Select component.
+ *
+ * @template Item - The type of the Select Items
  */
 export interface SelectState<Item> extends SelectCommonPropsAndState<Item> {
 	/**
@@ -213,6 +219,8 @@ export interface SelectState<Item> extends SelectCommonPropsAndState<Item> {
 
 /**
  * Interface representing the API for a Select component.
+ *
+ * @template Item - The type of the Select Items
  */
 export interface SelectApi<Item> {
 	/**
@@ -287,6 +295,8 @@ export interface SelectApi<Item> {
 
 /**
  * Interface representing the directives used in the Select component.
+ *
+ * @template Item - The type of the Select Items
  */
 export interface SelectDirectives<Item> {
 	/**
@@ -336,6 +346,8 @@ export interface SelectDirectives<Item> {
 
 /**
  * Represents a Select widget component.
+ *
+ * @template Item - The type of the Select Items
  */
 export type SelectWidget<Item> = Widget<SelectProps<Item>, SelectState<Item>, SelectApi<Item>, SelectDirectives<Item>>;
 
@@ -370,6 +382,8 @@ export function getSelectDefaultConfig(): SelectProps<any> {
 
 /**
  * Create a SelectWidget with given config props
+ *
+ * @template Item - The type of the Select Items
  * @param config - an optional alert config
  * @returns a SelectWidget
  */

core/src/services/floatingUI.ts

@@ -61,6 +61,9 @@ export interface FloatingUIState {
 	middlewareData: MiddlewareData | undefined;
 }
 
+/**
+ * Interface representing the directives used to enable floating ui.
+ */
 export interface FloatingUIDirectives {
 	/**
 	 * Directive to attach to the reference element

core/src/types.ts

@@ -180,6 +180,8 @@ export type DirectivesAndOptParam<T extends any[], U extends SSRHTMLElement = SS
  * - `null`
  * - A `string`
  * - A function that takes `props` of type `Props` and returns a `string`
+ *
+ * @template Props - The type of the props when the slot is a function
  */
 export type SlotContent<Props extends object = object> = undefined | null | string | ((props: Props) => string);
 

core/src/utils/internal/checks.ts

@@ -71,6 +71,8 @@ export const allowNull =
 
 /**
  * Builds a new type guard to check if an element belongs to an enum list
+ *
+ * @template T - the type of the enum
  * @param list - the list of all enum values
  * @returns the type guard
  */

core/src/utils/internal/promise.ts

@@ -16,6 +16,8 @@ export const promisePending: PromisePendingResult = {status: 'pending'};
 
 /**
  * Represents the state of a promise, which can be either fulfilled, rejected, or pending.
+ *
+ * @template T - The type of the value promised
  */
 export type PromiseState<T> = PromiseFulfilledResult<T> | PromiseRejectedResult | PromisePendingResult;
 

eslint.config.js

@@ -310,8 +310,8 @@ export default tseslint.config(
 	},
 	// jsdoc,
 	{
-		files: ['{core,core-bootstrap}/src/**/*.{ts,tsx}', '{angular,react,svelte}/headless/src/**/*.{ts,tsx}'],
-		ignores: ['**/*.spec.ts'],
+		files: ['{core,core-bootstrap}/src/**/*.{ts,tsx}', '{angular,react,svelte}/{headless,bootstrap}/src/**/*.{ts,tsx}'],
+		ignores: ['**/*.spec.ts', 'angular/bootstrap/src/**/*.component.ts'],
 		plugins: {
 			jsdoc,
 		},
@@ -333,6 +333,8 @@ export default tseslint.config(
 						'TSInterfaceDeclaration > TSInterfaceBody > TSMethodSignature',
 						'TSTypeAliasDeclaration > TSTypeLiteral > TSPropertySignature',
 						'TSTypeAliasDeclaration > TSTypeLiteral > TSMethodSignature',
+						'TSInterfaceDeclaration',
+						'TSTypeAliasDeclaration',
 					],
 					require: {
 						FunctionExpression: true,
@@ -343,6 +345,7 @@ export default tseslint.config(
 					checkConstructors: false,
 				},
 			],
+			'jsdoc/require-template': ['error'],
 		},
 	},
 	// demo

react/bootstrap/src/components/accordion/accordion.tsx

@@ -27,8 +27,8 @@ const AccordionDIContext: React.Context<Partial<AccordionApi>> = createContext({
 /**
  * Renders the default slot structure for an accordion item.
  *
- * @param {AccordionItemContext} slotContext - The context containing state and directives for the accordion item.
- * @returns {JSX.Element} The JSX element representing the accordion item's default slot structure.
+ * @param slotContext - The context containing state and directives for the accordion item.
+ * @returns The JSX element representing the accordion item's default slot structure.
  */
 export const AccordionItemDefaultSlotStructure = (slotContext: AccordionItemContext) => (
 	<>
@@ -81,16 +81,16 @@ export const AccordionItem: ForwardRefExoticComponent<Partial<AccordionItemProps
 
 /**
  * Accordion component that provides a collapsible content container.
- * 
+ *
  * This component uses a forward ref to expose the Accordion API to parent components.
- * It leverages the {@link useWidgetWithConfig} hook to create the accordion widget and 
+ * It leverages the {@link useWidgetWithConfig} hook to create the accordion widget and
  * {@link https://react.dev/reference/react/useImperativeHandle | useImperativeHandle} to bind the widget API to the ref.
-
+ *
  * @param {PropsWithChildren<Partial<AccordionProps>>} props - The properties for the Accordion component.
  * @param {ForwardedRef<AccordionApi>} ref - The ref to be forwarded to the Accordion API.
- * 
+ *
  * @returns {JSX.Element} The rendered Accordion component.
- * 
+ *
  */
 export const Accordion: ForwardRefExoticComponent<PropsWithChildren<Partial<AccordionProps>> & RefAttributes<AccordionApi>> = forwardRef(
 	function Accordion(props: PropsWithChildren<Partial<AccordionProps>>, ref: ForwardedRef<AccordionApi>) {

react/bootstrap/src/components/modal/modal.tsx

@@ -16,8 +16,8 @@ const CloseButton = ({directive}: {directive: Directive}) => <button className="
  * A default header component for the modal that displays a title and an optional close button.
  *
  * @template Data - The type of data used in the modal context.
- * @param {ModalContext<Data>} slotContext - The context object containing the state and directives for the modal.
- * @returns {JSX.Element} The JSX element representing the modal header.
+ * @param slotContext - The context object containing the state and directives for the modal.
+ * @returns The JSX element representing the modal header.
  */
 export const ModalDefaultSlotHeader = <Data,>(slotContext: ModalContext<Data>) => (
 	<>
@@ -32,8 +32,8 @@ export const ModalDefaultSlotHeader = <Data,>(slotContext: ModalContext<Data>) =
  * Renders the default slot structure for a modal component.
  *
  * @template Data - The type of the data used in the modal context.
- * @param {ModalContext<Data>} slotContext - The context containing the state and props for the modal slots.
- * @returns {JSX.Element} The JSX structure for the modal's default slots.
+ * @param slotContext - The context containing the state and props for the modal slots.
+ * @returns The JSX structure for the modal's default slots.
  */
 export const ModalDefaultSlotStructure = <Data,>(slotContext: ModalContext<Data>) => (
 	<>
@@ -98,8 +98,8 @@ export const Modal = forwardRef(function Modal<Data>(props: Partial<ModalProps<D
  * Opens a modal dialog with the specified options.
  *
  * @template Data - The type of data that the modal will handle.
- * @param {Partial<ModalProps<Data>>} options - The options to configure the modal.
- * @returns {Promise<any>} A promise that resolves when the modal is closed.
+ * @param options - The options to configure the modal.
+ * @returns A promise that resolves when the modal is closed.
  */
 export async function openModal<Data>(options: Partial<ModalProps<Data>>) {
 	const root = ReactDOM.createRoot(document.createElement('div'));

react/bootstrap/src/components/pagination/pagination.tsx

@@ -8,8 +8,8 @@ import {createPagination} from './pagination.gen';
 /**
  * Renders the default slot pages for the pagination component.
  *
- * @param {PaginationContext} slotContext - The context containing pagination state and directives.
- * @returns {JSX.Element | null} The rendered pagination items or null if there are no pages.
+ * @param slotContext - The context containing pagination state and directives.
+ * @returns The rendered pagination items or null if there are no pages.
  *
  * The function iterates over the pages in the pagination state and generates JSX elements for each page.
  * If a page is represented by -1, it renders an ellipsis item. Otherwise, it renders a page item.
@@ -53,8 +53,8 @@ export const PaginationDefaultSlotPages = (slotContext: PaginationContext) => {
 /**
  * Renders the default slot structure for the pagination component.
  *
- * @param {PaginationContext} slotContext - The context containing the state and directives for pagination.
- * @returns {JSX.Element} The rendered pagination component.
+ * @param slotContext - The context containing the state and directives for pagination.
+ * @returns The rendered pagination component.
  *
  * The function constructs the pagination structure based on the provided state and directives.
  * It conditionally includes navigation buttons for first, previous, next, and last pages based on the state.
@@ -113,8 +113,8 @@ export const PaginationDefaultSlotStructure = (slotContext: PaginationContext) =
  * Pagination component that renders a navigation element for paginated content.
  * It uses the {@link useWidgetWithConfig} hook to create a pagination widget with the provided props.
  *
- * @param {Partial<PaginationProps>} props - The properties for the Pagination component.
- * @returns {JSX.Element} The rendered pagination navigation element.
+ * @param props - The properties for the Pagination component.
+ * @returns The rendered pagination navigation element.
  */
 export function Pagination(props: Partial<PaginationProps>) {
 	const widgetContext = useWidgetWithConfig(createPagination, props, 'pagination', {

react/bootstrap/src/components/progressbar/progressbar.tsx

@@ -8,9 +8,9 @@ import {createProgressbar} from './progressbar.gen';
 /**
  * Renders a progress bar component with customizable appearance and behavior.
  *
- * @param {ProgressbarContext} slotContext - The context containing the state and properties for the progress bar.
+ * @param slotContext - The context containing the state and properties for the progress bar.
  *
- * @returns {JSX.Element} The rendered progress bar component.
+ * @returns The rendered progress bar component.
  */
 export const ProgressbarDefaultSlotStructure = (slotContext: ProgressbarContext) => {
 	const {striped, animated, type} = slotContext.state;
@@ -27,9 +27,9 @@ export const ProgressbarDefaultSlotStructure = (slotContext: ProgressbarContext)
 /**
  * Progressbar component that utilizes the {@link useWidgetWithConfig} hook to create a progress bar widget.
  *
- * @param {Partial<ProgressbarProps>} props - The properties to configure the progress bar.
+ * @param props - The properties to configure the progress bar.
  *
- * @returns {JSX.Element} A div element containing the progress bar with appropriate ARIA directives and slot content.
+ * @returns A div element containing the progress bar with appropriate ARIA directives and slot content.
  */
 export const Progressbar = (props: Partial<ProgressbarProps>) => {
 	const widgetContext = useWidgetWithConfig(createProgressbar, props, 'progressbar', {

react/bootstrap/src/components/rating/rating.tsx

@@ -20,8 +20,8 @@ function Star({star, state, directive}: {star: StarContext; state: RatingState;
 /**
  * Rating component that displays a series of stars based on the provided state.
  *
- * @param {Partial<RatingProps>} props - The properties for the Rating component.
- * @returns {JSX.Element} The rendered Rating component.
+ * @param props - The properties for the Rating component.
+ * @returns The rendered Rating component.
  *
  * @remarks
  * This component uses the {@link useWidgetWithConfig} hook to initialize and configure the rating widget.

react/bootstrap/src/components/select/select.tsx

@@ -56,16 +56,12 @@ function Rows<Item>({slotContext}: {slotContext: SelectContext<Item>; menuId: st
  * A generic Select component that provides a customizable dropdown selection interface.
  *
  * @template Item - The type of the items in the selection.
- * @param {Partial<SelectProps<Item>>} props - The properties for the Select component.
- * @returns {JSX.Element} The rendered Select component.
+ * @param props - The properties for the Select component.
+ * @returns The rendered Select component.
  *
  * @remarks
  * This component uses a widget context to manage its state and directives. It supports
  * custom badge labels and item labels through the widget configuration.
- *
- * @component
- * @param {Partial<SelectProps<Item>>} props - The properties for the Select component.
- * @returns {JSX.Element} The rendered Select component.
  */
 export function Select<Item>(props: Partial<SelectProps<Item>>) {
 	const widgetContext = useWidgetWithConfig<SelectWidget<Item>>(createSelect, props, 'select', {

react/bootstrap/src/components/slider/slider.tsx

@@ -10,8 +10,8 @@ import {createSlider} from './slider.gen';
  * A functional component that renders a button element with a directive applied to it.
  * The directive is provided through the `slotContext` parameter.
  *
- * @param {SliderSlotHandleContext} slotContext - The context object containing the directives and item for the slider handle.
- * @returns {JSX.Element} A button element with the applied directive.
+ * @param slotContext - The context object containing the directives and item for the slider handle.
+ * @returns A button element with the applied directive.
  */
 export const SliderDefaultSlotHandle = (slotContext: SliderSlotHandleContext) => {
 	return <button {...useDirective<{item: SliderHandle}>(slotContext.directives.handleDirective, {item: slotContext.item})}>&nbsp;</button>;
@@ -64,8 +64,8 @@ const CombinedLabel = (slotContext: SliderContext) => (
 /**
  * Renders the default slot structure for the Slider component.
  *
- * @param {SliderContext} slotContext - The context object containing state and directives for the slider.
- * @returns {JSX.Element} The JSX element representing the default slot structure.
+ * @param slotContext - The context object containing state and directives for the slider.
+ * @returns The JSX element representing the default slot structure.
  *
  */
 export const SliderDefaultSlotStructure = (slotContext: SliderContext) => (
@@ -93,8 +93,8 @@ export const SliderDefaultSlotStructure = (slotContext: SliderContext) => (
 /**
  * Slider component that integrates with a widget context and renders a slot structure.
  *
- * @param {PropsWithChildren<Partial<SliderProps>>} props - The properties for the Slider component.
- * @returns {JSX.Element} The rendered Slider component.
+ * @param props - The properties for the Slider component.
+ * @returns The rendered Slider component.
  *
  * The Slider component uses the {@link useWidgetWithConfig} hook to create a widget context with the provided
  * configuration. It then applies the `sliderDirective` to a `div` element and renders the slot content

react/bootstrap/src/components/toast/toast.tsx

@@ -22,8 +22,8 @@ const ToastCloseButtonNoHeader = (slotContext: ToastContext) => (
 /**
  * Renders the default slot structure for a Toast component.
  *
- * @param {ToastContext} slotContext - The context containing the state and properties for the Toast component.
- * @returns {JSX.Element} The JSX element representing the default slot structure of the Toast.
+ * @param slotContext - The context containing the state and properties for the Toast component.
+ * @returns The JSX element representing the default slot structure of the Toast.
  */
 export const ToastDefaultSlotStructure = (slotContext: ToastContext) => (
 	<>