prettier-plugin-expand-json 1.0.2 → 1.0.4

package/README.md

@@ -1,10 +1,36 @@
-[![](https://img.shields.io/npm/v/prettier-plugin-expand-json)](https://www.npmjs.com/package/prettier-plugin-expand-json)
-[![](https://img.shields.io/github/actions/workflow/status/porada/prettier-plugin-expand-json/test.yaml)](https://github.com/porada/prettier-plugin-expand-json/actions/workflows/test.yaml)
-[![](https://img.shields.io/codecov/c/github/porada/prettier-plugin-expand-json)](https://codecov.io/github/porada/prettier-plugin-expand-json)
+<p align="center">
+    <a href="https://github.com/porada/prettier-plugin-expand-json">
+        <picture>
+            <source srcset="https://github.com/porada/prettier-plugin-expand-json/blob/main/assets/prettier-plugin-expand-json-dark-scheme@3x.png?raw=true" media="(prefers-color-scheme: dark)" />
+            <source srcset="https://github.com/porada/prettier-plugin-expand-json/blob/main/assets/prettier-plugin-expand-json-light-scheme@3x.png?raw=true" media="(prefers-color-scheme: light)" />
+            <img src="https://github.com/porada/prettier-plugin-expand-json/blob/main/assets/prettier-plugin-expand-json-light-scheme@3x.png?raw=true" width="520" alt="" />
+        </picture>
+    </a>
+</p>
 
-# prettier-plugin-expand-json
+<h1 align="center">
+    prettier-plugin-expand&#8209;json
+</h1>
 
-Expand JSON arrays and objects into multi-line notation with Prettier—for JSON and JSONC files.
+<p align="center">
+    Expand JSON arrays and objects into multi&#8209;line&nbsp;format with&nbsp;Prettier.
+</p>
+
+<p align="center">
+    <a href="https://www.npmjs.com/package/prettier-plugin-expand-json"><img src="https://img.shields.io/npm/v/prettier-plugin-expand-json" alt="" /></a>
+    <a href="https://github.com/porada/prettier-plugin-expand-json/actions/workflows/test.yaml"><img src="https://img.shields.io/github/actions/workflow/status/porada/prettier-plugin-expand-json/test.yaml" alt="" /></a>
+    <a href="https://codecov.io/github/porada/prettier-plugin-expand-json"><img src="https://img.shields.io/codecov/c/github/porada/prettier-plugin-expand-json" alt="" /></a>
+</p>
+
+<div>&nbsp;</div>
+
+## Overview
+
+This plugin expands all JSON arrays and objects into a consistent multi-line format.
+
+- Works with both JSON and JSONC files.
+- Supports files that Prettier treats as special cases, including `package.json`, `composer.json`, and others.
+- Comes without any additional dependencies.
 
 ## Example
 
@@ -57,7 +83,7 @@ Reference `prettier-plugin-expand-json` in your [Prettier config](https://pretti
 }
 ```
 
-If you’re using multiple JSON-related plugins, make sure `prettier-plugin-expand-json` is listed last. This applies to each `overrides` entry as well.
+If you’re using any other JSON plugins, make sure `prettier-plugin-expand-json` is listed last. This applies to each `overrides` entry as well.
 
 ```json
 {
@@ -70,12 +96,9 @@ If you’re using multiple JSON-related plugins, make sure `prettier-plugin-expa
 
 ```json
 {
-    "plugins": [
-        "prettier-plugin-expand-json"
-    ],
     "overrides": [
         {
-            "files": "packages/**/package.json",
+            "files": "**/package.json",
             "options": {
                 "plugins": [
                     "prettier-plugin-pkg",
@@ -87,9 +110,10 @@ If you’re using multiple JSON-related plugins, make sure `prettier-plugin-expa
 }
 ```
 
-## Recommended
+## Related
 
-Try [**@standard-config/prettier**](https://github.com/standard-config/prettier) if you’re looking for a consistent, TypeScript-first Prettier config. It comes with this plugin pre-configured.
+- [**@standard-config/prettier**](https://github.com/standard-config/prettier)
+- [**prettier-plugin-yaml**](https://github.com/porada/prettier-plugin-yaml)
 
 ## License
 

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;cA0Ga,OAAA,EAAS,MAAA;AAAA,cAUT,QAAA,EAAU,MAAA"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;cA8Fa,OAAA,EAAS,MAAA;AAAA,cAUT,QAAA,EAAU,MAAA"}

package/dist/index.mjs

@@ -1,4 +1,3 @@
-import { applyEdits, format } from "jsonc-parser";
 import { parsers as parsers$1 } from "prettier/plugins/babel";
 import { printers as printers$1 } from "prettier/plugins/estree";
 
@@ -11,11 +10,7 @@ function createParser(name) {
 	const preprocess = async (text, options) => {
 		const priorParser = findPriorParser(name, options, parse);
 		if (typeof priorParser?.preprocess === "function") text = await priorParser.preprocess(text, omitCurrentParser(name, options, parse));
-		const edits = format(text, void 0, {
-			insertSpaces: !options.useTabs,
-			tabSize: options.tabWidth
-		});
-		return applyEdits(text, edits);
+		return text;
 	};
 	return {
 		...parsers$1[name],

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":["babelParsers","estreePrinters"],"sources":["../src/index.ts"],"sourcesContent":["import type { Parser, ParserOptions, Plugin } from 'prettier';\nimport { applyEdits, format } from 'jsonc-parser';\nimport { parsers as babelParsers } from 'prettier/plugins/babel';\nimport { printers as estreePrinters } from 'prettier/plugins/estree';\n\ntype ParserName = 'json' | 'json-stringify' | 'jsonc';\n\ntype ParserPlugin = Omit<Plugin, 'parsers'> & {\n\tparsers: NonNullable<Plugin['parsers']>;\n};\n\nfunction createParser(name: ParserName): Parser {\n\tconst parse: Parser['parse'] = async (\n\t\ttext: string,\n\t\toptions: ParserOptions\n\t) => {\n\t\tconst priorParser = findPriorParser(name, options, parse);\n\n\t\t/* oxlint-disable-next-line typescript/no-unsafe-return */\n\t\treturn typeof priorParser?.parse === 'function'\n\t\t\t? await priorParser.parse(\n\t\t\t\t\ttext,\n\t\t\t\t\tomitCurrentParser(name, options, parse)\n\t\t\t\t)\n\t\t\t: babelParsers[name].parse(text, options);\n\t};\n\n\tconst preprocess: NonNullable<Parser['preprocess']> = async (\n\t\ttext: string,\n\t\toptions: ParserOptions\n\t) => {\n\t\tconst priorParser = findPriorParser(name, options, parse);\n\n\t\tif (typeof priorParser?.preprocess === 'function') {\n\t\t\t/* oxlint-disable-next-line eslint/no-param-reassign */\n\t\t\ttext = await priorParser.preprocess(\n\t\t\t\ttext,\n\t\t\t\tomitCurrentParser(name, options, parse)\n\t\t\t);\n\t\t}\n\n\t\t// This is where the actual expansion happens\n\t\tconst edits = format(text, undefined, {\n\t\t\tinsertSpaces: !options.useTabs,\n\t\t\ttabSize: options.tabWidth,\n\t\t});\n\n\t\treturn applyEdits(text, edits);\n\t};\n\n\treturn {\n\t\t...babelParsers[name],\n\t\tastFormat: 'estree-json',\n\t\tparse,\n\t\tpreprocess,\n\t};\n}\n\nfunction findPriorParser(\n\tname: ParserName,\n\toptions: ParserOptions,\n\tcurrentParse: Parser['parse']\n): Parser | undefined {\n\tfor (const plugin of options.plugins.toReversed()) {\n\t\tif (!isParserPlugin(plugin)) {\n\t\t\tcontinue;\n\t\t}\n\n\t\tconst parser = plugin.parsers[name];\n\n\t\tif (parser && parser.parse !== currentParse) {\n\t\t\treturn parser;\n\t\t}\n\t}\n\n\t/* v8 ignore next -- @preserve */\n\treturn undefined;\n}\n\nfunction isParserPlugin(plugin: unknown): plugin is ParserPlugin {\n\t/* v8 ignore if -- @preserve */\n\tif (!plugin) {\n\t\treturn false;\n\t}\n\n\treturn typeof plugin === 'object' && Object.hasOwn(plugin, 'parsers');\n}\n\nfunction omitCurrentParser(\n\tname: ParserName,\n\toptions: ParserOptions,\n\tcurrentParse: Parser['parse']\n): ParserOptions {\n\treturn {\n\t\t...options,\n\t\tplugins: options.plugins.filter((plugin) => {\n\t\t\tif (!isParserPlugin(plugin)) {\n\t\t\t\treturn true;\n\t\t\t}\n\n\t\t\tconst parser = plugin.parsers[name];\n\t\t\treturn !(parser && parser.parse === currentParse);\n\t\t}),\n\t};\n}\n\nexport const parsers: Plugin['parsers'] = {\n\t'json': createParser('json'),\n\t'json-stringify': createParser('json-stringify'),\n\t'jsonc': createParser('jsonc'),\n};\n\n// Necessary for comment support in JSONC files\nconst { canAttachComment, isBlockComment, printComment } =\n\testreePrinters.estree;\n\nexport const printers: Plugin['printers'] = {\n\t'estree-json': {\n\t\t...estreePrinters['estree-json'],\n\t\tcanAttachComment,\n\t\tisBlockComment,\n\t\tprintComment,\n\t},\n};\n"],"mappings":";;;;;AAWA,SAAS,aAAa,MAA0B;CAC/C,MAAM,QAAyB,OAC9B,MACA,YACI;EACJ,MAAM,cAAc,gBAAgB,MAAM,SAAS,MAAM;AAGzD,SAAO,OAAO,aAAa,UAAU,aAClC,MAAM,YAAY,MAClB,MACA,kBAAkB,MAAM,SAAS,MAAM,CACvC,GACAA,UAAa,MAAM,MAAM,MAAM,QAAQ;;CAG3C,MAAM,aAAgD,OACrD,MACA,YACI;EACJ,MAAM,cAAc,gBAAgB,MAAM,SAAS,MAAM;AAEzD,MAAI,OAAO,aAAa,eAAe,WAEtC,QAAO,MAAM,YAAY,WACxB,MACA,kBAAkB,MAAM,SAAS,MAAM,CACvC;EAIF,MAAM,QAAQ,OAAO,MAAM,QAAW;GACrC,cAAc,CAAC,QAAQ;GACvB,SAAS,QAAQ;GACjB,CAAC;AAEF,SAAO,WAAW,MAAM,MAAM;;AAG/B,QAAO;EACN,GAAGA,UAAa;EAChB,WAAW;EACX;EACA;EACA;;AAGF,SAAS,gBACR,MACA,SACA,cACqB;AACrB,MAAK,MAAM,UAAU,QAAQ,QAAQ,YAAY,EAAE;AAClD,MAAI,CAAC,eAAe,OAAO,CAC1B;EAGD,MAAM,SAAS,OAAO,QAAQ;AAE9B,MAAI,UAAU,OAAO,UAAU,aAC9B,QAAO;;;AAQV,SAAS,eAAe,QAAyC;;AAEhE,KAAI,CAAC,OACJ,QAAO;AAGR,QAAO,OAAO,WAAW,YAAY,OAAO,OAAO,QAAQ,UAAU;;AAGtE,SAAS,kBACR,MACA,SACA,cACgB;AAChB,QAAO;EACN,GAAG;EACH,SAAS,QAAQ,QAAQ,QAAQ,WAAW;AAC3C,OAAI,CAAC,eAAe,OAAO,CAC1B,QAAO;GAGR,MAAM,SAAS,OAAO,QAAQ;AAC9B,UAAO,EAAE,UAAU,OAAO,UAAU;IACnC;EACF;;AAGF,MAAa,UAA6B;CACzC,QAAQ,aAAa,OAAO;CAC5B,kBAAkB,aAAa,iBAAiB;CAChD,SAAS,aAAa,QAAQ;CAC9B;AAGD,MAAM,EAAE,kBAAkB,gBAAgB,iBACzCC,WAAe;AAEhB,MAAa,WAA+B,EAC3C,eAAe;CACd,GAAGA,WAAe;CAClB;CACA;CACA;CACA,EACD"}
+{"version":3,"file":"index.mjs","names":["babelParsers","estreePrinters"],"sources":["../src/index.ts"],"sourcesContent":["import type { Parser, ParserOptions, Plugin } from 'prettier';\nimport type { ParserName, PluginWithParsers } from './types/index.d.ts';\nimport { parsers as babelParsers } from 'prettier/plugins/babel';\nimport { printers as estreePrinters } from 'prettier/plugins/estree';\n\nfunction createParser(name: ParserName): Parser {\n\tconst parse: Parser['parse'] = async (\n\t\ttext: string,\n\t\toptions: ParserOptions\n\t) => {\n\t\tconst priorParser = findPriorParser(name, options, parse);\n\n\t\t/* oxlint-disable-next-line typescript/no-unsafe-return */\n\t\treturn typeof priorParser?.parse === 'function'\n\t\t\t? await priorParser.parse(\n\t\t\t\t\ttext,\n\t\t\t\t\tomitCurrentParser(name, options, parse)\n\t\t\t\t)\n\t\t\t: babelParsers[name].parse(text, options);\n\t};\n\n\tconst preprocess: NonNullable<Parser['preprocess']> = async (\n\t\ttext: string,\n\t\toptions: ParserOptions\n\t) => {\n\t\tconst priorParser = findPriorParser(name, options, parse);\n\n\t\tif (typeof priorParser?.preprocess === 'function') {\n\t\t\t/* oxlint-disable-next-line eslint/no-param-reassign */\n\t\t\ttext = await priorParser.preprocess(\n\t\t\t\ttext,\n\t\t\t\tomitCurrentParser(name, options, parse)\n\t\t\t);\n\t\t}\n\n\t\treturn text;\n\t};\n\n\treturn {\n\t\t...babelParsers[name],\n\t\tastFormat: 'estree-json',\n\t\tparse,\n\t\tpreprocess,\n\t};\n}\n\nfunction findPriorParser(\n\tname: ParserName,\n\toptions: ParserOptions,\n\tcurrentParse: Parser['parse']\n): Parser | undefined {\n\tfor (const plugin of options.plugins.toReversed()) {\n\t\tif (!isParserPlugin(plugin)) {\n\t\t\tcontinue;\n\t\t}\n\n\t\tconst parser = plugin.parsers[name];\n\n\t\tif (parser && parser.parse !== currentParse) {\n\t\t\treturn parser;\n\t\t}\n\t}\n\n\t/* v8 ignore next -- @preserve */\n\treturn undefined;\n}\n\nfunction isParserPlugin(plugin: unknown): plugin is PluginWithParsers {\n\t/* v8 ignore if -- @preserve */\n\tif (!plugin) {\n\t\treturn false;\n\t}\n\n\treturn typeof plugin === 'object' && Object.hasOwn(plugin, 'parsers');\n}\n\nfunction omitCurrentParser(\n\tname: ParserName,\n\toptions: ParserOptions,\n\tcurrentParse: Parser['parse']\n): ParserOptions {\n\treturn {\n\t\t...options,\n\t\tplugins: options.plugins.filter((plugin) => {\n\t\t\tif (!isParserPlugin(plugin)) {\n\t\t\t\treturn true;\n\t\t\t}\n\n\t\t\tconst parser = plugin.parsers[name];\n\t\t\treturn !(parser && parser.parse === currentParse);\n\t\t}),\n\t};\n}\n\nexport const parsers: Plugin['parsers'] = {\n\t'json': createParser('json'),\n\t'json-stringify': createParser('json-stringify'),\n\t'jsonc': createParser('jsonc'),\n};\n\n// Necessary for comment support in JSONC files\nconst { canAttachComment, isBlockComment, printComment } =\n\testreePrinters.estree;\n\nexport const printers: Plugin['printers'] = {\n\t'estree-json': {\n\t\t...estreePrinters['estree-json'],\n\t\tcanAttachComment,\n\t\tisBlockComment,\n\t\tprintComment,\n\t},\n};\n"],"mappings":";;;;AAKA,SAAS,aAAa,MAA0B;CAC/C,MAAM,QAAyB,OAC9B,MACA,YACI;EACJ,MAAM,cAAc,gBAAgB,MAAM,SAAS,MAAM;AAGzD,SAAO,OAAO,aAAa,UAAU,aAClC,MAAM,YAAY,MAClB,MACA,kBAAkB,MAAM,SAAS,MAAM,CACvC,GACAA,UAAa,MAAM,MAAM,MAAM,QAAQ;;CAG3C,MAAM,aAAgD,OACrD,MACA,YACI;EACJ,MAAM,cAAc,gBAAgB,MAAM,SAAS,MAAM;AAEzD,MAAI,OAAO,aAAa,eAAe,WAEtC,QAAO,MAAM,YAAY,WACxB,MACA,kBAAkB,MAAM,SAAS,MAAM,CACvC;AAGF,SAAO;;AAGR,QAAO;EACN,GAAGA,UAAa;EAChB,WAAW;EACX;EACA;EACA;;AAGF,SAAS,gBACR,MACA,SACA,cACqB;AACrB,MAAK,MAAM,UAAU,QAAQ,QAAQ,YAAY,EAAE;AAClD,MAAI,CAAC,eAAe,OAAO,CAC1B;EAGD,MAAM,SAAS,OAAO,QAAQ;AAE9B,MAAI,UAAU,OAAO,UAAU,aAC9B,QAAO;;;AAQV,SAAS,eAAe,QAA8C;;AAErE,KAAI,CAAC,OACJ,QAAO;AAGR,QAAO,OAAO,WAAW,YAAY,OAAO,OAAO,QAAQ,UAAU;;AAGtE,SAAS,kBACR,MACA,SACA,cACgB;AAChB,QAAO;EACN,GAAG;EACH,SAAS,QAAQ,QAAQ,QAAQ,WAAW;AAC3C,OAAI,CAAC,eAAe,OAAO,CAC1B,QAAO;GAGR,MAAM,SAAS,OAAO,QAAQ;AAC9B,UAAO,EAAE,UAAU,OAAO,UAAU;IACnC;EACF;;AAGF,MAAa,UAA6B;CACzC,QAAQ,aAAa,OAAO;CAC5B,kBAAkB,aAAa,iBAAiB;CAChD,SAAS,aAAa,QAAQ;CAC9B;AAGD,MAAM,EAAE,kBAAkB,gBAAgB,iBACzCC,WAAe;AAEhB,MAAa,WAA+B,EAC3C,eAAe;CACd,GAAGA,WAAe;CAClB;CACA;CACA;CACA,EACD"}

package/package.json

@@ -1,68 +1,62 @@
 {
-	"name": "prettier-plugin-expand-json",
-	"version": "1.0.2",
-	"description": "Expand JSON arrays and objects into multi-line notation with Prettier",
-	"license": "MIT",
-	"author": {
-		"name": "Dom Porada",
-		"email": "dom@dom.engineering",
-		"url": "https://dom.engineering"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/porada/prettier-plugin-expand-json.git"
-	},
-	"keywords": [
-		"formatting",
-		"json",
-		"jsonc",
-		"prettier",
-		"prettier-plugin"
-	],
-	"files": [
-		"dist/**"
-	],
-	"type": "module",
-	"sideEffects": false,
-	"exports": "./dist/index.mjs",
-	"types": "./dist/index.d.mts",
-	"engines": {
-		"node": ">=20"
-	},
-	"packageManager": "pnpm@10.28.1",
-	"dependencies": {
-		"jsonc-parser": "^3.3.1"
-	},
-	"peerDependencies": {
-		"prettier": ">=3"
-	},
-	"devDependencies": {
-		"@standard-config/eslint": "1.0.0",
-		"@standard-config/prettier": "1.5.0",
-		"@standard-config/tsconfig": "2.0.0",
-		"@vitest/coverage-v8": "4.0.18",
-		"eslint": "9.39.2",
-		"husky": "9.1.7",
-		"jiti": "2.6.1",
-		"oxlint": "1.41.0",
-		"oxlint-tsgolint": "0.11.1",
-		"prettier": "3.8.1",
-		"prettier-plugin-sort-json": "4.2.0",
-		"publint": "0.3.17",
-		"tsdown": "0.20.1",
-		"typescript": "5.9.3",
-		"vitest": "4.0.18"
-	},
-	"scripts": {
-		"build": "tsdown",
-		"fix": "pnpm format && pnpm lint",
-		"format": "prettier --write --ignore-unknown .",
-		"format:check": "prettier --check --ignore-unknown .",
-		"lint": "oxlint --fix --type-aware --type-check --deny-warnings --report-unused-disable-directives && eslint . --fix",
-		"lint:check": "oxlint --type-aware --type-check --deny-warnings --report-unused-disable-directives && eslint .",
-		"prepack": "pnpm run '/^(format:check|lint:check|test|typecheck)$/' && pnpm build",
-		"prepare": "husky",
-		"test": "vitest run",
-		"typecheck": "tsc --noEmit"
-	}
-}
+  "name": "prettier-plugin-expand-json",
+  "version": "1.0.4",
+  "description": "Expand JSON arrays and objects into multi-line format with Prettier",
+  "license": "MIT",
+  "author": {
+    "name": "Dom Porada",
+    "email": "dom@dom.engineering",
+    "url": "https://dom.engineering"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/porada/prettier-plugin-expand-json.git"
+  },
+  "keywords": [
+    "formatting",
+    "json",
+    "jsonc",
+    "prettier",
+    "prettier-plugin"
+  ],
+  "files": [
+    "dist/**"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "engines": {
+    "node": ">=20"
+  },
+  "peerDependencies": {
+    "prettier": ">=3"
+  },
+  "devDependencies": {
+    "@standard-config/eslint": "1.2.1",
+    "@standard-config/prettier": "1.7.0",
+    "@standard-config/tsconfig": "2.0.2",
+    "@vitest/coverage-v8": "4.0.18",
+    "eslint": "9.39.2",
+    "husky": "9.1.7",
+    "jiti": "2.6.1",
+    "oxlint": "1.42.0",
+    "oxlint-tsgolint": "0.11.3",
+    "prettier": "3.8.1",
+    "prettier-plugin-sort-json": "4.2.0",
+    "publint": "0.3.17",
+    "tsdown": "0.20.1",
+    "typescript": "5.9.3",
+    "vitest": "4.0.18"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "fix": "pnpm format && pnpm lint",
+    "format": "prettier --write --ignore-unknown .",
+    "format:check": "prettier --check --ignore-unknown .",
+    "lint": "oxlint --fix --type-aware --type-check --deny-warnings --report-unused-disable-directives && eslint . --fix",
+    "lint:check": "oxlint --type-aware --type-check --deny-warnings --report-unused-disable-directives && eslint .",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  }
+}