input-output-hk · apskhem · Jan 30, 2024 · Jan 12, 2024 · Jan 15, 2024 · Jan 15, 2024
diff --git a/hermes/crates/cbork/cddl-parser/src/grammar/cddl_test.pest b/hermes/crates/cbork/cddl-parser/src/grammar/cddl_test.pest
@@ -3,7 +3,9 @@
 // Test Expressions ONLY TO Be USED by Unit Tests.
 // Extends `cddl.pest` with rules needed to properly check sub-rules.
 
-// cspell: words intfloat hexfloat
+// cspell: words intfloat hexfloat groupname assignt
+// cspell: words assigng genericparm genericarg rangeop ctlop
+// cspell: words grpchoice grpent memberkey bareword optcom
 
 /// Test Expression for the `rule` Rule.
 rule_TEST  = ${ SOI ~ rule ~ EOI }

diff --git a/hermes/crates/cbork/cddl-parser/src/grammar/rfc_8610.pest b/hermes/crates/cbork/cddl-parser/src/grammar/rfc_8610.pest
@@ -1,9 +1,9 @@
 //! CDDL Grammar adapted from RFC8610 Appendix B
 //! https://www.rfc-editor.org/rfc/rfc8610#appendix-B
 
-// cspell: words assignt groupname grpent genericparm assigng
+// cspell: words assignt groupname grpent genericparm assigng optcom
 // cspell: words genericarg rangeop ctlop grpchoice memberkey bareword hexfloat intfloat
-// cspell: words SCHAR BCHAR PCHAR SESC FFFD Characterset Visiable
+// cspell: words SCHAR BCHAR PCHAR SESC FFFD Characterset Visiable 
 
 cddl = ${
     SOI

diff --git a/hermes/crates/cbork/cddl-parser/src/lib.rs b/hermes/crates/cbork/cddl-parser/src/lib.rs
@@ -114,9 +114,7 @@ pub struct CDDLError(CDDLErrorType);
 /// let result = parse_cddl(&mut input, &Extension::CDDLParser);
 /// assert!(result.is_ok());
 /// ```
-pub fn parse_cddl<'a>(
-    input: &'a mut String, extension: &Extension,
-) -> Result<AST<'a>, CDDLError> {
+pub fn parse_cddl<'a>(input: &'a mut String, extension: &Extension) -> Result<AST<'a>, CDDLError> {
     input.push_str("\n\n");
     input.push_str(POSTLUDE);
 
@@ -138,7 +136,7 @@ pub fn parse_cddl<'a>(
         },
     };
 
-    result.map_err( CDDLError::from)
+    result.map_err(CDDLError::from)
 }
 
 #[cfg(test)]

