@davidwells/extract-deps 0.1.14 → 0.1.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@davidwells/extract-deps",
-  "version": "0.1.14",
+  "version": "0.1.15",
   "description": "Get imports and requires from a codebase without AST",
   "main": "src/index.js",
   "exports": {

package/src/dep-graph.js

@@ -164,6 +164,10 @@ function resolveImportPathUncached(baseDir, importPath) {
  * @param {boolean} throwOnFirstError - Whether to throw immediately on first error
  */
 function verifyImportedValuesExist(dep, targetDeps, targetPath, sourcePath, errors, throwOnFirstError) {
+  // JSON modules have no export statements to check: the parsed value IS the default export
+  // (ESM, `with { type: 'json' }`) or module.exports (CJS require). Scanning the JSON text
+  // for exports found none and reported a missing default export for `require('./x.json')`.
+  if (/\.json$/i.test(targetPath)) return
   // Check if this is a destructured import
   if (dep.definitions && dep.definitions.expectsDestructuring && dep.definitions.destructuredParameters) {
     const importedNames = dep.definitions.destructuredParameters.map(p => p.name.replace(/,$/, ''))

package/src/index.js

@@ -45,7 +45,9 @@ function extractDeps(code, filePath = '') {
 }
 
 function parseDeps(code) {
-  const imports = getImports(code)
+  // Import-attribute imports (`import data from './x.json' with { type: 'json' }`) are
+  // dependencies too: without them a changed JSON file never reaches its importers
+  const imports = getImports(code, { includeAssertionImports: true })
   //console.log('imports', imports)
   const requires = getRequires(code)
   // console.log('requires', requires)

package/tests/dep-graph-json.test.js

@@ -0,0 +1,79 @@
+// JSON modules in the dependency graph (smart-ci sci-nrnc.4 / sci-nrnc.11)
+const { test } = require('uvu')
+const assert = require('uvu/assert')
+const fs = require('fs')
+const os = require('os')
+const path = require('path')
+const { resolveDepPaths, clearDepGraphCache } = require('../src/dep-graph')
+
+function makeFiles(files) {
+  const dir = fs.realpathSync(fs.mkdtempSync(path.join(os.tmpdir(), 'extract-deps-json-')))
+  for (const [rel, content] of Object.entries(files)) {
+    fs.mkdirSync(path.dirname(path.join(dir, rel)), { recursive: true })
+    fs.writeFileSync(path.join(dir, rel), content)
+  }
+  return dir
+}
+
+const VERIFY = { verifyGraph: true, verifyNodeModules: true, includeNodeModules: true, returnErrors: true }
+
+test('CommonJS require of JSON: listed, and no "default export" error', () => {
+  clearDepGraphCache()
+  const dir = makeFiles({
+    'handler.js': "const messages = require('./messages.json')\nmodule.exports.handler = async () => messages.hello\n",
+    'messages.json': '{ "hello": "Foobar!!!" }\n',
+  })
+  try {
+    const { files, errors } = resolveDepPaths(path.join(dir, 'handler.js'), VERIFY)
+    assert.ok(files.includes(path.join(dir, 'messages.json')), 'messages.json is a dependency')
+    assert.equal((errors || []).map(e => e.message), [])
+  } finally {
+    fs.rmSync(dir, { recursive: true, force: true })
+  }
+})
+
+test('CommonJS destructuring require of JSON: no export errors', () => {
+  clearDepGraphCache()
+  const dir = makeFiles({
+    'handler.js': "const { hello } = require('./messages.json')\nmodule.exports.handler = async () => hello\n",
+    'messages.json': '{ "hello": "hi" }\n',
+  })
+  try {
+    const { errors } = resolveDepPaths(path.join(dir, 'handler.js'), VERIFY)
+    assert.equal((errors || []).map(e => e.message), [])
+  } finally {
+    fs.rmSync(dir, { recursive: true, force: true })
+  }
+})
+
+test('ESM import of JSON with import attributes (with / assert): listed as a dependency', () => {
+  clearDepGraphCache()
+  const dir = makeFiles({
+    'src/app.mjs': "import contract from '../docs/api.json' with { type: 'json' }\nimport legacy from './legacy.json' assert { type: 'json' }\nexport const h = () => [contract, legacy]\n",
+    'src/legacy.json': '{}\n',
+    'docs/api.json': '{ "version": 1 }\n',
+  })
+  try {
+    const { files, errors } = resolveDepPaths(path.join(dir, 'src/app.mjs'), VERIFY)
+    assert.ok(files.includes(path.join(dir, 'docs/api.json')), 'with { type: json } import is a dependency')
+    assert.ok(files.includes(path.join(dir, 'src/legacy.json')), 'assert { type: json } import is a dependency')
+    assert.equal((errors || []).map(e => e.message), [])
+  } finally {
+    fs.rmSync(dir, { recursive: true, force: true })
+  }
+})
+
+test('a missing JSON import is still reported', () => {
+  clearDepGraphCache()
+  const dir = makeFiles({
+    'app.mjs': "import contract from './missing.json' with { type: 'json' }\nexport const h = () => contract\n",
+  })
+  try {
+    const { errors } = resolveDepPaths(path.join(dir, 'app.mjs'), VERIFY)
+    assert.ok((errors || []).length > 0, 'missing.json is an error')
+  } finally {
+    fs.rmSync(dir, { recursive: true, force: true })
+  }
+})
+
+test.run()

package/types/dep-graph.d.ts

@@ -22,7 +22,8 @@ export function depGraph(filePath: string, options?: {
     errors: Error[];
 } | undefined;
 /**
- * Get all dependency file paths in build order (dependencies first), deduplicated
+ * Get all dependency file paths in build order (dependencies first), deduplicated.
+ * Files in an import cycle are kept together, in discovery order.
  * @param {string} filePath - Entry file path
  * @param {object} options - Options to pass to depGraph
  * @param {boolean} [options.verifyGraph] - If true, verify imports/exports. Default: true
@@ -42,4 +43,6 @@ export function resolveDepPaths(filePath: string, options?: {
     builtIns: string[];
     errors?: Error[];
 };
+/** Drop memoized parses and resolutions (e.g. between runs in a long-lived process). */
+export function clearDepGraphCache(): void;
 //# sourceMappingURL=dep-graph.d.ts.map

package/types/dep-graph.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dep-graph.d.ts","sourceRoot":"","sources":["../src/dep-graph.js"],"names":[],"mappings":"AAmUA;;;;;;;;;;;GAWG;AACH,mCAVW,MAAM,YAEd;IAA0B,UAAU,GAA5B,OAAO;IACW,WAAW,GAA7B,OAAO;IACW,iBAAiB,GAAnC,OAAO;IACW,kBAAkB,GAApC,OAAO;IACW,iBAAiB,GAAnC,OAAO;IACW,YAAY,GAA9B,OAAO;CACf,GAAU,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAC;IAAC,KAAK,gBAAM;IAAC,MAAM,EAAE,KAAK,EAAE,CAAA;CAAC,GAAC,SAAS,CA8BzE;AAGD;;;;;;;;;GASG;AACH,0CARW,MAAM,YAEd;IAA0B,WAAW,GAA7B,OAAO;IACW,iBAAiB,GAAnC,OAAO;IACW,iBAAiB,GAAnC,OAAO;IACW,YAAY,GAA9B,OAAO;CACf,GAAU;IAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IAAC,WAAW,EAAE,MAAM,EAAE,CAAC;IAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAA;CAAE,CAkF5F"}
+{"version":3,"file":"dep-graph.d.ts","sourceRoot":"","sources":["../src/dep-graph.js"],"names":[],"mappings":"AA6ZA;;;;;;;;;;;GAWG;AACH,mCAVW,MAAM,YAEd;IAA0B,UAAU,GAA5B,OAAO;IACW,WAAW,GAA7B,OAAO;IACW,iBAAiB,GAAnC,OAAO;IACW,kBAAkB,GAApC,OAAO;IACW,iBAAiB,GAAnC,OAAO;IACW,YAAY,GAA9B,OAAO;CACf,GAAU,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAC;IAAC,KAAK,gBAAM;IAAC,MAAM,EAAE,KAAK,EAAE,CAAA;CAAC,GAAC,SAAS,CA8BzE;AAgJD;;;;;;;;;;GAUG;AACH,0CARW,MAAM,YAEd;IAA0B,WAAW,GAA7B,OAAO;IACW,iBAAiB,GAAnC,OAAO;IACW,iBAAiB,GAAnC,OAAO;IACW,YAAY,GAA9B,OAAO;CACf,GAAU;IAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IAAC,WAAW,EAAE,MAAM,EAAE,CAAC;IAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAA;CAAE,CAgD5F;AArkBD,wFAAwF;AACxF,2CAKC"}

package/types/get-cjs-exports.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-cjs-exports.d.ts","sourceRoot":"","sources":["../src/get-cjs-exports.js"],"names":[],"mappings":"AAoCA,gDAgDC;AA+BD;;;;;;;;IAqGC;AAED;;;;;;;IAqBC;AAED;;;;;;;IAqBC;AAED;;;;;;;IAiDC;AAED;;;;;;;;;IAwEC"}
+{"version":3,"file":"get-cjs-exports.d.ts","sourceRoot":"","sources":["../src/get-cjs-exports.js"],"names":[],"mappings":"AAyCA,gDAoDC;AA+BD;;;;;;;;IAqGC;AAED;;;;;;;IAqBC;AAED;;;;;;;IAqBC;AAED;;;;;;;IAiDC;AAED;;;;;;;;;IAwEC"}

package/types/get-exports.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-exports.d.ts","sourceRoot":"","sources":["../src/get-exports.js"],"names":[],"mappings":"AAiBA,+DAqCC;AAED;;;;;;;;IAqDC;AAED;;;;;;IAeC;AAED,uEAuBC;AAED;;;;;;IAeC;AAED;;;;;;;IAgBC;AAED;;;;;;IAeC;AAED;;;;;;;;;;;;IA0BC"}
+{"version":3,"file":"get-exports.d.ts","sourceRoot":"","sources":["../src/get-exports.js"],"names":[],"mappings":"AAiBA,+DAsCC;AAED;;;;;;;;IAqDC;AAED;;;;;;IAeC;AAED,uEAuBC;AAED;;;;;;IAeC;AAED;;;;;;;IAgBC;AAED;;;;;;IAeC;AAED;;;;;;;;;;;;IA0BC"}

package/types/get-imports.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-imports.d.ts","sourceRoot":"","sources":["../src/get-imports.js"],"names":[],"mappings":"AAsCA;;;;;;;;;;IAcC;AAGD;;;;;;;;;;IAsCC;AAED;;;;;;;;;IAkBC;AAED;;;;;;;;;;;IAuBC;AAED;;;;;;;;;;;;;IA0BC"}
+{"version":3,"file":"get-imports.d.ts","sourceRoot":"","sources":["../src/get-imports.js"],"names":[],"mappings":"AAsCA;;;;;;;;;;IAiBC;AAGD;;;;;;;;;;IAsCC;AAED;;;;;;;;;IAkBC;AAED;;;;;;;;;;;IAuBC;AAED;;;;;;;;;;;;;IA0BC"}

package/types/get-requires.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-requires.d.ts","sourceRoot":"","sources":["../src/get-requires.js"],"names":[],"mappings":"AA0GA;;;;;;;;;;;IAUC;AArCD;;;;;;;;;;;IAyBC;AA/FD;;;;;;;;;;;IA6BC"}
+{"version":3,"file":"get-requires.d.ts","sourceRoot":"","sources":["../src/get-requires.js"],"names":[],"mappings":"AA0GA;;;;;;;;;;;IAWC;AAtCD;;;;;;;;;;;IAyBC;AA/FD;;;;;;;;;;;IA6BC"}

package/types/utils.d.ts

@@ -63,6 +63,14 @@ export function stripStringContents(code: string): string;
  * @returns {string}
  */
 export function stripCommentsAndStrings(code: string): string;
+/**
+ * `stripStringContents(stripComments(code))`, the prelude of the import, require
+ * and export scanners (comments first, then strings: see getImports). Pure in
+ * `code`; the latest result is kept for the next scanner of the same text.
+ * @param {string} code
+ * @returns {string}
+ */
+export function stripCommentsThenStrings(code: string): string;
 /**
  * Check if a module specifier is a Node.js built-in
  * @param {string} moduleName - The module specifier (e.g., 'fs', 'node:fs/promises')

package/types/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.js"],"names":[],"mappings":"AAsQA;;;;;;GAMG;AACH,oCAHW,MAAM,GACJ,MAAM,CAIlB;AAtQD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,0CAHW,MAAM,GACJ,MAAM,CA6ClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,8CAHW,MAAM,GACJ,MAAM,CAIlB;AAkKD;;;;GAIG;AACH,sCAHW,MAAM,GACJ,OAAO,CAUnB;AAED,+DAEC;AAED,yEAKC;AAgFD,6DA+DC;AAGD,yDAqCC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.js"],"names":[],"mappings":"AA0RA;;;;;;GAMG;AACH,oCAHW,MAAM,GACJ,MAAM,CAIlB;AA1RD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,0CAHW,MAAM,GACJ,MAAM,CAuDlB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,8CAHW,MAAM,GACJ,MAAM,CAIlB;AAiLD;;;;;;GAMG;AACH,+CAHW,MAAM,GACJ,MAAM,CAQlB;AAED;;;;GAIG;AACH,sCAHW,MAAM,GACJ,OAAO,CAUnB;AAED,+DAEC;AAED,yEAKC;AAgFD,6DA+DC;AAGD,yDAqCC"}