analyzer plugins do not reanalyze non-Dart files when they are modified about sdk

[bwilkerson]

While doing that, I encountered an issue, so I thought to create an issue and debug.

And we appreciate that, thanks!

I didn't want to create that linter using a non-dart tool since ARB files are used for localization by flutter apps ...

Linting ARB files might very well be a compelling enough case. Thanks!

@mossmana @anderdobo for visibility

[bwilkerson]

@srawlins @DanTup

[DanTup]

The dart.additionalAnalyzerFileExtensions setting in the VS Code extension was for the legacy analysis server integration because we needed to know which extensions to interact with the server for.

In LSP, the server can declare these file types itself dynamically, so the setting is unnecessary.

In the code linked above, it uses the getter fullySupportedTypes, which types that plugins declare they are interested in:

sdk/pkg/analysis_server/lib/src/lsp/registration/feature_registration.dart

Lines 72 to 76 in adabc90

	List<TextDocumentFilterWithScheme> get fullySupportedTypes {
	return {
	...dartFiles,
	...pluginTypes,
	}.toList();

An example of how a plugin declares this interest is here:

https://github.com/dart-lang/sdk/blob/main/pkg/analyzer_plugin/doc/tutorial/getting_started.md#:~:text=String%3E%20get-,fileGlobsToAnalyze,-%3D%3E%20%3CString

It's not clear to me if the plugin here knows what types the lint is trying to use, but I do think it would be better to handle this somehow via the plugin rather than use this setting because that setting requires specific client configuration and this seems like something the server/plugin should be able to just make work automatically.

[ishchhabra]

I wasn't aware that dart.additionalAnalyzerFileExtensions setting is only for legacy analysis server integration. Perhaps a documentation update here and in VSCode at some point would make sense?

For the bug, I looked into it more. It looks like there was an update needed in custom_lint and it wasn't a bug in the sdk. However, even after the feature registration is done with the extension included, I still did not see the files getting reanalyzed. I'm not sure if this is correct, but I believe at

sdk/pkg/analyzer/lib/src/dart/analysis/driver.dart

Lines 611 to 618 in d91f05c

	if (file_paths.isDart(resourceProvider.pathContext, path)) {
	_priorityResults.clear();
	_resolvedLibraryCache.clear();
	_pendingFileChanges.add(
	_FileChange(path, _FileChangeKind.change),
	);
	_scheduler.notify();
	}

since the file is not a dart file, it does not get added to the list of _pendingFileChanges, resulting in affected at

sdk/pkg/analyzer_plugin/lib/plugin/plugin.dart

Lines 140 to 145 in d91f05c

	var affected = await analysisContext.applyPendingFileChanges();
	await handleAffectedFiles(
	analysisContext: analysisContext,
	paths: affected,
	);
	});

to not include the file without the dart extension.

[DanTup]

Perhaps a documentation update here and in VSCode at some point would make sense?

Yes, this should be made clearer - I've opened Dart-Code/Dart-Code#5133 to update the description against the setting (which shows both in VS Code and on the site).

However, even after the feature registration is done with the extension included, I still did not see the files getting reanalyzed. I'm not sure if this is correct, but

I'm not too familiar with this code - @scheglov or @srawlins may be best placed to comment. I think the question is whether ServerPlugin.handleAffectedFiles should be called with/passed non-Dart files that were passed to contentChanged. Currently it gets just the result from analysisContext.applyPendingFileChanges() which seems to only include Dart files.

(I've updated the title to something I think is more accurate for the current issue)

[bwilkerson]

IIRC, this support was added to support the Angular Dart plugin. Those products were discontinued a long time ago and a lot of code has changed since then. I suspect that support for this feature has bit-rotted in the interval.

We'd probably need a fairly compelling case to justify the effort required to make it work again. Can you tell us why you want/need support for this?

[ishchhabra]

IIRC, this support was added to support the Angular Dart plugin. Those products were discontinued a long time ago and a lot of code has changed since then. I suspect that support for this feature has bit-rotted in the interval.

We'd probably need a fairly compelling case to justify the effort required to make it work again. Can you tell us why you want/need support for this?

I was trying to build a linter that analyzes non dart files. I didn't want to create that linter using a non-dart tool since ARB files are used for localization by flutter apps, and so it made sense to use a tool already available there - dart analyzer. At the time of creating that, it was mostly just a prototype that I built for learning purposes. While doing that, I encountered an issue, so I thought to create an issue and debug.