Update patterns.json

patterns.json

@@ -25,21 +25,47 @@
             "pattern": "\\b(?:USC|U\\.S\\.C)\\b",
             "description": "USC should be U.S.C.",
             "is_error": true,
-            "replacement": "U.S.C."
+            "replacement": "U.S.C. (per the GPO Style Manual)"
+        },
+        {
+            "_comment": "Flag U.S.C without final period",
+            "pattern": "\\bU\\.S\\.C\\b",
+            "description": "U.S.C should have a final period (U.S.C.)",
+            "is_error": true,
+            "replacement": "U.S.C. (per the GPO Style Manual)"
+        },
+        {
+            "_comment": "Handle Technical Standard Order acronyms",
+            "pattern": "\\bTechnical Standard Order \\(TSO\\)\\b",
+            "description": "Technical Standard Order (TSO) is a valid form",
+            "is_error": false
+        },
+        {
+            "_comment": "Handle Technical Standard Order with hyphen",
+            "pattern": "\\bTechnical Standard Order \\(TSO-\\)\\b",
+            "description": "Technical Standard Order (TSO-) is a valid form",
+            "is_error": false
         },
         {
             "_comment": "Per FAA Order 1320.46",
             "pattern": "\\bCFR Part\\b",
             "description": "CFR Part should be CFR part (lowercase)",
             "is_error": true,
-            "replacement": "CFR part"
+            "replacement": "CFR part (per FAA Order 1320.46)"
         },
         {
             "_comment": "Per the GPO Style Manual",
             "pattern": "\\bC\\.F\\.R\\.\\b",
-            "description": "C.F.R. should be CFR",
+            "description": "C.F.R. should be CFR (per the GPO Style Manual)",
+            "is_error": true,
+            "replacement": "CFR (per the GPO Style Manual)"
+        },
+        {
+            "_comment": "Replace ACO with Certification Branch",
+            "pattern": "\\bACO\\b",
+            "description": "ACO should be replaced with Certification Branch",
             "is_error": true,
-            "replacement": "CFR"
+            "replacement": "Certification Branch"
         },
         {
             "pattern": "\\b(?:[Ww]e)\\b",
@@ -53,23 +79,23 @@
         {
             "_comment": "Per the GPO Style Manual",
             "pattern": "\\bcancelled\\b",
-            "description": "'cancelled' should be 'canceled'",
+            "description": "'cancelled' should be 'canceled' (per the GPO Style Manual)",
             "is_error": true,
-            "replacement": "canceled"
+            "replacement": "canceled (per the GPO Style Manual)"
         },
         {
             "_comment": "Per FAA Order 1320.46",
             "pattern": "\\bshall\\b",
-            "description": "'shall' should be 'must'",
+            "description": "'shall' should be 'must' (per FAA Order 1320.46)",
             "is_error": true,
-            "replacement": "must"
+            "replacement": "must (per FAA Order 1320.46)"
         },
         {
             "_comment": "Per AIR-600 Quick Reference Guide",
             "pattern": "\\bflight crew\\b",
-            "description": "'flight crew' should be 'flightcrew'",
+            "description": "'flight crew' should be 'flightcrew' (per AIR-600 Quick Reference Guide)",
             "is_error": true,
-            "replacement": "flightcrew"
+            "replacement": "flightcrew (per AIR-600 Quick Reference Guide)"
         },
         {
             "_comment": "Per AIR-600 Quick Reference Guide",
@@ -77,26 +103,26 @@
             "description": "Replace gendered terms with their appropriate alternatives",
             "is_error": true,
             "replacements": {
-                "chairman": "chair",
-                "flagman": "flagperson",
-                "man": "person",
-                "manmade": "personmade",
-                "manpower": "labor force"
+                "chairman": "chair (per AIR-600 Quick Reference Guide)",
+                "flagman": "flagperson (per AIR-600 Quick Reference Guide)",
+                "man": "person (per AIR-600 Quick Reference Guide)",
+                "manmade": "personmade (per AIR-600 Quick Reference Guide)",
+                "manpower": "labor force (per AIR-600 Quick Reference Guide)"
             }
         },
         {
             "_comment": "Per AIR-600 Quick Reference Guide. Changed per GENOT N 7930.114",
             "pattern": "\\bnotice to air missions\\b",
-            "description": "'notice to air missions' should be 'notice to airmen'",
+            "description": "'notice to air missions' should be 'notice to airmen' (per GENOT N 7930.114)",
             "is_error": true,
-            "replacement": "notice to airmen"
+            "replacement": "notice to airmen (per GENOT N 7930.114)"
         },
         {
             "_comment": "Per AIR-600 Quick Reference Guide",
             "pattern": "\\bcockpit\\b",
-            "description": "'cockpit' should be 'flight deck'",
+            "description": "'cockpit' should be 'flight deck' (per AIR-600 Quick Reference Guide)",
             "is_error": true,
-            "replacement": "flight deck"
+                "replacement": "flight deck (per AIR-600 Quick Reference Guide)"
         },
         {
             "pattern": "\\b(in order to|for the purpose of)\\b",
@@ -232,6 +258,181 @@
             "pattern": "\\b(as stated in|refer to|see)\\b.*?(\\bAppendix\\b|\\bTable\\b|\\bSection\\b|\\bFigure\\b)",
             "description": "Ensure references are complete and properly formatted",
             "is_error": true
+        },
+        {
+            "pattern": "\\band/or\\b",
+            "description": "Avoid using 'and/or'; rewrite the sentence to be more specific about the conditions",
+            "is_error": true,
+            "replacement": "written sentence breaking up and/or (per AGC)"
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:pursuant to|in accordance with|in compliance with)\\b",
+            "description": "Use simpler alternatives like 'under' or 'following'",
+            "is_error": true,
+            "replacement": "under (per Document Drafting Handbook)"
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:authority|authorized|authorizes)\\b",
+            "description": "Specify the specific authority (e.g., 'under 49 U.S.C. § 44701')",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:means|includes|does not include|includes but is not limited to)\\b",
+            "description": "Ensure proper formatting of regulatory definitions",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:amends|adds|removes|revises|replaces)\\b",
+            "description": "Ensure proper use of regulatory action terms",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:applies|applicable|covers)\\s+(?:to|for|in)\\b",
+            "description": "Ensure clear specification of regulatory scope",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:comply|compliance|noncompliance)\\b",
+            "description": "Ensure proper handling of compliance terms",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:enforce|enforcement|violation)\\b",
+            "description": "Ensure proper handling of enforcement terms",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:implement|implementation|carry out)\\b",
+            "description": "Ensure proper handling of implementation terms",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:delegated|authorized|assigned)\\s+(?:to|by)\\b",
+            "description": "Ensure proper specification of authority delegation",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:requirement|standard|specification)\\s+(?:for|of|in)\\b",
+            "description": "Ensure proper specification of requirements and standards",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:procedure|process|method)\\s+(?:for|of|in)\\b",
+            "description": "Ensure proper specification of procedures and processes",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:document|record|report)\\s+(?:required|maintained|submitted)\\b",
+            "description": "Ensure proper specification of documentation requirements",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:review|approval|authorization)\\s+(?:required|granted|denied)\\b",
+            "description": "Ensure proper specification of review and approval processes",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:violation|penalty|sanction)\\s+(?:for|of|in)\\b",
+            "description": "Ensure proper specification of violations and penalties",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:waiver|exemption|variance)\\s+(?:from|of|for)\\b",
+            "description": "Ensure proper specification of waivers and exemptions",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:compliance|implementation|enforcement)\\s+(?:date|deadline|requirement)\\b",
+            "description": "Ensure proper specification of compliance dates",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:defined|definition|term)\\s+(?:in|under|for)\\b",
+            "description": "Ensure proper formatting of regulatory definitions",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:authority|power|jurisdiction)\\s+(?:to|for|over)\\b",
+            "description": "Ensure proper specification of regulatory authority",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:compliance|enforcement)\\s+(?:with|under|of)\\b",
+            "description": "Ensure proper specification of compliance and enforcement terms",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:implementation|transition|phase-in)\\s+(?:of|for|under)\\b",
+            "description": "Ensure proper specification of implementation and transition terms",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:regulatory|economic|environmental)\\s+(?:impact|analysis|assessment)\\s+(?:of|for|under)\\b",
+            "description": "Ensure proper handling of regulatory analysis terms",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:except|unless|provided that|notwithstanding)\\s+(?:for|under|in)\\b",
+            "description": "Ensure proper formatting of regulatory exceptions",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:requirement|standard|specification)\\s+(?:for|of|in)\\b",
+            "description": "Ensure proper specification of requirements and standards",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:procedure|process|method)\\s+(?:for|of|in)\\b",
+            "description": "Ensure proper specification of procedures and processes",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:document|record|report)\\s+(?:required|maintained|submitted)\\b",
+            "description": "Ensure proper specification of documentation requirements",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:review|approval|authorization)\\s+(?:required|granted|denied)\\b",
+            "description": "Ensure proper specification of review and approval processes",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:violation|penalty|sanction)\\s+(?:for|of|in)\\b",
+            "description": "Ensure proper specification of violations and penalties",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:waiver|exemption|variance)\\s+(?:from|of|for)\\b",
+            "description": "Ensure proper specification of waivers and exemptions",
+            "is_error": true
         }
     ],
     "section_symbol": [
@@ -250,6 +451,11 @@
             "description": "Do not flag properly formatted citations with section symbols (e.g., '5 U.S.C. § 533(a)(1)')",
             "is_error": false
         },
