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

Remove FSharpProjectOptions from Transparent Compiler check results #18205

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

0101
Copy link
Contributor

@0101 0101 commented Jan 6, 2025

Description

Proper fix for #16979

FSharpProjectOptions is part of the public API, however it might be ok to not have it if you use the new snapshot based API. We could also add FSharpProjectSnapshot to the ProjectContext. But the user has to have it in order to request the result, so maybe we can just leave it up to them to hold it if they need it later...

Checklist

  • Test cases added
  • Performance benchmarks added in case of performance changes
  • Release notes entry updated

Copy link
Contributor

github-actions bot commented Jan 6, 2025

❗ Release notes required

@0101,

Caution

No release notes found for the changed paths (see table below).

Please make sure to add an entry with an informative description of the change as well as link to this pull request, issue and language suggestion if applicable. Release notes for this repository are based on Keep A Changelog format.

The following format is recommended for this repository:

* <Informative description>. ([PR #XXXXX](https://github.com/dotnet/fsharp/pull/XXXXX))

See examples in the files, listed in the table below or in th full documentation at https://fsharp.github.io/fsharp-compiler-docs/release-notes/About.html.

If you believe that release notes are not necessary for this PR, please add NO_RELEASE_NOTES label to the pull request.

You can open this PR in browser to add release notes: open in github.dev

Change path Release notes path Description
src/Compiler docs/release-notes/.FSharp.Compiler.Service/9.0.200.md No release notes found or release notes format is not correct

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.

This change only affects internal APIs, right?

@0101
Copy link
Contributor Author

0101 commented Jan 7, 2025

This change only affects internal APIs, right?

No. With this change, if you use Transparent Compiler to get FSharpCheckFileResults and then you do .ProjectContext.ProjectOptions you'll get an exception.

But if you use the default BackgroundCompiler it keeps working as before.

I think this is ok, since TC is marked as experimental.

But eventually we should probably change the public API. Not sure what the point of options being accessible there is anyway.

@0101
Copy link
Contributor Author

0101 commented Jan 7, 2025

Another thing is that currently it might already be possible to get an exception requesting ProjectContext under some circumstances:

member _.ProjectContext =
match details with
| None -> failwith "not available"
| Some(scope, _builderOpt) ->

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

Successfully merging this pull request may close these issues.

2 participants