_SUMMARY.md

Summary

• Introduction
• The ReSharper Platform
• About This Guide
• Key Topics
• Getting Help
• Recently Updated

How To

• How To
  • Start
    • 1. Create a Project
    • 2. Create a NuGet Package for the Plugin
    • 3. Set Up the Environment
  • Integrate with ReSharper
  • Obtain Components in Runtime
  • Work with Lifetime
  • Work with Signals
  • Work with IProperty
  • Work with Shell Locks
  • Work with Threading
  • Work with Zoning
  • Navigate Code
    • Get a Tree Node under Caret
    • Get a Tree Node by Full CLR Name
    • Get a Tree Node by Reference
    • Find Code Elements Using AsyncFinder
    • Use Manual Navigation
    • Navigate to a Particular Tree Node
    • Add a Navigation Action to the 'Navigate To' Menu
  • Create, Replace, and Update the Code
    • Select a Block of Code
    • Delete a Block of Code
    • Add Code in the Editor
    • Replace Code in the Editor
    • Add a Code-Generation Action to the Generate Menu
  • Create Menu Items Using Actions
  • Run Actions from Code
  • Create a Context Action
  • Create a Quick Fix
  • Analyze Code on the Fly
  • Track Solution Loading Status
  • Create Tool Windows
  • Add Settings to ReSharper Options
  • Work with Color Themes
  • Cover a Plugin with Tests

Part I - Extending the ReSharper Platform

• Getting Started
  • Tools
  • Internal mode
  • Platform Versioning
• What's New?
• Declarative Extensions
  • Live Templates
  • Structural Search and Replace Patterns
  • External Annotations
    • Attribute Reference
    • Annotator Tool
• Compiled Extensions (Plugins)
  • Project Setup
    • Creating Projects
    • NuGet References
    • Initial Installation
    • Copy Plugin on Build
  • Debugging
  • Plugin Testing
    • Project Structure
    • Test Environment
    • Zones
    • Test Components
    • Gold Files
    • Base Classes
    • Attributes
    • Project References
    • Temporary Settings
    • Combinatorial Settings
    • Utility Classes
    • Reference
  • Known Issues
• Deployment
  • Installing the ReSharper Platform
    • Host Identifiers
    • Dependencies
  • Packaging Details
  • Localisation
  • Installing Locally
    • Experimental Instances
    • Package the Extension
    • Install Local Copy
    • Copy Plugin on Build
  • Supporting ReSharper 8
• Troubleshooting
• Hints and Tips
• Best Practices

Part II - Architectural Overview

• Overview
• Platform
• Project Model
• PSI
• Features
• Products
  • Standalone
  • Deployment

Part III - Platform

• Logging
  • Advanced Configuration
  • Usage
  • Category Reference
• Lifetime
  • Usage
  • Lifetime Management
  • Advanced Lifetime Management
  • Component Lifetime
  • Case Study
• DataFlow
  • IViewable
  • IProperty
  • ISignal
• Component Model
  • Containers, Parts and Catalogues
  • Visual Studio interfaces
• Zones
  • Implementation
  • Usage
  • Features and Products
  • Activation
  • Licensing
  • Troubleshooting
  • How to Define a Zone Marker
  • Reference
• DataContext
• TextControl
• Documents
• Threading
• Locks
• Transactions
• IL Metadata
• Shell
  • Visual Studio integration
    • Experimental Instances
  • Command line
  • Tool windows
  • Icons
    • Consuming Icons
    • Creating Compiled Icons
    • Icon Types
    • Custom Icon Types
  • Tooltips
  • TreeView
  • Progress reporting
  • Popup menus
  • Extensions
  • Theming
    • Themed Icons
• Settings
  • Reading and writing
  • Defaults
  • Layers
  • File format
  • Util

Part IV - Project Model

• Overview
• Change Manager
• MSBuild Integration
• Project Files

Part V - PSI

• Overview
• PSI Languages
  • Per-language Components
• Files and Modules
• Syntax Trees
• Navigating Syntax Trees
  • Manual Navigation
  • Helper methods
  • Strongly Typed Navigation
  • Recursive navigation
  • Finding nodes
• Manipulating syntax trees
  • Transactions