diff --git a/hermes/crates/cbork/cddl-parser/tests/byte_sequences.rs b/hermes/crates/cbork/cddl-parser/tests/byte_sequences.rs
@@ -1,4 +1,4 @@
-// cspell: words hexpair rstuvw abcdefghijklmnopqrstuvwyz rstuvw
+// cspell: words hexpair rstuvw abcdefghijklmnopqrstuvwyz rstuvw Xhhb Bhcm
 
 use cddl_parser::{
     self,

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl.rs b/hermes/crates/cbork/cddl-parser/tests/cddl.rs
@@ -13,17 +13,28 @@ fn parse_cddl_files() {
 
     file_paths.sort();
 
-    let valid_file_paths = file_paths
-        .iter()
-        .filter(|p| matches!(p.file_name().and_then(OsStr::to_str).map(|p| p.starts_with("valid")), Some(true)));
-    let invalid_file_paths = file_paths
-        .iter()
-        .filter(|p| matches!(p.file_name().and_then(OsStr::to_str).map(|p| p.starts_with("invalid")), Some(true)));
+    let valid_file_paths = file_paths.iter().filter(|p| {
+        matches!(
+            p.file_name()
+                .and_then(OsStr::to_str)
+                .map(|p| p.starts_with("valid")),
+            Some(true)
+        )
+    });
+    let invalid_file_paths = file_paths.iter().filter(|p| {
+        matches!(
+            p.file_name()
+                .and_then(OsStr::to_str)
+                .map(|p| p.starts_with("invalid")),
+            Some(true)
+        )
+    });
 
     // test for valid files
     let mut err_messages = vec![];
     for file_path in valid_file_paths {
-        let mut content = fs::read_to_string(&file_path).expect(&format!("failed to read `{:?}`", &file_path));
+        let mut content =
+            fs::read_to_string(&file_path).expect(&format!("failed to read `{:?}`", &file_path));
 
         if let Err(e) = parse_cddl(&mut content, &Extension::RFC8610Parser) {
             err_messages.push(format!("{}) {file_path:?} {e}", err_messages.len() + 1));
@@ -32,7 +43,8 @@ fn parse_cddl_files() {
 
     // test for invalid files
     for file_path in invalid_file_paths {
-        let mut content = fs::read_to_string(&file_path).expect(&format!("failed to read `{:?}`", &file_path));
+        let mut content =
+            fs::read_to_string(&file_path).expect(&format!("failed to read `{:?}`", &file_path));
 
         let result = parse_cddl(&mut content, &Extension::RFC8610Parser);
 

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/invalid_rfc8610_sample_2.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/invalid_rfc8610_sample_2.cddl
@@ -1,2 +1,4 @@
+; cspell: words tstr
+
 sample = {
   tstr => tstr
diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/invalid_rfc8610_sample_3.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/invalid_rfc8610_sample_3.cddl
@@ -1,3 +1,5 @@
+; cspell: words tstr
+
 sample = ; comment here {
   tstr => tstr
 }
diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_arrays.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_arrays.cddl
@@ -1,5 +1,7 @@
 ; 3.4.  Arrays
 
+; cspell: words tstr
+
 unlimited-people = [* person]
 one-or-two-people = [1*2 person]
 at-least-two-people = [2* person]

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_ctrl_bits.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_ctrl_bits.cddl
@@ -1,5 +1,7 @@
 ; 3.8.2.  Control Operator .bits
 
+; cspell: words tcpflagbytes rwxbits
+
 tcpflagbytes = bstr .bits flags
 flags = &(
   fin: 8,

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_ctrl_regexp.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_ctrl_regexp.cddl
@@ -1,5 +1,7 @@
 ; 3.8.3.  Control Operator .regexp
 
+; cspell: words tstr
+
 nai = tstr .regexp "[A-Za-z0-9]+@[A-Za-z0-9]+(\\.[A-Za-z0-9]+)+"
 
 ; "N1@CH57HF.4Znqe0.dYJRN.igjf" should pass this regexp
diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_cuts_in_maps.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_cuts_in_maps.cddl
@@ -1,5 +1,7 @@
 ; 3.5.4.  Cuts in Maps
 
+; cspell: words tstr
+
 extensible-map-example = {
   ? "optional-key" => int,
   * tstr => any

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_cuts_in_maps_alt_1.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_cuts_in_maps_alt_1.cddl
@@ -1,5 +1,7 @@
 ; 3.5.4.  Cuts in Maps
 
+; cspell: words tstr
+
 extensible-map-example = {
   ? "optional-key" ^ => int,
   * tstr => any

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_cuts_in_maps_alt_2.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_cuts_in_maps_alt_2.cddl
@@ -1,5 +1,7 @@
 ; 3.5.4.  Cuts in Maps
 
+; cspell: words tstr
+
 extensible-map-example = {
   ? "optional-key": int,
   * tstr => any

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_cuts_in_maps_alt_3.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_cuts_in_maps_alt_3.cddl
@@ -1,5 +1,7 @@
 ; 3.5.4.  Cuts in Maps
 
+; cspell: words tstr
+
 extensible-map-example = {
   ? optional-key: int,
   * tstr => any

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_group_to_choice.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_group_to_choice.cddl
@@ -1,5 +1,7 @@
 ; 2.2.2.2.  Turning a Group into a Choice
 
+; cspell: words basecolors
+
 terminal-color = &basecolors
 basecolors = (
   black: 0,  red: 1,  green: 2,  yellow: 3,

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_represenation_types.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_represenation_types.cddl
@@ -1,5 +1,7 @@
 ; 2.2.3.  Representation Types
 
+; cspell: words cbor tstr
+
 my_breakfast = #6.55799(breakfast)   ; cbor-any is too general!
 breakfast = cereal / porridge
 cereal = #6.998(tstr)

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_reputon_compact.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_reputon_compact.cddl
@@ -1,3 +1,5 @@
+; cspell: words reputons reputon
+
 reputation-object = {
   application: text
   reputons: [* reputon]

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_reputon_full.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_reputon_full.cddl
@@ -1,3 +1,5 @@
+; cspell: words reputons reputon
+
 reputation-object = {
   reputation-context,
   reputon-list

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_simple_1.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_simple_1.cddl
@@ -1,5 +1,7 @@
 ; Figure 1: Using a Group Directly in a Map
 
+; cspell: words tstr
+
 person = {
   age: int,
   name: tstr,

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_simple_2.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_simple_2.cddl
@@ -1,5 +1,7 @@
 ; Figure 2: A Basic Group
 
+; cspell: words tstr
+
 pii = (
   age: int,
   name: tstr,

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_simple_3.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_simple_3.cddl
@@ -1,5 +1,7 @@
 ; Figure 3: Using a Group by Name
 
+; cspell: words tstr
+
 person = {
   pii
 }

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_simple_4.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_simple_4.cddl
@@ -1,5 +1,7 @@
 ; Figure 4: Using a Parenthesized Group in a Map
 
+; cspell: words tstr
+
 person = {(
   age: int,
   name: tstr,

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_simple_5.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_simple_5.cddl
@@ -1,5 +1,7 @@
 ; Figure 5: Maps with Copy/Paste
 
+; cspell: words tstr
+
 person = {
   age: int,
   name: tstr,

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_simple_6.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_simple_6.cddl
@@ -1,5 +1,7 @@
 ; Figure 6: Using a Group for Factorization
 
+; cspell: words tstr
+
 person = {
   identity,
   employer: tstr,

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_simple_7.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_simple_7.cddl
@@ -1,5 +1,7 @@
 ; 2.2.2.  Choices
 
+; cspell: words tstr
+
 attire = "bow tie" / "necktie" / "Internet attire"
 protocol = 6 / 17
 

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_simple_8.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_simple_8.cddl
@@ -1,5 +1,7 @@
 ; 2.2.2.  Choices
 
+; cspell: words tstr
+
 attire /= "swimwear"
 
 delivery //= (

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_simple_9.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_simple_9.cddl
@@ -1,3 +1,5 @@
+; cspell: words tstr bareword
+
 ; This is a comment
 person = { g }
 

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_socket_plug_ext.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_socket_plug_ext.cddl
@@ -1,5 +1,7 @@
 ; 3.9.  Socket/Plug
 
+; cspell: words tstr personaldata shoesize
+
 PersonalData = {
   ? displayName: tstr,
   NameComponents,

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_structs.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_structs.cddl
@@ -1,5 +1,7 @@
 ; 3.5.1.  Structs
 
+; cspell: words tstr
+
 Geography = [
     city           : tstr,
     gpsCoordinates : GpsCoordinates,

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_structs_alt.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_structs_alt.cddl
@@ -1,5 +1,7 @@
 ; 3.5.1.  Structs
 
+; cspell: words tstr
+
 Geography = [
     city           : tstr,
     gpsCoordinates : GpsCoordinates,

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_tables.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_tables.cddl
@@ -1,5 +1,7 @@
 ; 3.5.2.  Tables
 
+; cspell: words tstr tostring mynumber
+
 square-roots = {* x => y}
 x = int
 y = float

diff --git a/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_tags.cddl b/hermes/crates/cbork/cddl-parser/tests/cddl/valid_rfc8610_tags.cddl
@@ -1,5 +1,7 @@
 ; 3.6.  Tags
 
+; cspell: words biguint buuid tstr
+
 biguint = #6.2(bstr)
 
 buuid = #6.37(bstr)

diff --git a/hermes/crates/cbork/cddl-parser/tests/group_elements.rs b/hermes/crates/cbork/cddl-parser/tests/group_elements.rs
@@ -1,3 +1,6 @@
+// cspell: words OPTCOM MEMBERKEY bareword tstr GRPENT GRPCHOICE
+// cspell: words optcom memberkey grpent grpchoice
+
 use cddl_parser::{
     self,
     cddl_test::{CDDLTestParser, Parser, Rule},

diff --git a/hermes/crates/cbork/cddl-parser/tests/rules.rs b/hermes/crates/cbork/cddl-parser/tests/rules.rs
@@ -1,3 +1,6 @@
+// cspell: words GENERICARG bigfloat ASSIGNG GROUPNAME tstr genericarg GENERICARG
+// cspell: words assigng assignt ASSIGNT GENERICPARM genericparm
+
 use cddl_parser::{
     self,
     cddl_test::{CDDLTestParser, Parser, Rule},

diff --git a/hermes/crates/cbork/cddl-parser/tests/type_declarations.rs b/hermes/crates/cbork/cddl-parser/tests/type_declarations.rs
@@ -1,3 +1,6 @@
+// cspell: words CTLOP aname groupsocket typesocket RANGEOP tstr ctlop
+// cspell: words rangeop RANGEOP
+
 use cddl_parser::{
     self,
     cddl_test::{CDDLTestParser, Parser, Rule},