feat: jsonc support (#38)

Author: ryoppippi

package.json

@@ -65,6 +65,7 @@
     "escalade": "^3.1.2",
     "fast-glob": "^3.3.2",
     "js-yaml": "^4.1.0",
+    "jsonc-parser": "^3.3.1",
     "prompts": "^2.4.2",
     "semver": "^7.6.3"
   },
@@ -74,8 +75,6 @@
     "@types/node": "^22.0.2",
     "@types/prompts": "^2.4.9",
     "@types/semver": "^7.5.8",
-    "detect-indent": "^7.0.1",
-    "detect-newline": "^4.0.1",
     "eslint": "^9.8.0",
     "esno": "^4.7.0",
     "log-symbols": "^6.0.0",

pnpm-lock.yaml

@@ -1,7 +1,6 @@
 import fs from 'node:fs'
 import path from 'node:path'
-import detectIndent from 'detect-indent'
-import { detectNewline } from 'detect-newline'
+import * as jsonc from 'jsonc-parser'
 
 /**
  * Describes a plain-text file.
@@ -11,38 +10,43 @@ export interface TextFile {
   data: string
 }
 
+/**
+ * Modifies a JSON file.
+ */
+type ModifyUnion = [jsonc.JSONPath, unknown]
+
 /**
  * Describes a JSON file.
  */
 interface JsonFile {
-  path: string
-  data: unknown
-  indent: string
-  newline: string | undefined
+  path: Readonly<string>
+  text: Readonly<string>
+  data: Readonly<unknown>
+  modified: ModifyUnion[]
 }
 
 /**
- * Reads a JSON file and returns the parsed data.
+ * Reads a JSON/JSONC file and returns the parsed data.
  */
-export async function readJsonFile(name: string, cwd: string): Promise<JsonFile> {
+export async function readJsoncFile(name: string, cwd: string): Promise<JsonFile> {
   const file = await readTextFile(name, cwd)
-  const data = JSON.parse(file.data) as unknown
-  const indent = detectIndent(file.data).indent
-  const newline = detectNewline(file.data)
+  const data = jsonc.parse(file.data)
+  const modified: ModifyUnion[] = []
 
-  return { ...file, data, indent, newline }
+  return { ...file, data, modified, text: file.data }
 }
 
 /**
- * Writes the given data to the specified JSON file.
+ * Writes the given data to the specified JSON/JSONC file.
  */
-export async function writeJsonFile(file: JsonFile): Promise<void> {
-  let json = JSON.stringify(file.data, undefined, file.indent)
-
-  if (file.newline)
-    json += file.newline
+export async function writeJsoncFile(file: JsonFile): Promise<void> {
+  let newJSON = file.text
+  for (const [key, value] of file.modified) {
+    const edit = (jsonc.modify(file.text, key, value, {}))
+    newJSON = jsonc.applyEdits(newJSON, edit)
+  }
 
-  return writeTextFile({ ...file, data: json })
+  return writeTextFile({ ...file, data: newJSON })
 }
 
 /**

src/fs.ts

@@ -1,5 +1,5 @@
 import { valid as isValidVersion } from 'semver'
-import { readJsonFile } from './fs'
+import { readJsoncFile } from './fs'
 import { isManifest } from './manifest'
 import type { Operation } from './operation'
 
@@ -50,7 +50,7 @@ export async function getCurrentVersion(operation: Operation): Promise<Operation
  */
 async function readVersion(file: string, cwd: string): Promise<string | undefined> {
   try {
-    const { data: manifest } = await readJsonFile(file, cwd)
+    const { data: manifest } = await readJsoncFile(file, cwd)
 
     if (isManifest(manifest)) {
       if (isValidVersion(manifest.version))

src/get-current-version.ts

@@ -1,5 +1,5 @@
 import * as ezSpawn from '@jsdevtools/ez-spawn'
-import { readJsonFile } from './fs'
+import { readJsoncFile } from './fs'
 import type { Manifest } from './manifest'
 import { isManifest } from './manifest'
 import type { Operation } from './operation'
@@ -13,7 +13,7 @@ export async function runNpmScript(script: NpmScript, operation: Operation): Pro
   const { cwd, ignoreScripts } = operation.options
 
   if (!ignoreScripts) {
-    const { data: manifest } = await readJsonFile('package.json', cwd)
+    const { data: manifest } = await readJsoncFile('package.json', cwd)
 
     if (isManifest(manifest) && hasScript(manifest, script)) {
       await ezSpawn.async('npm', ['run', script, '--silent'], { stdio: 'inherit' })

src/run-npm-script.ts

@@ -1,5 +1,5 @@
 import * as path from 'node:path'
-import { readJsonFile, readTextFile, writeJsonFile, writeTextFile } from './fs'
+import { readJsoncFile, readTextFile, writeJsoncFile, writeTextFile } from './fs'
 import { isManifest, isPackageLockManifest } from './manifest'
 import type { Operation } from './operation'
 import { ProgressEvent } from './types/version-bump-progress'
@@ -44,7 +44,9 @@ async function updateFile(relPath: string, operation: Operation): Promise<boolea
     case 'bower.json':
     case 'component.json':
     case 'jsr.json':
+    case 'jsr.jsonc':
     case 'deno.json':
+    case 'deno.jsonc':
       return updateManifestFile(relPath, operation)
 
     default:
@@ -65,14 +67,14 @@ async function updateManifestFile(relPath: string, operation: Operation): Promis
   const { newVersion } = operation.state
   let modified = false
 
-  const file = await readJsonFile(relPath, cwd)
+  const file = await readJsoncFile(relPath, cwd)
 
   if (isManifest(file.data) && file.data.version !== newVersion) {
-    file.data.version = newVersion
+    file.modified.push([['version'], newVersion])
     if (isPackageLockManifest(file.data))
-      file.data.packages[''].version = newVersion
+      file.modified.push([['packages', '', 'version'], newVersion])
 
-    await writeJsonFile(file)
+    await writeJsoncFile(file)
     modified = true
   }