jsonette-core 0.3.0

JSON parse, format, query, and diagnostics engine — core library for the jsonette tool
Documentation
/*
 * Copyright (c) 2026 DevEtte.
 *
 * This project is dual-licensed under both the MIT License and the
 * Apache License, Version 2.0 (the "License"). You may not use this
 * file except in compliance with one of these licenses.
 *
 * You may obtain a copy of the Licenses at:
 * - MIT: https://opensource.org
 * - Apache 2.0: http://apache.org
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

//! JSONPath auto-completion and suggestion engine.

use crate::json_node::JsonNode;
use crate::types::CompletionItem;

/// Provides autocomplete suggestions for a JSONPath prefix given the current document state.
///
/// # Arguments
///
/// * `node` - A reference to the parsed root `JsonNode` context.
/// * `path_prefix` - The incomplete JSONPath prefix string slice typed by the user.
///
/// # Returns
///
/// A list of `CompletionItem` candidates suitable for autocomplete suggestions.
pub fn completions_at(node: &JsonNode, path_prefix: &str) -> Vec<CompletionItem> {
    todo!("Autocomplete suggestion logic will be implemented in subsequent issues")
}

#[cfg(test)]
mod stub_tests {
    use super::*;
    use crate::parser::parse;

    #[test]
    #[should_panic(expected = "not yet implemented")]
    fn test_completions_at_is_stub() {
        let node = parse("{}").unwrap();
        completions_at(&node, "$.");
    }
}