@traqula/chevrotain 0.0.23 → 0.0.25

package/README.md

@@ -1,186 +1,22 @@
-# Traqula core package
+# Traqula Chevrotain package
 
-Traqula core contains core components of Traqula.
-Most importantly, its [lexer builder](./lib/lexer-builder/LexerBuilder.ts), [parser builder](./lib/parser-builder/parserBuilder.ts), and [generator builder](./lib/generator-builder/generatorBuilder.ts).
-This library heavily relies on the amazing [Chevrotain package](https://chevrotain.io/docs/).
-Knowing the basics of that package will allow you to quickly generate your own grammars.
+[![npm version](https://badge.fury.io/js/@traqula%2Fchevrotain.svg)](https://www.npmjs.com/package/@traqula/chevrotain)
+
+Exports the [Chevrotain](https://chevrotain.io/docs/) package and tries to bundle a CJS version too.
+This is NOT a redistribution of Chevrotain, not should a project outside of Traqula depend on this.
+
+The reason for exporting is so the transpiled versions of the traqula packages use the same version of Chevrotain (instead of copying).
+I copied the licence of Chevrotain just to be sure :)
+So this part is APACHE 2.0 licenced!
 
 ## Installation
 
 ```bash
-npm install @traqula/core
+npm install @traqula/chevrotain
 ```
 
 or
 
 ```bash
-yarn add @traqula/core
-```
-
-## Usage
-
-Each parser contains two steps:
-1. a lexer
-2. a grammar + abstract syntax tree generation step.
-
-Sometimes grammar definitions and abstract syntax tree generation is split into separate steps.
-In this library, we choose to keep the two together when building a parser.
-
-### Lexer Builder
-
-To tackle the first step, a lexer should be created.
-This is a system that separates different groups of characters into annotated groups.
-In human language for example the sentence 'I eat apples' is lexed into different groups called **tokens** namely `words` and `spaces`:
-`I`, ` `, `eat`, ` `, `apples`.
-
-To create a token definition, you use the provided function `createToken` like:
-```typescript
-const select = createToken({ name: 'Select', pattern: /select/i, label: 'SELECT' });
-```
-
-Lexer definitions are then put in a list and when a lexer is build, the lexer will match a string to the [**first token in the list**](https://chevrotain.io/docs/tutorial/step1_lexing.html#creating-the-lexer) that matches.
-Note that the order of definitions in the list is thus essential.
-
-We therefore use a [lexer builder](./lib/lexer-builder/LexerBuilder.ts) which allows you to easily:
-1. change the order of lexer rules,
-2. and create a new lexer staring from an existing one.
-
-Creating a builder is as easy as:
-
-```typescript
-const sparql11Tokens = LexerBuilder.create(<const> [select, describe]);
-```
-
-A new lexer can be created from an existing one, and altered by calling:
-```typescript
-const sparql11AdjustTokens = LexerBuilder.create(sparql11Tokens).addBefore(select, BuiltInAdjust);
-```
-
-### Parser Builder
-
-The grammar builder is used to link together grammar rules such that they can be converted into a parser.
-Grammar rule definitions come in the form of [ParserRule](./lib/parser-builder/ruleDefTypes.ts) objects.
-Each `ParserRule` object contains its name and its returnType.
-Optionally, it can also contain arguments that should be provided to the SUBRULE calls.
-A simple example of a grammar rule is the rule bellow that allows you to parse booleanLiterals.
-
-```typescript
-/**
- * Parses a boolean literal.
- * [[134]](https://www.w3.org/TR/sparql11-query/#rBooleanLiteral)
- */
-export const booleanLiteral: ParserRule<'booleanLiteral', LiteralTerm> = <const> {
-    name: 'booleanLiteral',
-    impl: ({ CONSUME, OR, context }) => () => OR([
-      { ALT: () => context.dataFactory.literal(
-          CONSUME(l.true_).image.toLowerCase(),
-          context.dataFactory.namedNode(CommonIRIs.BOOLEAN),
-        ) },
-      { ALT: () => context.dataFactory.literal(
-          CONSUME(l.false_).image.toLowerCase(),
-          context.dataFactory.namedNode(CommonIRIs.BOOLEAN),
-        ) },
-    ]),
-  };
-```
-
-The `impl` member of `ParserRule` is a function that receives:
-1. essential functions to create a grammar rule (capitalized members),
-2. a context object that can be used by the rules,
-3. a cache object ([WeakMap](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap)) that can be used to cache the creation of long lists in the parser, [increasing parser performance](https://chevrotain.io/docs/guide/performance.html#caching-arrays-of-alternatives).
-
-You cannot unpack the context entry in the function definition itself because the parser uses a [recording phase](https://chevrotain.io/docs/guide/internals.html#grammar-recording) to optimize itself. During this phase, the context entry will be undefined, as such, it can only be accessed within the `ACTION` function.
-
-The result of an `impl` call is a function called a `rule`.
-Rules can be [parameterized](https://chevrotain.io/docs/features/parameterized_rules.html), although I have not found a scenario where that is usefully.
-Personally I create a function that can be used to create multiple `ParserRule` objects.
-The result of a rule should match the type provided in the `ParserRule` definition, and is the result of a call of `SUBRULE` with that rule.
-
-##### Testing the correctness of your parser
-By default, the parser builder will construct a parser that does not perform validation (to be more speedy).
-When creating a parser, you best enable the validation by passing a context to the parser builder like:
-```typescript
-const context = {
-  tokenVocabulary: myLexerVoc,
-    lexerConfig: {
-    skipValidations: false,
-      ensureOptimizations: true,
-  },
-  parserConfig: {
-    skipValidations: false,
-  },
-}
-```
-
-#### Patching rules
-
-When a rule definition calls to a subrule using `SUBRULE(mySub)`, the implementation itself is not necessarily called.
-That is because the SUBRULE function will call the function with the same name as `mySub` that is present in the current grammarBuilder.
-
-A builder is thus free to override definitions as it pleases. Doing so does however **break the types** and should thus only be done with care.
-An example patch is:
-
-```typescript
-const myBuilder = Builder
-  .createBuilder(<const> [selectOrDescribe, selectRule, describeRule])
-  .patchRule(selectRuleAlternative);
-```
-
-When `selectOrDescribe` calls what it thinks to be `selectRule`,
-it will instead call `selectRuleAlternative` since it overwrote the function `selectRule` with the same name.
-
-When you are creating a new parser,
-it might be good to test your parser by setting `skipValidations: false` in the context of the `.build` function.
-
-### Generator Builder
-
-The generator builder function in much the same as the [parser builder](#parser-builder).
-Your builder expects objects of type [GeneratorRule](lib/generator-builder/generatorTypes.ts),
-containing the implementation of the generator in the `gImpl` member.
-The `gImpl` function gets essential functions to create a generator rule (capitalized members),
-returning a function that will get the AST and context, returning a string.
-For generator rules, you can unpack the context since no recording phase is present in this case.
-The idea is that GeneratorRules and ParserRules can be tied together in the same object, as such, similar behaviour is grouped together.
-
-```typescript
-/**
- * Parses a named node, either as an IRI or as a prefixed name.
- * [[136]](https://www.w3.org/TR/sparql11-query/#riri)
- */
-export const iri: GeneratorRule<'iri', IriTerm> = <const> {
-    name: 'iri',
-    gImpl: ({ PRINT }) => ast => { PRINT(ast.value) },
-  };
+yarn add @traqula/chevrotain
 ```
-
-While implementing a generator, you can easily support pretty print indentation manipulating `traqulaIndentation` context item.
-The key for this context item can be accessed like:
-```typescript
-import { traqulaIndentation } from '@traqula/core';
-C[traqulaIndentation] += 2;
-```
-
-### A word on round tripping:
-
-The generator builder can significantly help you with creating a round tripping parser.
-Basically what that allows you to do is to keep information that the AST finds 'unimportant' within the generated string.
-Take for example capitalization and spaces in the sparql spec.
-Both are ignored in the AST, but if you want to generate the same string out of your AST, yuo need to store them somewhere.
-Traqula helps you store this information using it's `Node` `Localization`.
-
-Localization basically allows you to remember what _portion of the original string_ a node represents.
-Take for example the `SENTENCE`: `I Love      Traqula`, If we ignore spaces and caps in the ast, a valid representation would be:
-```
-SENTENCE-node{ words: [ WORD-node{ value: "i" }, WORD-node{ value: "love" }, WORD-node{ value: "traqula" } ] }
-```
-If we generated we would loe the capitalisation and get: `i love traqula` for example.
-Round tripping will add a `source localization` for each node,
-we therefore register that our SENTENCE starts at 0 and ends at 19, while our words have ranges 0-1, 2-6, 12-19.
-Using this information our generator can reconstruct the original string (given the original string).
-The magic happens when we start manipulating the words, so imagine we want to lowercase the word 'Love',
-we would simply annotate in the `localization` that the node should be generated (and not reconstructed),
-and we can generate the sentence: `I love      Traqula`.
-
-To support this feature, the generator requires that your AST follows a tree structure with respect to the ranges.
-That means that a node cannot start later, or end earlier than its children.
-In our example: A sentence cannot start after the first word start, nor can it end before the last word ends.

package/licence.txt

@@ -0,0 +1,202 @@
+
+                                 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.

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@traqula/chevrotain",
   "type": "module",
-  "version": "0.0.23",
+  "version": "0.0.25",
   "description": "Core components of Traqula",
   "lsd:module": true,
-  "license": "MIT",
+  "license": "Apache-2.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/comunica/traqula.git",
@@ -27,20 +27,24 @@
     "access": "public"
   },
   "files": [
-    "dist/**/*.d.ts",
-    "dist/**/*.js",
-    "dist/**/*.js.map",
-    "dist/**/package.json"
+    "dist/*/lib/**/*.d.ts",
+    "dist/*/lib/**/*.js",
+    "dist/*/lib/**/*.js.map",
+    "dist/cjs/package.json"
   ],
   "engines": {
     "node": "^20.19.0 || >=22.12.0"
   },
   "scripts": {
-    "build": "node \"../../node_modules/typescript/bin/tsc\" -b",
-    "build:transpile": "node \"../../node_modules/esbuild/bin/esbuild\" --format=cjs --bundle --log-level=error --outfile=dist/cjs/lib/index.js lib/index.ts"
+    "build": "yarn build:ts && yarn build:transpile",
+    "build:ts": "node \"../../node_modules/typescript/bin/tsc\" -b",
+    "build:transpile": "node \"../../node_modules/esbuild/bin/esbuild\" --format=cjs --target=es2022 --bundle --log-level=error --outfile=dist/cjs/lib/index.js lib/index.ts"
   },
   "dependencies": {
     "chevrotain": "^11.0.3"
   },
-  "gitHead": "36ec1aae80524a84f044182811a55ebeef6d9cda"
+  "devDependencies": {
+    "esbuild": "^0.27.0"
+  },
+  "gitHead": "52cfb2b513294dc154febc0209ac811ceeb6785b"
 }

package/LICENSE.txt

@@ -1,22 +0,0 @@
-The MIT License (MIT)
-
-Copyright © 2024–now Jitse De Smet
-Comunica Association and Ghent University – imec, Belgium
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.