prettier-plugin-expand-json 1.0.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright © Dom Porada <dom@dom.engineering> (https://dom.engineering)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,92 @@
+[![](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)
+
+# prettier-plugin-expand-json
+
+Prettier plugin that expands all JSON arrays and objects into multi-line notation. Works with both JSON and JSONC files.
+
+## Example
+
+<!-- prettier-ignore-start -->
+
+```json
+{
+	"extends": "@standard-config/tsconfig",
+	"compilerOptions": { "exactOptionalPropertyTypes": true },
+	"files": ["src/index.ts", "src/index.d.ts"]
+}
+```
+
+<!-- prettier-ignore-end -->
+
+…will always be formatted as:
+
+```json
+{
+    "extends": "@standard-config/tsconfig",
+    "compilerOptions": {
+        "exactOptionalPropertyTypes": true
+    },
+    "files": [
+        "src/index.ts",
+        "src/index.d.ts"
+    ]
+}
+```
+
+## Install
+
+```sh
+npm install --save-dev prettier-plugin-expand-json
+```
+
+```sh
+pnpm add --save-dev prettier-plugin-expand-json
+```
+
+## Usage
+
+Reference `prettier-plugin-expand-json` in your [Prettier config](https://prettier.io/docs/configuration):
+
+```json
+{
+    "plugins": [
+        "prettier-plugin-expand-json"
+    ]
+}
+```
+
+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.
+
+```json
+{
+    "plugins": [
+        "prettier-plugin-sort-json",
+        "prettier-plugin-expand-json"
+    ]
+}
+```
+
+```json
+{
+    "plugins": [
+        "prettier-plugin-expand-json"
+    ],
+    "overrides": [
+        {
+            "files": "packages/**/package.json",
+            "options": {
+                "plugins": [
+                    "prettier-plugin-pkg",
+                    "prettier-plugin-expand-json"
+                ]
+            }
+        }
+    ]
+}
+```
+
+## Recommended
+
+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.

package/dist/index.d.mts

@@ -0,0 +1,8 @@
+import { Plugin } from "prettier";
+
+//#region src/index.d.ts
+declare const parsers: Plugin['parsers'];
+declare const printers: Plugin['printers'];
+//#endregion
+export { parsers, printers };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -0,0 +1,54 @@
+import { applyEdits, format } from "jsonc-parser";
+import { parsers as parsers$1 } from "prettier/plugins/babel";
+import { printers as printers$1 } from "prettier/plugins/estree";
+
+//#region src/index.ts
+function createParser(name) {
+	const parse = async (text, options) => {
+		const priorParser = findPriorParser(name, options, parse, preprocess);
+		return typeof priorParser?.parse === "function" ? await priorParser.parse(text, options) : parsers$1[name].parse(text, options);
+	};
+	const preprocess = async (text, options) => {
+		const priorParser = findPriorParser(name, options, parse, preprocess);
+		if (typeof priorParser?.preprocess === "function") text = await priorParser.preprocess(text, options);
+		const edits = format(text, void 0, {
+			insertSpaces: !options.useTabs,
+			tabSize: options.tabWidth
+		});
+		return applyEdits(text, edits);
+	};
+	return {
+		...parsers$1[name],
+		astFormat: "estree-json",
+		parse,
+		preprocess
+	};
+}
+function findPriorParser(name, options, ownParser, ownPreprocessor) {
+	const plugins = options.plugins ?? [];
+	for (const plugin of plugins.toReversed()) {
+		if (!isParserPlugin(plugin)) continue;
+		const parser = plugin.parsers[name];
+		if (parser && parser.parse !== ownParser && parser.preprocess !== ownPreprocessor) return parser;
+	}
+}
+function isParserPlugin(plugin) {
+	if (!plugin) return false;
+	return typeof plugin === "object" && Object.hasOwn(plugin, "parsers");
+}
+const parsers = {
+	"json": createParser("json"),
+	"json-stringify": createParser("json-stringify"),
+	"jsonc": createParser("jsonc")
+};
+const { canAttachComment, isBlockComment, printComment } = printers$1.estree;
+const printers = { "estree-json": {
+	...printers$1["estree-json"],
+	canAttachComment,
+	isBlockComment,
+	printComment
+} };
+
+//#endregion
+export { parsers, printers };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +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 = keyof typeof babelParsers;\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, preprocess);\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(text, options)\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, preprocess);\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(text, options);\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\townParser: Parser['parse'],\n\townPreprocessor: Parser['preprocess']\n): Parser | undefined {\n\tconst plugins = options.plugins ?? [];\n\n\tfor (const plugin of 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 (\n\t\t\tparser &&\n\t\t\tparser.parse !== ownParser &&\n\t\t\tparser.preprocess !== ownPreprocessor\n\t\t) {\n\t\t\treturn parser;\n\t\t}\n\t}\n\n\treturn undefined;\n}\n\nfunction isParserPlugin(plugin: unknown): plugin is ParserPlugin {\n\tif (!plugin) {\n\t\treturn false;\n\t}\n\n\treturn typeof plugin === 'object' && Object.hasOwn(plugin, 'parsers');\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,OAAO,WAAW;AAGrE,SAAO,OAAO,aAAa,UAAU,aAClC,MAAM,YAAY,MAAM,MAAM,QAAQ,GACtCA,UAAa,MAAM,MAAM,MAAM,QAAQ;;CAG3C,MAAM,aAAgD,OACrD,MACA,YACI;EACJ,MAAM,cAAc,gBAAgB,MAAM,SAAS,OAAO,WAAW;AAErE,MAAI,OAAO,aAAa,eAAe,WAEtC,QAAO,MAAM,YAAY,WAAW,MAAM,QAAQ;EAInD,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,WACA,iBACqB;CACrB,MAAM,UAAU,QAAQ,WAAW,EAAE;AAErC,MAAK,MAAM,UAAU,QAAQ,YAAY,EAAE;AAC1C,MAAI,CAAC,eAAe,OAAO,CAC1B;EAGD,MAAM,SAAS,OAAO,QAAQ;AAE9B,MACC,UACA,OAAO,UAAU,aACjB,OAAO,eAAe,gBAEtB,QAAO;;;AAOV,SAAS,eAAe,QAAyC;AAChE,KAAI,CAAC,OACJ,QAAO;AAGR,QAAO,OAAO,WAAW,YAAY,OAAO,OAAO,QAAQ,UAAU;;AAGtE,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

@@ -0,0 +1,65 @@
+{
+	"name": "prettier-plugin-expand-json",
+	"version": "1.0.0",
+	"description": "Prettier plugin that expands JSON arrays and objects into multi-line notation",
+	"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": ">=22"
+	},
+	"packageManager": "pnpm@10.28.1",
+	"dependencies": {
+		"jsonc-parser": "^3.3.1"
+	},
+	"peerDependencies": {
+		"prettier": ">=3"
+	},
+	"devDependencies": {
+		"@standard-config/prettier": "1.3.0",
+		"@standard-config/tsconfig": "2.0.0",
+		"@vitest/coverage-v8": "4.0.17",
+		"husky": "9.1.7",
+		"oxlint": "1.41.0",
+		"oxlint-tsgolint": "0.11.1",
+		"prettier": "3.8.0",
+		"prettier-plugin-sort-json": "4.2.0",
+		"publint": "0.3.16",
+		"tsdown": "0.19.0",
+		"typescript": "5.9.3",
+		"vitest": "4.0.17"
+	},
+	"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",
+		"lint:check": "oxlint --type-aware --type-check --deny-warnings --report-unused-disable-directives",
+		"prepack": "pnpm run '/^(format:check|lint:check|test|typecheck)$/' && pnpm build",
+		"prepare": "husky",
+		"test": "vitest run",
+		"typecheck": "tsc --noEmit"
+	}
+}