mirror of
https://github.com/apple/pkl.git
synced 2026-02-25 11:54:57 +01:00
73264e8fd1
This enables defining declarative key and/or value transformations in cases where neither `Class`- nor path-based converters can be applied gracefully. It is also the only way to express transforming the resulting property names in `Typed` objects without applying a converter to the entire containing type, which is cumbersome at best. SPICE: https://github.com/apple/pkl-evolution/pull/26
70 lines
2.9 KiB
Plaintext
70 lines
2.9 KiB
Plaintext
//===----------------------------------------------------------------------===//
|
|
// Copyright © 2024-2025 Apple Inc. and the Pkl project authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// https://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// 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.
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
/// A JSON parser.
|
|
@ModuleInfo { minPklVersion = "0.31.0" }
|
|
module pkl.json
|
|
|
|
/// Annotate properties of classes and modules with this class to override how a [JsonRenderer]
|
|
/// interprets a property's name.
|
|
@Since { version = "0.31.0" }
|
|
class Property extends ConvertProperty {
|
|
/// The new name to use for the annotated property when rendered by [JsonRenderer].
|
|
name: String
|
|
|
|
render = (prop, renderer) -> if (renderer is JsonRenderer) Pair(name, prop.value) else prop
|
|
}
|
|
|
|
/// A JSON parser.
|
|
///
|
|
/// JSON values are mapped to Pkl values as follows:
|
|
///
|
|
/// | JSON type | Pkl type |
|
|
/// | ----------- | ------------------------------------------------------- |
|
|
/// | null | [Null] |
|
|
/// | Boolean | [Boolean] |
|
|
/// | Number | [Number] |
|
|
/// | String | [String] |
|
|
/// | Array | [Listing] |
|
|
/// | Object | [Dynamic] or [Mapping] depending on [Parser.useMapping] |
|
|
///
|
|
/// The element order of JSON arrays and objects is maintained.
|
|
class Parser {
|
|
/// Determines what the parser produces when parsing JSON objects.
|
|
///
|
|
/// If [true], they turn into a [Mapping].
|
|
/// Otherwise, they turn into a [Dynamic].
|
|
///
|
|
/// If [useMapping] is [false], JSON object properties named "default" will be shadowed by the
|
|
/// built-in [Dynamic.default] property.
|
|
useMapping: Boolean = false
|
|
|
|
/// Value converters to apply to parsed values.
|
|
///
|
|
/// For further information see [PcfRenderer.converters].
|
|
converters: Mapping<Class | String(!isEmpty), (unknown) -> unknown>
|
|
|
|
/// Parses [source] as a JSON document.
|
|
///
|
|
/// Throws if an error occurs during parsing.
|
|
///
|
|
/// If [source] is a [Resource], the resource URI is included in parse error messages.
|
|
external function parse(source: Resource | String): Value
|
|
}
|
|
|
|
/// Pkl representation of a JSON value.
|
|
typealias Value = Null | Boolean | Number | String | Listing | Dynamic | Mapping
|