update pkglint to use regex

aws · Jan 29, 2024 · 0129288 · 0129288
1 parent 34e9ee8
commit 0129288
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/tools/@aws-cdk/pkglint/lib/rules.ts b/tools/@aws-cdk/pkglint/lib/rules.ts
@@ -1231,7 +1231,7 @@ export class MustHaveIntegCommand extends ValidationRule {
   public validate(pkg: PackageJson): void {
     if (!hasIntegTests(pkg)) { return; }
 
-    expectJSON(this.name, pkg, 'scripts.integ', /integ-runner/);
+    expectJSON(this.name, pkg, 'scripts.integ', /integ-runner/, undefined, false, true);
 
     // We can't ACTUALLY require cdk-build-tools/package.json here,
     // because WE don't depend on cdk-build-tools and we don't know if

diff --git a/tools/@aws-cdk/pkglint/lib/util.ts b/tools/@aws-cdk/pkglint/lib/util.ts
@@ -5,17 +5,32 @@ import { PackageJson, PKGLINT_IGNORES } from './packagejson';
 /**
  * Expect a particular JSON key to be a given value
  */
-export function expectJSON(ruleName: string, pkg: PackageJson, jsonPath: string, expected: any, ignore?: RegExp, caseInsensitive: boolean = false) {
+export function expectJSON(
+  ruleName: string,
+  pkg: PackageJson,
+  jsonPath: string,
+  expected: any,
+  ignore?: RegExp,
+  caseInsensitive: boolean = false,
+  regexMatch: boolean = false,
+) {
   const parts = jsonPath.split('.');
   const actual = deepGet(pkg.json, parts);
-  if (applyCaseInsensitive(applyIgnore(actual)) !== applyCaseInsensitive(applyIgnore(expected))) {
+  if (checkEquality()) {
     pkg.report({
       ruleName,
       message: `${jsonPath} should be ${JSON.stringify(expected)}${ignore ? ` (ignoring ${ignore})` : ''}, is ${JSON.stringify(actual)}`,
       fix: () => { deepSet(pkg.json, parts, expected); },
     });
   }
 
+  function checkEquality(): boolean {
+    if (regexMatch) {
+      return !expected.test(applyCaseInsensitive(applyIgnore(actual)));
+    }
+    return applyCaseInsensitive(applyIgnore(actual)) !== applyCaseInsensitive(applyIgnore(expected));
+  }
+
   function applyIgnore(val: any): string {
     if (!ignore || val == null) { return JSON.stringify(val); }
     const str = JSON.stringify(val);