• Generating code
  • Generating comments
• Declared Elements
  • Declared Element Types
  • Declared Element Envoys
• References
  • Resolving references
  • Reference providers
  • Code Completion
  • References within elements
  • Managing reference providers
  • Path references
  • Colour references
• Type Systems
  • Overview
• Symbols and Symbol Tables
• Constant Evaluation
• Control Flow Graphs
• Caching
  • Persistent Caches
    • Symbol Cache
    • Word Index
  • Persistent Indexes
  • Transient Caches
• Searching
• Pointers
• External Annotations
  • Testing
• PSI Icons
• PSI Implementations Reference
  • C#
  • Visual Basic
  • JavaScript
  • TypeScript
  • JSON
  • HTML
  • CSS
  • Razor
  • ASP.net
  • XML and DTD
    • Manipulating the Tree
    • Navigators
    • Element Factories
    • Utils
    • Tree Nodes
    • Tree Nodes (DTD)
  • Build scripts
  • XAML
  • XML Doc

Part VI - Features

• Analysis
  • Highlights
  • Custom Highlights
  • Daemons
  • Suppressing Highlights
  • Element problem analysers
  • Xml and Html analysers
  • Solution Wide Analysis
  • Error Stripe
  • Gutter Marks
  • Syntax Highlighting
  • Caches again
  • Value Analysis
  • Call Hierarchy
  • Testing
• Actions
  • Menu items
  • Quick fixes
  • Context actions
  • Bulk actions
  • Overriding
  • Temporary editor actions
  • Action ID reference
• Code Completion
  • Basic, smart and import
  • Dynamic completion
  • Double completion
  • Lookup items
• Contextual highlighting
  • Brace matching
  • string.Format style highlighting
  • Find usages in file style highlighting
• Popup docs
  • Quick Doc
    • IQuickDocProvider
    • IQuickDocPresenter
    • Helper classes
    • Existing providers
    • Testing
  • Parameter Info
• Refactoring
  • Workflow
  • Integrating
  • Renaming
  • Unused references
• Generate Menu
• Navigation
  • Go to everything
  • Go to related
  • Go to next/prev
  • Contextual - find exits
  • Navigate from here
  • Occurrences
• Options Pages
  • Search in Options Pages
• Tools
  • Code cleanup
  • Code structure
  • Todo items
  • Bookmarks
  • Assembly explorer
• Naming
  • Suggestions
  • Policy
• Editing
  • Formatting
  • Typing assist
  • Complete statement
  • Extend selection
  • Rearrange code
  • Comments
• Structural Search and Replace
  • C# vs HTML and CSS
  • Programmatic usage
• Live Templates
  • Macros
  • Scopes
  • Categories
  • Quick lists
  • Hotspots
  • Programmatic usage
• Unit Test
  • Test discovery
  • Test execution
  • .NET Core tests
  • Non-CLR tests
• Diagramming
  • Architecture diagrams
• External sources
  • PDB symbols
  • Decompiling
  • Source servers
• Asp.net MVC
• Internationalisation
• Working with XML-like files

Part VII - Products

• Rider
• dotPeek
• InspectCode
• Custom products

Part VIII - Custom languages

• Overview
• Registering a Custom Language
  • Project File Type
  • PSI Language Definition
  • Per-language Components
  • Project File Language Service
  • PSI Language Service
  • Testing
• Secondary PSI
• Injected PSI
• Building the PSI tree
  • Node Types
    • Token Node Types
    • Composite Node Types
    • Creating Node Types
  • Lexing
    • The Tao of Writing a Lexer
    • Lexer Factories
    • Text Buffers
    • Implementing a Lexer
    • Using CsLex
    • Lexer Utility Methods
    • Lexer Utility Classes
    • Filtering Lexers
    • Caching Lexers
    • Testing
  • Parsing
    • PsiGen and .psi Files
    • TreeBuilder
    • Testing
  • Extending Existing Languages
  • Incremental Parsing
• Creating Declared Elements
• Language Specific Features
  • Disabling Intellisense
• HTML-Like Languages
  • Registering HTML-Like Languages
  • HTML Token Node Types
  • Lexing HTML-Like Languages
  • Parsing HTML-Like Languages
  • Extending standard HTML