add more readmes

comunica · Jan 14, 2025 · 2423a35 · 2423a35
1 parent 1c8da8d
commit 2423a35
Showing 13 changed files with 62 additions and 26 deletions.
diff --git a/engines/engine-sparql-1-1-adjust/package.json b/engines/engine-sparql-1-1-adjust/package.json
@@ -42,8 +42,5 @@
     "@traqula/rules-sparql-1-1": "workspace:^",
     "chevrotain": "^11.0.3",
     "rdf-data-factory": "^2.0.1"
-  },
-  "devDependencies": {
-    "@rdfjs/types": "^2.0.0"
   }
 }
diff --git a/engines/engine-sparql-1-1/package.json b/engines/engine-sparql-1-1/package.json
@@ -49,7 +49,6 @@
     "rdf-data-factory": "^2.0.1"
   },
   "devDependencies": {
-    "@rdfjs/types": "^2.0.0",
     "@traqula/test-utils": "workspace:^"
   }
 }
diff --git a/engines/engine-sparql-1-2/package.json b/engines/engine-sparql-1-2/package.json
@@ -47,8 +47,5 @@
     "@traqula/rules-sparql-1-1": "workspace:^",
     "chevrotain": "^11.0.3",
     "rdf-data-factory": "^2.0.1"
-  },
-  "devDependencies": {
-    "@rdfjs/types": "^2.0.0"
   }
 }
diff --git a/package.json b/package.json
@@ -14,6 +14,7 @@
     "build:ts": "tsc",
     "build:transpile": "yarn workspaces foreach --all -pt run build:transpile",
     "build:transpile-spec": "yarn workspaces foreach --all -pt --include \"engines/*\" run build:transpile-spec",
+    "version": "yarn workspaces foreach --all -pt version $1",
     "publish": "yarn workspaces foreach --all -pt npm publish",
     "clean": "git clean -dfx",
     "lint": "eslint . --cache",

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -37,8 +37,5 @@
   "dependencies": {
     "chevrotain": "^11.0.3",
     "rdf-data-factory": "^2.0.1"
-  },
-  "devDependencies": {
-    "@rdfjs/types": "^2.0.0"
   }
 }
diff --git a/packages/rules-sparal-1-1-adjust/README.md b/packages/rules-sparal-1-1-adjust/README.md
@@ -0,0 +1,16 @@
+# TRAQULA Rules SPARQL 1.1 + ADJUST package
+
+TRAQULA rules SPARQL 1.1 + ADJUST contains additional rules required for creating a parser for
+SPARQL 1.1 + ADJUST function from the SPARQL 1.1 rules.
+
+## Installation
+
+```bash
+npm install @traqula/rules-sparql-1-1-adjust
+```
+
+or
+
+```bash
+yarn add @traqula/rules-sparql-1-1-adjust
+```
diff --git a/packages/rules-sparal-1-1-adjust/package.json b/packages/rules-sparal-1-1-adjust/package.json
@@ -39,8 +39,5 @@
     "@traqula/rules-sparql-1-1": "workspace:^",
     "chevrotain": "^11.0.3",
     "rdf-data-factory": "^2.0.1"
-  },
-  "devDependencies": {
-    "@rdfjs/types": "^2.0.0"
   }
 }
diff --git a/packages/rules-sparql-1-1/README.md b/packages/rules-sparql-1-1/README.md
@@ -0,0 +1,15 @@
+# TRAQULA Rules SPARQL 1.1
+
+TRAQULA rules SPARQL 1.1 contains rules required for creating a parser for SPARQL 1.1.
+
+## Installation
+
+```bash
+npm install @traqula/rules-sparql-1-1
+```
+
+or
+
+```bash
+yarn add @traqula/rules-sparql-1-1
+```
diff --git a/packages/rules-sparql-1-1/package.json b/packages/rules-sparql-1-1/package.json
@@ -38,8 +38,5 @@
     "@traqula/core": "workspace:^",
     "chevrotain": "^11.0.3",
     "rdf-data-factory": "^2.0.1"
