blob: 2a81ac0344017d976c072b34b0f840cb1c251049 [file] [log] [blame]
// Copyright (c) 2018, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
import 'package:analysis_server/lsp_protocol/protocol_generated.dart';
import 'package:analysis_server/lsp_protocol/protocol_special.dart';
import 'package:analysis_server/src/lsp/constants.dart';
import 'package:analysis_server/src/lsp/handlers/commands/simple_edit_handler.dart';
import 'package:analysis_server/src/lsp/handlers/handlers.dart';
import 'package:analysis_server/src/lsp/lsp_analysis_server.dart';
import 'package:analysis_server/src/lsp/progress.dart';
import 'package:analysis_server/src/services/correction/organize_imports.dart';
class OrganizeImportsCommandHandler extends SimpleEditCommandHandler {
OrganizeImportsCommandHandler(LspAnalysisServer server) : super(server);
String get commandName => 'Organize Imports';
Future<ErrorOr<void>> handle(List<Object?>? arguments,
ProgressReporter reporter, CancellationToken cancellationToken) async {
if (arguments == null || arguments.length != 1 || arguments[0] is! String) {
return ErrorOr.error(ResponseError(
code: ServerErrorCodes.InvalidCommandArguments,
'$commandName requires a single String parameter containing the path of a Dart file',
// Get the version of the doc before we calculate edits so we can send it back
// to the client so that they can discard this edit if the document has been
// modified since.
final path = arguments.single as String;
final docIdentifier = server.getVersionedDocumentIdentifier(path);
final result = await requireResolvedUnit(path);
if (cancellationToken.isCancellationRequested) {
return error(ErrorCodes.RequestCancelled, 'Request was cancelled');
return result.mapResult((result) {
final code = result.content;
final unit = result.unit;
if (hasScanParseErrors(result.errors)) {
// It's not uncommon for editors to run this command automatically on-save
// so if the file in in an invalid state it's better to fail silently
// than trigger errors (VS Code recently started showing popups when
// LSP requests return errors).
'Unable to $commandName because the file contains parse errors');
return success(null);
final organizer = ImportOrganizer(code, unit, result.errors);
final edits = organizer.organize();
if (edits.isEmpty) {
return success(null);
return sendSourceEditsToClient(docIdentifier, unit, edits);