#12848

Committed 25 Jul 2024 12:51PM UTC coverage: 86.205% (+0.5%) from 85.656%

Build Type

push

Committed by

Commit Message

Merge 0c17734d3 into 5f3ffa3fa

Run Details

10601 of 13088 branches covered (81.0%)

Branch coverage included in aggregate %.

82 of 88 new or added lines in 15 files covered. (93.18%)

2 existing lines in 2 files now uncovered.

12302 of 13480 relevant lines covered (91.26%)

26605.76 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

78.85

/src/bscPlugin/codeActions/CodeActionsProcessor.ts

import { CodeActionKind } from 'vscode-languageserver';
import { codeActionUtil } from '../../CodeActionUtil';
import type { DiagnosticMessageType } from '../../DiagnosticMessages';
import { DiagnosticCodeMap } from '../../DiagnosticMessages';
import type { BrsFile } from '../../files/BrsFile';
import type { BscFile } from '../../files/BscFile';
import type { XmlFile } from '../../files/XmlFile';
import type { BsDiagnostic, OnGetCodeActionsEvent } from '../../interfaces';
import { ParseMode } from '../../parser/Parser';
import { util } from '../../util';
import { isBrsFile } from '../../astUtils/reflection';

export class CodeActionsProcessor {
    public constructor(
        public event: OnGetCodeActionsEvent
    ) {

    }

    public process() {
        for (const diagnostic of this.event.diagnostics) {
            if (diagnostic.code === DiagnosticCodeMap.cannotFindName || diagnostic.code === DiagnosticCodeMap.cannotFindFunction) {
                this.suggestCannotFindName(diagnostic as any);
            } else if (diagnostic.code === DiagnosticCodeMap.classCouldNotBeFound) {
                this.suggestClassImports(diagnostic as any);
            } else if (diagnostic.code === DiagnosticCodeMap.xmlComponentMissingExtendsAttribute) {
                this.addMissingExtends(diagnostic as any);
            }
        }
    }

    private suggestedImports = new Set<string>();

    /**
     * Generic import suggestion function. Shouldn't be called directly from the main loop, but instead called by more specific diagnostic handlers
     */
    private suggestImports(diagnostic: BsDiagnostic, key: string, files: BscFile[]) {
        //skip if we already have this suggestion
        if (this.suggestedImports.has(key) || !isBrsFile(this.event.file)) {
            return;
        }

        this.suggestedImports.add(key);
        // eslint-disable-next-line @typescript-eslint/dot-notation
        const importStatements = this.event.file['_cachedLookups'].importStatements;
        //find the position of the first import statement, or the top of the file if there is none
        const insertPosition = importStatements[importStatements.length - 1]?.tokens.import?.location?.range?.start ?? util.createPosition(0, 0);

        //find all files that reference this function
        for (const file of files) {
            const destPath = util.sanitizePkgPath(file.destPath);
            this.event.codeActions.push(
                codeActionUtil.createCodeAction({
                    title: `import "${destPath}"`,
                    diagnostics: [diagnostic],
                    isPreferred: false,
                    kind: CodeActionKind.QuickFix,
                    changes: [{
                        type: 'insert',
                        filePath: this.event.file.srcPath,
                        position: insertPosition,
                        newText: `import "${destPath}"\n`
                    }]
                })
            );
        }
    }

    private suggestCannotFindName(diagnostic: DiagnosticMessageType<'cannotFindName'>) {
        //skip if not a BrighterScript file
        const file = this.event.program.getFile(diagnostic.location?.uri);
        if (!file || (file as BrsFile).parseMode !== ParseMode.BrighterScript) {
            return;
        }
        const lowerName = (diagnostic.data.fullName ?? diagnostic.data.name).toLowerCase();

        this.suggestImports(
            diagnostic,
            lowerName,
            [
                ...this.event.program.findFilesForFunction(lowerName),
                ...this.event.program.findFilesForClass(lowerName),
                ...this.event.program.findFilesForNamespace(lowerName),
                ...this.event.program.findFilesForEnum(lowerName)
            ]
        );
    }