-  },
-  "devDependencies": {
-    "@rdfjs/types": "^2.0.0"
   }
 }
diff --git a/packages/rules-sparql-1-2/README.md b/packages/rules-sparql-1-2/README.md
@@ -0,0 +1,15 @@
+# TRAQULA Rules SPARQL 1.2 package
+
+TRAQULA rules SPARQL 1.2 contains additional rules required for creating a parser for SPARQL 1.2 from the SPARQL 1.1 rules.
+
+## Installation
+
+```bash
+npm install @traqula/rules-sparql-1-2
+```
+
+or
+
+```bash
+yarn add @traqula/rules-sparql-1-2
+```
diff --git a/packages/rules-sparql-1-2/package.json b/packages/rules-sparql-1-2/package.json
@@ -39,8 +39,5 @@
     "@traqula/rules-sparql-1-1": "workspace:^",
     "chevrotain": "^11.0.3",
     "rdf-data-factory": "^2.0.1"
-  },
-  "devDependencies": {
-    "@rdfjs/types": "^2.0.0"
   }
 }
diff --git a/packages/test-utils/README.md b/packages/test-utils/README.md
@@ -0,0 +1,15 @@
+# TRAQULA Test utils
+
+TRAQULA test utils contains some developer dependencies for testing packages and engines from the TRAQULA project.
+
+## Installation
+
+```bash
+npm install -D @traqula/test-utils
+```
+
+or
+
+```bash
+yarn add -D @traqula/test-utils
+```
diff --git a/yarn.lock b/yarn.lock
@@ -803,7 +803,6 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@traqula/core@workspace:packages/core"
   dependencies:
-    "@rdfjs/types": "npm:^2.0.0"
     chevrotain: "npm:^11.0.3"
     rdf-data-factory: "npm:^2.0.1"
   languageName: unknown
@@ -813,7 +812,6 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@traqula/engine-sparql-1-1-adjust@workspace:engines/engine-sparql-1-1-adjust"
   dependencies:
-    "@rdfjs/types": "npm:^2.0.0"
     "@traqula/core": "workspace:^"
     "@traqula/rules-sparql-1-1": "workspace:^"
     chevrotain: "npm:^11.0.3"
@@ -825,7 +823,6 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@traqula/engine-sparql-1-1@workspace:engines/engine-sparql-1-1"
   dependencies:
-    "@rdfjs/types": "npm:^2.0.0"
     "@traqula/core": "workspace:^"
     "@traqula/rules-sparql-1-1": "workspace:^"
     "@traqula/test-utils": "workspace:^"
@@ -838,7 +835,6 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@traqula/engine-sparql-1-2@workspace:engines/engine-sparql-1-2"
   dependencies:
-    "@rdfjs/types": "npm:^2.0.0"
     "@traqula/core": "workspace:^"
     "@traqula/rules-sparql-1-1": "workspace:^"
     chevrotain: "npm:^11.0.3"
@@ -850,7 +846,6 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@traqula/rules-sparql-1-1-adjust@workspace:packages/rules-sparal-1-1-adjust"
   dependencies:
-    "@rdfjs/types": "npm:^2.0.0"
     "@traqula/core": "workspace:^"
     "@traqula/rules-sparql-1-1": "workspace:^"
     chevrotain: "npm:^11.0.3"
@@ -862,7 +857,6 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@traqula/rules-sparql-1-1@workspace:packages/rules-sparql-1-1"
   dependencies:
-    "@rdfjs/types": "npm:^2.0.0"
     "@traqula/core": "workspace:^"
     chevrotain: "npm:^11.0.3"
     rdf-data-factory: "npm:^2.0.1"
@@ -873,7 +867,6 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@traqula/rules-sparql-1-2@workspace:packages/rules-sparql-1-2"
   dependencies:
-    "@rdfjs/types": "npm:^2.0.0"
     "@traqula/core": "workspace:^"
     "@traqula/rules-sparql-1-1": "workspace:^"
     chevrotain: "npm:^11.0.3"