ts_schema_spec 0.6.1 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3c86744b3644ad258aa39eff8ff11b55df1cc933003276126f7b1b3d9952d91
-  data.tar.gz: e0a59266d59248a00e092c96b85978bde02bf19d1dd85f6b382addc3ca9fb32b
+  metadata.gz: aa0e8f7875f653a96d983cef0b248b9a1aeeb94afc948ebf1ef1ac3bf75154f3
+  data.tar.gz: 4b0a49cea4dc148e4a28228f9fb877331cf04543e8f906e8ceffd04ba798f8e4
 SHA512:
-  metadata.gz: dbcc3f50c232a8cf847db8804abc4af17140f884c051b414fea6f6cd56d0f93127c2e002b2856c255305dc3685b236329dd2a58dc6e552f99dc11b6d441ccd4d
-  data.tar.gz: 83f7161eebc10dd01d0634fa4eb022c7d5afa5f8ace26690bfa5022c5fa624409f167497dcaf9c2ef2cd3b05ea452dccf7124bd64581c5cba456b162cad2fc97
+  metadata.gz: aeb87cc7d2e5fffc8a0b3c31519fe0b40f0d22f2a44216c32f9129252bff2e25d8327fc1064c61609ac25da881af50d35a2eb56e8fd9b2f14e204a675d7251f0
+  data.tar.gz: 6b5a662b7e8cba8b5a00cf85c4a7f8f33f76738d255a01c46633221e6d46452cf9f4e743b071be8bd8cc046677ef5957f5f407ee71b4ba96f182a55a38b20d4f

data/README.md

@@ -148,14 +148,14 @@ empty array.
 
 ## API
 
-| Call                                    | Returns                                                     |
-| --------------------------------------- | ----------------------------------------------------------- |
-| `TsSchemaSpec.schema_for(path, type)`   | a `JSONSchemer` schema scoped to that exported type          |
-| `match_ts_schema(path, type)`           | matcher; validates a hash, or every item of an array         |
-| `react_component_props(name[, html])`   | array of props hashes, one per mount                         |
-| `TsSchemaSpec::Skill.check!(root)`      | raises if the installed skill is stale or missing            |
-| `TsSchemaSpec.configure`                | sets `tsconfig` and extra generator arguments                |
-| `TsSchemaSpec.clear_cache!`             | drops the generated-schema cache                             |
+| Call                                  | Returns                                              |
+| ------------------------------------- | ---------------------------------------------------- |
+| `TsSchemaSpec.schema_for(path, type)` | a `JSONSchemer` schema scoped to that exported type  |
+| `match_ts_schema(path, type)`         | matcher; validates a hash, or every item of an array |
+| `react_component_props(name[, html])` | array of props hashes, one per mount                 |
+| `TsSchemaSpec::Skill.check!(root)`    | raises if the installed skill is stale or missing    |
+| `TsSchemaSpec.configure`              | sets `tsconfig` and extra generator arguments        |
+| `TsSchemaSpec.clear_cache!`           | drops the generated-schema cache                     |
 
 `match_ts_schema` was called `match_schema` before 0.6.1. The old name still
 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.
 
 ## Troubleshooting
 
-| Symptom                                              | Cause                                                          |
-| ---------------------------------------------------- | -------------------------------------------------------------- |
-| `GenerationError: ... Is it exported?`               | the type has no `export`, or the name is misspelled             |
-| `GenerationError` listing a rerunnable command       | run it — the generator's own stderr is in the message           |
-| passes against an obviously wrong payload            | the type is all-optional, or an unresolved import became `{}`   |
-| `could not run npx ts-json-schema-generator`         | the generator is not in your `node_modules`                     |
-| `disallowed additional property`                     | see above — the payload sends what TypeScript does not declare  |
-| `has no data-react-props attribute`                  | hand-written markup, or a mount from another integration        |
+| Symptom                                        | Cause                                                          |
+| ---------------------------------------------- | -------------------------------------------------------------- |
+| `GenerationError: ... Is it exported?`         | the type has no `export`, or the name is misspelled            |
+| `GenerationError` listing a rerunnable command | run it — the generator's own stderr is in the message          |
+| passes against an obviously wrong payload      | the type is all-optional, or an unresolved import became `{}`  |
+| `could not run npx ts-json-schema-generator`   | the generator is not in your `node_modules`                    |
+| `disallowed additional property`               | see above — the payload sends what TypeScript does not declare |
+| `has no data-react-props attribute`            | hand-written markup, or a mount from another integration       |
 
 ## What this can't catch
 
@@ -263,7 +263,7 @@ Worth knowing before you rely on it.
 a spec for; an uncovered endpoint is exactly as exposed as before. That is what
 the skill is for, and it is convention rather than enforcement.
 
-**It only checks what TypeScript declares.** If Rails *intends* to send a field
+**It only checks what TypeScript declares.** If Rails _intends_ to send a field
 nobody typed — say `as_json(only:)` carrying a misspelled attribute, which
 Rails drops silently — no generated schema requires it, so nothing fails. A
 structured serializer catches that class of mistake; this does not.

data/lib/ts_schema_spec/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TsSchemaSpec
-  VERSION = "0.6.1"
+  VERSION = "0.6.3"
 end

data/skills/ts-schema-spec/SKILL.md

@@ -65,9 +65,9 @@ implying the spec covers them.
 
 ## Step 4 — Write the test
 
-| Action | Data source |
-| ------ | ----------- |
-| `render json:` | `response.parsed_body["key"]` |
+| Action            | Data source                              |
+| ----------------- | ---------------------------------------- |
+| `render json:`    | `response.parsed_body["key"]`            |
 | `react_component` | `react_component_props("ComponentName")` |
 
 `react_component_props` returns **an array**, one entry per mount, and needs
@@ -79,6 +79,8 @@ times on an empty array and asserts nothing.
 describe "the props handed to MyComponent" do
   render_views
 
+  my_component = "app/javascript/MyComponent.tsx"
+
   it "matches MyComponentProps" do
     record = create(:factory_name, trait_a: true)
     create(:factory_name, :some_trait)
@@ -87,13 +89,14 @@ describe "the props handed to MyComponent" do
 
     expect(response).to be_successful
     props = react_component_props("MyComponent")
-    expect(props).to match_ts_schema("app/javascript/MyComponent.tsx", "MyComponentProps")
+    expect(props).to match_ts_schema(my_component, "MyComponentProps")
   end
 end
 ```
 
-Name the file and type at the assertion. When several examples read the same
-source, bind the path to a constant or a let variable.
+Name the file and type at the assertion. Bind the path to a local variable or a
+`let`, not a constant: a constant assigned inside a `describe` block is global
+and collides between spec files.
 
 Rules:
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ts_schema_spec
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.3
 platform: ruby
 authors:
 - Vernon Coffey