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.

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

Attribute targets on records #17207

Merged
merged 24 commits into from
Jul 8, 2024

Conversation

edgarfgp
Copy link
Contributor

@edgarfgp edgarfgp commented May 21, 2024

Follow up: #17173

Records compiles down to a class or struct sharplab.

This PR enforces the new rules on records.

Old rules

  • AttributeTargets.Class
  • AttributeTargets.Interface
  • AttributeTargets.Delegate
  • AttributeTargets.Struct
  • AttributeTargets.Enum

New Rules

  • AttributeTargets.Class
  • AttributeTargets.Struct when using [<Struct>]

Before sharplab

[<AttributeUsage(AttributeTargets.Class)>]
 type ClassTargetAttribute() =
     inherit Attribute()

 [<AttributeUsage(AttributeTargets.Interface)>]
 type InterfaceTargetAttribute() =
     inherit Attribute()

 [<AttributeUsage(AttributeTargets.Struct)>]
 type StructTargetAttribute() =
     inherit Attribute()

 [<InterfaceTarget>] // Does not fail. It should
 [<StructTarget>] // Does not fail. It should
 [<ClassTarget>]
 type Record = { Prop: string }

 [<ClassTarget>] // Does not fail. It should
 [<InterfaceTarget>] // Does not fail. It should
 [<Struct>]
type StructRecord = { Prop: string }

After

[<AttributeUsage(AttributeTargets.Class)>]
 type ClassTargetAttribute() =
     inherit Attribute()

 [<AttributeUsage(AttributeTargets.Interface)>]
 type InterfaceTargetAttribute() =
     inherit Attribute()

 [<AttributeUsage(AttributeTargets.Struct)>]
 type StructTargetAttribute() =
     inherit Attribute()

 [<InterfaceTarget>] // Fails as expected
 [<StructTarget>] // Fails as expected
 [<ClassTarget>]
 type Record = { Prop: string }

 [<ClassTarget>] // Fails as expected
 [<InterfaceTarget>] // Fails as expected
 [<Struct>]
type StructRecord = { Prop: string }

Checklist

  • Test cases added
  • Release notes entry updated

Copy link
Contributor

github-actions bot commented May 21, 2024

❗ Release notes required


✅ Found changes and release notes in following paths:

Change path Release notes path Description
src/FSharp.Core docs/release-notes/.FSharp.Core/8.0.400.md
src/Compiler docs/release-notes/.FSharp.Compiler.Service/8.0.400.md

@edgarfgp edgarfgp force-pushed the attribute-targets-on-records branch from 5131943 to d43956f Compare May 22, 2024 22:03
@edgarfgp edgarfgp closed this May 23, 2024
@edgarfgp edgarfgp reopened this May 23, 2024
@edgarfgp edgarfgp marked this pull request as ready for review June 11, 2024 14:38
@edgarfgp edgarfgp requested a review from a team as a code owner June 11, 2024 14:38
@edgarfgp
Copy link
Contributor Author

Ready for review

@psfinaki
Copy link
Member

/azp run

Copy link

Azure Pipelines successfully started running 2 pipeline(s).

Copy link
Member

@T-Gro T-Gro left a comment

Choose a reason for hiding this comment

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

Can you explain the RequireQualifiedAccess reasoning here, maybe even in the comment as part of code?

Is it only a temporary need caused by new compiler + old FSharp.Core combination, eventually to be removed?

Copy link
Contributor

github-actions bot commented Jul 3, 2024

Caution

Repository is on lockdown for maintenance, all merges are on hold.

@edgarfgp edgarfgp closed this Jul 3, 2024
@edgarfgp edgarfgp reopened this Jul 3, 2024
@edgarfgp
Copy link
Contributor Author

edgarfgp commented Jul 4, 2024

Can you explain the RequireQualifiedAccess reasoning here, maybe even in the comment as part of code?

Is it only a temporary need caused by new compiler + old FSharp.Core combination, eventually to be removed?

@T-Gro So the check for RequireQualifiedAccess is not needed at all. Turns out that when you use dotnet build on FSharp.Compiler.Service it uses the FSharp.Core nuget as opposed to the project reference and that is why my unit test was failing locally.

Thanks for the review

Copy link
Member

@psfinaki psfinaki left a comment

Choose a reason for hiding this comment

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

Thanks! Appreciate your consistent and meticulous approach.
Do you see the light at the end of the attributes tunnel?

@edgarfgp
Copy link
Contributor Author

edgarfgp commented Jul 4, 2024

Thanks! Appreciate your consistent and meticulous approach. Do you see the light at the end of the attributes tunnel?

Yes. I have 2 more PRs and then a RFC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants