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

Enforce AttributeTargets properly. #1375

Open
5 of 6 tasks
edgarfgp opened this issue Jul 13, 2024 · 1 comment
Open
5 of 6 tasks

Enforce AttributeTargets properly. #1375

edgarfgp opened this issue Jul 13, 2024 · 1 comment

Comments

@edgarfgp
Copy link
Member

I propose we Enforce the correct use of AttributeTargets in the language and write a specification to document it.

The existing way of approaching this problem in F# is

In most cases just use interchangeably custom attributes with AttributeTargets and the compiler will not raise any errors.

open System

[<AttributeUsage(AttributeTargets.Method)>]
type MethodOnlyAttribute() = 
  inherit System.Attribute()

[<MethodOnly>]
let someFunction () = "abc"

[<MethodOnly>] // Should error  with: This attribute is not valid for use on this language element
let someValue =  "abc"

[<AttributeUsage(AttributeTargets.Field)>]
type FieldOnlyAttribute() = 
  inherit System.Attribute()

[<FieldOnly>] // Should error  with: This attribute is not valid for use on this language element
let someFunction () = "abc"

[<FieldOnly>]
let someValue =  "abc"

Note: The above snippet is just one of the many issues with AttributeTargets.

Pros and Cons

The advantages of making this adjustment to F# are

  • The compiler will raise errors when using an incorrect AttributeTargets
  • We will have a language specification about where and how this AttributeTargets are meant to used.

The disadvantages of making this adjustment to F# are

  • Any existing custom defined attribute that uses and incorrect AttributeTarget will get an error.

Extra information

**Estimated cost (XS, S, M, L, XL, XXL): M

Related suggestions: (put links to related suggestions here)

Affidavit (please submit!)

Please tick these items by placing a cross in the box:

  • This is not a question (e.g. like one you might ask on StackOverflow) and I have searched StackOverflow for discussions of this issue
  • This is a language change and not purely a tooling change (e.g. compiler bug, editor support, warning/error messages, new warning, non-breaking optimisation) belonging to the compiler and tooling repository
  • This is not something which has obviously "already been decided" in previous versions of F#. If you're questioning a fundamental design decision that has obviously already been taken (e.g. "Make F# untyped") then please don't submit it
  • I have searched both open and closed suggestions on this site and believe this is not a duplicate

Please tick all that apply:

  • This is not a breaking change to the F# language design
  • I or my company would be willing to help implement and/or test this

For Readers

If you would like to see this issue implemented, please click the 👍 emoji on this issue. These counts are used to generally order the suggestions by engagement.

@edgarfgp
Copy link
Member Author

I have already done most of the job for this and now I would like to create a RFC for this :). cc @vzarytovskii

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

No branches or pull requests

1 participant