Skip to content
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

Jump to bottom

Prevent use of augment decorators on template instantiations #1744

Merged
merged 5 commits into from
Mar 31, 2023
Merged

Prevent use of augment decorators on template instantiations #1744

merged 5 commits into from
Mar 31, 2023

Conversation

tjprescott
Copy link
Member

@tjprescott tjprescott commented Mar 27, 2023 •
edited
Loading

Fix #1354.

Throws a diagnostic if any arguments are provided in the augment decorator.
Error @@decorator(Foo<string>, "blah")
Error @@decorator(Foo<T>, "blah")
Okay @@decorator(Foo, "blah") // the template args left off

@github-actions
Copy link
Contributor

Changes in this PR will be published to the following url to try(check status of TypeSpec Pull Request Try It pipeline for publish status):
Playground: https://cadlplayground.z22.web.core.windows.net/prs/1744/

Website: https://cadlwebsite.z1.web.core.windows.net/prs/1744/

@azure-pipelines
Copy link

You can try these changes at https://cadlplayground.z22.web.core.windows.net/prs/1744/

Check the website changes at https://cadlwebsite.z1.web.core.windows.net/prs/1744/

@tjprescott tjprescott force-pushed the fixTemplateTarget branch 2 times, most recently from 3322e30 to 7d2f6ac Compare March 29, 2023 18:12
tjprescott
tjprescott commented Mar 29, 2023
View reviewed changes
packages/compiler/test/checker/augment-decorators.test.ts Outdated
Comment on lines 187 to 201
"test.tsp",
`
import "./test.js";

model Foo<T> {
testProp: T;
};

@test
op stringTest(): Foo<string>;

@@customName(Foo, "Some foo thing");
`
);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@timotheeguerin so this will not work if you do:
@@customName(Foo<T>, "Some foo thing");

Is that okay? One scenario we've seen with docs looks like:

@doc("Foo of {T}", T)
model Foo<T> {
  prop: T;
}

How would that work with augment? Like this?
@@doc(Foo<T>, "Foo of {T}", T)

With this PR, the above would throw a diagnostic.

@tjprescott tjprescott mentioned this pull request Mar 29, 2023
Closed
@tjprescott tjprescott force-pushed the fixTemplateTarget branch 3 times, most recently from 78bbe11 to 10a15e6 Compare March 31, 2023 19:19
@tjprescott tjprescott merged commit 85b5abf into main Mar 31, 2023
@tjprescott tjprescott deleted the fixTemplateTarget branch March 31, 2023 20:08
@tjprescott tjprescott mentioned this pull request Mar 31, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timotheeguerin timotheeguerin timotheeguerin approved these changes

@bterlson bterlson Awaiting requested review from bterlson bterlson is a code owner

@daviwil daviwil Awaiting requested review from daviwil

@nguerrera nguerrera Awaiting requested review from nguerrera

@markcowl markcowl Awaiting requested review from markcowl markcowl is a code owner

@allenjzhang allenjzhang Awaiting requested review from allenjzhang allenjzhang is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Emit error when attempting to target augment decorators at an instantiated template
2 participants
@tjprescott @timotheeguerin