@apple/tree-sitter-pkl 0.16.0 → 0.17.0

package/test/corpus/string/multiline.txt

@@ -0,0 +1,39 @@
+================================================================================
+multiline
+================================================================================
+
+res1 = """
+  Hi there
+  """
+
+res2 = #"""
+  "AS IS"
+  """#
+
+res3 = #"""
+  ""AS IS""
+  """#
+
+res4 = #"""
+  """""AS IS"""""
+  """#
+
+--------------------------------------------------------------------------------
+
+(module
+  (classProperty
+    (identifier)
+    (mlStringLiteral
+      (mlStringLiteralPart)))
+  (classProperty
+    (identifier)
+    (mlStringLiteral
+      (mlStringLiteralPart)))
+  (classProperty
+    (identifier)
+    (mlStringLiteral
+      (mlStringLiteralPart)))
+  (classProperty
+    (identifier)
+    (mlStringLiteral
+      (mlStringLiteralPart))))

package/test/corpus/string/multilineInterpolation.txt

@@ -0,0 +1,102 @@
+================================================================================
+multilineInterpolation
+================================================================================
+
+res1 = """
+  Well hello there how are you?
+  """
+
+res2 = """
+  Hi \(bob)
+  """
+
+res3 = #"""
+  Hi \(bob)
+  """#
+
+res4 = #"""
+  Hi \#(bob)
+  """#
+
+res5 = ##"""
+  Hi \#(bob)
+  """##
+
+res6 = ###"""
+  Hi \###(bob)
+  """###
+
+res7 = ####"""
+  Hi \####(bob)
+  """####
+
+res8 = #####"""
+  Hi \#####(bob)
+  """#####
+
+res9 = ######"""
+  Hi \######(bob)
+  """######
+--------------------------------------------------------------------------------
+
+(module
+  (classProperty
+    (identifier)
+    (mlStringLiteral
+      (mlStringLiteralPart)))
+  (classProperty
+    (identifier)
+    (mlStringLiteral
+      (mlStringLiteralPart)
+      (interpolationExpr
+        (variableExpr
+          (identifier)))
+      (mlStringLiteralPart)))
+  (classProperty
+    (identifier)
+    (mlStringLiteral
+      (mlStringLiteralPart)))
+  (classProperty
+    (identifier)
+    (mlStringLiteral
+      (mlStringLiteralPart)
+      (interpolationExpr
+        (variableExpr
+          (identifier)))
+      (mlStringLiteralPart)))
+  (classProperty
+    (identifier)
+    (mlStringLiteral
+      (mlStringLiteralPart)))
+  (classProperty
+    (identifier)
+    (mlStringLiteral
+      (mlStringLiteralPart)
+      (interpolationExpr
+        (variableExpr
+          (identifier)))
+      (mlStringLiteralPart)))
+  (classProperty
+    (identifier)
+    (mlStringLiteral
+      (mlStringLiteralPart)
+      (interpolationExpr
+        (variableExpr
+          (identifier)))
+      (mlStringLiteralPart)))
+  (classProperty
+    (identifier)
+    (mlStringLiteral
+      (mlStringLiteralPart)
+      (interpolationExpr
+        (variableExpr
+          (identifier)))
+      (mlStringLiteralPart)))
+  (classProperty
+    (identifier)
+    (mlStringLiteral
+      (mlStringLiteralPart)
+      (interpolationExpr
+        (variableExpr
+          (identifier)))
+      (mlStringLiteralPart))))

package/test/corpus/string/simple.txt

@@ -0,0 +1,13 @@
+================================================================================
+simple
+================================================================================
+
+str = "Hello there"
+
+--------------------------------------------------------------------------------
+
+(module
+  (classProperty
+    (identifier)
+    (slStringLiteral
+      (slStringLiteralPart))))

package/test/corpus/string/singleLineEscapes.txt

@@ -0,0 +1,64 @@
+===
+singleLineEscapes
+===
+
+res1 = "bar \\t \t baz"
+
+res2 = #"bar \t \#t baz"#
+
+res3 = ##"bar \#t \##t baz"##
+
+res4 = ###"bar \##t \###t baz"###
+
+res5 = ####"bar \###t \####t baz"####
+
+res6 = #####"bar \####t \#####t baz"#####
+
+res7 = ######"bar \#####t \######t baz"######
+---
+
+(module
+  (classProperty
+    (identifier)
+    (slStringLiteral
+      (slStringLiteralPart)
+      (escapeSequence)
+      (slStringLiteralPart)
+      (escapeSequence)
+      (slStringLiteralPart)))
+  (classProperty
+    (identifier)
+    (slStringLiteral
+      (slStringLiteralPart)
+      (escapeSequence)
+      (slStringLiteralPart)))
+  (classProperty
+    (identifier)
+    (slStringLiteral
+      (slStringLiteralPart)
+      (escapeSequence)
+      (slStringLiteralPart)))
+  (classProperty
+    (identifier)
+    (slStringLiteral
+      (slStringLiteralPart)
+      (escapeSequence)
+      (slStringLiteralPart)))
+  (classProperty
+    (identifier)
+    (slStringLiteral
+      (slStringLiteralPart)
+      (escapeSequence)
+      (slStringLiteralPart)))
+  (classProperty
+    (identifier)
+    (slStringLiteral
+      (slStringLiteralPart)
+      (escapeSequence)
+      (slStringLiteralPart)))
+  (classProperty
+    (identifier)
+    (slStringLiteral
+      (slStringLiteralPart)
+      (escapeSequence)
+      (slStringLiteralPart))))

package/test/corpus/string/singleLineInterpolation.txt

@@ -0,0 +1,94 @@
+================================================================================
+singleLineInterpolation
+================================================================================
+
+res1 = "Hi there \(bob)"
+
+res2 = #"Hi there \(bob)"#
+
+res3 = #"Hi there \#(bob)"#
+
+res4 = ##"Hi there \#(bob)"##
+
+res5 = ##"Hi there \##(bob)"##
+
+res6 = ##"Hi there \##(#"Hi there \#(bob)"#)"##
+
+res7 = ###"Hi there \###(bob)"###
+
+res8 = ####"Hi there \####(bob)"####
+
+res9 = #####"Hi there \#####(bob)"#####
+
+res10 = ######"Hi there \######(bob)"######
+
+--------------------------------------------------------------------------------
+
+(module
+  (classProperty
+    (identifier)
+    (slStringLiteral
+      (slStringLiteralPart)
+      (interpolationExpr
+        (variableExpr
+          (identifier)))))
+  (classProperty
+    (identifier)
+    (slStringLiteral
+      (slStringLiteralPart)))
+  (classProperty
+    (identifier)
+    (slStringLiteral
+      (slStringLiteralPart)
+      (interpolationExpr
+        (variableExpr
+          (identifier)))))
+  (classProperty
+    (identifier)
+    (slStringLiteral
+      (slStringLiteralPart)))
+  (classProperty
+    (identifier)
+    (slStringLiteral
+      (slStringLiteralPart)
+      (interpolationExpr
+        (variableExpr
+          (identifier)))))
+  (classProperty
+    (identifier)
+    (slStringLiteral
+      (slStringLiteralPart)
+      (interpolationExpr
+        (slStringLiteral
+          (slStringLiteralPart)
+          (interpolationExpr
+            (variableExpr
+              (identifier)))))))
+  (classProperty
+    (identifier)
+    (slStringLiteral
+      (slStringLiteralPart)
+      (interpolationExpr
+        (variableExpr
+          (identifier)))))
+  (classProperty
+    (identifier)
+    (slStringLiteral
+      (slStringLiteralPart)
+      (interpolationExpr
+        (variableExpr
+          (identifier)))))
+  (classProperty
+    (identifier)
+    (slStringLiteral
+      (slStringLiteralPart)
+      (interpolationExpr
+        (variableExpr
+          (identifier)))))
+  (classProperty
+    (identifier)
+    (slStringLiteral
+      (slStringLiteralPart)
+      (interpolationExpr
+        (variableExpr
+          (identifier))))))

package/test/corpus/string/stringWithTwoSlashes.txt

@@ -0,0 +1,20 @@
+===
+stringWithTwoSlashes
+===
+
+foo = "// this is string text"
+
+bar = """
+  // this is string text
+  """
+---
+
+(module
+  (classProperty
+    (identifier)
+    (slStringLiteral
+      (slStringLiteralPart)))
+  (classProperty
+    (identifier)
+    (mlStringLiteral
+      (mlStringLiteralPart))))

package/README.adoc

@@ -1,61 +0,0 @@
-A tree-sitter grammar for Pkl.
-
-[source, shell]
-----
-# install dependencies
-$ npm install
-
-# build parser
-$ npm run build
-
-# parse some code
-$ ./node_modules/.bin/tree-sitter parse test.pkl
-----
-
-== Tests
-
-Tree sitter comes with its own test framework.
-Files in `corpus/` describe one test each.
-All tests in `corpus/` are performed by the command
-
-[source,shell]
----
-$ tree-sitter test
----
-
-The script `src/synctests.ts` creates `corpus/` test files from tests in `pkl`'s `LanguageSnippetTests`.
-The script assumes that `../pkl` is a checked out `pkl` repository (and that the tests are under `pkl-core/src/test/files/LanguageSnippetFiles/input`).
-A pre-condition of the script is that `tree-sitter test` currently passes.
-If broken tests need replacing, the broken tests must first be deleted.
-
-It can be executed by running
-
-[source,shell]
----
-$ npm run synctests
----
-
-== Upgrading tree-sitter
-
-Upgrading tree-sitter involves upgrading the NPM package.
-
-1. Run `npm update tree-sitter` to install the newer version of tree-sitter.
-2. Commit to main, and push.
-
-== Releasing
-
-1. Run the build & test to make sure everything is up-to-date and passes (check 0 diff).
-2. Create a `Prepare 1.2.3 release` (with appropriate version number) commit where
-  * Versions are bumped in `package.json`, `Cargo.toml`
-  * Lockfiles are updated (`npm install`, `cargo check`)
-  * You have checked the previous release PR for any changes in process not described in this `README.adoc`; if any
-    - Adopt the changes accordingly
-    - Update this description to capture the changed process
-3. Merge into `main` & push
-4. Check that CI release succeeded (https://app.circleci.com/pipelines/github/apple/tree-sitter-pkl[release pipeline])
-5. Check the publication is reachable, https://www.npmjs.com/package/@apple/tree-sitter-pkl[on NPM]
-
-== Resources
-
-- https://tree-sitter.github.io/tree-sitter/[Tree-sitter docs]
-- https://gist.github.com/Aerijo/df27228d70c633e088b0591b8857eeef[Guide to your first Tree-sitter grammar]

package/src/synctests.ts

@@ -1,44 +0,0 @@
-/**
- * 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.
- */
-import { glob as _glob } from 'glob'
-import * as fs from 'fs/promises'
-import { promisify } from 'util'
-import * as path from 'path'
-import { spawn as _spawn } from 'child_process'
-
-const glob = promisify(_glob);
-const spawn = promisify(_spawn);
-
-const testDir = '../pkl/pkl-core/src/test/files/LanguageSnippetTests/input';
-const pattern = '**/*.pkl';
-const treeSitterCmd = 'node_modules/.bin/tree-sitter';
-
-(async () => {
-  await fs.rmdir('corpus/snippetTests/', { recursive: true });
-
-  const srcFiles = await glob(`${testDir}/${pattern}`);
-  for (const srcFile of srcFiles) {
-    const contents = await fs.readFile(srcFile, { encoding: 'utf-8' })
-    const testName = srcFile.replace(testDir + '/', '').replace(/.pkl$/, '')
-    const output = `==========\n${testName}\n==========\n\n${contents.trim()}\n\n---\n\n`
-    const dest = `corpus/snippetTests/${testName}.txt`;
-    // const destExists = await fs.
-    await fs.mkdir(path.dirname(dest), { recursive: true });
-    await fs.writeFile(dest, output, { encoding: 'utf-8' });
-  }
-
-  await spawn(treeSitterCmd, ['test', '--update'], { stdio: 'inherit' });
-})();