8000 Add autocorrect for RBS parameter kinds by Morriar · Pull Request #8857 · sorbet/sorbet · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add autocorrect for RBS parameter kinds #8857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 14, 2025
Merged

Add autocorrect for RBS parameter kinds #8857

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf2cc6d
Separate arg loc and name loc
Morriar May 9, 2025
9b4b2e5
Add autocorrect to RBS signature params
Morriar May 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
152 changes: 122 additions & 30 deletions rbs/MethodTypeToParserNode.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ namespace {

struct RBSArg {
core::LocOffsets loc;
core::LocOffsets nameLoc;
rbs_ast_symbol_t *name;
rbs_node_t *type;

Expand All @@ -34,6 +35,23 @@ struct RBSArg {
Kind kind;
};

struct Autocorrect {
core::Loc loc;
string source;
};

core::LocOffsets adjustNameLoc(const RBSDeclaration &declaration, rbs_node_t *node) {
auto range = node->location->rg;

auto nameRange = node->location->children->entries[0].rg;
if (nameRange.start != -1 && nameRange.end != -1) {
range.start.char_pos = nameRange.start;
range.end.char_pos = nameRange.end;
}

return declaration.typeLocFromRange(range);
}

unique_ptr<parser::Node> handleAnnotations(unique_ptr<parser::Node> sigBuilder, const vector<Comment> &annotations) {
for (auto &annotation : annotations) {
if (annotation.string == "final") {
Expand Down Expand Up @@ -118,7 +136,82 @@ string nodeKindToString(const parser::Node *node) {
return kind;
}

bool checkParameterKindMatch(core::MutableContext ctx, const RBSArg &arg, const parser::Node *methodArg) {
optional<Autocorrect> autocorrectArg(core::MutableContext ctx, const parser::Node *methodArg, RBSArg arg,
unique_ptr<parser::Node> type) {
if (arg.kind == RBSArg::Kind::Block || parser::isa_node<parser::Blockarg>((parser::Node *)methodArg)) {
// Block arguments are not autocorrected
return nullopt;
}

string corrected;
auto source = ctx.file.data(ctx.state).source();
auto typeString = source.substr(type->loc.beginPos(), type->loc.endPos() - type->loc.beginPos());

typecase(
methodArg,
// Should be: `Type name`
[&](const parser::Arg *a) {
if (arg.name) {
auto nameString = nodeName(a).toString(ctx.state);
corrected = fmt::format("{} {}", typeString, nameString);
} else {
corrected = fmt::format("{}", typeString);
}
},
// Should be: `?Type name`
[&](const parser::Optarg *a) {
if (arg.name) {
auto nameString = nodeName(a).toString(ctx.state);
corrected = fmt::format("?{} {}", typeString, nameString);
} else {
corrected = fmt::format("?{}", typeString);
}
},
// Should be: `*Type name`
[&](const parser::Restarg *a) {
if (arg.name) {
auto nameString = nodeName(a).toString(ctx.state);
10000 corrected = fmt::format("*{} {}", typeString, nameString);
} else {
corrected = fmt::format("*{}", typeString);
}
},
// Should be: `name: Type`
[&](const parser::Kwarg *a) {
auto nameString = nodeName(a).toString(ctx.state);
corrected = fmt::format("{}: {}", nameString, typeString);
},
// Should be: `?name: Type`
[&](const parser::Kwoptarg *a) {
auto nameString = nodeName(a).toString(ctx.state);
corrected = fmt::format("?{}: {}", nameString, typeString);
},
// Should be: `**Type name`
[&](const parser::Kwrestarg *a) {
if (arg.name) {
auto nameString = nodeName(a).toString(ctx.state);
corrected = fmt::format("**{} {}", typeString, nameString);
} else {
corrected = fmt::format("**{}", typeString);
}
},
[&](const parser::Node *other) { Exception::raise("Unexpected expression type: {}", other->nodeName()); });

core::LocOffsets loc = arg.loc;

// Adjust the location to account for the autocorrect
// TODO: remove this once we fixed the location generation by the parser
if (arg.kind == RBSArg::Kind::OptionalPositional || arg.kind == RBSArg::Kind::RestPositional ||
arg.kind == RBSArg::Kind::OptionalKeyword) {
loc.beginLoc -= 1;
} else if (arg.kind == RBSArg::Kind::RestKeyword) {
loc.beginLoc -= 2;
}

return Autocorrect{ctx.locAt(loc), corrected};
}

bool checkParameterKindMatch(const RBSArg &arg, const parser::Node *methodArg) {
auto kindMatch = false;

typecase(
Expand All @@ -129,16 +222,7 @@ bool checkParameterKindMatch(core::MutableContext ctx, const RBSArg &arg, const
[&](const parser::Kwoptarg *parserArg) { kindMatch = arg.kind == RBSArg::Kind::OptionalKeyword; },
[&](const parser::Kwrestarg *parserArg) { kindMatch = arg.kind == RBSArg::Kind::RestKeyword; },
[&](const parser::Blockarg *parserArg) { kindMatch = arg.kind == RBSArg::Kind::Block; },
[&](const parser::Node *other) {
Exception::raise("Unexpected expression type: {}", ((parser::Node *)methodArg)->nodeName());
});

if (!kindMatch) {
if (auto e = ctx.beginError(arg.loc, core::errors::Rewriter::RBSIncorrectParameterKind)) {
e.setHeader("Argument kind mismatch for `{}`, method declares `{}`, but RBS signature declares `{}`",
nodeName(methodArg).show(ctx.state), nodeKindToString(methodArg), argKindToString(arg.kind));
}
}
[&](const parser::Node *other) { Exception::raise("Unexpected expression type: {}", methodArg->nodeName()); });

return kindMatch;
}
Expand Down Expand Up @@ -166,18 +250,10 @@ void collectArgs(const RBSDeclaration &declaration, rbs_node_list_t *field, vect
"Unexpected node type `{}` in function parameter list, expected `{}`",
rbs_node_type_name(list_node->node), "FunctionParam");

auto range = list_node->node->location->rg;

// If the arg is named, we need to adjust the location to point to the name
auto nameRange = list_node->node->location->children->entries[0].rg;
if (nameRange.start != -1 && nameRange.end != -1) {
range.start.char_pos = nameRange.start;
range.end.char_pos = nameRange.end;
}

auto loc = declaration.typeLocFromRange(range);
auto loc = declaration.typeLocFromRange(list_node->node->location->rg);
auto nameLoc = adjustNameLoc(declaration, list_node->node);
auto node = (rbs_types_function_param_t *)list_node->node;
auto arg = RBSArg{loc, node->name, node->type, kind};
auto arg = RBSArg{loc, nameLoc, node->name, node->type, kind};
args.emplace_back(arg);
}
}
Expand All @@ -196,10 +272,11 @@ void collectKeywords(const RBSDeclaration &declaration, rbs_hash_t *field, vecto
"Unexpected node type `{}` in keyword argument value, expected `{}`",
rbs_node_type_name(hash_node->value), "FunctionParam");

auto loc = declaration.typeLocFromRange(hash_node->key->location->rg);
auto nameLoc = declaration.typeLocFromRange(hash_node->key->location->rg);
auto loc = nameLoc.join(declaration.typeLocFromRange(hash_node->value->location->rg));
rbs_ast_symbol_t *keyNode = (rbs_ast_symbol_t *)hash_node->key;
rbs_types_function_param_t *valueNode = (rbs_types_function_param_t *)hash_node->value;
auto arg = RBSArg{loc, keyNode, valueNode->type, kind};
auto arg = RBSArg{loc, nameLoc, keyNode, valueNode->type, kind};
args.emplace_back(arg);
}
}
Expand Down Expand Up @@ -272,8 +349,9 @@ unique_ptr<parser::Node> MethodTypeToParserNode::methodSignature(const parser::N
rbs_node_type_name(restPositionals), "FunctionParam");

auto loc = declaration.typeLocFromRange(restPositionals->location->rg);
auto nameLoc = adjustNameLoc(declaration, restPositionals);
auto node = (rbs_types_function_param_t *)restPositionals;
auto arg = RBSArg{loc, node->name, node->type, RBSArg::Kind::RestPositional};
auto arg = RBSArg{loc, nameLoc, node->name, node->type, RBSArg::Kind::RestPositional};
args.emplace_back(arg);
}

Expand All @@ -291,8 +369,9 @@ unique_ptr<parser::Node> MethodTypeToParserNode::methodSignature(const parser::N
"FunctionParam");

auto loc = declaration.typeLocFromRange(restKeywords->location->rg);
auto nameLoc = adjustNameLoc(declaration, restKeywords);
auto node = (rbs_types_function_param_t *)restKeywords;
auto arg = RBSArg{loc, node->name, node->type, RBSArg::Kind::RestKeyword};
auto arg = RBSArg{loc, nameLoc, node->name, node->type, RBSArg::Kind::RestKeyword};
args.emplace_back(arg);
}