+        {
+            "pattern": "\\b(\\d+ U\\.S\\.C\\. §§? \\d+\\([a-zA-Z0-9]*\\)(?:\\([a-zA-Z0-9]*\\))?)\\.\\b",
+            "description": "Do not flag properly formatted citations with section symbols that end sentences (e.g., '5 U.S.C. § 533(a)(1).')",
+            "is_error": false
+        },
         {
             "pattern": "\\b14 CFR §\\s*\\d+\\.\\d+\\b",
             "description": "14 CFR should not use section symbol",
@@ -313,6 +519,48 @@
             "pattern": "(?<![\\w/-])(\\d{1,2}/\\d{1,2}/\\d{2,4}|\\d{1,2}-\\d{1,2}-\\d{2,4}|\\d{4}-\\d{1,2}-\\d{1,2})(?![\\w/-])",
             "description": "Use 'Month Day, Year' format instead of numeric date formats (MM/DD/YYYY, MM-DD-YYYY, YYYY-MM-DD)",
             "is_error": true
+        },
+        {
+            "_comment": "Common aviation/regulatory references that look like dates but aren't",
+            "pattern": "\\b(?:AD|SFAR|AC|Order|Notice|Policy|Memo)\\s*\\d{2,4}[-/]\\d{1,2}[-/]\\d{1,2}\\b",
+            "description": "Do not flag aviation/regulatory references as date format issues",
+            "is_error": false
+        },
+        {
+            "_comment": "Docket numbers including placeholders",
+            "pattern": "\\bDocket\\s+(?:No\\.?|Number)\\s*\\d{2,4}[-/][xX]{1,2}[-/][xX]{1,2}\\b",
+            "description": "Do not flag docket numbers with placeholders as date format issues",
+            "is_error": false
+        },
+        {
+            "_comment": "TSO references",
+            "pattern": "\\bTSO-[A-Z]?\\d{1,3}[a-zA-Z]?\\b",
+            "description": "Do not flag TSO references as date format issues",
+            "is_error": false
+        },
+        {
+            "_comment": "Part/section references",
+            "pattern": "\\b(?:Part|Section|§)\\s*\\d{1,3}[-/]\\d{1,3}\\b",
+            "description": "Do not flag part/section references as date format issues",
+            "is_error": false
+        },
+        {
+            "_comment": "Document numbers",
+            "pattern": "\\b(?:No\\.?|Number)\\s*\\d{2,4}[-/]\\d{1,2}[-/]\\d{1,2}\\b",
+            "description": "Do not flag document numbers as date format issues",
+            "is_error": false
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:effective|commencing|beginning)\\s+(?:on|as of|from)\\s+(?:the|this)\\s+(?:date|day)\\b",
+            "description": "Specify the exact effective date",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:compliance|implementation|enforcement)\\s+(?:date|deadline)\\b",
+            "description": "Ensure proper formatting of compliance dates",
+            "is_error": true
         }
     ],
     "placeholders": [
@@ -456,13 +704,13 @@
             "pattern": "(?<!^)(?<![.!?])\\s+(Table|Figure)\\s+\\d+(?:-\\d+)?",
             "description": "'Table' and 'Figure' references within sentences should be lowercase",
             "is_error": true,
-            "enforce_case": "lowercase"
+            "replacement": "table/figure (lowercase when used within a sentence)"
         },
         {
             "pattern": "^(table|figure)\\s+\\d+(?:-\\d+)?",
             "description": "'Table' and 'Figure' references at the start of a sentence should be capitalized",
             "is_error": true,
-            "enforce_case": "capitalized"
+            "replacement": "Table/Figure (capitalized when starting a sentence)"
         }
     ],
     "parentheses": [
@@ -472,5 +720,105 @@
             "is_error": true,
             "notes": "Matches cases where a closing parenthesis is missing after an opening or an opening parenthesis is missing before a closing."
         }
