FreePascal Toolkit

FreePascal Toolkit is a VS Code extension for developing FreePascal programs.

For Chinese documentation, see 中文文档.

Requirements

• Install Lazarus or FreePascal.
• The extension will automatically search for the FPC path. If not found, please add FPC to your system PATH, or set fpctoolkit.env.PP in the extension settings.
• Install GDB Debugger - Beyond for debugging.

Features

Core Features

• Project Management - Build, rebuild, and clean FreePascal and Lazarus programs
• Project Templates - Create new projects from built-in or custom templates with variable substitution
• Lazarus LPI Support - Full project file support with multi-mode build management and lazbuild integration
• Advanced Build System - Customizable tasks with inheritance and cross-platform compilation
• Code Intelligence - Auto-completion, go-to-definition, and symbol references
• Code Snippets - Rich templates for rapid development
• Syntax Highlighting - Pascal syntax with conditional compilation support
• Code Formatting - Integrated jcf cli formatter
• Quick Fixes - Smart suggestions and auto-corrections
• Refactoring - Symbol renaming and code actions
• MCP Server - Model Context Protocol server for AI assistant integration

Detailed Feature Overview

Project & Build Management

• Project Templates: Template-based project creation system
  • Built-in templates for console applications and modular programs
  • Custom template support with variable substitution (date, time, username, project name)
  • Multi-file templates with pre-configured build tasks
  • Template initialization and management commands
• Lazarus LPI Project Support: Automatically detects and parses .lpi project files, extracts all build modes, and supports multi-mode build management with intelligent compiler selection (lazbuild preferred, fpc fallback)
• Advanced Task System:
  • Customize build tasks with inheritance
  • Support for custom build options (target platform/CPU, output directory, compiler flags, etc.)
  • Cross-platform and multi-architecture compilation (Linux/Windows/macOS, x86_64/i386, etc.)
  • Pre/post build event support for automation and integration
  • Seamless management of mixed FreePascal and Lazarus projects

Code Intelligence & Navigation

• Smart Auto-completion: Intelligent completion for functions, procedures, classes, variables, and keywords

  

• Navigation:

  • Use Ctrl+Up and Ctrl+Down to jump between declaration and implementation
  • Class and function references with document outline

  

Code Quality & Formatting

• Syntax Highlighting:

  • Advanced Pascal syntax highlighting
  • Identify compilation conditions such as {$IFDEF} {$ELSE} {$ENDIF}

• Code Formatting:

  

  • Format source code using integrated jcf cli
  • Uses jcfsettings.cfg as config, or Lazarus config if installed

Development Productivity

• Quick Fixes: Smart suggestions for common issues

  • Quick fix for (5025) Local variable "xxx" not used

  

• Refactoring Tools:

  • Auto rename symbols (functions, classes, variables, and their references)
  • Use Ctrl+Shift+C to auto-implement procedures
  • Remove unused units and clean up code

• Code Snippets: Rich templates including class, if-else, begin-end, and more

Project Templates

Create new Pascal projects quickly using built-in or custom templates:

Built-in Templates

• Simple Console App: Basic console application with greeting message
• Program with Unit: Demonstrates modular programming with separate unit files

Template Features

• Variable Substitution: Automatic replacement of {{DATE}}, {{TIME}}, {{USER}}, {{PROJECT_NAME}}
• Multi-file Support: Templates can include multiple source files, documentation, and configuration
• Pre-configured Tasks: Templates include debug and release build configurations
• Custom Templates: Create your own templates in the templates/ directory

Usage

1. Click the "+" button in FPC Projects view or use Ctrl+Shift+P → "FpcToolkit: Create New Project"
2. Select from available templates
3. Project files are created with variables automatically replaced
4. Build tasks are configured and ready to use

For detailed template creation and customization, see the Template Guide.

AI Integration

• MCP Server: Model Context Protocol server for AI assistants
  • Get compile commands for Pascal files
  • Project information extraction
  • Source file analysis
  • Enable with fpctoolkit.mcp.enabled setting

Pascal Language Server

Based on pascal-language-server

An LSP server implementation for Pascal variants supported by FreePascal, including Object Pascal. It uses CodeTools from Lazarus as the backend.

FreePascal Task Settings

You can add FreePascal or Lazarus compile tasks by editing tasks.json in your .vscode folder.

The task's type is fpc. The following configuration options are available:

Task Settings

Build Events

Build Options

Additional Options

Example

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "debug",
      "file": "main.lpr",
      "type": "fpc",
      "buildOption": {
        "unitOutputDir": "./out",
        "customOptions": [
          "-dDEBUG",
          "-gw2"
        ]
      }
    }
  ]
}

Documentation

For detailed documentation, see:

• Configuration Guide (English) / 配置指南 (中文)
• Template Guide (English) / 模板指南 (中文)
• Lazbuild Usage Guide (English) / Lazbuild 使用指南 (中文)

Thanks

Syntax Highlighting

Syntax files from https://github.com/maresmar/ST-Pascal

Formatter

Modified from https://github.com/git-bee/jcf-cli

Pascal-language-server

Modified from: https://github.com/genericptr/pascal-language-server https://github.com/arjanadriaanse/pascal-language-server

Release Notes

View changelog