@rline/schema 1.0.0 → 8.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +61 -3
  2. package/package.json +3 -20
  3. package/schema-config.schema.json +3 -0
package/README.md CHANGED
@@ -1,17 +1,75 @@
1
+ <div align="center">
2
+ <img src="https://raw.githubusercontent.com/rbrightline/common/refs/heads/main/libs/schema/favicon.png" alt="Logo" width="200"/>
3
+ </div>
4
+
1
5
  # @rline/schema
2
6
 
3
- - [ ] add description for the library
7
+ - Commonly used schemas
4
8
 
5
9
  ## Installation
6
10
 
11
+ You do not need to install the package to use schemas
12
+
7
13
  ```shell
8
14
  pnpm add @rline/schema
9
15
  ```
10
16
 
11
17
  ## Usage
12
18
 
13
- - [ ] add example for the librarys
19
+ JSON
20
+
21
+ ```json
22
+ {
23
+ "$schema": "https://raw.githubusercontent.com/rbrightline/common/refs/heads/main/libs/schema/schema-config.schema.json"
24
+ }
25
+ ```
26
+
27
+ YAML
28
+
29
+ ```yaml
30
+ # yaml-language-server: $schema=https://raw.githubusercontent.com/rbrightline/common/refs/heads/main/libs/schema/schema-config.schema.json
31
+ ```
32
+
33
+ ## Local Usage
14
34
 
15
- ```typescript
35
+ JSON
16
36
 
37
+ ```json
38
+ {
39
+ "$schema": "./node_modules/@rline/schema/schema-config.schema.json"
40
+ }
17
41
  ```
42
+
43
+ YAML
44
+
45
+ ```yaml
46
+ # yaml-language-server: $schema=./node_modules/@rline/schema/schema-config.schema.json
47
+ ```
48
+
49
+ ## CDN
50
+
51
+ - `https://raw.githubusercontent.com/rbrightline/common/refs/heads/main/libs/schema/icon.schema.json`
52
+ - `https://raw.githubusercontent.com/rbrightline/common/refs/heads/main/libs/schema/input-type.schema.json`
53
+ - `https://raw.githubusercontent.com/rbrightline/common/refs/heads/main/libs/schema/number-format.schema.json`
54
+ - `https://raw.githubusercontent.com/rbrightline/common/refs/heads/main/libs/schema/string-format.schema.json`
55
+ - `https://raw.githubusercontent.com/rbrightline/common/refs/heads/main/libs/schema/schema-config.schema.json`
56
+ - `https://raw.githubusercontent.com/rbrightline/common/refs/heads/main/libs/schema/unit.schema.json`
57
+ - `https://raw.githubusercontent.com/rbrightline/common/refs/heads/main/libs/schema/property.schema.json`
58
+ - `https://raw.githubusercontent.com/rbrightline/common/refs/heads/main/libs/schema/model.schema.json`
59
+ - `https://raw.githubusercontent.com/rbrightline/common/refs/heads/main/libs/schema/project.schema.json`
60
+ - `https://raw.githubusercontent.com/rbrightline/common/refs/heads/main/libs/schema/server.schema.json`
61
+ - `https://raw.githubusercontent.com/rbrightline/common/refs/heads/main/libs/schema/security.schema.json`
62
+
63
+ ## Local
64
+
65
+ - `./node_modules/@rline/schema/icon.schema.json`
66
+ - `./node_modules/@rline/schema/input-type.schema.json`
67
+ - `./node_modules/@rline/schema/number-format.schema.json`
68
+ - `./node_modules/@rline/schema/string-format.schema.json`
69
+ - `./node_modules/@rline/schema/schema-config.schema.json`
70
+ - `./node_modules/@rline/schema/unit.schema.json`
71
+ - `./node_modules/@rline/schema/property.schema.json`
72
+ - `./node_modules/@rline/schema/model.schema.json`
73
+ - `./node_modules/@rline/schema/project.schema.json`
74
+ - `./node_modules/@rline/schema/server.schema.json`
75
+ - `./node_modules/@rline/schema/security.schema.json`
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "@rline/schema",
3
- "version": "1.0.0",
3
+ "version": "8.0.1",
4
4
  "description": "Project description",
5
5
  "author": {
6
6
  "email": "robert.brightline@gmail.com",
7
7
  "name": "Robert Brightline",
8
8
  "url": "https://rbrightline.github.io"
9
9
  },
10
- "homepage": "https://rbrightline.github.io/rline/schema",
10
+ "homepage": "https://rbrightline.github.io/common/schema",
11
11
  "repository": {
12
12
  "url": "https://github.com/rbrightline/common/tree/main/libs/schema",
13
13
  "type": "github"
@@ -34,25 +34,8 @@
34
34
  "default": "./dist/index.js"
35
35
  }
36
36
  },
37
- "module": "./dist/index.js",
38
37
  "nx": {
39
- "sourceRoot": "libs/schema/src",
40
38
  "projectType": "library",
41
- "targets": {
42
- "build": {
43
- "executor": "@nx/js:swc",
44
- "outputs": [
45
- "{options.outputPath}"
46
- ],
47
- "options": {
48
- "outputPath": "libs/schema/dist",
49
- "main": "libs/schema/src/index.ts",
50
- "tsConfig": "libs/schema/tsconfig.lib.json",
51
- "skipTypeCheck": true,
52
- "stripLeadingPaths": true
53
- }
54
- }
55
- },
56
39
  "name": "schema"
57
40
  }
58
- }
41
+ }
package/schema-config.schema.json CHANGED
@@ -3,6 +3,9 @@
3
3
  "title": "SchemaCompilerConfig",
4
4
  "description": "Schema is for the `@rline/json` schema compiler. This file is generated using `json init`",
5
5
  "properties": {
6
+ "$schema": {
7
+ "type": "string"
8
+ },
6
9
  "root": {
7
10
  "type": "string",
8
11
  "description": "Project's root directory, the relative path to the directory of the main schema file such as `./schemas` and `./src`"