+    ],
+    "citations": [
+        {
+            "_comment": "Per GPO Style Manual",
+            "pattern": "\\b(\\d+)\\s+(?:U\\.S\\.C\\.|CFR)\\s+(§|§§)\\s+(\\d+(?:\\.\\d+)*)\\b",
+            "description": "Ensure proper formatting of legal citations",
+            "is_error": true,
+            "replacement": "$1 $2 §$3 (per GPO Style Manual)"
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:refer|reference|see)\\s+(?:section|paragraph|subsection|clause)\\s+(\\d+(?:\\.\\d+)*)\\b",
+            "description": "Ensure proper formatting of cross-references",
+            "is_error": true,
+            "replacement": "see §$1"
+        }
+    ],
+    "regulatory_analysis": [
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:comment|commenter|commenting)\\b",
+            "description": "Ensure proper handling of public comment references",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:cost-benefit|regulatory impact|economic impact)\\b",
+            "description": "Ensure proper handling of regulatory analysis terms",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:regulatory|economic|environmental)\\s+(?:impact|analysis|assessment)\\b",
+            "description": "Ensure proper handling of regulatory analysis terms",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:regulatory|economic|environmental)\\s+(?:impact|analysis|assessment)\\s+(?:of|for|under)\\b",
+            "description": "Ensure proper handling of regulatory analysis terms",
+            "is_error": true
+        }
+    ],
+    "exceptions": [
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:except|unless|provided that)\\b",
+            "description": "Ensure proper formatting of regulatory exceptions",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:except|unless|provided that|notwithstanding)\\b",
+            "description": "Ensure proper formatting of regulatory exceptions",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:except|unless|provided that|notwithstanding)\\s+(?:for|under|in)\\b",
+            "description": "Ensure proper formatting of regulatory exceptions",
+            "is_error": true
+        }
+    ],
+    "compliance": [
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:compliance|enforcement)\\s+(?:date|deadline|requirement|action)\\b",
+            "description": "Ensure proper specification of compliance and enforcement terms",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:implementation|transition|phase-in)\\s+(?:period|schedule|plan)\\b",
+            "description": "Ensure proper specification of implementation and transition terms",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:compliance|implementation|enforcement)\\s+(?:date|deadline|requirement)\\b",
+            "description": "Ensure proper specification of compliance dates",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:compliance|enforcement)\\s+(?:with|under|of)\\b",
+            "description": "Ensure proper specification of compliance and enforcement terms",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:implementation|transition|phase-in)\\s+(?:of|for|under)\\b",
+            "description": "Ensure proper specification of implementation and transition terms",
+            "is_error": true
+        },
+        {
+            "_comment": "Per Document Drafting Handbook",
+            "pattern": "\\b(?:compliance|implementation|enforcement)\\s+(?:date|deadline|requirement)\\b",
+            "description": "Ensure proper specification of compliance dates",
+            "is_error": true
+        }
     ]
-}
+}