FarNet.template 6.1.0

FarNet.template

FarNet module and script template for C# and F# projects

With .NET SDK installed with Visual Studio or manually, the easiest way to create module and script projects for FarNet is using FarNet.template NuGet.

Projects created from the template can be used for development and debugging in Visual Studio and VSCode.

To install the FarNet template from NuGet, run:

dotnet new install FarNet.template

Take a look at all templates:

dotnet new list

The list should contain "FarNet module" and "FarNet script":

Template Name  Short Name     Language  Tags
-------------  -------------  --------  -------------
FarNet module  farnet-module  [C#],F#   FarNet/Module
FarNet script  farnet-script  [C#],F#   FarNet/Script

To create a C# (default) or F# module or script project, create a new folder with the new module or script name, change to it, and invoke one of these:

dotnet new farnet-module
dotnet new farnet-script
dotnet new farnet-module --language F#
dotnet new farnet-script --language F#

To uninstall the template, run:

dotnet new uninstall FarNet.template

Created FarNet project

Before opening created projects in Visual Studio or VSCode ensure you have the environment variable FARHOME set to the Far Manager home. If it is missing then the development location C:\Bin\Far\x64 is used, see the project file and change if needed.

If you build or start Visual Studio or VSCode from Far Manager then FARHOME exists and set to this Far Manager home directory.

Visual Studio

The project is ready to use in Visual Studio.

VSCode

Requirements:

• VSCode C# Dev Kit for C# projects and for debugging F# projects.
• VSCode F# extension for F# projects.

Project details

All projects include:

• .vscode
  • launch.json - VSCode debug settings
  • tasks.json - VSCode build task
• Properties
  • launchSettings.json - Visual Studio debug settings
• README.md - documentation file
• {name}.csproj/fsproj - project file

Module projects include:

• Host.cs/fs - optional module host and its instance
• Tool1.cs/fs - plugin menu item "Hello from {name}"
• Command1.cs/fs - command invoked using "{name}:" prefix

Script projects include:

• Program.cs/fs - method invoked by fn: script={name}; method=.Program.Run

All projects reference FarNet.dll.

F# projects reference FSharp.Core.dll and optional FarNet.FSharp.dll. They are installed together with the module FarNet.FSharpFar (recommended if you develop in F# for Far Manager).

Building

This command is used to build projects:

dotnet build

Alternatively, you may build from Visual Studio or VSCode.

When you build a project the output goes to the standard FarNet module or script folder. Ensure Far Manager is not running to avoid locked files.

With script projects and simple methods you may use unload=true to unload the scripts after the calls. In this case you do not have to restart Far Manager.

Debugging

Press F5 to starts debugging in Visual Studio or VSCode. Debug modes:

• Start Far (Visual Studio, VSCode default mode)
  • The build step is called at first and then debugging starts. Far.exe should be in the path or you should adjust settings.
• Attach single Far (select in VSCode)
  • Attach to the already running single Far.exe.
• Attach selected Far (select in VSCode)
  • Choose one of the several running Far.exe.