mirror of
https://github.com/apple/pkl.git
synced 2026-09-09 19:31:51 +02:00
Mark protobuf module as deprecated (#1778)
This moves the protobuf module from experimental to deprecated Rationale: * This is very seldom used, if used at all * Not fully fleshed out (this really should be paired with a protoc-gen-pkl, which doesn't exist) * There is a ProtoJSON wire format that we can already render to
This commit is contained in:
@@ -307,7 +307,7 @@ The default output renderer for a module supports the following formats:
|
|||||||
* `pcf`
|
* `pcf`
|
||||||
* `plist`
|
* `plist`
|
||||||
* `properties`
|
* `properties`
|
||||||
* `textproto`
|
* `textproto` (deprecated in Pkl 0.33)
|
||||||
* `xml`
|
* `xml`
|
||||||
* `yaml`
|
* `yaml`
|
||||||
|
|
||||||
|
|||||||
@@ -152,7 +152,7 @@ The default output renderer for a module supports the following formats:
|
|||||||
* `"pcf"`
|
* `"pcf"`
|
||||||
* `"plist"`
|
* `"plist"`
|
||||||
* `"properties"`
|
* `"properties"`
|
||||||
* `"textproto"`
|
* `"textproto"` (deprecated in Pkl 0.33)
|
||||||
* `"xml"`
|
* `"xml"`
|
||||||
* `"yaml"`
|
* `"yaml"`
|
||||||
====
|
====
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
/*
|
/*
|
||||||
* Copyright © 2024-2025 Apple Inc. and the Pkl project authors. All rights reserved.
|
* Copyright © 2024-2026 Apple Inc. and the Pkl project authors. All rights reserved.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
@@ -51,7 +51,7 @@ data class CliEvaluatorOptions(
|
|||||||
* - `"pcf"` (default)
|
* - `"pcf"` (default)
|
||||||
* - `"plist"`
|
* - `"plist"`
|
||||||
* - `"properties"`
|
* - `"properties"`
|
||||||
* - `"textproto"`
|
* - `"textproto"` (deprecated in Pkl 0.33)
|
||||||
* - `"xml"`
|
* - `"xml"`
|
||||||
* - `"yaml"`
|
* - `"yaml"`
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -102,17 +102,7 @@ class BaseOptions : OptionGroup() {
|
|||||||
private val defaults = CliBaseOptions()
|
private val defaults = CliBaseOptions()
|
||||||
|
|
||||||
private val output =
|
private val output =
|
||||||
arrayOf(
|
arrayOf("json", "jsonnet", "pcf", "properties", "plist", "xml", "yaml", "pkl-binary")
|
||||||
"json",
|
|
||||||
"jsonnet",
|
|
||||||
"pcf",
|
|
||||||
"properties",
|
|
||||||
"plist",
|
|
||||||
"textproto",
|
|
||||||
"xml",
|
|
||||||
"yaml",
|
|
||||||
"pkl-binary",
|
|
||||||
)
|
|
||||||
|
|
||||||
val allowedModules: List<Pattern> by
|
val allowedModules: List<Pattern> by
|
||||||
option(
|
option(
|
||||||
|
|||||||
@@ -24,6 +24,7 @@ import "pkl:json"
|
|||||||
import "pkl:jsonnet"
|
import "pkl:jsonnet"
|
||||||
import "pkl:math"
|
import "pkl:math"
|
||||||
import "pkl:pklbinary"
|
import "pkl:pklbinary"
|
||||||
|
// noinspection Deprecated
|
||||||
import "pkl:protobuf"
|
import "pkl:protobuf"
|
||||||
import "pkl:xml"
|
import "pkl:xml"
|
||||||
import "pkl:yaml"
|
import "pkl:yaml"
|
||||||
|
|||||||
+8
-2
@@ -1,5 +1,5 @@
|
|||||||
//===----------------------------------------------------------------------===//
|
//===----------------------------------------------------------------------===//
|
||||||
// Copyright © 2024-2025 Apple Inc. and the Pkl project authors. All rights reserved.
|
// Copyright © 2024-2026 Apple Inc. and the Pkl project authors. All rights reserved.
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
@@ -15,10 +15,16 @@
|
|||||||
//===----------------------------------------------------------------------===//
|
//===----------------------------------------------------------------------===//
|
||||||
|
|
||||||
/// A renderer for [Protocol Buffers](https://developers.google.com/protocol-buffers).
|
/// A renderer for [Protocol Buffers](https://developers.google.com/protocol-buffers).
|
||||||
/// Note: This module is _experimental_ and not ready for production use.
|
///
|
||||||
|
/// WARNING:
|
||||||
|
/// This module is deprecated, and scheduled for removal without replacement.
|
||||||
|
/// For rendering into a protobuf wire format, consider rendering to
|
||||||
|
/// [ProtoJSON](https://protobuf.dev/programming-guides/json/) using [json.Renderer].
|
||||||
@ModuleInfo { minPklVersion = "0.33.0" }
|
@ModuleInfo { minPklVersion = "0.33.0" }
|
||||||
|
@Deprecated { since = "0.33.0"; message = "Scheduled for removal without replacement" }
|
||||||
module pkl.protobuf
|
module pkl.protobuf
|
||||||
|
|
||||||
|
import "pkl:json"
|
||||||
import "pkl:reflect"
|
import "pkl:reflect"
|
||||||
|
|
||||||
/// A renderer for [Protocol Buffers](https://developers.google.com/protocol-buffers).
|
/// A renderer for [Protocol Buffers](https://developers.google.com/protocol-buffers).
|
||||||
|
|||||||
Reference in New Issue
Block a user