feat!: wip first naive json db semantic-conv #63
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CptSchnitz
changed the title
CptSchnitz
requested changes
Apr 8, 2024
package.json
Outdated
| @@ -11,11 +21,14 @@ | |||
| "lint": "eslint .", | |||
| "lint:fix": "eslint --fix .", | |||
| "release": "standard-version", | |||
| "prebuild": "npm run clean", | |||
| "prebuild": "npm run clean && npm run validate && npm run generateTypes && npm run generateAttributes", | |||
There was a problem hiding this comment.
generate types should not run in prebuild.
package.json
Outdated
Comment on lines
29
to
30
| "generateAttributes": "node --import=tsimp/import scripts/build-semantic-conventions.mts", | ||
| "generateTypes": "json2ts schemas/attribute.schema.json > scripts/autogen.mts", |
There was a problem hiding this comment.
lets change is so the format of the name is generate:types like with format and lint
schemas/attribute.schema.json
Outdated
There was a problem hiding this comment.
Add descriptions to the various fields
src/semanticConventions/README.md
Outdated
Comment on lines
8
to
89
| ## example | ||
| Below are short examples for schema definition and domain.json files. | ||
|
|
||
| ### Some json-schema definition | ||
| ```json | ||
| { | ||
| "$schema": "http://json-schema.org/draft-07/schema", | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "title": "cat family hierarchy schema", | ||
| "required": ["clan", "content"], | ||
| "properties": { | ||
| "clan": { | ||
| "type": "string" | ||
| }, | ||
| "content": { | ||
| "$ref": "#/definitions/recursive" | ||
| } | ||
| }, | ||
| "definitions": { | ||
| "recursive": { | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "title": "clan tree", | ||
| "required": ["propertyName", "description"], | ||
| "properties": { | ||
| "propertyName": { | ||
| "type": "string" | ||
| }, | ||
| "kind": { | ||
| "type": "string" | ||
| }, | ||
| "description": { | ||
| "type": "string" | ||
| }, | ||
| "deprecated": { | ||
| "type": "boolean" | ||
| }, | ||
| "subAttributes": { | ||
| "type": "object", | ||
| "additionalProperties": { | ||
| "$ref": "#/definitions/recursive" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Convert json-schema definition into typescripts | ||
| running CLI (json2ts) | ||
|
|
||
| ```bash | ||
| npx json2ts schemas/cats.schema.json > scripts/cats.mts | ||
| ``` | ||
|
|
||
| Will expect ts autogenerated module with types | ||
|
|
||
| ```typescript | ||
| /* eslint-disable */ | ||
| /** | ||
| * This file was automatically generated by json-schema-to-typescript. | ||
| * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, | ||
| * and run json-schema-to-typescript to regenerate this file. | ||
| */ | ||
|
|
||
| export interface ConventionSchema { | ||
| domain?: string; | ||
| content: AttributeDescription; | ||
| } | ||
| export interface AttributeDescription { | ||
| propertyName: string; | ||
| kind?: string; | ||
| description: string; | ||
| deprecated?: boolean; | ||
| subAttributes?: { | ||
| [k: string]: AttributeDescription; | ||
| }; | ||
| } | ||
| ``` | ||
|
|
There was a problem hiding this comment.
As we talked, this is not needed, only short section on when and how to generate types
Co-authored-by: Ofer <[email protected]>
Co-authored-by: Ofer <[email protected]>
Co-authored-by: Ofer <[email protected]>
Co-authored-by: Ofer <[email protected]>
Co-authored-by: Ofer <[email protected]>
Co-authored-by: Ofer <[email protected]>
Co-authored-by: Ofer <[email protected]>
Co-authored-by: Ofer <[email protected]>
Co-authored-by: Ofer <[email protected]>
…emetry into semanticsAttributesInfra
…emetry into semanticsAttributesInfra
|
If this a WIP, then please don't add the |
I added this as the ts config changes breaks existing code. |
Ok, NP. |
shimoncohen
requested changes
Apr 9, 2024
Co-authored-by: Shimon Cohen <[email protected]>
Co-authored-by: Shimon Cohen <[email protected]>
Co-authored-by: Shimon Cohen <[email protected]>
Co-authored-by: Shimon Cohen <[email protected]>
Co-authored-by: Shimon Cohen <[email protected]>
Co-authored-by: Shimon Cohen <[email protected]>
Co-authored-by: Shimon Cohen <[email protected]>
…emetry into semanticsAttributesInfra
CptSchnitz
approved these changes
Apr 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MapColonies implementaion for semantic convention of project attributes
first imlementation of static db (json) based.
Raster domain oriented