Print empty namespace or module.#13813

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
vzarytovskii merged 5 commits into from
Sep 2, 2022
Merged

Print empty namespace or module. #13813

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d969f65
Print empty namespace or module.
nojaf Aug 30, 2022
88886d4
Update failing unit tests.
nojaf Aug 31, 2022
842b381
Collect all empty namespaces.
nojaf Sep 1, 2022
54971c5
Add test for empty recursive namespace.
nojaf Sep 1, 2022
75856a7
Move XML doc comment to signature file.
nojaf Sep 2, 2022
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
18 changes: 17 additions & 1 deletion src/Compiler/Checking/NicePrint.fs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2420,7 +2420,23 @@ module InferredSigPrinting =
modNameEqualsL @@* basic
layoutXmlDoc denv true mspec.XmlDoc basicL

imdefL denv expr
let emptyModuleOrNamespace mspec =
let innerPath = (fullCompPathOfModuleOrNamespace mspec).AccessPath
let pathL = innerPath |> List.map (fst >> ConvertLogicalNameToDisplayLayout (tagNamespace >> wordL))

let keyword =
if not mspec.IsImplicitNamespace && mspec.IsNamespace then
"namespace"
else
"module"

wordL (tagKeyword keyword) ^^ sepListL SepL.dot pathL

match expr with
| EmptyModuleOrNamespaces mspecs ->
List.map emptyModuleOrNamespace mspecs
|> aboveListL
| expr -> imdefL denv expr

//--------------------------------------------------------------------------

Expand Down
32 changes: 32 additions & 0 deletions src/Compiler/TypedTree/TypedTreeOps.fs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10360,3 +10360,35 @@ let isFSharpExceptionTy g ty =
| ValueSome tcref -> tcref.IsFSharpException
| _ -> false

let (|EmptyModuleOrNamespaces|_|) (moduleOrNamespaceContents: ModuleOrNamespaceContents) =
match moduleOrNamespaceContents with
| TMDefs(defs = defs) ->
let mdDefsLength =
defs
|> List.count (function
| ModuleOrNamespaceContents.TMDefRec _
| ModuleOrNamespaceContents.TMDefs _ -> true
| _ -> false)

let emptyModuleOrNamespaces =
defs
|> List.choose (function
| ModuleOrNamespaceContents.TMDefRec _ as defRec
| ModuleOrNamespaceContents.TMDefs(defs = [ ModuleOrNamespaceContents.TMDefRec _ as defRec ]) ->
match defRec with
| TMDefRec(bindings = [ ModuleOrNamespaceBinding.Module(mspec, ModuleOrNamespaceContents.TMDefs(defs = defs)) ]) ->
defs
|> List.forall (function
| ModuleOrNamespaceContents.TMDefOpens _
| ModuleOrNamespaceContents.TMDefDo _
| ModuleOrNamespaceContents.TMDefRec (isRec = true; tycons = []; bindings = []) -> true
| _ -> false)
|> fun isEmpty -> if isEmpty then Some mspec else None
| _ -> None
| _ -> None)

if mdDefsLength = emptyModuleOrNamespaces.Length then

@01010101Sep 1, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

There seems to be another edge case which could theoretically happen:

namespaceFoodo()namespaceBarmoduleBaz =do()

In this case it won't be matched and namespace Foo won't be in the signatures.

@nojafnojafSep 1, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I can live with that, the goal is to avoid purely empty file generation.
This will give a result because of the nested module and that is good enough for my use case.

Some emptyModuleOrNamespaces
else
None
| _ -> None

@01010101Sep 1, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we also check for TMDefRec here? Consider these (and maybe add to tests):

modulerecFoobardo()
namespacerecFoobardo()

@nojafnojafSep 1, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

modulerecFoobardo()

currently produces

moduleFoobarval``doval@3`` :unit

This probably isn't correct but is outside my scope here.

6 changes: 6 additions & 0 deletions src/Compiler/TypedTree/TypedTreeOps.fsi
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2676,3 +2676,9 @@ type TraitConstraintInfo with

/// Get the key associated with the member constraint.
member GetWitnessInfo: unit -> TraitWitnessInfo

/// Matches a ModuleOrNamespaceContents that is empty from a signature printing point of view.
/// Signatures printed via the typed tree in NicePrint don't print TMDefOpens or TMDefDo.
/// This will match anything that does not have any types or bindings.
val (|EmptyModuleOrNamespaces|_|):
Comment thread
0101 marked this conversation as resolved.
Outdated
moduleOrNamespaceContents: ModuleOrNamespaceContents -> (ModuleOrNamespace list) option
55 changes: 55 additions & 0 deletions tests/FSharp.Compiler.ComponentTests/Signatures/ModuleOrNamespaceTests.fs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -142,3 +142,58 @@ namespace Fantomas.Core
val genExpr: e: FSharp.Compiler.Syntax.SynExpr -> ctx: Context.Context -> Context.Context

val genLambdaArrowWithTrivia: bodyExpr: (FSharp.Compiler.Syntax.SynExpr -> Context.Context -> Context.Context) -> body: FSharp.Compiler.Syntax.SynExpr -> arrowRange: FSharp.Compiler.Text.Range option -> (Context.Context -> Context.Context)"""

[<Fact>]
let ``Empty namespace`` () =
FSharp
"""
namespace System

open System.Runtime.CompilerServices

[<assembly: InternalsVisibleTo("Fantomas.Core.Tests")>]

do ()
"""
|> printSignatures
|> should equal "namespace System"

[<Fact>]
let ``Empty module`` () =
FSharp
"""
module Foobar

do ()
"""
|> printSignatures
|> should equal "module Foobar"

[<Fact>]
let ``Two empty namespaces`` () =
FSharp
"""
namespace Foo

do ()

namespace Bar

do ()
"""
|> printSignatures
|> prependNewline
|> should equal """
namespace Foo
namespace Bar"""

[<Fact>]
let ``Empty namespace module`` () =
FSharp
"""
namespace rec Foobar

