ts_schema_spec 0.6.1 → 0.6.2
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.
- checksums.yaml +4 -4
- data/README.md +17 -17
- data/lib/ts_schema_spec/version.rb +1 -1
- data/skills/ts-schema-spec/SKILL.md +3 -3
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1d8e48873074ac373b562a69c895679dc7afbe1a21d81df9910f8e9f766c2fcc
|
|
4
|
+
data.tar.gz: bdc53ec65a7c01ff8c63d9ce95525cf01587d25bbf0726b7566a129724401fff
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 482f0478728009f5bc10ac65f2a9046c5c1d28393d394bddfbd3c59ad4f029a26d9b9eb9587006d4b065756c3b6e6fc59eea95fc60e4f136b8454760cc7eb0e7
|
|
7
|
+
data.tar.gz: 6a65b04776bd6c9eb5c12a6bf96b97cbd939d6e7215171e71e71c10f8fbee8f9c4925bb59444110714d262a05e4c0793d73c62da394b48798271bb689d56012c
|
data/README.md
CHANGED
|
@@ -148,14 +148,14 @@ empty array.
|
|
|
148
148
|
|
|
149
149
|
## API
|
|
150
150
|
|
|
151
|
-
| Call
|
|
152
|
-
|
|
|
153
|
-
| `TsSchemaSpec.schema_for(path, type)`
|
|
154
|
-
| `match_ts_schema(path, type)`
|
|
155
|
-
| `react_component_props(name[, html])`
|
|
156
|
-
| `TsSchemaSpec::Skill.check!(root)`
|
|
157
|
-
| `TsSchemaSpec.configure`
|
|
158
|
-
| `TsSchemaSpec.clear_cache!`
|
|
151
|
+
| Call | Returns |
|
|
152
|
+
| ------------------------------------- | ---------------------------------------------------- |
|
|
153
|
+
| `TsSchemaSpec.schema_for(path, type)` | a `JSONSchemer` schema scoped to that exported type |
|
|
154
|
+
| `match_ts_schema(path, type)` | matcher; validates a hash, or every item of an array |
|
|
155
|
+
| `react_component_props(name[, html])` | array of props hashes, one per mount |
|
|
156
|
+
| `TsSchemaSpec::Skill.check!(root)` | raises if the installed skill is stale or missing |
|
|
157
|
+
| `TsSchemaSpec.configure` | sets `tsconfig` and extra generator arguments |
|
|
158
|
+
| `TsSchemaSpec.clear_cache!` | drops the generated-schema cache |
|
|
159
159
|
|
|
160
160
|
`match_ts_schema` was called `match_schema` before 0.6.1. The old name still
|
|
161
161
|
works but is deprecated and will be removed.
|
|
@@ -246,14 +246,14 @@ The cache lives in the process, so parallel test workers each pay for it once.
|
|
|
246
246
|
|
|
247
247
|
## Troubleshooting
|
|
248
248
|
|
|
249
|
-
| Symptom
|
|
250
|
-
|
|
|
251
|
-
| `GenerationError: ... Is it exported?`
|
|
252
|
-
| `GenerationError` listing a rerunnable command
|
|
253
|
-
| passes against an obviously wrong payload
|
|
254
|
-
| `could not run npx ts-json-schema-generator`
|
|
255
|
-
| `disallowed additional property`
|
|
256
|
-
| `has no data-react-props attribute`
|
|
249
|
+
| Symptom | Cause |
|
|
250
|
+
| ---------------------------------------------- | -------------------------------------------------------------- |
|
|
251
|
+
| `GenerationError: ... Is it exported?` | the type has no `export`, or the name is misspelled |
|
|
252
|
+
| `GenerationError` listing a rerunnable command | run it — the generator's own stderr is in the message |
|
|
253
|
+
| passes against an obviously wrong payload | the type is all-optional, or an unresolved import became `{}` |
|
|
254
|
+
| `could not run npx ts-json-schema-generator` | the generator is not in your `node_modules` |
|
|
255
|
+
| `disallowed additional property` | see above — the payload sends what TypeScript does not declare |
|
|
256
|
+
| `has no data-react-props attribute` | hand-written markup, or a mount from another integration |
|
|
257
257
|
|
|
258
258
|
## What this can't catch
|
|
259
259
|
|
|
@@ -263,7 +263,7 @@ Worth knowing before you rely on it.
|
|
|
263
263
|
a spec for; an uncovered endpoint is exactly as exposed as before. That is what
|
|
264
264
|
the skill is for, and it is convention rather than enforcement.
|
|
265
265
|
|
|
266
|
-
**It only checks what TypeScript declares.** If Rails
|
|
266
|
+
**It only checks what TypeScript declares.** If Rails _intends_ to send a field
|
|
267
267
|
nobody typed — say `as_json(only:)` carrying a misspelled attribute, which
|
|
268
268
|
Rails drops silently — no generated schema requires it, so nothing fails. A
|
|
269
269
|
structured serializer catches that class of mistake; this does not.
|
|
@@ -65,9 +65,9 @@ implying the spec covers them.
|
|
|
65
65
|
|
|
66
66
|
## Step 4 — Write the test
|
|
67
67
|
|
|
68
|
-
| Action
|
|
69
|
-
|
|
|
70
|
-
| `render json:`
|
|
68
|
+
| Action | Data source |
|
|
69
|
+
| ----------------- | ---------------------------------------- |
|
|
70
|
+
| `render json:` | `response.parsed_body["key"]` |
|
|
71
71
|
| `react_component` | `react_component_props("ComponentName")` |
|
|
72
72
|
|
|
73
73
|
`react_component_props` returns **an array**, one entry per mount, and needs
|