    private suggestClassImports(diagnostic: DiagnosticMessageType<'classCouldNotBeFound'>) {
        //skip if not a BrighterScript file
        const file = this.event.program.getFile(diagnostic.location?.uri);
        if (!file || (file as BrsFile).parseMode !== ParseMode.BrighterScript) {
            return;
        }
        const lowerClassName = diagnostic.data.className.toLowerCase();
        this.suggestImports(
            diagnostic,
            lowerClassName,
            this.event.program.findFilesForClass(lowerClassName)
        );
    }

    private addMissingExtends(diagnostic: DiagnosticMessageType<'xmlComponentMissingExtendsAttribute'>) {
        const srcPath = this.event.file.srcPath;
        const { componentElement } = (this.event.file as XmlFile).parser.ast;
        //inject new attribute after the final attribute, or after the `<component` if there are no attributes
        const pos = (componentElement.attributes[componentElement.attributes.length - 1] ?? componentElement.tokens.startTagName)?.location?.range.end;
        this.event.codeActions.push(
            codeActionUtil.createCodeAction({
                title: `Extend "Group"`,
                diagnostics: [diagnostic],
                isPreferred: true,
                kind: CodeActionKind.QuickFix,
                changes: [{
                    type: 'insert',
                    filePath: srcPath,
                    position: pos,
                    newText: ' extends="Group"'
                }]
            })
        );
        this.event.codeActions.push(
            codeActionUtil.createCodeAction({
                title: `Extend "Task"`,
                diagnostics: [diagnostic],
                kind: CodeActionKind.QuickFix,
                changes: [{
                    type: 'insert',
                    filePath: srcPath,
                    position: pos,
                    newText: ' extends="Task"'
                }]
            })
        );
        this.event.codeActions.push(
            codeActionUtil.createCodeAction({
                title: `Extend "ContentNode"`,
                diagnostics: [diagnostic],
                kind: CodeActionKind.QuickFix,
                changes: [{
                    type: 'insert',
                    filePath: srcPath,
                    position: pos,
                    newText: ' extends="ContentNode"'
                }]
            })
        );
    }
}

