Add jsonc support for deno config.

Author: raineorshine

package-lock.json

@@ -80,6 +80,7 @@
     "semver-utils": "^1.1.4",
     "source-map-support": "^0.5.21",
     "spawn-please": "^2.0.1",
+    "strip-json-comments": "^5.0.0",
     "untildify": "^4.0.0",
     "update-notifier": "^6.0.2",
     "yaml": "^2.2.1"

package.json

@@ -31,6 +31,8 @@ export default async function findLockfile(
         return { directoryPath: currentPath, filename: 'pnpm-lock.yaml' }
       } else if (files.includes('deno.json')) {
         return { directoryPath: currentPath, filename: 'deno.json' }
+      } else if (files.includes('deno.jsonc')) {
+        return { directoryPath: currentPath, filename: 'deno.jsonc' }
       }
 
       const pathParent = path.resolve(currentPath, '..')

src/lib/findLockfile.ts

@@ -70,7 +70,11 @@ async function findPackage(options: Options) {
     pkgData = data || getPackageDataFromFile(await pkgFile, pkgPath)
   } else {
     // find the closest package starting from the current working directory and going up to the root
-    pkgFile = pkgPath ? findUp.sync(pkgPath, { cwd: options.cwd || process.cwd() }) : null
+    pkgFile = pkgPath
+      ? findUp.sync(!options.packageFile && options.packageManager === 'deno' ? ['deno.json', 'deno.jsonc'] : pkgPath, {
+          cwd: options.cwd || process.cwd(),
+        })
+      : null
     pkgData = getPackageDataFromFile(pkgFile, pkgPath)
   }
 

src/lib/findPackage.ts

@@ -158,11 +158,7 @@ async function initOptions(runOptions: RunOptions, { cli }: { cli?: boolean } =
 
   const resolvedOptions: Options = {
     ...options,
-    ...(options.deep
-      ? { packageFile: '**/package.json' }
-      : packageManager === 'deno' && !options.packageFile
-      ? { packageFile: 'deno.json' }
-      : null),
+    ...(options.deep ? { packageFile: '**/package.json' } : null),
     ...(packageManager === 'deno' && options.dep !== cliOptionsMap.dep.default ? { dep: ['imports'] } : null),
     ...(options.format && options.format.length > 0 ? { format: options.format } : null),
     filter: args || filter,

src/lib/initOptions.ts

@@ -164,13 +164,16 @@ async function runLocal(
   print(options, '\nOptions:', 'verbose')
   print(options, sortOptions(options), 'verbose')
 
-  let pkg
+  let pkg: PackageFile
 
   try {
     if (!pkgData) {
-      throw new Error('Missing pkgData: ' + pkgData)
+      throw new Error('Missing pkgData')
     } else {
-      pkg = jph.parse(pkgData)
+      // strip comments from jsonc files
+      const pkgDataStripped =
+        pkgFile?.endsWith('.jsonc') && pkgData ? (await import('strip-json-comments')).default(pkgData) : pkgData
+      pkg = jph.parse(pkgDataStripped)
     }
   } catch (e: any) {
     programError(

src/lib/runLocal.ts

@@ -24,11 +24,11 @@ describe('deno', async function () {
         'ncu-test-v2': 'npm:[email protected]',
       },
     }
-    await fs.writeFile(pkgFile, JSON.stringify(pkg), 'utf-8')
+    await fs.writeFile(pkgFile, JSON.stringify(pkg))
     try {
       const pkgData = await spawn(
         'node',
-        [bin, '--jsonUpgraded', '--verbose', '--packageManager', 'deno', '--packageFile', pkgFile],
+        [bin, '--jsonUpgraded', '--packageManager', 'deno', '--packageFile', pkgFile],
         undefined,
       )
       const pkg = jph.parse(pkgData)
@@ -46,9 +46,9 @@ describe('deno', async function () {
         'ncu-test-v2': 'npm:[email protected]',
       },
     }
-    await fs.writeFile(pkgFile, JSON.stringify(pkg), 'utf-8')
+    await fs.writeFile(pkgFile, JSON.stringify(pkg))
     try {
-      const pkgData = await spawn('node', [bin, '--jsonUpgraded', '--verbose'], undefined, {
+      const pkgData = await spawn('node', [bin, '--jsonUpgraded'], undefined, {
         cwd: tempDir,
       })
       const pkg = jph.parse(pkgData)
@@ -57,4 +57,71 @@ describe('deno', async function () {
       await fs.rm(tempDir, { recursive: true, force: true })
     }
   })
+
+  it('rewrite deno.json', async () => {
+    const tempDir = await fs.mkdtemp(path.join(os.tmpdir(), 'npm-check-updates-'))
+    const pkgFile = path.join(tempDir, 'deno.json')
+    const pkg = {
+      imports: {
+        'ncu-test-v2': 'npm:[email protected]',
+      },
+    }
+    await fs.writeFile(pkgFile, JSON.stringify(pkg))
+    try {
+      await spawn('node', [bin, '-u'], undefined, { cwd: tempDir })
+      const pkgDataNew = await fs.readFile(pkgFile, 'utf-8')
+      const pkg = jph.parse(pkgDataNew)
+      pkg.should.deep.equal({
+        imports: {
+          'ncu-test-v2': 'npm:[email protected]',
+        },
+      })
+    } finally {
+      await fs.rm(tempDir, { recursive: true, force: true })
+    }
+  })
+
+  it('auto detect deno.jsonc', async () => {
+    const tempDir = await fs.mkdtemp(path.join(os.tmpdir(), 'npm-check-updates-'))
+    const pkgFile = path.join(tempDir, 'deno.jsonc')
+    const pkgString = `{
+  "imports": {
+    // this comment should be ignored in a jsonc file
+    "ncu-test-v2": "npm:[email protected]"
+  }
+}`
+    await fs.writeFile(pkgFile, pkgString)
+    try {
+      const pkgData = await spawn('node', [bin, '--jsonUpgraded'], undefined, {
+        cwd: tempDir,
+      })
+      const pkg = jph.parse(pkgData)
+      pkg.should.have.property('ncu-test-v2')
+    } finally {
+      await fs.rm(tempDir, { recursive: true, force: true })
+    }
+  })
+
+  it('rewrite deno.jsonc', async () => {
+    const tempDir = await fs.mkdtemp(path.join(os.tmpdir(), 'npm-check-updates-'))
+    const pkgFile = path.join(tempDir, 'deno.jsonc')
+    const pkg = {
+      imports: {
+        'ncu-test-v2': 'npm:[email protected]',
+      },
+    }
+    await fs.writeFile(pkgFile, JSON.stringify(pkg))
+    try {
+      await spawn('node', [bin, '-u'], undefined, { cwd: tempDir })
+      const pkgDataNew = await fs.readFile(pkgFile, 'utf-8')
+      const pkg = jph.parse(pkgDataNew)
+      pkg.should.deep.equal({
+        imports: {
+          'ncu-test-v2': 'npm:[email protected]',
+        },
+      })
+    } finally {
+      await fs.rm(tempDir, { recursive: true, force: true })
+    }
+  })
 })