prettier-plugin-multiline-arrays-2 1.0.0

package/dist/test/json.test.js

@@ -0,0 +1,403 @@
+import { describe } from '@augment-vir/test';
+import { nextWrapThresholdComment } from '../options.js';
+import { runTests } from './run-tests.mock.js';
+const jsonTests = [
+    {
+        it: 'formats ending array correctly',
+        code: `
+            {
+                "files": [],
+                "references": [
+                    {"path": "./tsconfig.app.json"},
+                    {"path": "./tsconfig.node.json"}
+                ]
+            }
+        `,
+    },
+    {
+        it: 'basic JSON format',
+        code: `
+            {
+                "hello": "there",
+                "stuff": ["a", "b", "c", "d", "e"],
+                "object": {"example": "instance"}
+            }
+        `,
+        expect: `
+            {
+                "hello": "there",
+                "object": {"example": "instance"},
+                "stuff": [
+                    "a",
+                    "b",
+                    "c",
+                    "d",
+                    "e"
+                ]
+            }
+        `,
+        options: {
+            multilineArraysWrapThreshold: 0,
+        },
+    },
+    {
+        it: 'still formats tsconfig.json keys',
+        code: `
+            {
+                "exclude": [
+                    "./configs",
+                    "./coverage",
+                    "./dist",
+                    "./node_modules",
+                    "./test-files"
+                ],
+                "compilerOptions": {
+                    "outDir": "./dist",
+                    "rootDir": "./src"
+                }
+            }
+        `,
+        expect: `
+            {
+                "compilerOptions": {
+                    "outDir": "./dist",
+                    "rootDir": "./src"
+                },
+                "exclude": [
+                    "./configs",
+                    "./coverage",
+                    "./dist",
+                    "./node_modules",
+                    "./test-files"
+                ]
+            }
+        `,
+    },
+    {
+        it: 'basic wrap threshold comment',
+        code: `
+            // ${nextWrapThresholdComment} 3
+            ["hello"]
+        `,
+    },
+    {
+        it: 'invalid wrap threshold triggers error',
+        code: `
+            ["hello"]
+        `,
+        options: {
+            multilineArraysWrapThreshold: 'fifty two',
+        },
+        failureMessage: 'Invalid multilineArraysWrapThreshold value. Expected an integer, but received "fifty two".',
+    },
+    {
+        it: 'exact code desired by Robinfr',
+        code: `
+            [
+                ["thing1"],
+                ["thing2"]
+            ]
+        `,
+        options: {
+            multilineArraysWrapThreshold: 1,
+        },
+    },
+    {
+        it: 'wrap threshold through options',
+        code: `
+            ["hello"]
+        `,
+        options: {
+            multilineArraysWrapThreshold: 3,
+        },
+    },
+    {
+        it: 'line count through options',
+        code: `
+            ["a", "b", "c", "d", "e", "f", "g", "h"]
+        `,
+        expect: `
+            [
+                "a",
+                "b", "c",
+                "d", "e", "f",
+                "g",
+                "h"
+            ]
+        `,
+        options: {
+            multilineArraysLinePattern: '1 2 3',
+        },
+    },
+    {
+        it: 'line count overrides threshold',
+        code: `
+            ["a", "b", "c", "d", "e", "f", "g", "h"]
+        `,
+        expect: `
+            [
+                "a",
+                "b", "c",
+                "d", "e", "f",
+                "g",
+                "h"
+            ]
+        `,
+        options: {
+            multilineArraysLinePattern: '1 2 3',
+            multilineArraysWrapThreshold: 20,
+        },
+    },
+    {
+        it: 'pointless wrap threshold comment',
+        code: `
+            // ${nextWrapThresholdComment} 0
+            [
+                "hello"
+            ]
+        `,
+    },
+    {
+        it: 'leaves trailing newline',
+        code: `
+            {
+                "import": ".cspell-base.json",
+                "words": [
+                    "estree",
+                    "hardline",
+                    "jsplugin",
+                    "mmultiline",
+                    "vite"
+                ]
+            }
+        `,
+    },
+    {
+        /** This test is weird, it won't work if the newline before "example" isn't there. */
+        it: 'with object array element',
+        code: `
+            {
+                "hello": "there",
+                "stuff": ["a", "b", "c", "d", "e", {
+                    "example": "instance"}],
+                "object": {"example": "instance"}
+            }
+        `,
+        expect: `
+            {
+                "hello": "there",
+                "object": {"example": "instance"},
+                "stuff": [
+                    "a",
+                    "b",
+                    "c",
+                    "d",
+                    "e",
+                    {
+                        "example": "instance"
+                    }
+                ]
+            }
+        `,
+    },
+    {
+        it: 'with nested array',
+        code: `
+            {
+                "hello": "there",
+                "stuff": ["a", "b", "c", "d", "e", ["f", "g", "h", "i", "j"]],
+                "object": {"example": "instance"}
+            }
+        `,
+        expect: `
+            {
+                "hello": "there",
+                "object": {"example": "instance"},
+                "stuff": [
+                    "a",
+                    "b",
+                    "c",
+                    "d",
+                    "e",
+                    [
+                        "f",
+                        "g",
+                        "h",
+                        "i",
+                        "j"
+                    ]
+                ]
+            }
+        `,
+        options: {
+            multilineArraysWrapThreshold: 0,
+        },
+    },
+    {
+        it: 'with multiple nested arrays',
+        code: `
+            {
+                "hello": "there",
+                "stuff": ["a", "b", ["f", "g", "h", "i", "j"], "c", "d", "e", ["f", "g", "h", "i", "j"]],
+                "object": {"example": "instance"}
+            }
+        `,
+        expect: `
+            {
+                "hello": "there",
+                "object": {"example": "instance"},
+                "stuff": [
+                    "a",
+                    "b",
+                    [
+                        "f",
+                        "g",
+                        "h",
+                        "i",
+                        "j"
+                    ],
+                    "c",
+                    "d",
+                    "e",
+                    [
+                        "f",
+                        "g",
+                        "h",
+                        "i",
+                        "j"
+                    ]
+                ]
+            }
+        `,
+        options: {
+            multilineArraysWrapThreshold: 0,
+        },
+    },
+    {
+        it: 'basic JSON array with a comment',
+        code: `
+            {
+                "data": [
+                    "one",
+                    // comment
+                    "two"
+                ]
+            }
+        `,
+    },
+    {
+        it: 'basic JSON array with multiple comments',
+        code: `
+            {
+                // comment
+                "data": [
+                    // comment
+                    "one",
+                    // comment
+                    "two"
+                    // comment
+                ]
+                // comment
+            }
+            // comment
+        `,
+    },
+    {
+        it: 'basic JSON array with multiline comments',
+        code: `
+            {
+                /*
+                    comment
+                    comment
+                    comment
+                */
+                "data": [
+                    /*
+                        comment
+                        comment
+                        comment
+                    */
+                    "one",
+                    /*
+                        comment
+                        comment
+                        comment
+                    */
+                    "two"
+                    /*
+                        comment
+                        comment
+                        comment
+                    */
+                ]
+                /*
+                    comment
+                    comment
+                    comment
+                */
+            }
+            /*
+                comment
+                comment
+                comment
+            */
+        `,
+    },
+    {
+        it: 'handles array with only comments GitHub Issue #75',
+        code: `
+            {
+                "editor.codeActionsOnSave": [
+                    // "hello",
+                    // "source.fixAll.eslint",
+                    // "source.fixAll.prettier",
+                ]
+            }
+        `,
+    },
+    {
+        it: 'basic JSON array',
+        code: `
+            {
+                "data": [
+                    "one",
+                    "two"
+                ]
+            }
+        `,
+    },
+    {
+        it: 'basic lone element JSON array',
+        code: `
+            {
+                "data": [
+                    "one one one one one one one one one one one one one one one one one one one one",
+                    "two two two two two two two two two two two two two two two two two two two two"
+                ]
+            }
+        `,
+    },
+    {
+        it: 'keeps closing bracket on its own line for array of objects with bracketSpacing GitHub Issue #70',
+        code: `
+            {
+                "test": [
+                    { "foo": 1 },
+                    { "bar": 2 },
+                    { "baz": 3 }
+                ]
+            }
+        `,
+        options: {
+            bracketSpacing: true,
+            multilineArraysWrapThreshold: 1,
+        },
+    },
+];
+describe('json multiline array formatting', () => {
+    runTests({
+        extension: '.json',
+        tests: jsonTests,
+        parser: 'json',
+    });
+});

