feat!: wip first naive json db semantic-conv (#63)

* feat: wip first naive json db semantic-conv * feat: validation section of schema json * feat: build ts const file * docs(conventions-scripts): add full documentation + wrap code for pr and release * Update README.md Co-authored-by: Ofer <12687466+CptSchnitz@users.noreply.github.com> * Update README.md Co-authored-by: Ofer <12687466+CptSchnitz@users.noreply.github.com> * Update scripts/build-semantic-conventions.mts Co-authored-by: Ofer <12687466+CptSchnitz@users.noreply.github.com> * Update scripts/build-semantic-conventions.mts Co-authored-by: Ofer <12687466+CptSchnitz@users.noreply.github.com> * Update scripts/build-semantic-conventions.mts Co-authored-by: Ofer <12687466+CptSchnitz@users.noreply.github.com> * Update src/semanticConventions/README.md Co-authored-by: Ofer <12687466+CptSchnitz@users.noreply.github.com> * Update src/semanticConventions/README.md Co-authored-by: Ofer <12687466+CptSchnitz@users.noreply.github.com> * Update src/semanticConventions/README.md Co-authored-by: Ofer <12687466+CptSchnitz@users.noreply.github.com> * Update src/semanticConventions/README.md Co-authored-by: Ofer <12687466+CptSchnitz@users.noreply.github.com> * fix(conventions-scripts): pr notes * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * chore: readme * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * fix(conventions-scripts): refactor package.json script terminology * docs: updated semantic readme * Update README.md * docs(conventions-scripts): adding doc string and logging * Update src/semanticConventions/README.md Co-authored-by: Shimon Cohen <33935191+shimoncohen@users.noreply.github.com> * Update src/semanticConventions/README.md Co-authored-by: Shimon Cohen <33935191+shimoncohen@users.noreply.github.com> * Update src/semanticConventions/README.md Co-authored-by: Shimon Cohen <33935191+shimoncohen@users.noreply.github.com> * Update src/semanticConventions/README.md Co-authored-by: Shimon Cohen <33935191+shimoncohen@users.noreply.github.com> * Update src/semanticConventions/README.md Co-authored-by: Shimon Cohen <33935191+shimoncohen@users.noreply.github.com> * Update src/semanticConventions/README.md Co-authored-by: Shimon Cohen <33935191+shimoncohen@users.noreply.github.com> * docs: readme fixes by shimonc Co-authored-by: Shimon Cohen <33935191+shimoncohen@users.noreply.github.com> * docs: fixing readme according to grammerly * fix(conventions-scripts): implement auto docstring on convention objects * Update README.md * Update README.md * Update README.md * Update README.md --------- Co-authored-by: Ofer <12687466+CptSchnitz@users.noreply.github.com> Co-authored-by: Shimon Cohen <33935191+shimoncohen@users.noreply.github.com>
MapColonies · Apr 14, 2024 · 646f441 · 646f441
1 parent 045e3d4
commit 646f441
Show file tree

Hide file tree

Showing 17 changed files with 1,674 additions and 40 deletions.
diff --git a/.gitignore b/.gitignore
@@ -105,3 +105,12 @@ dist
 
 # reports of jest tests
 reports
+
+# dev utils
+.tsimp
+
+# doc utils
+docs
+
+# semanticConventions
+src/semanticConventions/**/*.ts
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,12 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["src/semanticConventions/**/*.json"],
+      "url": "./schemas/attribute.schema.json"
+    }
+  ],
+  "files.associations": {
+    "**/src/semanticAttributes/**/*.json": "jsonc"
+  },
+  "typescript.tsdk": "node_modules/typescript/lib"
+}
diff --git a/README.md b/README.md
@@ -55,6 +55,13 @@ counter.add(1);
 
 metrics.stop().then(() => console.log('done'));
 ```
+
+## Semantic Conventions
+#### The package's Semantic Conventions submodule defines a common set of (semantic) attributes which provide meaning to data when collecting, producing and consuming it.
+Based on the [official OpenTelemetry conventions](https://opentelemetry.io/docs/specs/semconv/)
+
+[Link to full documentation](src/semanticConventions/README.md)
+
 ## Configuration
 ### Common configuration
 | name |allowed value| default value | description
@@ -86,3 +93,4 @@ metrics.stop().then(() => console.log('done'));
 Run the command `npm run release --` to bump the version in all the files and create a changelog.
 
 For more detailed documentation and examples check: https://github.com/conventional-changelog/standard-version
+
diff --git a/commitlint.config.js b/commitlint.config.js
@@ -1,6 +1,6 @@
 module.exports = {
   extends: ["@commitlint/config-conventional"],
   rules: {
-    "scope-enum": [2, "always", ["deps", "configurations", "tracing", "metrics"]],
+    "scope-enum": [2, "always", ["deps", "configurations", "tracing", "metrics", "conventions","conventions-scripts"]],
   },
 };