Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide pester functions (it, context, describe) in document symbols #490

Merged
merged 16 commits into from
Jun 5, 2017
Merged

Provide pester functions (it, context, describe) in document symbols #490

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
97ffcf0
Provide symbols in a pester file
Jun 3, 2017
93bf996
Use document provider interface to provide symbols
Jun 3, 2017
32f2804
Add provider for *.psd1 files
Jun 3, 2017
6273be1
Update IsPowerShellDataFileAst method
Jun 3, 2017
74cbd87
Update IDocumentSymbolProvider interface
Jun 3, 2017
f1cc069
Add document symbol provider for pester files
Jun 3, 2017
31821b3
Update document symbol providers' class names
Jun 3, 2017
8116e81
Update pester document provider implementation
Jun 3, 2017
81395d4
Fix psd1 document symbol provider
Jun 3, 2017
e5f3fbd
Add new lines at the end of new files
Jun 3, 2017
9ed6af3
Convert DocumentSymbolProvider interface to abstract class
Jun 5, 2017
df7a645
Implicitly iterate over document symbol providers
Jun 5, 2017
0611d4a
Remove redundant case from switch statement
Jun 5, 2017
ce741d1
Add tests for psd1 and pester document symbols
Jun 5, 2017
86753fe
Add xml documentation to a public method
Jun 5, 2017
c627165
Add relevant test files
Jun 5, 2017
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
Prev Previous commit
Next Next commit
Use document provider interface to provide symbols
  • Loading branch information
Kapil Borle committed Jun 3, 2017
commit 93bf9964f53d70fc270a7c4388520c135512d59f
23 changes: 23 additions & 0 deletions src/PowerShellEditorServices/Language/GenericDocumentSymbolProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
using System;
using System.Collections.Generic;

namespace Microsoft.PowerShell.EditorServices
{
internal class GenericDocumentSymbolProvider : IDocumentSymbolProvider
{
bool IDocumentSymbolProvider.CanProvideFor(ScriptFile scriptFile)
{
return scriptFile != null &&
scriptFile.FilePath != null &&
(scriptFile.FilePath.EndsWith(".ps1", StringComparison.OrdinalIgnoreCase) ||
scriptFile.FilePath.EndsWith(".psm1", StringComparison.OrdinalIgnoreCase));
}

IEnumerable<SymbolReference> IDocumentSymbolProvider.GetSymbols(ScriptFile scriptFile, Version psVersion)
{
return AstOperations.FindSymbolsInDocument(
scriptFile.ScriptAst,
psVersion);
}
}
}
11 changes: 11 additions & 0 deletions src/PowerShellEditorServices/Language/IDocumentSymbolProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
using System;
using System.Collections.Generic;

namespace Microsoft.PowerShell.EditorServices
{
internal interface IDocumentSymbolProvider
{
IEnumerable<SymbolReference> GetSymbols(ScriptFile scriptFile, Version psVersion = null);
bool CanProvideFor(ScriptFile scriptFile);
}
}
58 changes: 42 additions & 16 deletions src/PowerShellEditorServices/Language/LanguageService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ public class LanguageService
private string mostRecentRequestFile;
private Dictionary<String, List<String>> CmdletToAliasDictionary;
private Dictionary<String, String> AliasToCmdletDictionary;
private IDocumentSymbolProvider[] documentSymbolProviders;

const int DefaultWaitTimeoutMilliseconds = 5000;

Expand All @@ -54,6 +55,12 @@ public LanguageService(PowerShellContext powerShellContext)

this.CmdletToAliasDictionary = new Dictionary<String, List<String>>(StringComparer.OrdinalIgnoreCase);
this.AliasToCmdletDictionary = new Dictionary<String, String>(StringComparer.OrdinalIgnoreCase);
this.documentSymbolProviders = new IDocumentSymbolProvider[]
{
new GenericDocumentSymbolProvider()
// new PSDataFileDocumentSymbolProvider(),
// new PesterFileDocumentSymboleProvider()
};
}

#endregion
Expand Down Expand Up @@ -227,30 +234,49 @@ public FindOccurrencesResult FindSymbolsInFile(ScriptFile scriptFile)
{
Validate.IsNotNull("scriptFile", scriptFile);

// todo create a document symbol provider interface
// todo create document symbol providers for generic symbols, psd1 file symbols, pester file symbols
IEnumerable<SymbolReference> symbolReferencesinFile =
AstOperations
.FindSymbolsInDocument(scriptFile.ScriptAst, this.powerShellContext.LocalPowerShellVersion.Version)
.Select(
var symbolReferences = Enumerable.Empty<SymbolReference>();
foreach (var provider in documentSymbolProviders)
{
symbolReferences = symbolReferences.Concat(provider.GetSymbols(scriptFile));
}

return new FindOccurrencesResult
{
FoundOccurrences = symbolReferences.Select(
reference =>
{
reference.SourceLine =
scriptFile.GetLine(reference.ScriptRegion.StartLineNumber);
reference.FilePath = scriptFile.FilePath;
return reference;
});
})
};

if (IsPesterFile(scriptFile))
{
symbolReferencesinFile = symbolReferencesinFile.Concat(GetPesterSymbols(scriptFile));
}
// todo create a document symbol provider interface
// todo create document symbol providers for generic symbols, psd1 file symbols, pester file symbols

return
new FindOccurrencesResult
{
FoundOccurrences = symbolReferencesinFile
};
// IEnumerable<SymbolReference> symbolReferencesinFile =
// AstOperations
// .FindSymbolsInDocument(scriptFile.ScriptAst, this.powerShellContext.LocalPowerShellVersion.Version)
// .Select(
// reference =>
// {
// reference.SourceLine =
// scriptFile.GetLine(reference.ScriptRegion.StartLineNumber);
// reference.FilePath = scriptFile.FilePath;
// return reference;
// });

// if (IsPesterFile(scriptFile))
// {
// symbolReferencesinFile = symbolReferencesinFile.Concat(GetPesterSymbols(scriptFile));
// }

// return
// new FindOccurrencesResult
// {
// FoundOccurrences = symbolReferencesinFile
// };
}

private IEnumerable<SymbolReference> GetPesterSymbols(ScriptFile scriptFile)
Expand Down