Skip to content

Commit 67d0c5a

Browse files
author
Greg Van Liew
committed
Update per Acquent requests.
1 parent d1576ba commit 67d0c5a

File tree

6 files changed

+22
-18
lines changed

6 files changed

+22
-18
lines changed

docs/extensibility/open-folder.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Visual Studio Open Folder Extensibility Overview | Microsoft Docs"
2+
title: "Visual Studio Open Folder extensibility overview | Microsoft Docs"
33
ms.custom: ""
44
ms.date: "02/21/2018"
55
ms.reviewer: ""
@@ -15,7 +15,7 @@ manager: "viveis"
1515
ms.workload:
1616
- "vssdk"
1717
---
18-
# Open Folder Extensibility
18+
# Open Folder extensibility
1919

2020
The [Open Folder](../ide/develop-code-in-visual-studio-without-projects-or-solutions.md) feature allows users to open any codebase in Visual Studio without the need for project or solution files. Open Folder provides the features users expect from Visual Studio such as:
2121

@@ -53,6 +53,6 @@ Features that use the following types will need to adopt new APIs to support Ope
5353

5454
Open Folder and the `Microsoft.VisualStudio.Workspace.*` APIs are under active development. If you see unexpected behavior, then see the known issues for the release of interest. The Developer Community is the recommended place to vote and create any issues. For each feedback, we highly recommend a detailed description of your issue. Include the Visual Studio version you're developing for, the APIs you're using (both what you've implemented and what you're interacting with), the expected outcome, and the actual outcome. If possible, include a dump of the devenv.exe process. Use GitHub's issue tracking for giving feedback on this and related documentation.
5555

56-
## Next Steps
56+
## Next steps
5757

5858
* [Workspaces](workspaces.md) - Learn about the Open Folder workspace API.

docs/extensibility/workspace-build.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Workspace Build in Visual Studio | Microsoft Docs"
2+
title: "Workspace build in Visual Studio | Microsoft Docs"
33
ms.custom: ""
44
ms.date: "02/21/2018"
55
ms.reviewer: ""
@@ -15,11 +15,11 @@ manager: "viveis"
1515
ms.workload:
1616
- "vssdk"
1717
---
18-
# Workspace Build
18+
# Workspace build
1919

2020
Build support in [Open Folder](../ide/develop-code-in-visual-studio-without-projects-or-solutions.md) scenarios requires an extender to supply [indexed](workspace-indexing.md) and [file context](workspace-file-contexts.md) data for the [workspace](workspaces.md), as well as the build action to run.
2121

22-
Below is an outline of what your extension will need:
22+
Below is an outline of what your extension will need.
2323

2424
## Build file context
2525

@@ -103,4 +103,8 @@ Alternatively, extensions can directly interact with the **Error List** or **Bui
103103

104104
## tasks.vs.json and launch.vs.json
105105

106-
For information on authoring a tasks.vs.json or launch.vs.json file, see [Customize build and debug tasks](../ide/customize-build-and-debug-tasks-in-visual-studio.md).
106+
For information on authoring a tasks.vs.json or launch.vs.json file, see [Customize build and debug tasks](../ide/customize-build-and-debug-tasks-in-visual-studio.md).
107+
108+
## Next steps
109+
110+
* [Language Server Protocol](language-server-protocol.md) - Learn how to integrate language servers into Visual Studio.

docs/extensibility/workspace-file-contexts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Workspace File Contexts in Visual Studio | Microsoft Docs"
2+
title: "Workspace file contexts in Visual Studio | Microsoft Docs"
33
ms.custom: ""
44
ms.date: "02/21/2018"
55
ms.reviewer: ""
@@ -15,7 +15,7 @@ manager: "viveis"
1515
ms.workload:
1616
- "vssdk"
1717
---
18-
# Workspace File Contexts
18+
# Workspace file contexts
1919

2020
All insights into [Open Folder](../ide/develop-code-in-visual-studio-without-projects-or-solutions.md) workspaces are produced by "file context providers" that implement the <xref:Microsoft.VisualStudio.Workspace.IFileContextProvider> interface. These extensions might look for patterns in folders or files, read MSBuild files and makefiles, detect package dependencies, etc. in order to accumulate the insights they need to define a file context. A file context by itself does not perform any action, but rather provides data that another extension can then act on.
2121

@@ -72,7 +72,7 @@ A workspace listens to file change notifications and provides the <xref:Microsof
7272
>[!TIP]
7373
>A workspace's [indexing service](workspace-indexing.md) subscribes to file events by default. File additions and modifications will cause relevant `IFileScanner`s events to be invoked for new data for that file. File deletions will remove indexed data. You don't need to subscribe your `IFileScanner` to the file watcher service.
7474
75-
## Next Steps
75+
## Next steps
7676

