tom_forge_core 2.0.0

Tom Forge's core types, service contracts and defaults: documents, diagnostics, decorations, the undo manager, the workspace edit and the services the shell and its editors share.

tom_forge_core

Published on pub.dev as tom_forge_core 2.0.0.

Tom Forge's core: the types, service contracts and defaults the shell is built from, in pure Dart. The file system the shell and its editors work on is tom_file_system, and the undo stack under DefaultUndoManager is tom_undo.

What it holds

• Types — positions and ranges, diagnostics and their severities, decorations, editor options, the events and error codes the shell and its editors exchange, a listenable, and the workspace edit.
• Documents and configuration — ForgeDocument, ForgeConfig and the search configuration.
• Service contracts — clipboard, configuration, diagnostics, execution monitoring, notifications, output channels, progress, search, secret storage, terminals, undo, virtual documents, the performance contract and the quality gate: interfaces the Flutter shell (tom_forge_ui) implements or wires.
• Defaults — pure-Dart implementations of most of those services, an LRU cache and a retry policy, usable in a test or a headless tool.

Two entry points: package:tom_forge_core/tom_forge_core.dart for all of the above, and package:tom_forge_core/tom_forge_undo.dart for the undo manager alone. Neither reaches Flutter.

Getting started

dependencies:
  tom_forge_core: ^2.0.0

Usage

import 'package:tom_forge_core/tom_forge_core.dart';

void main() {
  final pos = ForgeTextPosition(line: 1, column: 5);
  print('Position: $pos');
}

Workspace edits

forgeApplyWorkspaceEdit(fs, edit) applies a ForgeWorkspaceEdit — text edits by position and file operations, as an editor or a refactoring produces them — to any TomFileSystem as one unit: every change, or, when one fails, none of them. The file system itself does not know what a workspace edit is.

.gitignore rules

forgeLoadGitignores(root) reads every .gitignore under a folder into one TomGitignoreSet from tom_basics (package:tom_basics/utilities.dart), which parses and applies the rules; Forge's part is only the walk. The root's file comes first and deeper ones later, so a nested file decides inside its folder. The walk never enters .git or a folder the rules already ignore, and passes over a file it cannot read.

final rules = await forgeLoadGitignores('/path/to/workspace');
if (rules.isIgnored('build/output.js', isDirectory: false)) {
  // skip it
}

Context-menu contributions

The pure-Dart model behind the shell's context menus (src/types/forge_context_menu.dart):

• ForgeContextTarget — what a menu is opened on: a kind the producer owns (forge.explorer.file, <module>.<unit>), opaque data, and the target's own items (ForgeContextMenuItem: commands only the producer can perform, drawn after the contributed entries).
• ForgeContextMenuContribution — a module's declaration that one of its actions, named by id, is an entry at targets of a kind: isApplicable (absent when false), label and unavailableReason (disabled, with the reason as tooltip) all read the target. The shell resolves the action from its registry and runs it with the target under ForgeContextTarget.parameterKey.

The drawing lives in tom_forge_ui (ForgeContextMenuController, ForgeContextTargetProvider).

License

BSD-3-Clause — See LICENSE for details.

Undo and redo

ForgeUndoManager is the shell's undo contract and DefaultUndoManager its implementation, with CompositeUndoEntry for a beginUndoGroup / endUndoGroup block; both run on tom_undo's TomUndoStack and tomApplyAllAsync. They are in package:tom_forge_core/tom_forge_undo.dart, which reaches no dart:io and no Flutter.

An editor keeps its history on that stack rather than its own list.