jsonrpc-middleware 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e61b560d7db3538454d0d5206eaea1fc2a86a01b25294c4d56de4b6237dd120
-  data.tar.gz: 1d7255ba3a462bbc9d53efbec3ba9b242f773b2c4fa270de280b951ea3b05743
+  metadata.gz: be698b3797653f7d1139c034b97f4be0895cc181f840c4fe3d9edfb9624fb0a2
+  data.tar.gz: 3276fd9d13964cf6fe92f9a64ffe5bfac21bef767b3fde94328bc744ca2c8731
 SHA512:
-  metadata.gz: b3d9b2f802ac5ffd1f342c45d00e001113ebf857e09208deac8560dd75a06f6201bcc4e7a99f0184cb6c1a48497d70e922d59d7f6b476c93f530584b60fa0066
-  data.tar.gz: b07c00f97c85c9a41f82decf00dbf58f10c2655e1011f0e3e6d5e63ff2f90cee88e310f6c892a8d49c2ec94aea5cfa7dccdf9292b7940256f82b1591823df2e2
+  metadata.gz: e4da3b7c0bd1fedc61baa9b8c4e9dc7fbd90c60c3e8509a676bd72b35d224a5928280bb56c5c4a7c92a40e5958544b81544e8461a551be818b8dd41b433416c0
+  data.tar.gz: cd7f389f4bf622cd9191c19dbba17890fa260259bd590d8d4bf9629dfc49f7573a05b772f25050c283fedc3b7f1d3899828ae1009a3b5deb52bc9911264c94ab

data/.aiexclude

@@ -0,0 +1,5 @@
+.kiro
+.ruby-lsp
+.vscode
+coverage
+doc

data/.claude/commands/document.md

@@ -0,0 +1,105 @@
+# Document
+
+Generates documentation for Ruby code using YARD with 100% coverage enforcement.
+
+## Commands
+
+Generate documentation:
+```bash
+bundle exec rake yard
+```
+
+Format YARD comments:
+```bash
+bundle exec rake yard:format
+```
+
+Verify 100% documentation coverage:
+```bash
+bundle exec rake verify_measurements
+```
+
+Check for documentation quality issues:
+```bash
+bundle exec rake yard:junk
+```
+
+Generate coverage report:
+```bash
+bundle exec rake yardstick_measure
+```
+
+## Configuration
+
+Requires `.yardstick.yml` in project root with 100% threshold:
+```yaml
+threshold: 100
+rules:
+  ApiTag::Presence: { enabled: true }
+  ApiTag::Inclusion: { enabled: true }
+  ApiTag::ProtectedMethod: { enabled: true }
+  ApiTag::PrivateMethod: { enabled: true }
+  ExampleTag: { enabled: true }
+  ReturnTag: { enabled: true }
+  Summary::Presence: { enabled: true }
+  Summary::Delimiter: { enabled: true }
+```
+
+## Coverage Report
+
+After running measurement, check detailed line-by-line issues:
+```bash
+cat measurements/report.txt
+```
+
+Report shows specific file, line number, method, and documentation issues that need fixing.
+
+## Documentation Standards
+
+### Required Tags
+- Every public/private method, class, and module requires `@api public` or `@api private`
+- All parameters: `@param name [Type] Description`
+- All returns: `@return [Type] Description` (use `[void]` if no return)
+- Examples required for all public methods: `@example Description`
+- Error conditions: `@raise [ExceptionClass] When this occurs`
+
+### Type Notation
+- Use `String` not `string`
+- Arrays: `Array<String>` for string arrays
+- Hashes: `Hash{String=>Object}` for hash types
+- Use `Boolean` not `bool`, `Integer` not `int`
+- Nullable types: `String, nil` or `String|nil`
+
+### Formatting Rules
+- Blank lines required between YARD tag groups
+- Exception: `@param` and `@option` tags can be grouped together
+- Wrap class/method names in `+` markers: `+PrivateKey+`
+- Cross-reference related methods: `@see #other_method`
+
+### Documentation Structure
+```ruby
+# Brief one-line summary ending with period.
+#
+# @api public
+#
+# @example Description of example
+#   code_example
+#   result # => expected_output
+#
+# @param name [Type] Description
+# @param other [Type] Other description  
+#
+# @return [Type] Description
+#
+# @raise [ExceptionClass] When this exception occurs
+#
+def method_name
+end
+```
+
+## Integration
+
+Documentation verification is included in the quality assurance pipeline:
+```bash
+bundle exec rake qa
+```