package/dist/test/json5.test.d.ts

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

package/dist/test/json5.test.js

@@ -0,0 +1,210 @@
+import { describe } from '@augment-vir/test';
+import { nextWrapThresholdComment } from '../options.js';
+import { runTests } from './run-tests.mock.js';
+const json5Tests = [
+    {
+        it: 'basic JSON format',
+        code: `
+            {
+                hello: 'there',
+                stuff: ['a', 'b', 'c', 'd', 'e'],
+                object: {example: 'instance'}
+            }
+        `,
+        expect: `
+            {
+                hello: 'there',
+                stuff: [
+                    'a',
+                    'b',
+                    'c',
+                    'd',
+                    'e',
+                ],
+                object: {example: 'instance'},
+            }
+        `,
+        options: {
+            multilineArraysWrapThreshold: 0,
+        },
+    },
+    {
+        it: 'basic wrap threshold comment',
+        code: `
+            // ${nextWrapThresholdComment} 3
+            ['hello']
+        `,
+    },
+    {
+        it: 'invalid wrap threshold triggers error',
+        code: `
+            ['hello']
+        `,
+        options: {
+            multilineArraysWrapThreshold: 'fifty two',
+        },
+        failureMessage: 'Invalid multilineArraysWrapThreshold value. Expected an integer, but received "fifty two".',
+    },
+    {
+        it: 'wrap threshold through options',
+        code: `
+            ['hello']
+        `,
+        options: {
+            multilineArraysWrapThreshold: 3,
+        },
+    },
+    {
+        it: 'line count through options',
+        code: `
+            ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h']
+        `,
+        expect: `
+            [
+                'a',
+                'b', 'c',
+                'd', 'e', 'f',
+                'g',
+                'h',
+            ]
+        `,
+        options: {
+            multilineArraysLinePattern: '1 2 3',
+        },
+    },
+    {
+        it: 'line count overrides threshold',
+        code: `
+            ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h']
+        `,
+        expect: `
+            [
+                'a',
+                'b', 'c',
+                'd', 'e', 'f',
+                'g',
+                'h',
+            ]
+        `,
+        options: {
+            multilineArraysLinePattern: '1 2 3',
+            multilineArraysWrapThreshold: 20,
+        },
+    },
+    {
+        it: 'pointless wrap threshold comment',
+        code: `
+            // ${nextWrapThresholdComment} 0
+            [
+                'hello',
+            ]
+        `,
+    },
+    {
+        it: 'with object array element',
+        code: `
+            {
+                hello: 'there',
+                stuff: ['a', 'b', 'c', 'd', 'e', {example: 'instance'}],
+                object: {example: 'instance'}
+            }
+        `,
+        expect: `
+            {
+                hello: 'there',
+                stuff: [
+                    'a',
+                    'b',
+                    'c',
+                    'd',
+                    'e',
+                    {example: 'instance'},
+                ],
+                object: {example: 'instance'},
+            }
+        `,
+        options: {
+            multilineArraysWrapThreshold: 0,
+        },
+    },
+    {
+        it: 'with nested array',
+        code: `
+            {
+                hello: 'there',
+                stuff: ['a', 'b', 'c', 'd', 'e', ['f', 'g', 'h', 'i', 'j']],
+                object: {example: 'instance'}
+            }
+        `,
+        expect: `
+            {
+                hello: 'there',
+                stuff: [
+                    'a',
+                    'b',
+                    'c',
+                    'd',
+                    'e',
+                    [
+                        'f',
+                        'g',
+                        'h',
+                        'i',
+                        'j',
+                    ],
+                ],
+                object: {example: 'instance'},
+            }
+        `,
+        options: {
+            multilineArraysWrapThreshold: 0,
+        },
+    },
+    {
+        it: 'with multiple nested arrays',
+        code: `
+            {
+                hello: 'there',
+                stuff: ['a', 'b', ['f', 'g', 'h', 'i', 'j'], 'c', 'd', 'e', ['f', 'g', 'h', 'i', 'j']],
+                object: {example: 'instance'}
+            }
+        `,
+        expect: `
+            {
+                hello: 'there',
+                stuff: [
+                    'a',
+                    'b',
+                    [
+                        'f',
+                        'g',
+                        'h',
+                        'i',
+                        'j',
+                    ],
+                    'c',
+                    'd',
+                    'e',
+                    [
+                        'f',
+                        'g',
+                        'h',
+                        'i',
+                        'j',
+                    ],
+                ],
+                object: {example: 'instance'},
+            }
+        `,
+        options: {
+            multilineArraysWrapThreshold: 0,
+        },
+    },
+];
+describe('json5 multiline array formatting', () => {
+    runTests({
+        extension: '.json',
+        tests: json5Tests,
+        parser: 'json5',
+    });
+});

package/dist/test/prettier-config.d.ts

@@ -0,0 +1,2 @@
+import type { Options } from "prettier";
+export declare const repoConfig: Options;

package/dist/test/prettier-config.js

@@ -0,0 +1,12 @@
+// @ts-expect-error: ignore this import cause it's not typed. This file itself is manually typing it.
+import importedRepoConfig from "../../prettier.config.mjs";
+export const repoConfig = importedRepoConfig;
+Object.assign(repoConfig, {
+    bracketSpacing: false,
+    jsonRecursiveSort: false,
+    plugins: (repoConfig.plugins ?? []).filter((plugin) => plugin !== "prettier-plugin-sort-json"),
+    printWidth: 100,
+    singleQuote: true,
+    tabWidth: 4,
+    trailingComma: "all",
+});

package/dist/test/prettier-versions.mock.script.d.ts

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