fix readme

comunica · Feb 6, 2025 · c55d795 · c55d795
1 parent f0fc724
commit c55d795
Show file tree

Hide file tree

Showing 35 changed files with 66 additions and 104 deletions.
diff --git a/engines/engine-sparql-1-1/README.md b/engines/engine-sparql-1-1/README.md
diff --git a/engines/generator-sparql-1-1/README.md b/engines/generator-sparql-1-1/README.md
@@ -0,0 +1,39 @@
+# TRAQULA SPARQL 1.1 generator
+
+TRAQULA Generator Sparql 1.1 is a [SPARQL 1.1](https://www.w3.org/TR/sparql11-query/#grammar) query generator for TypeScript.
+It can generate SPARQL given the AST created by [TRAQULA parser SPARQL 1-1](https://github.com/comunica/traqula/tree/main/engines/parser-sparql-1-1).
+
+## Installation
+
+```bash
+npm install @traqula/generator-sparql-1-1
+```
+
+or
+
+```bash
+yarn add @traqula/generator-sparql-1-1
+```
+
+## Import
+
+Either through ESM import:
+
+```javascript
+import {Parser} from 'engines/generator-sparql-1-1';
+```
+
+_or_ CJS require:
+
+```javascript
+const Parser = require('engines/generator-sparql-1-1').Parser;
+```
+
+## Usage
+
+This package contains a `Generator` that is able to generate SPARQL 1.1 queries:
+
+```typescript
+const generator = new Generator();
+const abstractSyntaxTree = generator.generate(abstractSyntaxTree);
+```
diff --git a/...s/engine-generate-sparql-1-1/lib/index.ts → engines/generator-sparql-1-1/lib/index.ts b/...s/engine-generate-sparql-1-1/lib/index.ts → engines/generator-sparql-1-1/lib/index.ts
diff --git a/...s/engine-generate-sparql-1-1/package.json → engines/generator-sparql-1-1/package.json b/...s/engine-generate-sparql-1-1/package.json → engines/generator-sparql-1-1/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@traqula/engine-generate-sparql-1-1",
+  "name": "@traqula/generator-sparql-1-1",
   "type": "module",
   "version": "0.0.0",
   "description": "SPARQL 1.1 generator",
@@ -8,7 +8,7 @@
   "repository": {
     "type": "git",
     "url": "git+https://github.com/comunica/traqula.git",
-    "directory": "engines/engine-generate-sparql-1-1"
+    "directory": "engines/generator-sparql-1-1"
   },
   "bugs": {
     "url": "https://github.com/comunica/traqula/issues"
@@ -42,7 +42,7 @@
     "@traqula/rules-sparql-1-1": "^0.0.0"
   },
   "devDependencies": {
-    "@traqula/engine-sparql-1-1": "^0.0.0",
+    "@traqula/parser-sparql-1-1": "^0.0.0",
     "@traqula/rules-sparql-1-1": "^0.0.0"
   }
 }
diff --git a/...erate-sparql-1-1/test/integration.test.ts → ...rator-sparql-1-1/test/integration.test.ts b/...erate-sparql-1-1/test/integration.test.ts → ...rator-sparql-1-1/test/integration.test.ts
@@ -1,4 +1,4 @@
-import { Parser } from '@traqula/engine-sparql-1-1';
+import { Parser } from '@traqula/parser-sparql-1-1';
 import type * as T11 from '@traqula/rules-sparql-1-1';
 import { describe, it } from 'vitest';
 import { Generator } from '../lib';

diff --git a/engines/engine-sparql-1-1-adjust/README.md → engines/parser-sparql-1-1-adjust/README.md b/engines/engine-sparql-1-1-adjust/README.md → engines/parser-sparql-1-1-adjust/README.md
@@ -1,32 +1,32 @@
 # TRAQULA parser engine for SPARQL 1.1 + Adjust
 
 TRAQULA Sparql 1.1 Adjust is a [SPARQL 1.1](https://www.w3.org/TR/sparql11-query/#grammar) query parser that also parses the [builtin function ADJUST](https://github.com/w3c/sparql-dev/blob/main/SEP/SEP-0002/sep-0002.md) for TypeScript.
-Simple grammar extension of [TRAQULA engine-sparql-1-1](https://github.com/comunica/traqula/tree/main/engines/engine-sparql-1-1)
+Simple grammar extension of [TRAQULA engine-sparql-1-1](https://github.com/comunica/traqula/tree/main/engines/parser-sparql-1-1)
 
 ## Installation
 
 ```bash
-npm install @traqula/engine-sparql-1-1
+npm install @traqula/parser-sparql-1-1-adjust
 ```
 
 or
 
 ```bash
-yarn add @traqula/engine-sparql-1-1
+yarn add @traqula/parser-sparql-1-1-adjust
 ```
 
 ## Import
 
 Either through ESM import:
 
 ```typescript
-import { Parser } from '@traqula/engine-sparql-1-1-adjust';
+import { Parser } from '@traqula/parser-sparql-1-1-adjust';
 ```
 
 _or_ CJS require:
 
 ```typescript
-const Sparql11AdjustParser = require('@traqula/engine-sparql-1-1-adjust').Parser;
+const Sparql11AdjustParser = require('@traqula/parser-sparql-1-1-adjust').Parser;
 ```
 
 ## Usage

diff --git a/...es/engine-sparql-1-1-adjust/lib/Parser.ts → ...es/parser-sparql-1-1-adjust/lib/Parser.ts b/...es/engine-sparql-1-1-adjust/lib/Parser.ts → ...es/parser-sparql-1-1-adjust/lib/Parser.ts
@@ -1,5 +1,5 @@
 import { Builder, LexerBuilder } from '@traqula/core';
-import { sparql11ParserBuilder } from '@traqula/engine-sparql-1-1';
+import { sparql11ParserBuilder } from '@traqula/parser-sparql-1-1';
 import type { Expression, gram as g11, SparqlQuery } from '@traqula/rules-sparql-1-1';
 import { lex as l11, SparqlParser } from '@traqula/rules-sparql-1-1';
 import { gram, lex } from '@traqula/rules-sparql-1-1-adjust';

diff --git a/...nes/engine-sparql-1-1-adjust/lib/index.ts → ...nes/parser-sparql-1-1-adjust/lib/index.ts b/...nes/engine-sparql-1-1-adjust/lib/index.ts → ...nes/parser-sparql-1-1-adjust/lib/index.ts
diff --git a/...nes/engine-sparql-1-1-adjust/package.json → ...nes/parser-sparql-1-1-adjust/package.json b/...nes/engine-sparql-1-1-adjust/package.json → ...nes/parser-sparql-1-1-adjust/package.json
@@ -1,13 +1,13 @@
 {
-  "name": "@traqula/engine-sparql-1-1-adjust",
+  "name": "@traqula/parser-sparql-1-1-adjust",
   "version": "0.0.0",
   "description": "SPARQL 1.1 + ADJUST parser",
   "lsd:module": true,
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/comunica/traqula.git",
-    "directory": "engines/engine-sparql-1-1-adjust"
+    "directory": "engines/parser-sparql-1-1-adjust"
   },
   "bugs": {
     "url": "https://github.com/comunica/traqula/issues"
@@ -43,7 +43,7 @@
   },
   "dependencies": {
     "@traqula/core": "^0.0.0",
-    "@traqula/engine-sparql-1-1": "^0.0.0",
+    "@traqula/parser-sparql-1-1": "^0.0.0",
     "@traqula/rules-sparql-1-1": "^0.0.0",
     "@traqula/rules-sparql-1-1-adjust": "^0.0.0"
   },

diff --git a/...ine-sparql-1-1-adjust/spec/earl-meta.json → ...ser-sparql-1-1-adjust/spec/earl-meta.json b/...ine-sparql-1-1-adjust/spec/earl-meta.json → ...ser-sparql-1-1-adjust/spec/earl-meta.json
diff --git a/...s/engine-sparql-1-1-adjust/spec/parser.ts → ...s/parser-sparql-1-1-adjust/spec/parser.ts b/...s/engine-sparql-1-1-adjust/spec/parser.ts → ...s/parser-sparql-1-1-adjust/spec/parser.ts
diff --git a/...ne-sparql-1-1-adjust/test/statics.test.ts → ...er-sparql-1-1-adjust/test/statics.test.ts b/...ne-sparql-1-1-adjust/test/statics.test.ts → ...er-sparql-1-1-adjust/test/statics.test.ts
diff --git a/engines/engine-generate-sparql-1-1/README.md → engines/parser-sparql-1-1/README.md b/engines/engine-generate-sparql-1-1/README.md → engines/parser-sparql-1-1/README.md
@@ -5,27 +5,27 @@ TRAQULA Sparql 1.1 is a [SPARQL 1.1](https://www.w3.org/TR/sparql11-query/#gramm
 ## Installation
 
 ```bash
-npm install @traqula/engine-sparql-1-1
+npm install @traqula/parser-sparql-1-1
 ```
 
 or
 
 ```bash
-yarn add @traqula/engine-sparql-1-1
+yarn add @traqula/parser-sparql-1-1
 ```
 
 ## Import
 
 Either through ESM import:
 
 ```javascript
-import { Parser } from '@traqula/engine-sparql-1-1';
+import {Parser} from 'engines/parser-sparql-1-1';
 ```
 
 _or_ CJS require:
 
 ```javascript
-const Parser = require('@traqula/engine-sparql-1-1').Parser;
+const Parser = require('engines/parser-sparql-1-1').Parser;
 ```
 
 ## Usage

diff --git a/engines/engine-sparql-1-1/lib/Parser.ts → engines/parser-sparql-1-1/lib/Parser.ts b/engines/engine-sparql-1-1/lib/Parser.ts → engines/parser-sparql-1-1/lib/Parser.ts
diff --git a/...engine-sparql-1-1/lib/expressionParser.ts → ...parser-sparql-1-1/lib/expressionParser.ts b/...engine-sparql-1-1/lib/expressionParser.ts → ...parser-sparql-1-1/lib/expressionParser.ts
diff --git a/engines/engine-sparql-1-1/lib/index.ts → engines/parser-sparql-1-1/lib/index.ts b/engines/engine-sparql-1-1/lib/index.ts → engines/parser-sparql-1-1/lib/index.ts
diff --git a/...engine-sparql-1-1/lib/objectListParser.ts → ...parser-sparql-1-1/lib/objectListParser.ts b/...engine-sparql-1-1/lib/objectListParser.ts → ...parser-sparql-1-1/lib/objectListParser.ts
diff --git a/.../engine-sparql-1-1/lib/queryUnitParser.ts → .../parser-sparql-1-1/lib/queryUnitParser.ts b/.../engine-sparql-1-1/lib/queryUnitParser.ts → .../parser-sparql-1-1/lib/queryUnitParser.ts
diff --git a/.../engine-sparql-1-1/lib/subSelectParser.ts → .../parser-sparql-1-1/lib/subSelectParser.ts b/.../engine-sparql-1-1/lib/subSelectParser.ts → .../parser-sparql-1-1/lib/subSelectParser.ts
diff --git a/...gine-sparql-1-1/lib/triplesBlockParser.ts → ...rser-sparql-1-1/lib/triplesBlockParser.ts b/...gine-sparql-1-1/lib/triplesBlockParser.ts → ...rser-sparql-1-1/lib/triplesBlockParser.ts
diff --git a/...l-1-1/lib/triplesTemplateParserBuilder.ts → ...l-1-1/lib/triplesTemplateParserBuilder.ts b/...l-1-1/lib/triplesTemplateParserBuilder.ts → ...l-1-1/lib/triplesTemplateParserBuilder.ts
diff --git a/...ne-sparql-1-1/lib/updateNoModifyParser.ts → ...er-sparql-1-1/lib/updateNoModifyParser.ts b/...ne-sparql-1-1/lib/updateNoModifyParser.ts → ...er-sparql-1-1/lib/updateNoModifyParser.ts
diff --git a/...engine-sparql-1-1/lib/updateUnitParser.ts → ...parser-sparql-1-1/lib/updateUnitParser.ts b/...engine-sparql-1-1/lib/updateUnitParser.ts → ...parser-sparql-1-1/lib/updateUnitParser.ts
diff --git a/engines/engine-sparql-1-1/package.json → engines/parser-sparql-1-1/package.json b/engines/engine-sparql-1-1/package.json → engines/parser-sparql-1-1/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@traqula/engine-sparql-1-1",
+  "name": "@traqula/parser-sparql-1-1",
   "type": "module",
   "version": "0.0.0",
   "description": "SPARQL 1.1 parser",
@@ -8,7 +8,7 @@
   "repository": {
     "type": "git",
     "url": "git+https://github.com/comunica/traqula.git",
-    "directory": "engines/engine-sparql-1-1"
+    "directory": "engines/parser-sparql-1-1"
   },
   "bugs": {
     "url": "https://github.com/comunica/traqula/issues"

diff --git a/...nes/engine-sparql-1-1/spec/earl-meta.json → ...nes/parser-sparql-1-1/spec/earl-meta.json b/...nes/engine-sparql-1-1/spec/earl-meta.json → ...nes/parser-sparql-1-1/spec/earl-meta.json
diff --git a/engines/engine-sparql-1-1/spec/parser.ts → engines/parser-sparql-1-1/spec/parser.ts b/engines/engine-sparql-1-1/spec/parser.ts → engines/parser-sparql-1-1/spec/parser.ts
diff --git a/...nes/engine-sparql-1-1/test/query.bench.ts → ...nes/parser-sparql-1-1/test/query.bench.ts b/...nes/engine-sparql-1-1/test/query.bench.ts → ...nes/parser-sparql-1-1/test/query.bench.ts
diff --git a/...es/engine-sparql-1-1/test/statics.test.ts → ...es/parser-sparql-1-1/test/statics.test.ts b/...es/engine-sparql-1-1/test/statics.test.ts → ...es/parser-sparql-1-1/test/statics.test.ts
diff --git a/engines/engine-sparql-1-2/README.md → engines/parser-sparql-1-2/README.md b/engines/engine-sparql-1-2/README.md → engines/parser-sparql-1-2/README.md
@@ -6,27 +6,27 @@ It is a grammar extension of [TRAQULA engine-sparql-1-1](https://github.com/comu
 ## Installation
 
 ```bash
-npm install @traqula/engine-sparql-1-1
+npm install @traqula/parser-sparql-1-1
 ```
 
 or
 
 ```bash
-yarn add @traqula/engine-sparql-1-1
+yarn add @traqula/parser-sparql-1-1
 ```
 
 ## Import
 
 Either through ESM import:
 
 ```typescript
-import { Parser } from '@traqula/engine-sparql-1-2';
+import {Parser} from '';
 ```
 
 _or_ CJS require:
 
 ```typescript
-const Parser = require('@traqula/engine-sparql-1-2').Parser;
+const Parser = require('').Parser;
 ```
 
 ## Usage

diff --git a/engines/engine-sparql-1-2/lib/Parser.ts → engines/parser-sparql-1-2/lib/Parser.ts b/engines/engine-sparql-1-2/lib/Parser.ts → engines/parser-sparql-1-2/lib/Parser.ts
@@ -1,5 +1,5 @@
 import { Builder } from '@traqula/core';
-import { sparql11ParserBuilder } from '@traqula/engine-sparql-1-1';
+import { sparql11ParserBuilder } from '@traqula/parser-sparql-1-1';
 import type { SparqlQuery } from '@traqula/rules-sparql-1-1';
 import { gram as g11, SparqlParser } from '@traqula/rules-sparql-1-1';
 import { gram as S12, lex as l12 } from '@traqula/rules-sparql-1-2';

diff --git a/engines/engine-sparql-1-2/lib/index.ts → engines/parser-sparql-1-2/lib/index.ts b/engines/engine-sparql-1-2/lib/index.ts → engines/parser-sparql-1-2/lib/index.ts
diff --git a/engines/engine-sparql-1-2/package.json → engines/parser-sparql-1-2/package.json b/engines/engine-sparql-1-2/package.json → engines/parser-sparql-1-2/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@traqula/engine-sparql-1-2",
+  "name": "@traqula/parser-sparql-1-2",
   "type": "module",
   "version": "0.0.0",
   "description": "SPARQL 1.2 parser",
@@ -8,7 +8,7 @@
   "repository": {
     "type": "git",
     "url": "git+https://github.com/comunica/traqula.git",
-    "directory": "engines/engine-sparql-1-2"
+    "directory": "engines/parser-sparql-1-2"
   },
   "bugs": {
     "url": "https://github.com/comunica/traqula/issues"
@@ -49,7 +49,7 @@
   },
   "dependencies": {
     "@traqula/core": "^0.0.0",
-    "@traqula/engine-sparql-1-1": "^0.0.0",
+    "@traqula/parser-sparql-1-1": "^0.0.0",
     "@traqula/rules-sparql-1-1": "^0.0.0",
     "@traqula/rules-sparql-1-2": "^0.0.0",
     "rdf-data-factory": "^2.0.1"

diff --git a/...nes/engine-sparql-1-2/spec/earl-meta.json → ...nes/parser-sparql-1-2/spec/earl-meta.json b/...nes/engine-sparql-1-2/spec/earl-meta.json → ...nes/parser-sparql-1-2/spec/earl-meta.json
diff --git a/engines/engine-sparql-1-2/spec/parser.ts → engines/parser-sparql-1-2/spec/parser.ts b/engines/engine-sparql-1-2/spec/parser.ts → engines/parser-sparql-1-2/spec/parser.ts
diff --git a/...es/engine-sparql-1-2/test/statics.test.ts → ...es/parser-sparql-1-2/test/statics.test.ts b/...es/engine-sparql-1-2/test/statics.test.ts → ...es/parser-sparql-1-2/test/statics.test.ts