prettier-plugin-multiline-arrays-2 1.0.0

package/dist/printer/multiline-array-printer.js

@@ -0,0 +1,42 @@
+import { assertWrap } from "@augment-vir/assert";
+import estreePluginModule from "prettier/plugins/estree";
+import { envDebugKey, fillInOptions, } from "../options.js";
+import { printWithMultilineArrays } from "./insert-new-lines.js";
+/**
+ * The estree plugin is bundled with Prettier and exposes the base printers we
+ * want to wrap. Its types don't currently export `printers`, so we access it
+ * via the module's exported value.
+ */
+const estreePlugin = estreePluginModule;
+const debug = !!process.env[envDebugKey];
+export function createMultilineArrayPrinter(basePrinter) {
+    return {
+        ...basePrinter,
+        /**
+         * The 4th parameter `args` is used by Prettier internally. We must
+         * declare it to preserve the function's arity (Function.length), which
+         * Prettier checks to determine behavior. Without this 4th parameter,
+         * Prettier's internal printing logic behaves differently, causing
+         * incorrect output for non-array code (like function calls).
+         */
+        print(path, options, print, args) {
+            if (debug) {
+                console.info("[multiline-arrays] multilineArrayPrinter.print for node:", path.getNode()?.type);
+            }
+            const originalOutput = basePrinter.print(path, options, print, args);
+            if (options.filepath?.endsWith("package.json") &&
+                options.plugins.some((plugin) => typeof plugin === "object" &&
+                    plugin.name?.includes("prettier-plugin-packagejson"))) {
+                return originalOutput;
+            }
+            const multilineOptions = fillInOptions(options);
+            return printWithMultilineArrays({
+                originalFormattedOutput: originalOutput,
+                path,
+                inputOptions: multilineOptions,
+                debug,
+            });
+        },
+    };
+}
+export const multilineArrayPrinter = createMultilineArrayPrinter(assertWrap.isDefined(estreePlugin.printers.estree, "No ESTree printer found."));

package/dist/printer/original-printer.d.ts

@@ -0,0 +1,3 @@
+import type { Printer } from "prettier";
+export declare function setOriginalPrinter(input: Printer): void;
+export declare function getOriginalPrinter(): Printer;

package/dist/printer/original-printer.js

@@ -0,0 +1,10 @@
+let originalPrinter;
+export function setOriginalPrinter(input) {
+    originalPrinter = input;
+}
+export function getOriginalPrinter() {
+    if (!originalPrinter) {
+        throw new Error("originalPrinter hasn't been defined yet!");
+    }
+    return originalPrinter;
+}

package/dist/printer/supported-node-types.d.ts

@@ -0,0 +1,9 @@
+import type { ArrayExpression, ArrayPattern, BaseNode, Node } from "estree";
+type TSTupleType = BaseNode & {
+    type: "TSTupleType";
+    elementTypes: (BaseNode | null)[];
+};
+export type ArrayLikeNode = ArrayExpression | ArrayPattern | TSTupleType;
+export declare function isArrayLikeNode(node: Node): boolean;
+export declare function getArrayLikeElements(node: ArrayLikeNode): (BaseNode | null)[];
+export {};

package/dist/printer/supported-node-types.js

@@ -0,0 +1,16 @@
+const arrayLikeNodeTypes = [
+    "ArrayExpression",
+    "ArrayPattern",
+    // this expression type isn't accounted for in the types, but I saw it used in another plugin
+    "TupleExpression",
+    "TSTupleType",
+];
+export function isArrayLikeNode(node) {
+    return arrayLikeNodeTypes.includes(node.type);
+}
+export function getArrayLikeElements(node) {
+    if (node.type === "TSTupleType") {
+        return node.elementTypes;
+    }
+    return node.elements;
+}

package/dist/printer/trailing-comma.d.ts

@@ -0,0 +1,6 @@
+import type { BaseNode } from "estree";
+export declare function containsTrailingComma({ nodeLocation, children, originalLines, }: Readonly<{
+    nodeLocation: BaseNode["loc"];
+    children: (BaseNode | null)[];
+    originalLines: string[];
+}>): boolean;