do ()
"""
|> printSignatures
|> should equal "namespace Foobar"
4 changes: 3 additions & 1 deletion tests/fsharp/core/load-script/out.stdout.bsl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,9 @@ World
-the end
Test 3=================================================

> [Loading D:\staging\staging\src\tests\fsharp\core\load-script\1.fsx
> module FSI_0001

[Loading D:\staging\staging\src\tests\fsharp\core\load-script\1.fsx
Loading D:\staging\staging\src\tests\fsharp\core\load-script\2.fsx
Loading D:\staging\staging\src\tests\fsharp\core\load-script\3.fsx]
Hello
Expand Down
6 changes: 5 additions & 1 deletion tests/fsharp/core/printing/output.1000.stdout.bsl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string = "A"
Expand DownExpand Up@@ -234,7 +236,9 @@ module D1 =
val words: System.Collections.Generic.IDictionary<string,int>
val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
val words: IDictionary<string,int>
val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down
6 changes: 5 additions & 1 deletion tests/fsharp/core/printing/output.200.stdout.bsl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string = "A"
Expand DownExpand Up@@ -129,7 +131,9 @@ module D1 =
val words: System.Collections.Generic.IDictionary<string,int>
val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
val words: IDictionary<string,int>
val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down
8 changes: 6 additions & 2 deletions tests/fsharp/core/printing/output.47.stdout.bsl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
val words: System.Collections.Generic.IDictionary<string,int>
val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
val words: IDictionary<string,int>
val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down
8 changes: 6 additions & 2 deletions tests/fsharp/core/printing/output.multiemit.stdout.bsl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
val words: System.Collections.Generic.IDictionary<string,int>
val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
val words: IDictionary<string,int>
val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down
6 changes: 5 additions & 1 deletion tests/fsharp/core/printing/output.off.stdout.bsl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string
Expand DownExpand Up@@ -94,7 +96,9 @@ module D1 =
val words: System.Collections.Generic.IDictionary<string,int>
val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
val words: IDictionary<string,int>
val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down
8 changes: 6 additions & 2 deletions tests/fsharp/core/printing/output.stdout.bsl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
val words: System.Collections.Generic.IDictionary<string,int>
val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
val words: IDictionary<string,int>
val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Print empty namespace or module.#13813

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

vzarytovskii
merged 5 commits into

from

Sep 2, 2022
 Merged


Print empty namespace or module.
#13813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d969f65

Print empty namespace or module.


nojaf Aug 30, 2022
88886d4

Update failing unit tests.


nojaf Aug 31, 2022
842b381

Collect all empty namespaces.


nojaf Sep 1, 2022
54971c5

Add test for empty recursive namespace.


nojaf Sep 1, 2022
75856a7

Move XML doc comment to signature file.


nojaf Sep 2, 2022

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


18 changes: 17 additions & 1 deletion
src/Compiler/Checking/NicePrint.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2420,7 +2420,23 @@ module InferredSigPrinting =
 modNameEqualsL @@* basic
 layoutXmlDoc denv true mspec.XmlDoc basicL

 imdefL denv expr
 let emptyModuleOrNamespace mspec =
 let innerPath = (fullCompPathOfModuleOrNamespace mspec).AccessPath
 let pathL = innerPath |> List.map (fst >> ConvertLogicalNameToDisplayLayout (tagNamespace >> wordL))

 let keyword =
 if not mspec.IsImplicitNamespace && mspec.IsNamespace then
 "namespace"
 else
 "module"

 wordL (tagKeyword keyword) ^^ sepListL SepL.dot pathL

 match expr with
 | EmptyModuleOrNamespaces mspecs ->
 List.map emptyModuleOrNamespace mspecs
 |> aboveListL
 | expr -> imdefL denv expr

//--------------------------------------------------------------------------

Expand Down

32 changes: 32 additions & 0 deletions
src/Compiler/TypedTree/TypedTreeOps.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10360,3 +10360,35 @@ let isFSharpExceptionTy g ty =
 | ValueSome tcref -> tcref.IsFSharpException
 | _ -> false

let (|EmptyModuleOrNamespaces|_|) (moduleOrNamespaceContents: ModuleOrNamespaceContents) =
 match moduleOrNamespaceContents with
 | TMDefs(defs = defs) ->
 let mdDefsLength =
 defs
 |> List.count (function
 | ModuleOrNamespaceContents.TMDefRec _
 | ModuleOrNamespaceContents.TMDefs _ -> true
 | _ -> false)

 let emptyModuleOrNamespaces =
 defs
 |> List.choose (function
 | ModuleOrNamespaceContents.TMDefRec _ as defRec
 | ModuleOrNamespaceContents.TMDefs(defs = [ ModuleOrNamespaceContents.TMDefRec _ as defRec ]) ->
 match defRec with
 | TMDefRec(bindings = [ ModuleOrNamespaceBinding.Module(mspec, ModuleOrNamespaceContents.TMDefs(defs = defs)) ]) ->
 defs
 |> List.forall (function
 | ModuleOrNamespaceContents.TMDefOpens _
 | ModuleOrNamespaceContents.TMDefDo _
 | ModuleOrNamespaceContents.TMDefRec (isRec = true; tycons = []; bindings = []) -> true
 | _ -> false)
 |> fun isEmpty -> if isEmpty then Some mspec else None
 | _ -> None
 | _ -> None)

 if mdDefsLength = emptyModuleOrNamespaces.Length then
@01010101Sep 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

There seems to be another edge case which could theoretically happen:
namespaceFoodo()namespaceBarmoduleBaz =do()
In this case it won't be matched and namespace Foo won't be in the signatures.
@nojafnojafSep 1, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I can live with that, the goal is to avoid purely empty file generation.

This will give a result because of the nested module and that is good enough for my use case.
 Some emptyModuleOrNamespaces
 else
 None
 | _ -> None
@01010101Sep 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Should we also check for TMDefRec here? Consider these (and maybe add to tests):
modulerecFoobardo()
namespacerecFoobardo()
@nojafnojafSep 1, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

modulerecFoobardo()
currently produces
moduleFoobarval``doval@3`` :unit
This probably isn't correct but is outside my scope here.

6 changes: 6 additions & 0 deletions
src/Compiler/TypedTree/TypedTreeOps.fsi

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2676,3 +2676,9 @@ type TraitConstraintInfo with

 /// Get the key associated with the member constraint.
 member GetWitnessInfo: unit -> TraitWitnessInfo

/// Matches a ModuleOrNamespaceContents that is empty from a signature printing point of view.
/// Signatures printed via the typed tree in NicePrint don't print TMDefOpens or TMDefDo.
/// This will match anything that does not have any types or bindings.
val (|EmptyModuleOrNamespaces|_|):
Comment thread
0101 marked this conversation as resolved.


Outdated

 moduleOrNamespaceContents: ModuleOrNamespaceContents -> (ModuleOrNamespace list) option

55 changes: 55 additions & 0 deletions
tests/FSharp.Compiler.ComponentTests/Signatures/ModuleOrNamespaceTests.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,3 +142,58 @@ namespace Fantomas.Core
 val genExpr: e: FSharp.Compiler.Syntax.SynExpr -> ctx: Context.Context -> Context.Context

 val genLambdaArrowWithTrivia: bodyExpr: (FSharp.Compiler.Syntax.SynExpr -> Context.Context -> Context.Context) -> body: FSharp.Compiler.Syntax.SynExpr -> arrowRange: FSharp.Compiler.Text.Range option -> (Context.Context -> Context.Context)"""

[<Fact>]
let ``Empty namespace`` () =
 FSharp
 """
namespace System

open System.Runtime.CompilerServices

[<assembly: InternalsVisibleTo("Fantomas.Core.Tests")>]

do ()
"""
 |> printSignatures
 |> should equal "namespace System"

[<Fact>]
let ``Empty module`` () =
 FSharp
 """
module Foobar

do ()
"""
 |> printSignatures
 |> should equal "module Foobar"

[<Fact>]
let ``Two empty namespaces`` () =
 FSharp
 """
namespace Foo

do ()

namespace Bar

do ()
"""
 |> printSignatures
 |> prependNewline
 |> should equal """
namespace Foo
namespace Bar"""

[<Fact>]
let ``Empty namespace module`` () =
 FSharp
 """
namespace rec Foobar

do ()
"""
 |> printSignatures
 |> should equal "namespace Foobar"

4 changes: 3 additions & 1 deletion
tests/fsharp/core/load-script/out.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,9 @@ World
-the end
Test 3=================================================