Expand All @@ -304,7 +383,7 @@ unique_ptr<parser::Node> MethodTypeToParserNode::methodSignature(const parser::N
// TODO: fix block location in RBS parser
loc.beginLoc = loc.beginLoc + 1;
loc.endLoc = loc.endLoc + 2;
auto arg = RBSArg{loc, nullptr, (rbs_node_t *)block, RBSArg::Kind::Block};
auto arg = RBSArg{loc, loc, nullptr, (rbs_node_t *)block, RBSArg::Kind::Block};
args.emplace_back(arg);
}

Expand All @@ -328,19 +407,32 @@ unique_ptr<parser::Node> MethodTypeToParserNode::methodSignature(const parser::N

auto methodArg = methodArgs->args[i].get();

if (!checkParameterKindMatch(arg, methodArg)) {
if (auto e = ctx.beginError(arg.loc, core::errors::Rewriter::RBSIncorrectParameterKind)) {
e.setHeader("Argument kind mismatch for `{}`, method declares `{}`, but RBS signature declares `{}`",
nodeName(methodArg).show(ctx.state), nodeKindToString(methodArg),
argKindToString(arg.kind));

if (auto autocorrect = autocorrectArg(ctx, methodArg, arg, type->deepCopy())) {
e.addAutocorrect(core::AutocorrectSuggestion{
fmt::format("Replace with `{}`", argKindToString(arg.kind)),
{core::AutocorrectSuggestion::Edit{autocorrect->loc, autocorrect->source}}});
}
}
}

if (auto nameSymbol = arg.name) {
// The RBS arg is named in the signature, so we use the explicit name used
auto nameStr = parser.resolveConstant(nameSymbol);
auto name = ctx.state.enterNameUTF8(nameStr);
sigParams.emplace_back(make_unique<parser::Pair>(arg.loc, parser::MK::Symbol(arg.loc, name), move(type)));
sigParams.emplace_back(
make_unique<parser::Pair>(arg.loc, parser::MK::Symbol(arg.nameLoc, name), move(type)));
} else {
// The RBS arg is not named in the signature, so we get it from the method definition
auto name = nodeName(methodArg);
sigParams.emplace_back(
make_unique<parser::Pair>(arg.loc, parser::MK::Symbol(methodArg->loc, name), move(type)));
}

checkParameterKindMatch(ctx, arg, methodArg);
}

