Skip to content

Commit 1d3aabc

Browse files
NikolaRHristovNikolaRHristov
committed
1 parent b68a61f commit 1d3aabc

2 files changed

Lines changed: 48 additions & 21 deletions

File tree

‎README.md‎

Lines changed: 47 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# **Common** 👨🏻‍🏭 The Architectural Core of Land
1313

1414
[![License: CC0-1.0](https://img.shields.io/badge/License-CC0_1.0-lightgrey.svg)](https://github.com/CodeEditorLand/Common/tree/Current/LICENSE)
15-
[![Rust Version](https://img.shields.io/badge/Rust-1.77+-blue.svg)](https://www.rust-lang.org/)
15+
[![Rust Version](https://img.shields.io/badge/Rust-1.85+-blue.svg)](https://www.rust-lang.org/)
1616
[![Crates.io](https://img.shields.io/crates/v/land-common.svg)](https://crates.io/crates/land-common)
1717

1818
Welcome to **Common**! This crate is the architectural heart of the Land Code
@@ -116,17 +116,43 @@ its trait definitions, DTOs, and effect constructors.
116116
```
117117
Common/
118118
└── Source/
119-
├── Library.rs # Crate root, declares all modules.
120-
├── Environment/ # The core DI system (Environment, Requires traits).
121-
├── Effect/ # The ActionEffect system (ActionEffect, ApplicationRunTime traits).
122-
├── Error/ # The universal CommonError enum.
123-
├── DTO/ # Shared Data Transfer Objects.
124-
└── Command/ # Example service domain:
125-
├── mod.rs # Module aggregator.
126-
├── CommandExecutor.rs # The abstract `trait` definition.
127-
├── DTO/ # (if any service-specific DTOs are needed)
128-
└── ExecuteCommand.rs # The `ActionEffect` constructor function.
129-
└── (Other service domains like FileSystem/, UserInterface/, etc. follow the same pattern)
119+
├── Library.rs # Crate root, declares all modules.
120+
├── Environment/ # The core DI system (Environment, Requires, HasEnvironment traits).
121+
├── Effect/ # The ActionEffect system (ActionEffect, ApplicationRunTime traits).
122+
├── Error/ # The universal CommonError enum.
123+
├── DTO/ # Shared Data Transfer Objects (re-exports from service modules).
124+
├── Utility/ # Utility functions (e.g., Serialization).
125+
├── Command/ # Command management service.
126+
├── Configuration/ # Configuration provider service.
127+
├── CustomEditor/ # Custom editor provider service.
128+
├── Debug/ # Debug service.
129+
├── Diagnostic/ # Diagnostic manager service.
130+
├── Document/ # Document provider service.
131+
├── ExtensionManagement/ # Extension management service.
132+
├── FileSystem/ # FileSystem read/write service.
133+
│ └── DTO/ # FileSystem-specific DTOs (FileTypeDTO, FileSystemStatDTO).
134+
├── IPC/ # Inter-process communication service.
135+
├── Keybinding/ # Keybinding provider service.
136+
├── LanguageFeature/ # Language feature provider registry.
137+
│ └── DTO/ # Language feature DTOs (CompletionListDTO, HoverResultDTO, etc.).
138+
├── Output/ # Output channel manager service.
139+
├── Search/ # Search provider service.
140+
├── Secret/ # Secret storage provider service.
141+
├── SourceControlManagement/ # Source control management service.
142+
│ └── DTO/ # SCM DTOs (SourceControlManagementProviderDTO, etc.).
143+
├── StatusBar/ # Status bar provider service.
144+
│ └── DTO/ # StatusBar DTOs (StatusBarEntryDTO).
145+
├── Storage/ # Storage provider service.
146+
├── Synchronization/ # Synchronization provider service.
147+
├── Terminal/ # Terminal provider service.
148+
├── Testing/ # Test controller service.
149+
├── TreeView/ # Tree view provider service.
150+
│ └── DTO/ # TreeView DTOs (TreeItemDTO, TreeViewOptionsDTO).
151+
├── UserInterface/ # User interface provider service.
152+
│ └── DTO/ # UI DTOs (MessageOptionsDTO, QuickPickOptionsDTO, etc.).
153+
├── Webview/ # Webview provider service.
154+
│ └── DTO/ # Webview DTOs (WebviewContentOptionsDTO).
155+
└── Workspace/ # Workspace provider service.
130156
```
131157

132158
---
@@ -135,9 +161,10 @@ Common/
135161

136162
To understand the core philosophy behind this crate and how its components work
137163
together, please refer to the detailed technical breakdown in
138-
[`Documentation/GitHub/DeepDive.md`](https://github.com/CodeEditorLand/Common/tree/Current/Documentation/GitHub/DeepDive.md). This document explains the
139-
`ActionEffect` system, the trait-based dependency injection model, and provides
140-
a guide for adding new services to the architecture.
164+
[`Documentation/GitHub/DeepDive.md`](https://github.com/CodeEditorLand/Common/tree/Current/Documentation/GitHub/DeepDive.md).
165+
This document explains the `ActionEffect` system, the trait-based dependency
166+
injection model, and provides a guide for adding new services to the
167+
architecture.
141168

142169
---
143170

@@ -239,14 +266,16 @@ async fn some_logic(runtime: Arc<impl ApplicationRunTime>) {
239266
This project is released into the public domain under the **Creative Commons CC0
240267
Universal** license. You are free to use, modify, distribute, and build upon
241268
this work for any purpose, without any restrictions. For the full legal text,
242-
see the [`LICENSE`](https://github.com/CodeEditorLand/Common/tree/Current/) file.
269+
see the [`LICENSE`](https://github.com/CodeEditorLand/Common/tree/Current/)
270+
file.
243271

244272
---
245273

246274
## Changelog 📜
247275

248-
Stay updated with our progress! See [`CHANGELOG.md`](https://github.com/CodeEditorLand/Common/tree/Current/) for a history
249-
of changes specific to **Common**.
276+
Stay updated with our progress! See
277+
[`CHANGELOG.md`](https://github.com/CodeEditorLand/Common/tree/Current/) for a
278+
history of changes specific to **Common**.
250279

251280
---
252281

‎tsconfig.json‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
"compilerOptions": {
33
"baseUrl": "./",
44

5-
"composite": true,
6-
75
"declarationMap": true,
86

97
"emitDeclarationOnly": true,
@@ -19,5 +17,5 @@
1917

2018
"extends": "@playform/build/tsconfig",
2119

22-
"include": ["Source"]
20+
"include": ["TypeScript"]
2321
}

0 commit comments

Comments
 (0)