> [Loading D:\staging\staging\src\tests\fsharp\core\load-script\1.fsx
> module FSI_0001

[Loading D:\staging\staging\src\tests\fsharp\core\load-script\1.fsx
 Loading D:\staging\staging\src\tests\fsharp\core\load-script\2.fsx
 Loading D:\staging\staging\src\tests\fsharp\core\load-script\3.fsx]
Hello
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.1000.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string = "A"
Expand DownExpand Up@@ -234,7 +236,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.200.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string = "A"
Expand DownExpand Up@@ -129,7 +131,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.47.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.multiemit.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.off.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string
Expand DownExpand Up@@ -94,7 +96,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Print empty namespace or module.#13813

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

vzarytovskii
merged 5 commits into

from

Sep 2, 2022
 Merged


Print empty namespace or module.
#13813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d969f65

Print empty namespace or module.


nojaf Aug 30, 2022
88886d4

Update failing unit tests.


nojaf Aug 31, 2022
842b381

Collect all empty namespaces.


nojaf Sep 1, 2022
54971c5

Add test for empty recursive namespace.


nojaf Sep 1, 2022
75856a7

Move XML doc comment to signature file.


nojaf Sep 2, 2022

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


18 changes: 17 additions & 1 deletion
src/Compiler/Checking/NicePrint.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2420,7 +2420,23 @@ module InferredSigPrinting =
 modNameEqualsL @@* basic
 layoutXmlDoc denv true mspec.XmlDoc basicL

 imdefL denv expr
 let emptyModuleOrNamespace mspec =
 let innerPath = (fullCompPathOfModuleOrNamespace mspec).AccessPath
 let pathL = innerPath |> List.map (fst >> ConvertLogicalNameToDisplayLayout (tagNamespace >> wordL))

 let keyword =
 if not mspec.IsImplicitNamespace && mspec.IsNamespace then
 "namespace"
 else
 "module"

 wordL (tagKeyword keyword) ^^ sepListL SepL.dot pathL

 match expr with
 | EmptyModuleOrNamespaces mspecs ->
 List.map emptyModuleOrNamespace mspecs
 |> aboveListL
 | expr -> imdefL denv expr

//--------------------------------------------------------------------------

Expand Down

32 changes: 32 additions & 0 deletions
src/Compiler/TypedTree/TypedTreeOps.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10360,3 +10360,35 @@ let isFSharpExceptionTy g ty =
 | ValueSome tcref -> tcref.IsFSharpException
 | _ -> false

let (|EmptyModuleOrNamespaces|_|) (moduleOrNamespaceContents: ModuleOrNamespaceContents) =
 match moduleOrNamespaceContents with
 | TMDefs(defs = defs) ->
 let mdDefsLength =
 defs
 |> List.count (function
 | ModuleOrNamespaceContents.TMDefRec _
 | ModuleOrNamespaceContents.TMDefs _ -> true
 | _ -> false)

 let emptyModuleOrNamespaces =
 defs
 |> List.choose (function
 | ModuleOrNamespaceContents.TMDefRec _ as defRec
 | ModuleOrNamespaceContents.TMDefs(defs = [ ModuleOrNamespaceContents.TMDefRec _ as defRec ]) ->
 match defRec with
 | TMDefRec(bindings = [ ModuleOrNamespaceBinding.Module(mspec, ModuleOrNamespaceContents.TMDefs(defs = defs)) ]) ->
 defs
 |> List.forall (function
 | ModuleOrNamespaceContents.TMDefOpens _
 | ModuleOrNamespaceContents.TMDefDo _
 | ModuleOrNamespaceContents.TMDefRec (isRec = true; tycons = []; bindings = []) -> true
 | _ -> false)
 |> fun isEmpty -> if isEmpty then Some mspec else None
 | _ -> None
 | _ -> None)

 if mdDefsLength = emptyModuleOrNamespaces.Length then
@01010101Sep 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

There seems to be another edge case which could theoretically happen:
namespaceFoodo()namespaceBarmoduleBaz =do()
In this case it won't be matched and namespace Foo won't be in the signatures.
@nojafnojafSep 1, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I can live with that, the goal is to avoid purely empty file generation.

This will give a result because of the nested module and that is good enough for my use case.
 Some emptyModuleOrNamespaces
 else
 None
 | _ -> None
@01010101Sep 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Should we also check for TMDefRec here? Consider these (and maybe add to tests):
modulerecFoobardo()
namespacerecFoobardo()
@nojafnojafSep 1, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

modulerecFoobardo()
currently produces
moduleFoobarval``doval@3`` :unit
This probably isn't correct but is outside my scope here.

6 changes: 6 additions & 0 deletions
src/Compiler/TypedTree/TypedTreeOps.fsi

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2676,3 +2676,9 @@ type TraitConstraintInfo with

 /// Get the key associated with the member constraint.
 member GetWitnessInfo: unit -> TraitWitnessInfo

/// Matches a ModuleOrNamespaceContents that is empty from a signature printing point of view.
/// Signatures printed via the typed tree in NicePrint don't print TMDefOpens or TMDefDo.
/// This will match anything that does not have any types or bindings.
val (|EmptyModuleOrNamespaces|_|):
Comment thread
0101 marked this conversation as resolved.


Outdated

 moduleOrNamespaceContents: ModuleOrNamespaceContents -> (ModuleOrNamespace list) option

55 changes: 55 additions & 0 deletions
tests/FSharp.Compiler.ComponentTests/Signatures/ModuleOrNamespaceTests.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,3 +142,58 @@ namespace Fantomas.Core
 val genExpr: e: FSharp.Compiler.Syntax.SynExpr -> ctx: Context.Context -> Context.Context

 val genLambdaArrowWithTrivia: bodyExpr: (FSharp.Compiler.Syntax.SynExpr -> Context.Context -> Context.Context) -> body: FSharp.Compiler.Syntax.SynExpr -> arrowRange: FSharp.Compiler.Text.Range option -> (Context.Context -> Context.Context)"""

[<Fact>]
let ``Empty namespace`` () =
 FSharp
 """
namespace System

open System.Runtime.CompilerServices

[<assembly: InternalsVisibleTo("Fantomas.Core.Tests")>]

do ()
"""
 |> printSignatures
 |> should equal "namespace System"

[<Fact>]
let ``Empty module`` () =
 FSharp
 """
module Foobar

do ()
"""
 |> printSignatures
 |> should equal "module Foobar"

[<Fact>]
let ``Two empty namespaces`` () =
 FSharp
 """
namespace Foo

do ()

namespace Bar

do ()
"""
 |> printSignatures
 |> prependNewline
 |> should equal """
namespace Foo
namespace Bar"""

[<Fact>]
let ``Empty namespace module`` () =
 FSharp
 """
namespace rec Foobar

do ()
"""
 |> printSignatures
 |> should equal "namespace Foobar"

4 changes: 3 additions & 1 deletion
tests/fsharp/core/load-script/out.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,9 @@ World
-the end
Test 3=================================================

> [Loading D:\staging\staging\src\tests\fsharp\core\load-script\1.fsx
> module FSI_0001

[Loading D:\staging\staging\src\tests\fsharp\core\load-script\1.fsx
 Loading D:\staging\staging\src\tests\fsharp\core\load-script\2.fsx
 Loading D:\staging\staging\src\tests\fsharp\core\load-script\3.fsx]
Hello
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.1000.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string = "A"
Expand DownExpand Up@@ -234,7 +236,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.200.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string = "A"
Expand DownExpand Up@@ -129,7 +131,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.47.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.multiemit.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.off.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string
Expand DownExpand Up@@ -94,7 +96,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Print empty namespace or module.#13813

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

vzarytovskii
merged 5 commits into

from

Sep 2, 2022
 Merged


Print empty namespace or module.
#13813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d969f65

Print empty namespace or module.


nojaf Aug 30, 2022
88886d4

Update failing unit tests.


nojaf Aug 31, 2022
842b381

Collect all empty namespaces.


nojaf Sep 1, 2022
54971c5

Add test for empty recursive namespace.


nojaf Sep 1, 2022
75856a7

Move XML doc comment to signature file.


nojaf Sep 2, 2022

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


18 changes: 17 additions & 1 deletion
src/Compiler/Checking/NicePrint.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2420,7 +2420,23 @@ module InferredSigPrinting =
 modNameEqualsL @@* basic
 layoutXmlDoc denv true mspec.XmlDoc basicL

 imdefL denv expr
 let emptyModuleOrNamespace mspec =
 let innerPath = (fullCompPathOfModuleOrNamespace mspec).AccessPath
 let pathL = innerPath |> List.map (fst >> ConvertLogicalNameToDisplayLayout (tagNamespace >> wordL))

 let keyword =
 if not mspec.IsImplicitNamespace && mspec.IsNamespace then
 "namespace"
 else
 "module"

 wordL (tagKeyword keyword) ^^ sepListL SepL.dot pathL

 match expr with
 | EmptyModuleOrNamespaces mspecs ->
 List.map emptyModuleOrNamespace mspecs
 |> aboveListL
 | expr -> imdefL denv expr

//--------------------------------------------------------------------------

Expand Down

32 changes: 32 additions & 0 deletions
src/Compiler/TypedTree/TypedTreeOps.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10360,3 +10360,35 @@ let isFSharpExceptionTy g ty =
 | ValueSome tcref -> tcref.IsFSharpException
 | _ -> false

let (|EmptyModuleOrNamespaces|_|) (moduleOrNamespaceContents: ModuleOrNamespaceContents) =
 match moduleOrNamespaceContents with
 | TMDefs(defs = defs) ->
 let mdDefsLength =
 defs
 |> List.count (function
 | ModuleOrNamespaceContents.TMDefRec _
 | ModuleOrNamespaceContents.TMDefs _ -> true
 | _ -> false)

 let emptyModuleOrNamespaces =
 defs
 |> List.choose (function
 | ModuleOrNamespaceContents.TMDefRec _ as defRec
 | ModuleOrNamespaceContents.TMDefs(defs = [ ModuleOrNamespaceContents.TMDefRec _ as defRec ]) ->
 match defRec with
 | TMDefRec(bindings = [ ModuleOrNamespaceBinding.Module(mspec, ModuleOrNamespaceContents.TMDefs(defs = defs)) ]) ->
 defs
 |> List.forall (function
 | ModuleOrNamespaceContents.TMDefOpens _
 | ModuleOrNamespaceContents.TMDefDo _
 | ModuleOrNamespaceContents.TMDefRec (isRec = true; tycons = []; bindings = []) -> true
 | _ -> false)
 |> fun isEmpty -> if isEmpty then Some mspec else None
 | _ -> None
 | _ -> None)

 if mdDefsLength = emptyModuleOrNamespaces.Length then
@01010101Sep 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

There seems to be another edge case which could theoretically happen:
namespaceFoodo()namespaceBarmoduleBaz =do()
In this case it won't be matched and namespace Foo won't be in the signatures.
@nojafnojafSep 1, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I can live with that, the goal is to avoid purely empty file generation.

This will give a result because of the nested module and that is good enough for my use case.
 Some emptyModuleOrNamespaces
 else
 None
 | _ -> None
@01010101Sep 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Should we also check for TMDefRec here? Consider these (and maybe add to tests):
modulerecFoobardo()
namespacerecFoobardo()
@nojafnojafSep 1, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

modulerecFoobardo()
currently produces
moduleFoobarval``doval@3`` :unit
This probably isn't correct but is outside my scope here.

6 changes: 6 additions & 0 deletions
src/Compiler/TypedTree/TypedTreeOps.fsi

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2676,3 +2676,9 @@ type TraitConstraintInfo with

 /// Get the key associated with the member constraint.
 member GetWitnessInfo: unit -> TraitWitnessInfo

/// Matches a ModuleOrNamespaceContents that is empty from a signature printing point of view.
/// Signatures printed via the typed tree in NicePrint don't print TMDefOpens or TMDefDo.
/// This will match anything that does not have any types or bindings.
val (|EmptyModuleOrNamespaces|_|):
Comment thread
0101 marked this conversation as resolved.


Outdated

 moduleOrNamespaceContents: ModuleOrNamespaceContents -> (ModuleOrNamespace list) option

55 changes: 55 additions & 0 deletions
tests/FSharp.Compiler.ComponentTests/Signatures/ModuleOrNamespaceTests.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,3 +142,58 @@ namespace Fantomas.Core
 val genExpr: e: FSharp.Compiler.Syntax.SynExpr -> ctx: Context.Context -> Context.Context

 val genLambdaArrowWithTrivia: bodyExpr: (FSharp.Compiler.Syntax.SynExpr -> Context.Context -> Context.Context) -> body: FSharp.Compiler.Syntax.SynExpr -> arrowRange: FSharp.Compiler.Text.Range option -> (Context.Context -> Context.Context)"""

[<Fact>]
let ``Empty namespace`` () =
 FSharp
 """
namespace System

open System.Runtime.CompilerServices

[<assembly: InternalsVisibleTo("Fantomas.Core.Tests")>]

do ()
"""
 |> printSignatures
 |> should equal "namespace System"

[<Fact>]
let ``Empty module`` () =
 FSharp
 """
module Foobar

do ()
"""
 |> printSignatures
 |> should equal "module Foobar"

[<Fact>]
let ``Two empty namespaces`` () =
 FSharp
 """
namespace Foo

do ()

namespace Bar

do ()
"""
 |> printSignatures
 |> prependNewline
 |> should equal """
namespace Foo
namespace Bar"""

[<Fact>]
let ``Empty namespace module`` () =
 FSharp
 """
namespace rec Foobar

do ()
"""
 |> printSignatures
 |> should equal "namespace Foobar"

4 changes: 3 additions & 1 deletion
tests/fsharp/core/load-script/out.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,9 @@ World
-the end
Test 3=================================================

> [Loading D:\staging\staging\src\tests\fsharp\core\load-script\1.fsx
> module FSI_0001

[Loading D:\staging\staging\src\tests\fsharp\core\load-script\1.fsx
 Loading D:\staging\staging\src\tests\fsharp\core\load-script\2.fsx
 Loading D:\staging\staging\src\tests\fsharp\core\load-script\3.fsx]
Hello
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.1000.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string = "A"
Expand DownExpand Up@@ -234,7 +236,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.200.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string = "A"
Expand DownExpand Up@@ -129,7 +131,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.47.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.multiemit.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.off.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string
Expand DownExpand Up@@ -94,7 +96,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Print empty namespace or module.#13813

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

vzarytovskii
merged 5 commits into

from

Sep 2, 2022
 Merged


Print empty namespace or module.
#13813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d969f65

Print empty namespace or module.


nojaf Aug 30, 2022
88886d4

Update failing unit tests.


nojaf Aug 31, 2022
842b381

Collect all empty namespaces.


nojaf Sep 1, 2022
54971c5

Add test for empty recursive namespace.


nojaf Sep 1, 2022
75856a7

Move XML doc comment to signature file.


nojaf Sep 2, 2022

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


18 changes: 17 additions & 1 deletion
src/Compiler/Checking/NicePrint.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2420,7 +2420,23 @@ module InferredSigPrinting =
 modNameEqualsL @@* basic
 layoutXmlDoc denv true mspec.XmlDoc basicL

 imdefL denv expr
 let emptyModuleOrNamespace mspec =
 let innerPath = (fullCompPathOfModuleOrNamespace mspec).AccessPath
 let pathL = innerPath |> List.map (fst >> ConvertLogicalNameToDisplayLayout (tagNamespace >> wordL))

 let keyword =
 if not mspec.IsImplicitNamespace && mspec.IsNamespace then
 "namespace"
 else
 "module"

 wordL (tagKeyword keyword) ^^ sepListL SepL.dot pathL

 match expr with
 | EmptyModuleOrNamespaces mspecs ->
 List.map emptyModuleOrNamespace mspecs
 |> aboveListL
 | expr -> imdefL denv expr

//--------------------------------------------------------------------------

Expand Down

32 changes: 32 additions & 0 deletions
src/Compiler/TypedTree/TypedTreeOps.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10360,3 +10360,35 @@ let isFSharpExceptionTy g ty =
 | ValueSome tcref -> tcref.IsFSharpException
 | _ -> false

let (|EmptyModuleOrNamespaces|_|) (moduleOrNamespaceContents: ModuleOrNamespaceContents) =
 match moduleOrNamespaceContents with
 | TMDefs(defs = defs) ->
 let mdDefsLength =
 defs
 |> List.count (function
 | ModuleOrNamespaceContents.TMDefRec _
 | ModuleOrNamespaceContents.TMDefs _ -> true
 | _ -> false)

 let emptyModuleOrNamespaces =
 defs
 |> List.choose (function
 | ModuleOrNamespaceContents.TMDefRec _ as defRec
 | ModuleOrNamespaceContents.TMDefs(defs = [ ModuleOrNamespaceContents.TMDefRec _ as defRec ]) ->
 match defRec with
 | TMDefRec(bindings = [ ModuleOrNamespaceBinding.Module(mspec, ModuleOrNamespaceContents.TMDefs(defs = defs)) ]) ->
 defs
 |> List.forall (function
 | ModuleOrNamespaceContents.TMDefOpens _
 | ModuleOrNamespaceContents.TMDefDo _
 | ModuleOrNamespaceContents.TMDefRec (isRec = true; tycons = []; bindings = []) -> true
 | _ -> false)
 |> fun isEmpty -> if isEmpty then Some mspec else None
 | _ -> None
 | _ -> None)

 if mdDefsLength = emptyModuleOrNamespaces.Length then
@01010101Sep 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

There seems to be another edge case which could theoretically happen:
namespaceFoodo()namespaceBarmoduleBaz =do()
In this case it won't be matched and namespace Foo won't be in the signatures.
@nojafnojafSep 1, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I can live with that, the goal is to avoid purely empty file generation.

This will give a result because of the nested module and that is good enough for my use case.
 Some emptyModuleOrNamespaces
 else
 None
 | _ -> None
@01010101Sep 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Should we also check for TMDefRec here? Consider these (and maybe add to tests):
modulerecFoobardo()
namespacerecFoobardo()
@nojafnojafSep 1, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

modulerecFoobardo()
currently produces
moduleFoobarval``doval@3`` :unit
This probably isn't correct but is outside my scope here.

6 changes: 6 additions & 0 deletions
src/Compiler/TypedTree/TypedTreeOps.fsi

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2676,3 +2676,9 @@ type TraitConstraintInfo with

 /// Get the key associated with the member constraint.
 member GetWitnessInfo: unit -> TraitWitnessInfo

/// Matches a ModuleOrNamespaceContents that is empty from a signature printing point of view.
/// Signatures printed via the typed tree in NicePrint don't print TMDefOpens or TMDefDo.
/// This will match anything that does not have any types or bindings.
val (|EmptyModuleOrNamespaces|_|):
Comment thread
0101 marked this conversation as resolved.


Outdated

 moduleOrNamespaceContents: ModuleOrNamespaceContents -> (ModuleOrNamespace list) option

55 changes: 55 additions & 0 deletions
tests/FSharp.Compiler.ComponentTests/Signatures/ModuleOrNamespaceTests.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,3 +142,58 @@ namespace Fantomas.Core
 val genExpr: e: FSharp.Compiler.Syntax.SynExpr -> ctx: Context.Context -> Context.Context

 val genLambdaArrowWithTrivia: bodyExpr: (FSharp.Compiler.Syntax.SynExpr -> Context.Context -> Context.Context) -> body: FSharp.Compiler.Syntax.SynExpr -> arrowRange: FSharp.Compiler.Text.Range option -> (Context.Context -> Context.Context)"""

[<Fact>]
let ``Empty namespace`` () =
 FSharp
 """
namespace System

open System.Runtime.CompilerServices

[<assembly: InternalsVisibleTo("Fantomas.Core.Tests")>]

do ()
"""
 |> printSignatures
 |> should equal "namespace System"

[<Fact>]
let ``Empty module`` () =
 FSharp
 """
module Foobar

do ()
"""
 |> printSignatures
 |> should equal "module Foobar"

[<Fact>]
let ``Two empty namespaces`` () =
 FSharp
 """
namespace Foo

do ()

namespace Bar

do ()
"""
 |> printSignatures
 |> prependNewline
 |> should equal """
namespace Foo
namespace Bar"""

[<Fact>]
let ``Empty namespace module`` () =
 FSharp
 """
namespace rec Foobar

do ()
"""
 |> printSignatures
 |> should equal "namespace Foobar"

4 changes: 3 additions & 1 deletion
tests/fsharp/core/load-script/out.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,9 @@ World
-the end
Test 3=================================================

> [Loading D:\staging\staging\src\tests\fsharp\core\load-script\1.fsx
> module FSI_0001

[Loading D:\staging\staging\src\tests\fsharp\core\load-script\1.fsx
 Loading D:\staging\staging\src\tests\fsharp\core\load-script\2.fsx
 Loading D:\staging\staging\src\tests\fsharp\core\load-script\3.fsx]
Hello
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.1000.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string = "A"
Expand DownExpand Up@@ -234,7 +236,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.200.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string = "A"
Expand DownExpand Up@@ -129,7 +131,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.47.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.multiemit.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.off.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string
Expand DownExpand Up@@ -94,7 +96,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Print empty namespace or module.#13813

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

vzarytovskii
merged 5 commits into

from

Sep 2, 2022
 Merged


Print empty namespace or module.
#13813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d969f65

Print empty namespace or module.


nojaf Aug 30, 2022
88886d4

Update failing unit tests.


nojaf Aug 31, 2022
842b381

Collect all empty namespaces.


nojaf Sep 1, 2022
54971c5

Add test for empty recursive namespace.


nojaf Sep 1, 2022
75856a7

Move XML doc comment to signature file.


nojaf Sep 2, 2022

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


18 changes: 17 additions & 1 deletion
src/Compiler/Checking/NicePrint.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2420,7 +2420,23 @@ module InferredSigPrinting =
 modNameEqualsL @@* basic
 layoutXmlDoc denv true mspec.XmlDoc basicL

 imdefL denv expr
 let emptyModuleOrNamespace mspec =
 let innerPath = (fullCompPathOfModuleOrNamespace mspec).AccessPath
 let pathL = innerPath |> List.map (fst >> ConvertLogicalNameToDisplayLayout (tagNamespace >> wordL))

 let keyword =
 if not mspec.IsImplicitNamespace && mspec.IsNamespace then
 "namespace"
 else
 "module"

 wordL (tagKeyword keyword) ^^ sepListL SepL.dot pathL

 match expr with
 | EmptyModuleOrNamespaces mspecs ->
 List.map emptyModuleOrNamespace mspecs
 |> aboveListL
 | expr -> imdefL denv expr

//--------------------------------------------------------------------------

Expand Down

32 changes: 32 additions & 0 deletions
src/Compiler/TypedTree/TypedTreeOps.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10360,3 +10360,35 @@ let isFSharpExceptionTy g ty =
 | ValueSome tcref -> tcref.IsFSharpException
 | _ -> false

let (|EmptyModuleOrNamespaces|_|) (moduleOrNamespaceContents: ModuleOrNamespaceContents) =
 match moduleOrNamespaceContents with
 | TMDefs(defs = defs) ->
 let mdDefsLength =
 defs
 |> List.count (function
 | ModuleOrNamespaceContents.TMDefRec _
 | ModuleOrNamespaceContents.TMDefs _ -> true
 | _ -> false)

 let emptyModuleOrNamespaces =
 defs
 |> List.choose (function
 | ModuleOrNamespaceContents.TMDefRec _ as defRec
 | ModuleOrNamespaceContents.TMDefs(defs = [ ModuleOrNamespaceContents.TMDefRec _ as defRec ]) ->
 match defRec with
 | TMDefRec(bindings = [ ModuleOrNamespaceBinding.Module(mspec, ModuleOrNamespaceContents.TMDefs(defs = defs)) ]) ->
 defs
 |> List.forall (function
 | ModuleOrNamespaceContents.TMDefOpens _
 | ModuleOrNamespaceContents.TMDefDo _
 | ModuleOrNamespaceContents.TMDefRec (isRec = true; tycons = []; bindings = []) -> true
 | _ -> false)
 |> fun isEmpty -> if isEmpty then Some mspec else None
 | _ -> None
 | _ -> None)

 if mdDefsLength = emptyModuleOrNamespaces.Length then
@01010101Sep 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

There seems to be another edge case which could theoretically happen:
namespaceFoodo()namespaceBarmoduleBaz =do()
In this case it won't be matched and namespace Foo won't be in the signatures.
@nojafnojafSep 1, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I can live with that, the goal is to avoid purely empty file generation.

This will give a result because of the nested module and that is good enough for my use case.
 Some emptyModuleOrNamespaces
 else
 None
 | _ -> None
@01010101Sep 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Should we also check for TMDefRec here? Consider these (and maybe add to tests):
modulerecFoobardo()
namespacerecFoobardo()
@nojafnojafSep 1, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

modulerecFoobardo()
currently produces
moduleFoobarval``doval@3`` :unit
This probably isn't correct but is outside my scope here.

6 changes: 6 additions & 0 deletions
src/Compiler/TypedTree/TypedTreeOps.fsi

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2676,3 +2676,9 @@ type TraitConstraintInfo with

 /// Get the key associated with the member constraint.
 member GetWitnessInfo: unit -> TraitWitnessInfo

/// Matches a ModuleOrNamespaceContents that is empty from a signature printing point of view.
/// Signatures printed via the typed tree in NicePrint don't print TMDefOpens or TMDefDo.
/// This will match anything that does not have any types or bindings.
val (|EmptyModuleOrNamespaces|_|):
Comment thread
0101 marked this conversation as resolved.


Outdated

 moduleOrNamespaceContents: ModuleOrNamespaceContents -> (ModuleOrNamespace list) option

55 changes: 55 additions & 0 deletions
tests/FSharp.Compiler.ComponentTests/Signatures/ModuleOrNamespaceTests.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,3 +142,58 @@ namespace Fantomas.Core
 val genExpr: e: FSharp.Compiler.Syntax.SynExpr -> ctx: Context.Context -> Context.Context

 val genLambdaArrowWithTrivia: bodyExpr: (FSharp.Compiler.Syntax.SynExpr -> Context.Context -> Context.Context) -> body: FSharp.Compiler.Syntax.SynExpr -> arrowRange: FSharp.Compiler.Text.Range option -> (Context.Context -> Context.Context)"""

[<Fact>]
let ``Empty namespace`` () =
 FSharp
 """
namespace System

open System.Runtime.CompilerServices

[<assembly: InternalsVisibleTo("Fantomas.Core.Tests")>]

do ()
"""
 |> printSignatures
 |> should equal "namespace System"

[<Fact>]
let ``Empty module`` () =
 FSharp
 """
module Foobar

do ()
"""
 |> printSignatures
 |> should equal "module Foobar"

[<Fact>]
let ``Two empty namespaces`` () =
 FSharp
 """
namespace Foo

do ()

namespace Bar

do ()
"""
 |> printSignatures
 |> prependNewline
 |> should equal """
namespace Foo
namespace Bar"""

[<Fact>]
let ``Empty namespace module`` () =
 FSharp
 """
namespace rec Foobar

do ()
"""
 |> printSignatures
 |> should equal "namespace Foobar"

4 changes: 3 additions & 1 deletion
tests/fsharp/core/load-script/out.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,9 @@ World
-the end
Test 3=================================================

> [Loading D:\staging\staging\src\tests\fsharp\core\load-script\1.fsx
> module FSI_0001

[Loading D:\staging\staging\src\tests\fsharp\core\load-script\1.fsx
 Loading D:\staging\staging\src\tests\fsharp\core\load-script\2.fsx
 Loading D:\staging\staging\src\tests\fsharp\core\load-script\3.fsx]
Hello
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.1000.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string = "A"
Expand DownExpand Up@@ -234,7 +236,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.200.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string = "A"
Expand DownExpand Up@@ -129,7 +131,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.47.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.multiemit.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.off.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string
Expand DownExpand Up@@ -94,7 +96,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Print empty namespace or module.#13813

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

vzarytovskii
merged 5 commits into

from

Sep 2, 2022
 Merged


Print empty namespace or module.
#13813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d969f65

Print empty namespace or module.


nojaf Aug 30, 2022
88886d4

Update failing unit tests.


nojaf Aug 31, 2022
842b381

Collect all empty namespaces.


nojaf Sep 1, 2022
54971c5

Add test for empty recursive namespace.


nojaf Sep 1, 2022
75856a7

Move XML doc comment to signature file.


nojaf Sep 2, 2022

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


18 changes: 17 additions & 1 deletion
src/Compiler/Checking/NicePrint.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2420,7 +2420,23 @@ module InferredSigPrinting =
 modNameEqualsL @@* basic
 layoutXmlDoc denv true mspec.XmlDoc basicL

 imdefL denv expr
 let emptyModuleOrNamespace mspec =
 let innerPath = (fullCompPathOfModuleOrNamespace mspec).AccessPath
 let pathL = innerPath |> List.map (fst >> ConvertLogicalNameToDisplayLayout (tagNamespace >> wordL))

 let keyword =
 if not mspec.IsImplicitNamespace && mspec.IsNamespace then
 "namespace"
 else
 "module"

 wordL (tagKeyword keyword) ^^ sepListL SepL.dot pathL

 match expr with
 | EmptyModuleOrNamespaces mspecs ->
 List.map emptyModuleOrNamespace mspecs
 |> aboveListL
 | expr -> imdefL denv expr

//--------------------------------------------------------------------------

Expand Down

32 changes: 32 additions & 0 deletions
src/Compiler/TypedTree/TypedTreeOps.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10360,3 +10360,35 @@ let isFSharpExceptionTy g ty =
 | ValueSome tcref -> tcref.IsFSharpException
 | _ -> false

let (|EmptyModuleOrNamespaces|_|) (moduleOrNamespaceContents: ModuleOrNamespaceContents) =
 match moduleOrNamespaceContents with
 | TMDefs(defs = defs) ->
 let mdDefsLength =
 defs
 |> List.count (function
 | ModuleOrNamespaceContents.TMDefRec _
 | ModuleOrNamespaceContents.TMDefs _ -> true
 | _ -> false)

 let emptyModuleOrNamespaces =
 defs
 |> List.choose (function
 | ModuleOrNamespaceContents.TMDefRec _ as defRec
 | ModuleOrNamespaceContents.TMDefs(defs = [ ModuleOrNamespaceContents.TMDefRec _ as defRec ]) ->
 match defRec with
 | TMDefRec(bindings = [ ModuleOrNamespaceBinding.Module(mspec, ModuleOrNamespaceContents.TMDefs(defs = defs)) ]) ->
 defs
 |> List.forall (function
 | ModuleOrNamespaceContents.TMDefOpens _
 | ModuleOrNamespaceContents.TMDefDo _
 | ModuleOrNamespaceContents.TMDefRec (isRec = true; tycons = []; bindings = []) -> true
 | _ -> false)
 |> fun isEmpty -> if isEmpty then Some mspec else None
 | _ -> None
 | _ -> None)

 if mdDefsLength = emptyModuleOrNamespaces.Length then
@01010101Sep 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

There seems to be another edge case which could theoretically happen:
namespaceFoodo()namespaceBarmoduleBaz =do()
In this case it won't be matched and namespace Foo won't be in the signatures.
@nojafnojafSep 1, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I can live with that, the goal is to avoid purely empty file generation.

This will give a result because of the nested module and that is good enough for my use case.
 Some emptyModuleOrNamespaces
 else
 None
 | _ -> None
@01010101Sep 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Should we also check for TMDefRec here? Consider these (and maybe add to tests):
modulerecFoobardo()
namespacerecFoobardo()
@nojafnojafSep 1, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

modulerecFoobardo()
currently produces
moduleFoobarval``doval@3`` :unit
This probably isn't correct but is outside my scope here.

6 changes: 6 additions & 0 deletions
src/Compiler/TypedTree/TypedTreeOps.fsi

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2676,3 +2676,9 @@ type TraitConstraintInfo with

 /// Get the key associated with the member constraint.
 member GetWitnessInfo: unit -> TraitWitnessInfo

/// Matches a ModuleOrNamespaceContents that is empty from a signature printing point of view.
/// Signatures printed via the typed tree in NicePrint don't print TMDefOpens or TMDefDo.
/// This will match anything that does not have any types or bindings.
val (|EmptyModuleOrNamespaces|_|):
Comment thread
0101 marked this conversation as resolved.


Outdated

 moduleOrNamespaceContents: ModuleOrNamespaceContents -> (ModuleOrNamespace list) option

55 changes: 55 additions & 0 deletions
tests/FSharp.Compiler.ComponentTests/Signatures/ModuleOrNamespaceTests.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,3 +142,58 @@ namespace Fantomas.Core
 val genExpr: e: FSharp.Compiler.Syntax.SynExpr -> ctx: Context.Context -> Context.Context

 val genLambdaArrowWithTrivia: bodyExpr: (FSharp.Compiler.Syntax.SynExpr -> Context.Context -> Context.Context) -> body: FSharp.Compiler.Syntax.SynExpr -> arrowRange: FSharp.Compiler.Text.Range option -> (Context.Context -> Context.Context)"""

[<Fact>]
let ``Empty namespace`` () =
 FSharp
 """
namespace System

open System.Runtime.CompilerServices

[<assembly: InternalsVisibleTo("Fantomas.Core.Tests")>]

do ()
"""
 |> printSignatures
 |> should equal "namespace System"

[<Fact>]
let ``Empty module`` () =
 FSharp
 """
module Foobar

do ()
"""
 |> printSignatures
 |> should equal "module Foobar"

[<Fact>]
let ``Two empty namespaces`` () =
 FSharp
 """
namespace Foo

do ()

namespace Bar

do ()
"""
 |> printSignatures
 |> prependNewline
 |> should equal """
namespace Foo
namespace Bar"""

[<Fact>]
let ``Empty namespace module`` () =
 FSharp
 """
namespace rec Foobar

do ()
"""
 |> printSignatures
 |> should equal "namespace Foobar"

4 changes: 3 additions & 1 deletion
tests/fsharp/core/load-script/out.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,9 @@ World
-the end
Test 3=================================================

> [Loading D:\staging\staging\src\tests\fsharp\core\load-script\1.fsx
> module FSI_0001

[Loading D:\staging\staging\src\tests\fsharp\core\load-script\1.fsx
 Loading D:\staging\staging\src\tests\fsharp\core\load-script\2.fsx
 Loading D:\staging\staging\src\tests\fsharp\core\load-script\3.fsx]
Hello
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.1000.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string = "A"
Expand DownExpand Up@@ -234,7 +236,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.200.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string = "A"
Expand DownExpand Up@@ -129,7 +131,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.47.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.multiemit.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.off.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string
Expand DownExpand Up@@ -94,7 +96,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Print empty namespace or module.#13813

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

vzarytovskii
merged 5 commits into

from

Sep 2, 2022
 Merged


Print empty namespace or module.
#13813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d969f65

Print empty namespace or module.


nojaf Aug 30, 2022
88886d4

Update failing unit tests.


nojaf Aug 31, 2022
842b381

Collect all empty namespaces.


nojaf Sep 1, 2022
54971c5

Add test for empty recursive namespace.


nojaf Sep 1, 2022
75856a7

Move XML doc comment to signature file.


nojaf Sep 2, 2022

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


18 changes: 17 additions & 1 deletion
src/Compiler/Checking/NicePrint.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2420,7 +2420,23 @@ module InferredSigPrinting =
 modNameEqualsL @@* basic
 layoutXmlDoc denv true mspec.XmlDoc basicL

 imdefL denv expr
 let emptyModuleOrNamespace mspec =
 let innerPath = (fullCompPathOfModuleOrNamespace mspec).AccessPath
 let pathL = innerPath |> List.map (fst >> ConvertLogicalNameToDisplayLayout (tagNamespace >> wordL))

 let keyword =
 if not mspec.IsImplicitNamespace && mspec.IsNamespace then
 "namespace"
 else
 "module"

 wordL (tagKeyword keyword) ^^ sepListL SepL.dot pathL

 match expr with
 | EmptyModuleOrNamespaces mspecs ->
 List.map emptyModuleOrNamespace mspecs
 |> aboveListL
 | expr -> imdefL denv expr

//--------------------------------------------------------------------------

Expand Down

32 changes: 32 additions & 0 deletions
src/Compiler/TypedTree/TypedTreeOps.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10360,3 +10360,35 @@ let isFSharpExceptionTy g ty =
 | ValueSome tcref -> tcref.IsFSharpException
 | _ -> false

let (|EmptyModuleOrNamespaces|_|) (moduleOrNamespaceContents: ModuleOrNamespaceContents) =
 match moduleOrNamespaceContents with
 | TMDefs(defs = defs) ->
 let mdDefsLength =
 defs
 |> List.count (function
 | ModuleOrNamespaceContents.TMDefRec _
 | ModuleOrNamespaceContents.TMDefs _ -> true
 | _ -> false)

 let emptyModuleOrNamespaces =
 defs
 |> List.choose (function
 | ModuleOrNamespaceContents.TMDefRec _ as defRec
 | ModuleOrNamespaceContents.TMDefs(defs = [ ModuleOrNamespaceContents.TMDefRec _ as defRec ]) ->
 match defRec with
 | TMDefRec(bindings = [ ModuleOrNamespaceBinding.Module(mspec, ModuleOrNamespaceContents.TMDefs(defs = defs)) ]) ->
 defs
 |> List.forall (function
 | ModuleOrNamespaceContents.TMDefOpens _
 | ModuleOrNamespaceContents.TMDefDo _
 | ModuleOrNamespaceContents.TMDefRec (isRec = true; tycons = []; bindings = []) -> true
 | _ -> false)
 |> fun isEmpty -> if isEmpty then Some mspec else None
 | _ -> None
 | _ -> None)

 if mdDefsLength = emptyModuleOrNamespaces.Length then
@01010101Sep 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

There seems to be another edge case which could theoretically happen:
namespaceFoodo()namespaceBarmoduleBaz =do()
In this case it won't be matched and namespace Foo won't be in the signatures.
@nojafnojafSep 1, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I can live with that, the goal is to avoid purely empty file generation.

This will give a result because of the nested module and that is good enough for my use case.
 Some emptyModuleOrNamespaces
 else
 None
 | _ -> None
@01010101Sep 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Should we also check for TMDefRec here? Consider these (and maybe add to tests):
modulerecFoobardo()
namespacerecFoobardo()
@nojafnojafSep 1, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

modulerecFoobardo()
currently produces
moduleFoobarval``doval@3`` :unit
This probably isn't correct but is outside my scope here.

6 changes: 6 additions & 0 deletions
src/Compiler/TypedTree/TypedTreeOps.fsi

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2676,3 +2676,9 @@ type TraitConstraintInfo with

 /// Get the key associated with the member constraint.
 member GetWitnessInfo: unit -> TraitWitnessInfo

/// Matches a ModuleOrNamespaceContents that is empty from a signature printing point of view.
/// Signatures printed via the typed tree in NicePrint don't print TMDefOpens or TMDefDo.
/// This will match anything that does not have any types or bindings.
val (|EmptyModuleOrNamespaces|_|):
Comment thread
0101 marked this conversation as resolved.


Outdated

 moduleOrNamespaceContents: ModuleOrNamespaceContents -> (ModuleOrNamespace list) option

55 changes: 55 additions & 0 deletions
tests/FSharp.Compiler.ComponentTests/Signatures/ModuleOrNamespaceTests.fs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,3 +142,58 @@ namespace Fantomas.Core
 val genExpr: e: FSharp.Compiler.Syntax.SynExpr -> ctx: Context.Context -> Context.Context

 val genLambdaArrowWithTrivia: bodyExpr: (FSharp.Compiler.Syntax.SynExpr -> Context.Context -> Context.Context) -> body: FSharp.Compiler.Syntax.SynExpr -> arrowRange: FSharp.Compiler.Text.Range option -> (Context.Context -> Context.Context)"""

[<Fact>]
let ``Empty namespace`` () =
 FSharp
 """
namespace System

open System.Runtime.CompilerServices

[<assembly: InternalsVisibleTo("Fantomas.Core.Tests")>]

do ()
"""
 |> printSignatures
 |> should equal "namespace System"

[<Fact>]
let ``Empty module`` () =
 FSharp
 """
module Foobar

do ()
"""
 |> printSignatures
 |> should equal "module Foobar"

[<Fact>]
let ``Two empty namespaces`` () =
 FSharp
 """
namespace Foo

do ()

namespace Bar

do ()
"""
 |> printSignatures
 |> prependNewline
 |> should equal """
namespace Foo
namespace Bar"""

[<Fact>]
let ``Empty namespace module`` () =
 FSharp
 """
namespace rec Foobar

do ()
"""
 |> printSignatures
 |> should equal "namespace Foobar"

4 changes: 3 additions & 1 deletion
tests/fsharp/core/load-script/out.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,9 @@ World
-the end
Test 3=================================================

> [Loading D:\staging\staging\src\tests\fsharp\core\load-script\1.fsx
> module FSI_0001

[Loading D:\staging\staging\src\tests\fsharp\core\load-script\1.fsx
 Loading D:\staging\staging\src\tests\fsharp\core\load-script\2.fsx
 Loading D:\staging\staging\src\tests\fsharp\core\load-script\3.fsx]
Hello
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.1000.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string = "A"
Expand DownExpand Up@@ -234,7 +236,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.200.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string = "A"
Expand DownExpand Up@@ -129,7 +131,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.47.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.multiemit.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

6 changes: 5 additions & 1 deletion
tests/fsharp/core/printing/output.off.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@

module FSI_0001

> val it: unit = ()

> val repeatId: string
Expand DownExpand Up@@ -94,7 +96,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0020

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down

8 changes: 6 additions & 2 deletions
tests/fsharp/core/printing/output.stdout.bsl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@

> val repeatId: string = "A"
> module FSI_0001

val repeatId: string = "A"

> val repeatId: string = "B"

Expand DownExpand Up@@ -249,7 +251,9 @@ module D1 =
 val words: System.Collections.Generic.IDictionary<string,int>
 val words2000: System.Collections.Generic.IDictionary<int,string>

> > module D2 =
> module FSI_0019

> module D2 =
 val words: IDictionary<string,int>
 val words2000: IDictionary<int,string>
val opt1: 'a option
Expand Down