// Build the sig
Expand Down
6 changes: 3 additions & 3 deletions test/testdata/rbs/signatures_defs.rb
View file
Open in desktop
6D47
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def sig_mismatch1(p1, p2); end
# ^^ error: Malformed `sig`. Type not specified for argument `p2`

#: (foo: P1) -> void
# ^^^ error: Argument kind mismatch for `p1`, method declares `positional`, but RBS signature declares `keyword`
# ^^^^^^^ error: Argument kind mismatch for `p1`, method declares `positional`, but RBS signature declares `keyword`
# ^^^ error: Unknown argument name `foo`
def sig_mismatch2(p1); end
# ^^ error: Malformed `sig`. Type not specified for argument `p1`
Expand All @@ -66,11 +66,11 @@ def sig_mismatch6(p:); end
def sig_mismatch7(*p); end

#: (?p: Integer) -> void
# ^ error: Argument kind mismatch for `p`, method declares `keyword`, but RBS signature declares `optional keyword`
# ^^^^^^^^^^ error: Argument kind mismatch for `p`, method declares `keyword`, but RBS signature declares `optional keyword`
def sig_mismatch8(p:); end

#: (p: Integer) -> void
# ^ error: Argument kind mismatch for `p`, method declares `optional keyword`, but RBS signature declares `keyword`
# ^^^^^^^^^^ error: Argument kind mismatch for `p`, method declares `optional keyword`, but RBS signature declares `keyword`
def sig_mismatch9(p: 42); end

#: (*Integer) -> void
Expand Down
Loading
0