docs: consolidate design documentation and standardize crate English

This commit is contained in:
2026-10-12 14:58:00 +09:00
parent a633a53274
commit 4efb0ace1f
404 changed files with 4556 additions and 11654 deletions
+9
View File
@@ -0,0 +1,9 @@
# config-source-wasm
WASM adapter exposing `config-source` snapshot evaluation and editing support to JavaScript. It handles browser-local edit candidates without changing Backend save permissions or persistent state.
## Main entry points
- [`set_snapshot`] and [`apply_changes`] — update local edit candidates
- [`evaluate_snapshot`] and [`evaluate_current`] — evaluation through the shared implementation
- [`analyze_snapshot`] and [`complete_current`] — diagnostics and completion
+10
View File
@@ -1,3 +1,5 @@
#![doc = include_str!("../README.md")]
use config_source::{
ConfigSchemaContribution, ConfigTreeChange, ConfigTreeSnapshot, EvaluationResult,
SnapshotEnvironment, ToolchainContract, VirtualPath, WorkspaceConfigSchemaBundle,
@@ -17,6 +19,10 @@ pub fn compose_schema_bundle(contributions: JsValue) -> Result<JsValue, JsValue>
encode(WorkspaceConfigSchemaBundle::compose(contributions).map_err(js_error)?)
}
/// Retain the browser's edit candidate as a snapshot.
///
/// Deserialization uses shared digest validation but neither saves to nor authorizes the Backend.
/// Keep the schema bundle in separate state to distinguish sources from evaluation conditions.
#[wasm_bindgen]
pub fn set_snapshot(snapshot: JsValue) -> Result<(), JsValue> {
let snapshot: ConfigTreeSnapshot = decode(snapshot)?;
@@ -85,6 +91,10 @@ struct WasmCompletionItem {
priority: i32,
}
/// Complete after converting the editor's UTF-16 offset to the shared analyzer's UTF-8 byte offset.
///
/// Convert the returned start position back to UTF-16 so non-ASCII characters do not
/// misalign editor and analyzer positions. Reject offsets that cannot map to a character boundary.
#[wasm_bindgen]
pub fn complete_current(
entrypoint: String,