diff --git a/.gitmodules b/.gitmodules index cdade19d04..7a9aa2346c 100644 --- a/.gitmodules +++ b/.gitmodules @@ -974,6 +974,9 @@ [submodule "vendor/grammars/pike-textmate"] path = vendor/grammars/pike-textmate url = https://github.com/hww3/pike-textmate +[submodule "vendor/grammars/pkl.tmbundle"] + path = vendor/grammars/pkl.tmbundle + url = https://github.com/apple/pkl.tmbundle.git [submodule "vendor/grammars/polar-grammar"] path = vendor/grammars/polar-grammar url = https://github.com/osohq/polar-grammar.git diff --git a/grammars.yml b/grammars.yml index 15ee02e35c..44e25154fa 100644 --- a/grammars.yml +++ b/grammars.yml @@ -903,6 +903,8 @@ vendor/grammars/pig-latin: - source.pig_latin vendor/grammars/pike-textmate: - source.pike +vendor/grammars/pkl.tmbundle: +- source.pkl vendor/grammars/polar-grammar: - source.polar vendor/grammars/portugol-grammar: diff --git a/lib/linguist/heuristics.yml b/lib/linguist/heuristics.yml index f06dec2bd9..9a7a53fb7f 100644 --- a/lib/linguist/heuristics.yml +++ b/lib/linguist/heuristics.yml @@ -530,6 +530,13 @@ disambiguations: pattern: '<\?hh' - language: PHP pattern: '<\?[^h]' +- extensions: ['.pkl'] + rules: + - language: Pkl + pattern: + - '^\s*(module|import|amends|extends|local|const|fixed|abstract|open|class|typealias|@\w+)\b' + - '^\s*[a-zA-Z0-9_$]+\s*(=|{|:)|^\s*`[^`]+`\s*(=|{|:)|for\s*\(|when\s*\(' + - language: Pickle - extensions: ['.pl'] rules: - language: Prolog diff --git a/lib/linguist/languages.yml b/lib/linguist/languages.yml index 58ab226aaa..3302d14e96 100644 --- a/lib/linguist/languages.yml +++ b/lib/linguist/languages.yml @@ -5320,6 +5320,16 @@ Pip Requirements: ace_mode: text tm_scope: source.pip-requirements language_id: 684385621 +Pkl: + type: programming + color: "#6b9543" + extensions: + - ".pkl" + interpreters: + - pkl + tm_scope: source.pkl + ace_mode: text + language_id: 288822799 PlantUML: type: data color: "#fbbd16" diff --git a/samples/Pkl/Parser.pkl b/samples/Pkl/Parser.pkl new file mode 100644 index 0000000000..eae7d3ad52 --- /dev/null +++ b/samples/Pkl/Parser.pkl @@ -0,0 +1,130 @@ +//===----------------------------------------------------------------------===// +// Copyright © 2024 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. +//===----------------------------------------------------------------------===// +/// Utility methods for parsing values into [JsonSchema]. +@ModuleInfo { minPklVersion = "0.25.0" } +module org.json_schema.Parser + +import "pkl:json" +import "pkl:reflect" + +import "JsonSchema.pkl" + +local jsonParser = new json.Parser { useMapping = true } + +local knownSchemaKeys: Set = reflect.Module(JsonSchema).moduleClass.properties.keys + +local function toJsonSchema( + raw: Mapping|Boolean, + baseSchema: JsonSchema?, + path: List +): JsonSchema.Schema = + if (raw is Boolean) + raw + else + new { + $$baseSchema = baseSchema ?? this + $id = raw.getOrNull("$id") + $ref = raw.getOrNull("$ref") + $schema = raw.getOrNull("$schema") + $comment = raw.getOrNull("$comment") + $defs = (raw.getOrNull("$defs") as Mapping?) + ?.toMap() + ?.map((key, value) -> Pair(key, toJsonSchema(value, $$baseSchema, path.add("definitions").add(key)))) + ?.toMapping() + definitions = (raw.getOrNull("definitions") as Mapping?) + ?.toMap() + ?.map((key, value) -> Pair(key, toJsonSchema(value, $$baseSchema, path.add("$defs").add(key)))) + ?.toMapping() + type = raw.getOrNull("type") + format = raw.getOrNull("format") + pattern = raw.getOrNull("pattern") + maxLength = raw.getOrNull("maxLength") + minLength = raw.getOrNull("minLength") + title = raw.getOrNull("title") + description = raw.getOrNull("description") + multipleOf = raw.getOrNull("multipleOf") + minimum = raw.getOrNull("minimum") + maximum = raw.getOrNull("maximum") + exclusiveMinimum = raw.getOrNull("exclusiveMinimum") + exclusiveMaximum = raw.getOrNull("exclusiveMaximum") + examples = raw.getOrNull("examples") + allOf = (raw.getOrNull("allOf") as Listing?) + ?.toList() + ?.mapIndexed((idx, elem) -> toJsonSchema(elem, $$baseSchema, path.add("allOf").add(idx))) + ?.toListing() + anyOf = (raw.getOrNull("anyOf") as Listing?) + ?.toList() + ?.mapIndexed((idx, elem) -> toJsonSchema(elem, $$baseSchema, path.add("anyOf").add(idx))) + ?.toListing() + oneOf = (raw.getOrNull("oneOf") as Listing?) + ?.toList() + ?.mapIndexed((idx, elem) -> toJsonSchema(elem, $$baseSchema, path.add("oneOf").add(idx))) + ?.toListing() + not = if (raw.containsKey("not")) toJsonSchema(raw["not"], $$baseSchema, path.add("not")) else null + properties = (raw.getOrNull("properties") as Mapping?) + ?.toMap() + ?.map((key, value) -> Pair(key, toJsonSchema(value, $$baseSchema, path.add("properties").add(key)))) + ?.toMapping() + items = + let (rawItems = raw.getOrNull("items")) + if (rawItems == null) null + else if (rawItems is Listing) + rawItems + .toList() + .mapIndexed((idx, elem) -> toJsonSchema(elem, $$baseSchema, path.add("items").add(idx))) + .toListing() + else toJsonSchema(rawItems, $$baseSchema, path.add("items")) + additionalItems = + let (rawAdditionalItems = raw.getOrNull("additionalItems")) + if (rawAdditionalItems == null) null + else toJsonSchema(rawAdditionalItems, $$baseSchema, path.add("additionalItems")) + contains = + let (rawContains = raw.getOrNull("contains")) + if (rawContains == null) null + else toJsonSchema(rawContains, $$baseSchema, path.add("contains")) + minItems = raw.getOrNull("minItems") + maxItems = raw.getOrNull("maxItems") + uniqueItems = raw.getOrNull("uniqueItems") + default = raw.getOrNull("default") + deprecated = raw.getOrNull("deprecated") + readOnly = raw.getOrNull("readOnly") + writeOnly = raw.getOrNull("writeOnly") + enum = raw.getOrNull("enum") + required = raw.getOrNull("required") + `const` = raw.getOrNull("const") + propertyNames = let (_raw = raw.getOrNull("propertyNames")) + if (_raw == null) null + else toJsonSchema(_raw, $$baseSchema, path.add("propertyNames")) + maxProperties = raw.getOrNull("maxProperties") + minProperties = raw.getOrNull("minProperties") + additionalProperties = + let (rawAdditionalProperties = raw.getOrNull("additionalProperties")) + if (rawAdditionalProperties == null) null + else toJsonSchema(rawAdditionalProperties, $$baseSchema, path.add("additionalProperties")) + patternProperties = (raw.getOrNull("patternProperties") as Mapping?) + ?.toMap() + ?.map((key, value) -> Pair(key, toJsonSchema(value, $$baseSchema, path.add("patternProperties").add(key)))) + ?.toMapping() + _inline_ = raw.toMap() + .filter((key, value) -> !knownSchemaKeys.contains(key) && value is Boolean|Mapping) + .map((key, value) -> Pair(key, toJsonSchema(value, $$baseSchema, path.add(key)))) + .toMapping() + } + +/// Given a JSON string or [Resource], parse it into a [JsonSchema.Schema] instance. +function parse(src: Resource|String): JsonSchema.Schema = + let (jsonParsed: Mapping|Boolean = jsonParser.parse(src) as Mapping|Boolean) + toJsonSchema(jsonParsed, null, List()) diff --git a/samples/Pkl/SchemaGenerator.pkl b/samples/Pkl/SchemaGenerator.pkl new file mode 100644 index 0000000000..7d3b355545 --- /dev/null +++ b/samples/Pkl/SchemaGenerator.pkl @@ -0,0 +1,72 @@ +//===----------------------------------------------------------------------===// +// Copyright © 2024 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. +//===----------------------------------------------------------------------===// +module org.openapis.v3.tests.SchemaGenerator + +amends "pkl:test" + +import "fixtures/SelfReference.pkl" +import "../examples/SwallowSchema.pkl" +import "../SchemaGenerator.pkl" +import "../Schema.pkl" + +local schema = SchemaGenerator.generate(SwallowSchema.Swallow) + +facts { + ["recursive references throw an error"] { + module.catch(() -> SchemaGenerator.generate(SelfReference).output.text) + .startsWith("Invalid Schema: Unable to convert a schema that refers to itself.") + } + ["nullable values show up as nullable"] { + (schema.properties!!["airSpeed"] as Schema).nullable == true + } + ["deprecated fields show up as deprecated"] { + (schema.properties!!["isDuck"] as Schema).deprecated == true + } + ["generates basic metadata"] { + schema.title == "Swallow" + schema.description == "This is a Swallow" + } + ["listings are encoded as arrays"] { + local nicknameSchema = schema.properties!!["nicknames"] as Schema + nicknameSchema.type == "array" + nicknameSchema.items.type == "string" + } + ["mappings are encoded as objects"] { + local tagsSchema = schema.properties!!["tags"] as Schema + tagsSchema.type == "object" + tagsSchema.additionalProperties.type == "string" + } + ["classes are encoded as objects"] { + local friendSchema = schema.properties!!["bestFriend"] as Schema + friendSchema.type == "object" + friendSchema.properties.toMap().keys == Set("name", "isSwallow", "tags") + } +} + +examples { + ["converts a module"] { + let (schema = new SchemaGenerator { + converters { + [DataSize] { + title = "DataSize" + type = "string" + description = "The size of data in [quantity][unit] representation." + } + } + }.generate(SwallowSchema.Swallow)) + new JsonRenderer {}.renderDocument(schema) + } +} diff --git a/samples/Pkl/rule.pkl b/samples/Pkl/rule.pkl new file mode 100644 index 0000000000..8ebab92dc9 --- /dev/null +++ b/samples/Pkl/rule.pkl @@ -0,0 +1,50 @@ +//===----------------------------------------------------------------------===// +// Copyright © 2024 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. +//===----------------------------------------------------------------------===// +module io.prometheus.examples.rule + +amends "../Rule.pkl" + +groups { + new AlertingRuleGroup { + name = "alerting_rules" + interval = 5.min + rules { + new { + alert = "HighRequestLatency" + expr = #"job:request_latency_seconds:mean5m{job="myjob"} > 0.5"# + `for` = 10.min + labels { + ["prod"] = true + ["priority"] = 1 + ["severity"] = "page" + } + annotations { + ["summary"] = "High request latency" + } + } + } + } + new RecordingRuleGroup { + name = "recording_rules" + interval = 10.h + rules { + new { + `record` = "job:http_inprogress_requests:sum" + expr = "sum by (job) (http_inprogress_requests)" + } + } + } +} diff --git a/test/test_heuristics.rb b/test/test_heuristics.rb index 4ac8cdf340..177ed995c8 100755 --- a/test/test_heuristics.rb +++ b/test/test_heuristics.rb @@ -762,6 +762,13 @@ def test_php_by_heuristics }) end + def test_pkl_by_heuristics + assert_heuristics({ + "Pkl" => all_fixtures("Pkl", "*.pkl"), + "Pickle" => all_fixtures("Pickle", "*.pkl") + }) + end + def test_pl_by_heuristics assert_heuristics({ "Prolog" => all_fixtures("Prolog", "*.pl"), diff --git a/vendor/README.md b/vendor/README.md index 45a4e0e276..88ac7c8452 100644 --- a/vendor/README.md +++ b/vendor/README.md @@ -427,6 +427,7 @@ This is a list of grammars that Linguist selects to provide syntax highlighting - **PigLatin:** [goblindegook/sublime-text-pig-latin](https://github.com/goblindegook/sublime-text-pig-latin) - **Pike:** [hww3/pike-textmate](https://github.com/hww3/pike-textmate) - **Pip Requirements:** [microsoft/vscode-python](https://github.com/microsoft/vscode-python) +- **Pkl:** [apple/pkl.tmbundle](https://github.com/apple/pkl.tmbundle) - **PlantUML:** [qjebbs/vscode-plantuml](https://github.com/qjebbs/vscode-plantuml) - **Pod 6:** [perl6/atom-language-perl6](https://github.com/perl6/atom-language-perl6) - **PogoScript:** [featurist/PogoScript.tmbundle](https://github.com/featurist/PogoScript.tmbundle) diff --git a/vendor/grammars/pkl.tmbundle b/vendor/grammars/pkl.tmbundle new file mode 160000 index 0000000000..ebeadfdc28 --- /dev/null +++ b/vendor/grammars/pkl.tmbundle @@ -0,0 +1 @@ +Subproject commit ebeadfdc288fd3294352a4defe01e527eb5a654c diff --git a/vendor/licenses/git_submodule/pkl.tmbundle.dep.yml b/vendor/licenses/git_submodule/pkl.tmbundle.dep.yml new file mode 100644 index 0000000000..1113a6bd6c --- /dev/null +++ b/vendor/licenses/git_submodule/pkl.tmbundle.dep.yml @@ -0,0 +1,212 @@ +--- +name: pkl.tmbundle +version: ebeadfdc288fd3294352a4defe01e527eb5a654c +type: git_submodule +homepage: https://github.com/apple/pkl.tmbundle.git +license: apache-2.0 +licenses: +- sources: LICENSE.txt + text: |2 + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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 + + http://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. +notices: []