@syncerauk/test-rules 1.0.2 → 1.0.3

package/README.md

@@ -67,6 +67,10 @@ A repo starts with `"fail": false`: breaches are printed and the exit is 0. One
 
 ## Versions
 
+- **1.0.3** — A JSON reads register no longer turns off the scan of the test's code. A source
+  file the test builds a path to from its own place, in a test that reads files, is a
+  `T4:source-text` breach unless the test declares it `// runs:`. A repo with a JSON register
+  (app, portal) can see breaches that are not on its list on its first run of 1.0.3.
 - **1.0.2** — A path that starts with a dot-folder (`.github/workflows/gate.yml`) is a repo
   path; only `./` and `../` are relative to the test. A JSON reads register may be the whole
   file (`"key": null`); a register with no map at its key cannot run (exit 3) instead of reading

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncerauk/test-rules",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "The static check of Syncera's test-writing rules (T1, T4, T6 and the line limit of R7). One file, no dependency. Published to npm by the orchestrator's publish-test-rules workflow; each repo pins an exact version.",
   "type": "module",
   "license": "UNLICENSED",

package/test-rules.mjs

@@ -33,11 +33,13 @@
 //   T4:source-text  the test reads a source file as text: a read it declares (the repo's reads
 //                   register) that is a source file or a folder and is neither under a fixture
 //                   folder nor on the wording list; a `?raw` import or a raw import.meta.glob;
-//                   and, where the register is comment lines or absent, a source file whose
-//                   path the test builds from its own place (new URL(…, import.meta.url), or
-//                   join( / resolve( on import.meta.dirname, __dirname, ROOT or HERE) in a test
-//                   that reads the file system and declares it neither `// reads:` nor
-//                   `// runs:` (a file that is only run is declared `// runs:`)
+//                   and, whatever the register's form, a source file whose path the test
+//                   builds from its own place (new URL(…, import.meta.url), or join( /
+//                   resolve( on import.meta.dirname, __dirname, ROOT or HERE) in a test that
+//                   reads the file system and declares it neither `// reads:`, `// runs:` nor
+//                   in its JSON register entry (a file that is only run is declared `// runs:`).
+//                   A JSON register is what a test says it reads; it does not stop the code
+//                   being read for what it does read (1.0.3).
 //   T6:timer        setTimeout( / setInterval( / sleep( / timers/promises with no fake timers in the file
 //   T6:clock        Date.now( / new Date() / performance.now( with no fake timers in the file
 //   T6:outside      homedir(), process.env.HOME, a relative path that climbs out of the repo,
@@ -291,8 +293,8 @@ function sourceTextLine({ path, text, code, bare, strings }, { config, register,
     if (/\?raw|as\s*:\s*['"]raw['"]/.test(call)) return lineOf(code, m.index);
   }
   // A source file whose path the test builds from its own place, in a test that reads the file
-  // system, where no register says what the test reads: declared `// runs:` when it is only run.
-  if (register && typeof register === 'object') return 0;
+  // system, that the test does not declare: `// runs:` when it is only run. A JSON register does
+  // not silence this: a register can miss a read, and a source file it names returned above.
   if (!FS_READ.test(code) || !tracked) return 0;
   const said = [...declared.reads, ...declared.runs].map((r) => r.pattern);
   for (const s of strings) {