1	import { CodeActionKind } from 'vscode-languageserver';	1✔
2	import { codeActionUtil } from '../../CodeActionUtil';	1✔
3	import type { DiagnosticMessageType } from '../../DiagnosticMessages';
4	import { DiagnosticCodeMap } from '../../DiagnosticMessages';	1✔
5	import type { BrsFile } from '../../files/BrsFile';
6	import type { BscFile } from '../../files/BscFile';
7	import type { XmlFile } from '../../files/XmlFile';
8	import type { BsDiagnostic, OnGetCodeActionsEvent } from '../../interfaces';
9	import { ParseMode } from '../../parser/Parser';	1✔
10	import { util } from '../../util';	1✔
11	import { isBrsFile } from '../../astUtils/reflection';	1✔
12
13	export class CodeActionsProcessor {	1✔
14	public constructor(
15	public event: OnGetCodeActionsEvent	10✔
16	) {
17
18	}
19
20	public process() {
21	for (const diagnostic of this.event.diagnostics) {	10✔
22	if (diagnostic.code === DiagnosticCodeMap.cannotFindName \|\| diagnostic.code === DiagnosticCodeMap.cannotFindFunction) {	12✔
23	this.suggestCannotFindName(diagnostic as any);	8✔
24	} else if (diagnostic.code === DiagnosticCodeMap.classCouldNotBeFound) {	4!
25	this.suggestClassImports(diagnostic as any);	×
26	} else if (diagnostic.code === DiagnosticCodeMap.xmlComponentMissingExtendsAttribute) {	4✔
27	this.addMissingExtends(diagnostic as any);	2✔
28	}
29	}
30	}
31
32	private suggestedImports = new Set<string>();	10✔
33
34	/**
35	* Generic import suggestion function. Shouldn't be called directly from the main loop, but instead called by more specific diagnostic handlers
36	*/
37	private suggestImports(diagnostic: BsDiagnostic, key: string, files: BscFile[]) {
38	//skip if we already have this suggestion
39	if (this.suggestedImports.has(key) \|\| !isBrsFile(this.event.file)) {	7!
40	return;	×
41	}
42
43	this.suggestedImports.add(key);	7✔
44	// eslint-disable-next-line @typescript-eslint/dot-notation
45	const importStatements = this.event.file['_cachedLookups'].importStatements;	7✔
46	//find the position of the first import statement, or the top of the file if there is none
47	const insertPosition = importStatements[importStatements.length - 1]?.tokens.import?.location?.range?.start ?? util.createPosition(0, 0);	7✔
48
49	//find all files that reference this function
50	for (const file of files) {	7✔
51	const destPath = util.sanitizePkgPath(file.destPath);	9✔
52	this.event.codeActions.push(	9✔
53	codeActionUtil.createCodeAction({
54	title: `import "${destPath}"`,
55	diagnostics: [diagnostic],
56	isPreferred: false,
57	kind: CodeActionKind.QuickFix,
58	changes: [{
59	type: 'insert',
60	filePath: this.event.file.srcPath,
61	position: insertPosition,
62	newText: `import "${destPath}"\n`
63	}]
64	})
65	);
66	}
67	}
68
69	private suggestCannotFindName(diagnostic: DiagnosticMessageType<'cannotFindName'>) {
70	//skip if not a BrighterScript file
71	const file = this.event.program.getFile(diagnostic.location?.uri);	8!
72	if (!file \|\| (file as BrsFile).parseMode !== ParseMode.BrighterScript) {	8✔
73	return;	1✔
74	}
75	const lowerName = (diagnostic.data.fullName ?? diagnostic.data.name).toLowerCase();	7!
76
77	this.suggestImports(	7✔
78	diagnostic,
79	lowerName,
80	[
81	...this.event.program.findFilesForFunction(lowerName),
82	...this.event.program.findFilesForClass(lowerName),
83	...this.event.program.findFilesForNamespace(lowerName),
84	...this.event.program.findFilesForEnum(lowerName)
85	]
86	);
87	}
88
89	private suggestClassImports(diagnostic: DiagnosticMessageType<'classCouldNotBeFound'>) {
90	//skip if not a BrighterScript file
NEW 91	const file = this.event.program.getFile(diagnostic.location?.uri);	×
NEW 92	if (!file \|\| (file as BrsFile).parseMode !== ParseMode.BrighterScript) {	×
UNCOV 93	return;	×
94	}
95	const lowerClassName = diagnostic.data.className.toLowerCase();	×
96	this.suggestImports(	×
97	diagnostic,
98	lowerClassName,
99	this.event.program.findFilesForClass(lowerClassName)
100	);
101	}
102
103	private addMissingExtends(diagnostic: DiagnosticMessageType<'xmlComponentMissingExtendsAttribute'>) {
104	const srcPath = this.event.file.srcPath;	2✔
105	const { componentElement } = (this.event.file as XmlFile).parser.ast;	2✔
106	//inject new attribute after the final attribute, or after the `<component` if there are no attributes
107	const pos = (componentElement.attributes[componentElement.attributes.length - 1] ?? componentElement.tokens.startTagName)?.location?.range.end;	2!
108	this.event.codeActions.push(	2✔
109	codeActionUtil.createCodeAction({
110	title: `Extend "Group"`,
111	diagnostics: [diagnostic],
112	isPreferred: true,
113	kind: CodeActionKind.QuickFix,
114	changes: [{
115	type: 'insert',
116	filePath: srcPath,
117	position: pos,
118	newText: ' extends="Group"'
119	}]
120	})
121	);
122	this.event.codeActions.push(	2✔
123	codeActionUtil.createCodeAction({
124	title: `Extend "Task"`,
125	diagnostics: [diagnostic],
126	kind: CodeActionKind.QuickFix,
127	changes: [{
128	type: 'insert',
129	filePath: srcPath,
130	position: pos,
131	newText: ' extends="Task"'
132	}]
133	})
134	);
135	this.event.codeActions.push(	2✔
136	codeActionUtil.createCodeAction({
137	title: `Extend "ContentNode"`,
138	diagnostics: [diagnostic],
139	kind: CodeActionKind.QuickFix,
140	changes: [{
141	type: 'insert',
142	filePath: srcPath,
143	position: pos,
144	newText: ' extends="ContentNode"'
145	}]
146	})
147	);
148	}
149	}

rokucommunity / brighterscript / #12848

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous