Skip to content

Mark protobuf module as deprecated #1778

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bioball wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Mark protobuf module as deprecated #1778

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3b9a5f
Mark protobuf module as deprecated
bioball Jul 15, 2026
5f27c12
Adjust help and docs
bioball Jul 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/modules/pkl-cli/pages/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ The default output renderer for a module supports the following formats:
* `pcf`
* `plist`
* `properties`
* `textproto`
* `textproto` (deprecated in Pkl 0.33)
* `xml`
* `yaml`

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/pkl-gradle/pages/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ The default output renderer for a module supports the following formats:
* `"pcf"`
* `"plist"`
* `"properties"`
* `"textproto"`
* `"textproto"` (deprecated in Pkl 0.33)
* `"xml"`
* `"yaml"`
====
Expand Down
4 changes: 2 additions & 2 deletions pkl-cli/src/main/kotlin/org/pkl/cli/CliEvaluatorOptions.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -51,7 +51,7 @@ data class CliEvaluatorOptions(
* - `"pcf"` (default)
* - `"plist"`
* - `"properties"`
* - `"textproto"`
* - `"textproto"` (deprecated in Pkl 0.33)
* - `"xml"`
* - `"yaml"`
*/
Expand Down
12 changes: 1 addition & 11 deletions pkl-commons-cli/src/main/kotlin/org/pkl/commons/cli/commands/BaseOptions.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,17 +102,7 @@ class BaseOptions : OptionGroup() {
private val defaults = CliBaseOptions()

private val output =
arrayOf(
"json",
"jsonnet",
"pcf",
"properties",
"plist",
"textproto",
"xml",
"yaml",
"pkl-binary",
)
arrayOf("json", "jsonnet", "pcf", "properties", "plist", "xml", "yaml", "pkl-binary")

val allowedModules: List<Pattern> by
option(
Expand Down
1 change: 1 addition & 0 deletions stdlib/base.pkl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import "pkl:json"
import "pkl:jsonnet"
import "pkl:math"
import "pkl:pklbinary"
// noinspection Deprecated
import "pkl:protobuf"
import "pkl:xml"
import "pkl:yaml"
Expand Down
10 changes: 8 additions & 2 deletions stdlib/protobuf.pkl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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");
// you may not use this file except in compliance with the License.
Expand All @@ -15,10 +15,16 @@
//===----------------------------------------------------------------------===//

/// 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" }
@Deprecated { since = "0.33.0"; message = "Scheduled for removal without replacement" }
module pkl.protobuf

import "pkl:json"
import "pkl:reflect"

/// A renderer for [Protocol Buffers](https://developers.google.com/protocol-buffers).
Expand Down
Loading