Add syntax highlighting for Pkl files

docker-images/syntax-highlighter/crates/syntax-analysis/queries/pkl/highlights.scm

@@ -0,0 +1,159 @@
+ ; 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.
+ ;
+ ; Based on https://github.com/apple/tree-sitter-pkl/blob/main/queries/highlights.scm
+
+
+; Operators
+
+"??" @operator
+"@"  @operator
+"="  @operator
+"<"  @operator
+">"  @operator
+"!"  @operator
+"==" @operator
+"!=" @operator
+"<=" @operator
+">=" @operator
+"&&" @operator
+"||" @operator
+"+"  @operator
+"-"  @operator
+"**" @operator
+"*"  @operator
+"/"  @operator
+"~/" @operator
+"%"  @operator
+"|>" @operator
+
+"?"  @operator.type
+"|"  @operator.type
+"->" @operator.type
+
+"," @punctuation.delimiter
+":" @punctuation.delimiter
+"." @punctuation.delimiter
+"?." @punctuation.delimiter
+
+"(" @punctuation.bracket
+")" @punctuation.bracket
+"[" @punctuation.bracket
+"]" @punctuation.bracket
+"{" @punctuation.bracket
+"}" @punctuation.bracket
+
+; Keywords
+
+"abstract" @keyword
+"amends" @include
+"as" @keyword
+"class" @keyword
+"const" @keyword
+"else" @keyword
+"extends" @keyword
+"external" @keyword
+(falseLiteral) @constant.builtin
+"fixed" @keyword
+"for" @keyword
+"function" @keyword
+"hidden" @keyword
+"if" @keyword
+(importExpr "import" @include)
+(importGlobExpr "import*" @include)
+"import" @include
+"import*" @include
+"in" @keyword
+"is" @keyword
+"let" @keyword
+"local" @keyword
+(moduleExpr "module" @include)
+"module" @keyword
+"new" @keyword
+"nothing" @type.builtin
+(nullLiteral) @constant.builtin
+"open" @keyword
+"out" @keyword
+(outerExpr) @variable.builtin
+"read" @function.method.builtin
+"read?" @function.method.builtin
+"read*" @function.method.builtin
+"super" @variable.builtin
+(thisExpr) @variable.builtin
+"throw" @function.method.builtin
+"trace" @function.method.builtin
+(trueLiteral) @constant.builtin
+"typealias" @keyword
+"unknown" @type.builtin
+"when" @keyword
+
+; Types
+
+(clazz (identifier) @type)
+(typeAlias (identifier) @type)
+((identifier) @type
+ (#match? @type "^[A-Z]"))
+
+(typeArgumentList
+  "<" @punctuation.bracket
+  ">" @punctuation.bracket)
+
+; Method calls
+
+(methodCallExpr
+  (identifier) @function.method)
+
+; Method definitions
+
+(classMethod (methodHeader (identifier)) @function.method)
+(objectMethod (methodHeader (identifier)) @function.method)
+
+; Identifiers
+
+(classProperty (identifier) @property)
+(objectProperty (identifier) @property)
+
+(parameterList (typedIdentifier (identifier) @variable.parameter))
+(objectBodyParameters (typedIdentifier (identifier) @variable.parameter))
+
+(identifier) @variable
+
+; Literals
+
+(stringConstant) @string
+(slStringLiteral) @string
+(mlStringLiteral) @string
+
+(escapeSequence) @escape
+
+(intLiteral) @number
+(floatLiteral) @number
+
+(interpolationExpr
+  "\\(" @punctuation.special
+  ")" @punctuation.special) @embedded
+
+(interpolationExpr
+ "\\#(" @punctuation.special
+ ")" @punctuation.special) @embedded
+
+(interpolationExpr
+  "\\##(" @punctuation.special
+  ")" @punctuation.special) @embedded
+
+(lineComment) @comment
+(blockComment) @comment
+(docComment) @comment
+
+

docker-images/syntax-highlighter/crates/syntax-analysis/src/highlighting.rs

@@ -166,14 +166,6 @@ struct SublimeLanguageName {
 
 impl SublimeLanguageName {
     fn into_tree_sitter_name(self, file_info: &FileInfo<'_>) -> TreeSitterLanguageName {
-        if self.raw.is_empty() || self.raw.to_lowercase() == "plain text" {
-            #[allow(clippy::single_match)]
-            match file_info.extension() {
-                Some("ncl") => return TreeSitterLanguageName::new("nickel"),
-                _ => {}
-            };
-        }
-
         // Written in an unusual style so that we can:
         // 1. Avoid case-sensitive comparison
         // 2. We can look up corresponding Sublime Grammars easily

docker-images/syntax-highlighter/crates/syntax-analysis/src/highlighting/snapshots/files/pkl.pkl

@@ -0,0 +1,187 @@
+module some.module
+
+amends "fileB.pkl"
+
+import "fileA.pkl" as fileA
+
+import* "globbed/*.pkl"
+
+impExp = import("fileC.pkl")
+
+// Single-line comment
+
+/*
+  Multiline
+  comment
+*/
+
+
+// Strings and interpolation
+name = "Dodo"
+greeting = "Hi, \(name)!"
+x = 42
+message1 = "\(x + 2) plus \(x * 2) is \(0x80)"
+message2 = """
+Although the \(name) is extinct,
+the species will be remembered.
+"""
+
+message3 = #" \\\\\ \#n \#u{12AF} \#(name) """"" "#
+message4 = ##"""
+\\\\\ \#\#\# """""
+multi-line with custom escape
+"""##
+
+
+strLength = "dodo".length
+reversedStr = "dodo".reverse()
+hasAx = "dodo".contains("alive")
+
+
+# Functions
+addToA = (b: Number) -> a + b
+list = List(1, 2, 3).map(addToA)
+
+
+# Operators
+comparison1 = 5 == 2
+
+# Numbers
+num1 = 123
+num2 = 0x012AFF
+
+
+// Floats
+f1: Float(isFinite) = 1.0
+f2: Float(isBetween(0, 10e6))
+f3 = .23
+notANumber = NaN
+positiveInfinity = Infinity
+
+// Booleans
+b1 = true && false
+b3 = true.xor(false)
+
+
+# Durations
+duration1 = 5.min
+xySeconds = (x + y).s
+
+
+// Data Sizes
+datasize1 = 5.b  // bytes (smallest unit)
+
+
+// Consts
+const laysEggs: Boolean = true
+
+const examples: Listing<String> = new {
+  "Pigeon"
+  "Hawk"
+}
+
+// Classes
+
+class BunchOfTypes {
+  someString: String
+  someInt: Int
+  hidden someHiddenString: String
+  local someLocalThing = ","
+}
+
+class Bird {
+  name: String(length >= 3)
+  lifespan: UInt8
+  function isOlderThan(bird: Bird): Boolean = lifespan > bird.lifespan
+  fixed species: String
+}
+
+class Osprey extends Bird {
+  fixed species: "Pandion haliaetus"
+}
+
+typealias Adult = Bird(lifespan >= 2)
+
+function Infant(_name: String): Bird = new { name = _name; lifespan = 0 }
+
+pigeon: Bird = new {
+  name = "Pigeon"
+}
+
+@Deprecated { message = "Replace with \(pigeonName)" }
+oldPigeonName: String
+
+class Project {
+  local emailAddress = (str) -> str.matches(Regex(#".+@.+"#))
+  // constrain the nullable type's element type
+  type: String(contains("source"))?
+  // constrain the map type and its key/value types
+  contacts: Map<String(!isEmpty), String(emailAddress)>(length <= 5)
+}
+
+project: Project = new {
+  contacts = Map("Pigeon", "pigeon@example.com")
+}
+
+
+// Mixins
+withDietTyped = new Mixin<Bird> {
+  diet = "Seeds"
+}
+
+// Generators
+
+parrot {
+  lifespan = 20
+  for (_name in names) {
+    new {
+      name = _name
+      lifespan = 42
+    }
+  }
+  when (isSinger) {
+    idol = "Aretha Franklin"
+  } else {
+    idol = "Wolfgang Amadeus Mozart"
+  }
+}
+
+
+// Let bindings
+name = let (_ = trace("defining name")) "Eagle"
+
+
+// Spreading
+entries1 {
+  ["Pigeon"] = "Piggy the Pigeon"
+}
+
+entries2 {
+  ...entries1
+}
+
+// Member Predicates
+environmentVariables {
+  new { name = "PARROT"; value = "parrot-value" }
+}
+
+updated = (environmentVariables) {
+  [[name == "PARROT"]] {
+    value = "new-value"
+  }
+}
+
+/// Doc comments
+// showing amending
+woodPigeon (parrot) {
+  name = "Common wood pigeon"
+  taxonomy {
+    `class` = "Aves"
+  }
+}
+
+// Transforming objects
+res = woodPigeon
+    .toMap()
+    .remove("name")
+