Commit 78835fcd authored by David Sveningsson's avatar David Sveningsson
Browse files

feat(api): make `Reporter` class internal 

if you need this class file an issue explaining the use-case
parent 63d02ec2

etc/browser.api.md

+6 −5
Original line number Diff line number Diff line
@@ -1000,18 +1000,19 @@ export { Report_2 as Report } 


// @public (undocumented)

export class Reporter {

    // @internal

    constructor();

    // (undocumented)

    // @internal (undocumented)

    add<ContextType, OptionsType>(rule: Rule<ContextType, OptionsType>, message: string, severity: number, node: DOMNode | null, location: Location_2, context: ContextType): void;

    // (undocumented)

    // @internal (undocumented)

    addManual(filename: string, message: DeferredMessage): void;

    // (undocumented)

    // @internal (undocumented)

    protected isValid(): boolean;

    static merge(reports: Report_2[]): Report_2;

    static merge(reports: Promise<Report_2[]> | Array<Promise<Report_2>>): Promise<Report_2>;

    // (undocumented)

    // @internal (undocumented)

    protected result: Record<string, DeferredMessage[]>;

    // (undocumented)

    // @internal (undocumented)

    save(sources?: Source[]): Report_2;

}

etc/index.api.md

+6 −5
Original line number Diff line number Diff line
@@ -1105,18 +1105,19 @@ export { Report_2 as Report } 


// @public (undocumented)

export class Reporter {

    // @internal

    constructor();

    // (undocumented)

    // @internal (undocumented)

    add<ContextType, OptionsType>(rule: Rule<ContextType, OptionsType>, message: string, severity: number, node: DOMNode | null, location: Location_2, context: ContextType): void;

    // (undocumented)

    // @internal (undocumented)

    addManual(filename: string, message: DeferredMessage): void;

    // (undocumented)

    // @internal (undocumented)

    protected isValid(): boolean;

    static merge(reports: Report_2[]): Report_2;

    static merge(reports: Promise<Report_2[]> | Array<Promise<Report_2>>): Promise<Report_2>;

    // (undocumented)

    // @internal (undocumented)

    protected result: Record<string, DeferredMessage[]>;

    // (undocumented)

    // @internal (undocumented)

    save(sources?: Source[]): Report_2;

}

src/reporter.ts

+20 −0
Original line number Diff line number Diff line
@@ -60,8 +60,14 @@ export interface Report { 
 * @public

 */

export class Reporter {

	/**

	 * @internal

	 */

	protected result: Record<string, DeferredMessage[]>;



	/**

	 * @internal

	 */

	public constructor() {

		this.result = {};

	}
@@ -69,6 +75,7 @@ export class Reporter { 
	/**

	 * Merge two or more reports into a single one.

	 *

	 * @public

	 * @param reports- Reports to merge.

	 * @returns A merged report.

	 */
@@ -77,6 +84,7 @@ export class Reporter { 
	/**

	 * Merge two or more reports into a single one.

	 *

	 * @public

	 * @param reports- Reports to merge.

	 * @returns A promise resolved with the merged report.

	 */
@@ -117,6 +125,9 @@ export class Reporter { 
		};

	}



	/**

	 * @internal

	 */

	/* eslint-disable-next-line @typescript-eslint/max-params -- technical debt */

	public add<ContextType, OptionsType>(

		rule: Rule<ContextType, OptionsType>,
@@ -151,6 +162,9 @@ export class Reporter { 
		this.result[location.filename].push(entry);

	}



	/**

	 * @internal

	 */

	public addManual(filename: string, message: DeferredMessage): void {

		if (!(filename in this.result)) {

			this.result[filename] = [];
@@ -158,6 +172,9 @@ export class Reporter { 
		this.result[filename].push(message);

	}



	/**

	 * @internal

	 */

	public save(sources?: Source[]): Report {

		const report: Report = {

			valid: this.isValid(),
@@ -180,6 +197,9 @@ export class Reporter { 
		return report;

	}



	/**

	 * @internal

	 */

	protected isValid(): boolean {

		const numErrors = Object.values(this.result).reduce((sum, messages) => {

			return sum + countErrors(messages);