prettier-plugin-multiline-arrays-2 1.0.0 → 5.0.0

package/dist/printer/leading-new-line.d.ts

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

package/dist/printer/leading-new-line.js

@@ -1,6 +1,7 @@
+import { arrayFirst } from "ts-extras";
 import { extractTextBetweenRanges } from "../augments/array.js";
 export function containsLeadingNewline({ nodeLocation, children, originalLines, debug, }) {
-    const firstElement = children[0];
+    const firstElement = arrayFirst(children);
     if (firstElement) {
         const startLocation = nodeLocation?.start;
         if (!startLocation) {

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

@@ -1,5 +1,6 @@
 import { assertWrap } from "@augment-vir/assert";
 import estreePluginModule from "prettier/plugins/estree";
+import { safeCastTo } from "ts-extras";
 import { envDebugKey, fillInOptions, } from "../options.js";
 import { printWithMultilineArrays } from "./insert-new-lines.js";
 /**
@@ -8,7 +9,8 @@ import { printWithMultilineArrays } from "./insert-new-lines.js";
  * via the module's exported value.
  */
 const estreePlugin = estreePluginModule;
-const debug = !!process.env[envDebugKey];
+const debugEnvValue = process.env[envDebugKey];
+const debug = Boolean(debugEnvValue);
 export function createMultilineArrayPrinter(basePrinter) {
     return {
         ...basePrinter,
@@ -24,7 +26,7 @@ export function createMultilineArrayPrinter(basePrinter) {
                 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") &&
+            if (safeCastTo(options.filepath)?.endsWith("package.json") &&
                 options.plugins.some((plugin) => typeof plugin === "object" &&
                     plugin.name?.includes("prettier-plugin-packagejson"))) {
                 return originalOutput;

package/dist/printer/original-printer.js

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

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

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

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

@@ -1,12 +1,13 @@
-const arrayLikeNodeTypes = [
+import { setHas } from "ts-extras";
+const arrayLikeNodeTypes = new Set([
     "ArrayExpression",
     "ArrayPattern",
-    // this expression type isn't accounted for in the types, but I saw it used in another plugin
-    "TupleExpression",
     "TSTupleType",
-];
+    // This expression type isn't accounted for in the types, but I saw it used in another plugin
+    "TupleExpression",
+]);
 export function isArrayLikeNode(node) {
-    return arrayLikeNodeTypes.includes(node.type);
+    return setHas(arrayLikeNodeTypes, node.type);
 }
 export function getArrayLikeElements(node) {
     if (node.type === "TSTupleType") {

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

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

package/dist/printer/trailing-comma.js

@@ -1,6 +1,6 @@
 import { extractTextBetweenRanges } from "../augments/array.js";
 export function containsTrailingComma({ nodeLocation, children, originalLines, }) {
-    const lastElement = children[children.length - 1];
+    const [lastElement] = children.toReversed();
     if (lastElement) {
         const startLocation = lastElement.loc?.end;
         if (!startLocation) {

package/package.json

@@ -1,7 +1,7 @@
 {
     "$schema": "https://www.schemastore.org/package.json",
     "name": "prettier-plugin-multiline-arrays-2",
-    "version": "1.0.0",
+    "version": "5.0.0",
     "description": "Prettier plugin to force array elements to wrap onto new lines.",
     "keywords": [
         "array",
@@ -45,47 +45,67 @@
         "README.md"
     ],
     "scripts": {
-        "build": "tsc -p tsconfig.build.json",
-        "changelog:generate": "git-cliff --config cliff.toml --output CHANGELOG.md",
-        "changelog:preview": "git-cliff --config cliff.toml --unreleased",
-        "changelog:release-notes": "git-cliff --config cliff.toml --current --strip all",
+        "build": "node -e \"const fs = require('node:fs'); fs.rmSync('dist', {recursive: true, force: true});\" && npx tsc -p tsconfig.build.json",
+        "changelog:generate": "npx git-cliff --config cliff.toml --output CHANGELOG.md",
+        "changelog:preview": "npx git-cliff --config cliff.toml --unreleased",
+        "changelog:release-notes": "npx git-cliff --config cliff.toml --current --strip all",
         "clean": "node -e \"const fs = require('node:fs'); fs.rmSync('dist', {recursive: true, force: true}); fs.rmSync('coverage', {recursive: true, force: true});\"",
-        "format": "prettier . --write",
-        "format:check": "prettier . --check",
-        "lint": "eslint . --cache --cache-strategy content --cache-location .cache/.eslintcache",
-        "lint:fix": "eslint . --cache --cache-strategy content --cache-location .cache/.eslintcache --fix",
-        "lint:package": "publint",
-        "lint:prettier": "prettier . --log-level warn --cache --cache-location=.cache/.prettier-cache --cache-strategy=content --check",
-        "lint:prettier:fix": "prettier . --log-level warn --cache --cache-location=.cache/.prettier-cache --cache-strategy=content --write",
+        "format": "npx prettier . --write",
+        "format:check": "npx prettier . --check",
+        "lint": "npx eslint . --cache --cache-strategy content --cache-location .cache/.eslintcache",
+        "lint:fix": "npx eslint . --cache --cache-strategy content --cache-location .cache/.eslintcache --fix",
+        "lint:gitleaks": "gitleaks dir --config .gitleaks.toml .",
+        "lint:package": "npx publint",
+        "lint:package-json": "npx npmPkgJsonLint . --config .npmpackagejsonlintrc.json",
+        "lint:prettier": "npx prettier . --log-level warn --cache --cache-location=.cache/.prettier-cache --cache-strategy=content --check",
+        "lint:prettier:fix": "npx prettier . --log-level warn --cache --cache-location=.cache/.prettier-cache --cache-strategy=content --write",
+        "lint:remark": "npx remark . --frail --ignore-path .remarkignore",
+        "lint:remark:fix": "npx remark . --ignore-path .remarkignore --output",
+        "lint:yamllint": "yamllint -c .yamllint .",
         "prepack": "npm run build",
         "release:check": "npm run release:verify && npm pack --dry-run",
-        "release:verify": "npm run build && npm run typecheck && npm run lint && npm run lint:prettier && npm run lint:package && npm run test:prettier-latest && npm test",
-        "test": "node --import tsx --test \"src/**/*.test.ts\"",
-        "test:prettier-latest": "npm install --no-save --save-dev prettier@latest && npm test",
-        "test:versions": "npm run build && tsx src/test/prettier-versions.mock.script.ts",
-        "typecheck": "tsc -p tsconfig.json --noEmit",
-        "update-deps": "npx ncu -i --install never && npm update --force && npm install --force"
+        "release:verify": "npm run build && npm run typecheck && npm run lint && npm run lint:prettier && npm run lint:package && npm run lint:package-json && npm run lint:remark && npm run lint:yamllint && npm run test:coverage && npm run test:prettier-latest",
+        "sync:node-version-files": "node scripts/sync-node-version-files.mjs",
+        "sync:peer-prettier-range": "node scripts/sync-peer-prettier-range.mjs",
+        "test": "npx vitest run --coverage",
+        "test:ci": "npx vitest run --coverage --reporter=default --reporter=junit --outputFile.junit=coverage/test-report.junit.xml",
+        "test:coverage": "npx vitest run --coverage",
+        "test:coverage:open": "npm run test:coverage && node -e \"import('node:child_process').then(({spawn}) => spawn(process.platform === 'win32' ? 'cmd' : 'xdg-open', process.platform === 'win32' ? ['/c', 'start', '', 'coverage/index.html'] : ['coverage/index.html'], {stdio: 'ignore', detached: true}))\"",
+        "test:prettier-latest": "npm install --min-release-age=0 --package-lock=false --no-save --save-dev prettier@latest && npm test",
+        "test:versions": "npm run build && npx tsx test/prettier-versions.mock.script.ts",
+        "test:watch": "npx vitest",
+        "typecheck": "npx tsc -p tsconfig.json --noEmit",
+        "update-actions": "npx actions-up --yes --style sha --quiet",
+        "update-all": "npm run update-actions && npm run update-deps",
+        "update-deps": "npx ncu -i --install never && npm update --force && npm install --force && npm run sync:peer-prettier-range && npm run sync:node-version-files"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.73.2",
-        "@augment-vir/common": "^31.73.2",
-        "proxy-vir": "^2.0.3"
+        "@augment-vir/assert": "^32.0.0",
+        "@augment-vir/common": "^32.0.0",
+        "proxy-vir": "^2.0.3",
+        "ts-extras": "^1.2.0"
     },
     "devDependencies": {
-        "@augment-vir/test": "^31.73.2",
+        "@augment-vir/node": "^32.0.0",
         "@eslint/js": "^10.0.1",
+        "@microsoft/tsdoc-config": "^0.18.1",
         "@types/esprima": "^4.0.6",
         "@types/estree": "^1.0.9",
-        "@types/node": "^26.0.0",
+        "@types/node": "^26.1.0",
         "@types/semver": "^7.7.1",
+        "@vitest/coverage-v8": "^4.1.9",
         "cspell": "^10.0.1",
-        "eslint": "^10.5.0",
-        "eslint-config-nick2bad4u": "^3.0.3",
+        "date-vir": "^8.6.2",
+        "eslint": "^10.6.0",
+        "eslint-config-nick2bad4u": "^3.3.1",
         "git-cliff": "^2.13.1",
-        "npm-check-updates": "^22.2.7",
+        "gitleaks-config-nick2bad4u": "^1.0.3",
+        "npm-check-updates": "^22.2.9",
+        "npm-package-json-lint": "^10.4.1",
+        "npm-package-json-lint-config-nick2bad4u": "^1.0.4",
         "object-shape-tester": "^6.14.0",
         "prettier": "^3.9.4",
-        "prettier-config-nick2bad4u": "^1.0.19",
+        "prettier-config-nick2bad4u": "^1.0.22",
         "prettier-plugin-interpolated-html-tags": "^2.0.1",
         "prettier-plugin-jsdoc": "^1.8.1",
         "prettier-plugin-organize-imports": "^4.3.0",
@@ -93,9 +113,16 @@
         "prettier-plugin-sort-json": "^4.2.0",
         "prettier-plugin-toml": "^2.0.6",
         "publint": "^0.3.21",
+        "remark": "^15.0.1",
+        "remark-cli": "^12.0.1",
+        "remark-config-nick2bad4u": "^1.1.3",
         "semver": "^7.8.5",
-        "tsx": "^4.22.4",
-        "typescript": "^6.0.3"
+        "tsdoc-config-nick2bad4u": "^1.0.6",
+        "tsx": "^4.23.0",
+        "typescript": "^6.0.3",
+        "vite": "^8.1.3",
+        "vitest": "^4.1.9",
+        "yamllint-config-nick2bad4u": "^1.1.1"
     },
     "peerDependencies": {
         "prettier": "^3.0.0"

package/dist/augments/array.test.d.ts

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

package/dist/augments/array.test.js

@@ -1,34 +0,0 @@
-import { assert } from '@augment-vir/assert';
-import { describe, it } from '@augment-vir/test';
-import { extractTextBetweenRanges } from './array.js';
-describe(extractTextBetweenRanges.name, () => {
-    it('extracts text from multiple lines', () => {
-        assert.strictEquals(extractTextBetweenRanges([
-            'a b c d e f g h i j k l m n',
-            'o p q r s',
-            't u v w x y',
-            'z',
-        ], {
-            start: {
-                line: 0,
-                column: 4,
-            },
-            end: {
-                line: 2,
-                column: 3,
-            },
-        }), ' d e f g h i j k l m n\no p q r s\nt u');
-    });
-    it('extracts text from the same line', () => {
-        assert.strictEquals(extractTextBetweenRanges(['a b c d e f g h i j k l m n'], {
-            start: {
-                line: 0,
-                column: 4,
-            },
-            end: {
-                line: 0,
-                column: 7,
-            },
-        }), ' d');
-    });
-});

package/dist/options.test.d.ts

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

package/dist/options.test.js

@@ -1,48 +0,0 @@
-import { describe, itCases } from '@augment-vir/test';
-import { optionPropertyValidators } from './options.js';
-describe('optionPropertyValidators', () => {
-    itCases((optionType, input) => {
-        return optionPropertyValidators[optionType](input);
-    }, [
-        {
-            it: 'allows -1 for multilineArraysWrapThreshold',
-            inputs: [
-                'multilineArraysWrapThreshold',
-                -1,
-            ],
-            expect: true,
-        },
-        {
-            it: 'allows numbers for multilineArraysWrapThreshold',
-            inputs: [
-                'multilineArraysWrapThreshold',
-                63,
-            ],
-            expect: true,
-        },
-        {
-            it: 'rejects strings for multilineArraysWrapThreshold',
-            inputs: [
-                'multilineArraysWrapThreshold',
-                '63',
-            ],
-            expect: false,
-        },
-        {
-            it: 'allows numeric strings for multilineArraysLinePattern',
-            inputs: [
-                'multilineArraysLinePattern',
-                '63',
-            ],
-            expect: true,
-        },
-        {
-            it: 'rejects non-numeric strings for multilineArraysLinePattern',
-            inputs: [
-                'multilineArraysLinePattern',
-                '63 keys',
-            ],
-            expect: false,
-        },
-    ]);
-});

package/dist/printer/insert-new-lines.test.d.ts

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

package/dist/printer/insert-new-lines.test.js

@@ -1,36 +0,0 @@
-import { assert } from '@augment-vir/assert';
-import { describe, it } from '@augment-vir/test';
-import { doc } from 'prettier';
-import { insertLinesIntoArray } from './insert-new-lines.js';
-describe(insertLinesIntoArray.name, () => {
-    it('handles comment-only array doc emitted by Prettier GitHub Issue #75', () => {
-        const commentOnlyArrayDoc = [
-            '[',
-            [
-                doc.builders.indent([
-                    doc.builders.softline,
-                    [
-                        '// "source.fixAll.eslint",',
-                        [
-                            doc.builders.hardline,
-                            doc.builders.breakParent,
-                        ],
-                        '// "source.fixAll.prettier",',
-                    ],
-                ]),
-                [
-                    doc.builders.hardline,
-                    doc.builders.breakParent,
-                ],
-            ],
-            ']',
-        ];
-        assert.strictEquals(insertLinesIntoArray({
-            inputDoc: commentOnlyArrayDoc,
-            manualWrap: false,
-            lineCounts: [],
-            wrapThreshold: Infinity,
-            debug: false,
-        }), commentOnlyArrayDoc);
-    });
-});

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

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

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

@@ -1,16 +0,0 @@
-// 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

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

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

@@ -1,12 +0,0 @@
-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

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

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

@@ -1,6 +0,0 @@
-// 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

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

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

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

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

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

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

@@ -1,10 +0,0 @@
-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

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