package/dist/printer/trailing-comma.js

@@ -0,0 +1,28 @@
+import { extractTextBetweenRanges } from "../augments/array.js";
+export function containsTrailingComma({ nodeLocation, children, originalLines, }) {
+    const lastElement = children[children.length - 1];
+    if (lastElement) {
+        const startLocation = lastElement.loc?.end;
+        if (!startLocation) {
+            return false;
+        }
+        const endLocation = nodeLocation?.end;
+        if (!endLocation) {
+            return false;
+        }
+        const textPastLastElement = extractTextBetweenRanges(originalLines, {
+            start: {
+                column: startLocation.column - 1,
+                line: startLocation.line - 1,
+            },
+            end: {
+                column: endLocation.column - 1,
+                line: endLocation.line - 1,
+            },
+        });
+        if (textPastLastElement.includes(",")) {
+            return true;
+        }
+    }
+    return false;
+}

package/dist/readme-examples/formatted-with-comments.example.d.ts

@@ -0,0 +1,3 @@
+export declare const linePatternArray: string[];
+export declare const highThresholdArray: string[];
+export declare const superHighThresholdArray: string[];

package/dist/readme-examples/formatted-with-comments.example.js

@@ -0,0 +1,16 @@
+// prettier-multiline-arrays-next-line-pattern: 2 1
+export const linePatternArray = [
+    'a', 'b',
+    'c',
+    'd', 'e',
+];
+// Even if this example had a leading new line or a trailing comma, it won't wrap because the
+// comment overrides that behavior.
+// prettier-multiline-arrays-next-threshold: 10
+export const highThresholdArray = ['a', 'b', 'c', 'd', 'e'];
+// this array doesn't fully wrap even though it exceeded the column width because the
+// "next-line-pattern" comment overrides Prettier's column width wrapping
+// prettier-multiline-arrays-next-line-pattern: 100
+export const superHighThresholdArray = [
+    'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u',
+];

package/dist/readme-examples/formatted.example.d.ts

@@ -0,0 +1,2 @@
+export declare const myArray: string[];
+export declare const myCustomArray: string[];

package/dist/readme-examples/formatted.example.js

@@ -0,0 +1,12 @@
+export const myArray = [
+    'a',
+    'b',
+    'c',
+]; // note the trailing comma which forces a wrap
+export const myCustomArray = [
+    'a',
+    'b',
+    'c',
+    'd',
+    'e',
+]; // note the leading new line which forces a wrap

package/dist/readme-examples/not-formatted.example.d.ts

@@ -0,0 +1,2 @@
+export declare const myArray: string[];
+export declare const myCustomArray: string[];

package/dist/readme-examples/not-formatted.example.js

@@ -0,0 +1,6 @@
+// prettier-ignore
+export const myArray = ['a', 'b', 'c',]; // note the trailing comma which forces a wrap
+// prettier-ignore
+export const myCustomArray = [
+    'a', 'b', 'c', 'd', 'e'
+]; // note the leading new line which forces a wrap

package/dist/readme-examples/prettier-options.example.d.ts

@@ -0,0 +1,4 @@
+declare const _default: {
+    plugins: string[];
+};
+export default _default;

package/dist/readme-examples/prettier-options.example.js

@@ -0,0 +1,5 @@
+export default {
+    plugins: [
+        'prettier-plugin-multiline-arrays',
+    ],
+};

package/dist/test/babel-ts.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/babel-ts.test.js

@@ -0,0 +1,10 @@
+import { describe } from '@augment-vir/test';
+import { runTests } from './run-tests.mock.js';
+import { typescriptTests } from './typescript-tests.mock.js';
+describe('babel-ts multiline array formatting', () => {
+    runTests({
+        extension: '.ts',
+        tests: typescriptTests,
+        parser: 'babel-ts',
+    });
+});

package/dist/test/javascript.test.d.ts

@@ -0,0 +1 @@
+export {};