7777
* [Indexing](workspace-indexing.md) - Workspace indexing collects and persists information about the workspace.
7878
* [Workspaces](workspaces.md) - Review workspace concepts and settings storage.

docs/extensibility/workspace-indexing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Workspace Indexing in Visual Studio | Microsoft Docs"
2+
title: "Workspace indexing in Visual Studio | Microsoft Docs"
33
ms.custom: ""
44
ms.date: "02/21/2018"
55
ms.reviewer: ""
@@ -15,7 +15,7 @@ manager: "viveis"
1515
ms.workload:
1616
- "vssdk"
1717
---
18-
# Workspace Indexing
18+
# Workspace indexing
1919

2020
In a solution, project systems are responsible for providing functionality for build, debug, **GoTo** symbol searching, and more. Project systems can do this work because they understand the relation and capabilities of files within a project. An [Open Folder](../ide/develop-code-in-visual-studio-without-projects-or-solutions.md) workspace needs the same insight to provide rich IDE features as well. The collection and persistent storage of this data is a process called workspace indexing. This indexed data can be queried through a set of asynchronous APIs. Extenders can participate in the indexing process by providing <xref:Microsoft.VisualStudio.Workspace.Indexing.IFileScanner>s that know how to handle certain types of files.
2121

@@ -67,7 +67,7 @@ Extensions can export a scanner by implementing `IWorkspaceProviderFactory<IFile
6767
6868
In advanced situations, an extension might dynamically support an arbitrary set of file types. Rather than MEF exporting `IWorkspaceProviderFactory<IFileScanner>`, an extension can export `IWorkspaceProviderFactory<IFileScannerProvider>`. When indexing begins, this factory type will be imported, instantiated, and have its <xref:Microsoft.VisualStudio.Workspace.Indexing.IFileScannerProvider.GetSymbolScannersAsync%2A> method invoked. `IFileScanner` instances supporting any value from `FileScannerTpeConstants` will be honored, not just symbols.
6969

70-
## Next Steps
70+
## Next steps
7171

7272
* [Workspaces and language services](workspace-language-services.md) - Learn how to integrate language services into an Open Folder workspace.
7373
* [Workspace build](workspace-build.md) - Open Folder supports build systems such as MSBuild and makefiles.

docs/extensibility/workspace-language-services.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Workspaces Language Services in Visual Studio | Microsoft Docs"
2+
title: "Workspaces and language services in Visual Studio | Microsoft Docs"
33
ms.custom: ""
44
ms.date: "02/21/2018"
55
ms.reviewer: ""
@@ -25,7 +25,7 @@ In a [workspace](workspaces.md), language services are initialized by an <xref:M
2525

2626
When a document is opened in the editor, Visual Studio only considers language service providers that require file context types for which a matching file context provider can be found. It then passes the file context(s) from the matching provider(s) to the selected language service provider via `ILangaugeServiceProvider.InitializeAsync`. What the language service provider does with that file context data is an implementation detail of the language service provider, but the expected user experience is a richer language service for that opened document.
2727

28-
## Using `ILanguageServiceProvider`
28+
## Using ILanguageServiceProvider
2929

3030
The language service will be notified when a file context is created with a `ContextType` that matches one of the `SupportedContextTypes` values of the language server export attribute.
3131

@@ -59,6 +59,6 @@ The `Microsoft.VisualStudio.Workspace.*` APIs aren't the only way to enable your
5959

6060
- <xref:Microsoft.VisualStudio.Workspace.Intellisense.ILanguageServiceProvider> is invoked when a file of matching file types is opened or closed for editing.
6161

62-
## Next Steps
62+
## Next steps
6363

6464
* [Workspace build](workspace-build.md) - Open Folder supports build systems such as MSBuild and makefiles.

docs/extensibility/workspaces.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,11 +174,11 @@ A UI context can be used to auto-load your package. The value is `4646B819-1AE0-
174174

175175
## Troubleshooting
176176

177-
### The 'SourceExplorerPackage' package did not load correctly
177+
### The SourceExplorerPackage package did not load correctly
178178

179179
Workspace extensibility is heavily MEF-based, and composition errors will cause the package hosting Open Folder to fail to load. For example, if an extension exports a type with `ExportFileContextProviderAttribute`, but the type only implements `IWorkspaceProviderFactory<IFileContextActionProvider>`, an error will occur when trying to open a folder in Visual Studio. Error details can be found in _%LOCALAPPDATA%\Microsoft\VisualStudio\15.0_id\ComponentModelCache\Microsoft.VisualStudio.Default.err_. Resolve any errors for types implemented by your extension.
180180

181-
## Next Steps
181+
## Next steps
182182

183183
* [File contexts](workspace-file-contexts.md) - File context providers bring code intelligence for Open Folder workspaces.
184184
* [Indexing](workspace-indexing.md) - Workspace indexing collects and persists information about the workspace.

0 commit comments

Comments
 (0)