Skip to content

Allow skipping symlink patterns, to avoid raising a fault - #15533

Merged
sosukesuzuki merged 13 commits into
prettier:mainfrom
sanmai-NL:Recover-from-breaking-change-to-symlink-handling
Dec 7, 2023
Merged

Allow skipping symlink patterns, to avoid raising a fault#15533
sosukesuzuki merged 13 commits into
prettier:mainfrom
sanmai-NL:Recover-from-breaking-change-to-symlink-handling

Conversation

@sanmai-NL

@sanmai-NL sanmai-NL commented Oct 23, 2023

Copy link
Copy Markdown
Contributor

Description

In #14627, Prettier was redesigned to ‘no longer follow symbolic links’. However, the implementation went further and turned into a breaking change. Rather than adhering to the exit status contract of only returning a non-zero exit status when a file is not formatted or when something is wrong with Prettier itself, #14627 made Prettier return a non-zero exit status upon any pattern turning out to be a pointing to symlink.

This PR fixes the original PR by @andersk to behave in line with its documentation.

Checklist

  • I’ve added tests to confirm my change works.
  • (If changing the API or CLI) I’ve documented the changes I’ve made (in the docs/ directory).
  • (If the change is user-facing) I’ve added my changes to changelog_unreleased/*/XXXX.md file following changelog_unreleased/TEMPLATE.md.
  • I’ve read the contributing guidelines.

Try the playground for this PR

@sanmai-NL

Copy link
Copy Markdown
Contributor Author

@fisker Can you approve to kick off CI?

@fisker

fisker commented Nov 3, 2023

Copy link
Copy Markdown
Member

I think the behavior is expected, but maybe we can skip it if --no-error-on-unmatched-pattern is used.

@sanmai-NL

sanmai-NL commented Nov 3, 2023

Copy link
Copy Markdown
Contributor Author

@fisker, Can you comment on the fact that the behavior does not match the docs and was different up to the breaking change? These are things I explained in my OP.

@sanmai-NL

Copy link
Copy Markdown
Contributor Author

@fisker This a reminder. My team is waiting for this.

@fisker

fisker commented Nov 21, 2023

Copy link
Copy Markdown
Member

If I remember correctly, it only throws when the pattern is used as arguments.

Say you have a/b is a symblink. The error only throws when you use prettier a/b or prettier a/b someother-pattern. It doesn't throws if you use prettier a or prettier "a/**/*". So, why are you using it as argument?

Correct me if I'm wrong.

@sanmai-NL

Copy link
Copy Markdown
Contributor Author

This was clarified in #14627 (comment).

A tool that uses e.g., Git index changes to trigger Prettier cannot filter for symlinks in a cross-OS compatible manner.

@fisker

fisker commented Nov 21, 2023

Copy link
Copy Markdown
Member

Put it behind --no-error-on-unmatched-pattern then. #15533 (comment)

@sanmai-NL

sanmai-NL commented Nov 21, 2023

Copy link
Copy Markdown
Contributor Author

What do you mean with ‘it’? Do you mean changing this PR to fix --no-error-on-unmatched-pattern or just using --no-error-on-unmatched-pattern in the first place?

This invocation throws a fault - we have been using that parameter all along. This is also discussed in the PR, that you wanted me to open a new issue for.

│ [lefthook] executing: prettier --list-different --no-error-on-unmatched-pattern --ignore-unknown -- .lefthook.yml .mega-linter.yml .sourcery.yaml .v8rrc.yml
┃  prettier ❯ 

[error] Explicitly specified pattern ".lefthook.yml" is a symbolic link.
[error] Explicitly specified pattern ".mega-linter.yml" is a symbolic link.
[error] Explicitly specified pattern ".sourcery.yaml" is a symbolic link.
[error] Explicitly specified pattern ".v8rrc.yml" is a symbolic link.

@fisker

fisker commented Nov 21, 2023

Copy link
Copy Markdown
Member

I think the behavior is expected, but maybe we can skip it if --no-error-on-unmatched-pattern is used.

NOT THROW IF --no-error-on-unmatched-pattern.

@sosukesuzuki

Copy link
Copy Markdown
Member

@fisker Please allow me to ask a question for clarification. Is what you are meaning following?

It is expected behavior that Prettier throws an error when you directly specify the symbolic link path.
However, we can accept pull requests that change that it does not throw errors when --no-error-on-unmatched-pattern is enabled.

@fisker

fisker commented Nov 22, 2023

Copy link
Copy Markdown
Member

Yes, that's what I expect, what do you think?

@sosukesuzuki

Copy link
Copy Markdown
Member

I'm 👍 on your opinion.

@sanmai-NL

Copy link
Copy Markdown
Contributor Author

@sosukesuzuki I implemented the requested change. Can you review please?

Comment thread changelog_unreleased/cli/15533.md Outdated
Comment thread src/cli/expand-patterns.js Outdated
Comment thread changelog_unreleased/cli/15533.md Outdated
@fisker

fisker commented Nov 30, 2023

Copy link
Copy Markdown
Member

@sanmai-NL @andersk Please take a look if you are fine with the changes.

@fisker
fisker requested a review from sosukesuzuki November 30, 2023 08:25
renovate Bot added a commit to mmkal/eslint-plugin-mmkal that referenced this pull request Aug 21, 2024
##### [v3.3.3](https://github.com/prettier/prettier/blob/HEAD/CHANGELOG.md#333)

[diff](prettier/prettier@3.3.2...3.3.3)

##### Add parentheses for nullish coalescing in ternary ([#16391](prettier/prettier#16391) by [@cdignam-segment](https://github.com/cdignam-segment))

This change adds clarity to operator precedence.

<!-- prettier-ignore -->

```js
// Input
foo ? bar ?? foo : baz;
foo ?? bar ? a : b;
a ? b : foo ?? bar;

// Prettier 3.3.2
foo ? bar ?? foo : baz;
foo ?? bar ? a : b;
a ? b : foo ?? bar;

// Prettier 3.3.3
foo ? (bar ?? foo) : baz;
(foo ?? bar) ? a : b;
a ? b : (foo ?? bar);
```

##### Add parentheses for decorator expressions ([#16458](prettier/prettier#16458) by [@y-schneider](https://github.com/y-schneider))

Prevent parentheses around member expressions or tagged template literals from being removed to follow the stricter parsing rules of TypeScript 5.5.

<!-- prettier-ignore -->

```ts
// Input
@(foo`tagged template`)
class X {}

// Prettier 3.3.2
@foo`tagged template`
class X {}

// Prettier 3.3.3
@(foo`tagged template`)
class X {}
```

##### Support `@let` declaration syntax ([#16474](prettier/prettier#16474) by [@sosukesuzuki](https://github.com/sosukesuzuki))

Adds support for Angular v18 `@let` declaration syntax.

Please see the following code example. The `@let` declaration allows you to define local variables within the template:

<!-- prettier-ignore -->

```html
@let name = 'Frodo';

<h1>Dashboard for {{name}}</h1>
Hello, {{name}}
```

For more details, please refer to the excellent blog post by the Angular Team: [Introducing @let in Angular](https://blog.angular.dev/introducing-let-in-angular-686f9f383f0f).

We also appreciate the Angular Team for kindly answering our questions to implement this feature.
##### [v3.3.2](https://github.com/prettier/prettier/blob/HEAD/CHANGELOG.md#332)

[diff](prettier/prettier@3.3.1...3.3.2)

##### Fix handlebars path expressions starts with `@` ([#16358](prettier/prettier#16358) by [@Princeyadav05](https://github.com/Princeyadav05))

<!-- prettier-ignore -->

```hbs
{{! Input }}
<div>{{@x.y.z}}</div>

{{! Prettier 3.3.1 }}
<div>{{@x}}</div>

{{! Prettier 3.3.2 }}
<div>{{@x.y.z}}</div>
```
##### [v3.3.1](https://github.com/prettier/prettier/blob/HEAD/CHANGELOG.md#331)

[diff](prettier/prettier@3.3.0...3.3.1)

##### Preserve empty lines in front matter ([#16347](prettier/prettier#16347) by [@fisker](https://github.com/fisker))

<!-- prettier-ignore -->

```markdown
<!-- Input -->
---
foo:
  - bar1

  - bar2

  - bar3
---
Markdown

<!-- Prettier 3.3.0 -->

---
foo:
  - bar1
  - bar2
  - bar3
---

Markdown


<!-- Prettier 3.3.1 -->
---
foo:
  - bar1

  - bar2

  - bar3
---

Markdown
```

##### Preserve explicit language in front matter ([#16348](prettier/prettier#16348) by [@fisker](https://github.com/fisker))

<!-- prettier-ignore -->

```markdown
<!-- Input -->
---yaml
title: Hello
slug: home
---

<!-- Prettier 3.3.0 -->
---
title: Hello
slug: home
---

<!-- Prettier 3.3.1 -->
---yaml
title: Hello
slug: home
---
```

##### Avoid line breaks in import attributes ([#16349](prettier/prettier#16349) by [@fisker](https://github.com/fisker))

<!-- prettier-ignore -->

```jsx
// Input
import something from "./some-very-very-very-very-very-very-very-very-long-path.json" with { type: "json" };

// Prettier 3.3.0
import something from "./some-very-very-very-very-very-very-very-very-long-path.json" with { type:
  "json" };

// Prettier 3.3.1
import something from "./some-very-very-very-very-very-very-very-very-long-path.json" with { type: "json" };
```
##### [v3.3.0](https://github.com/prettier/prettier/blob/HEAD/CHANGELOG.md#330)

[diff](prettier/prettier@3.2.5...3.3.0)

🔗 [Release Notes](https://prettier.io/blog/2024/06/01/3.3.0.html)
##### [v3.2.5](https://github.com/prettier/prettier/blob/HEAD/CHANGELOG.md#325)

[diff](prettier/prettier@3.2.4...3.2.5)

##### Support Angular inline styles as single template literal ([#15968](prettier/prettier#15968) by [@sosukesuzuki](https://github.com/sosukesuzuki))

[Angular v17](https://blog.angular.io/introducing-angular-v17-4d7033312e4b) supports single string inline styles.

<!-- prettier-ignore -->

```ts
// Input
@component({
  template: `<div>...</div>`,
  styles: `h1 { color: blue; }`,
})
export class AppComponent {}

// Prettier 3.2.4
@component({
  template: `<div>...</div>`,
  styles: `h1 { color: blue; }`,
})
export class AppComponent {}

// Prettier 3.2.5
@component({
  template: `<div>...</div>`,
  styles: `
    h1 {
      color: blue;
    }
  `,
})
export class AppComponent {}

```

##### Unexpected embedded formatting for Angular template ([#15969](prettier/prettier#15969) by [@JounQin](https://github.com/JounQin))

Computed template should not be considered as Angular component template

<!-- prettier-ignore -->

```ts
// Input
const template = "foobar";

@component({
  [template]: `<h1>{{       hello }}</h1>`,
})
export class AppComponent {}

// Prettier 3.2.4
const template = "foobar";

@component({
  [template]: `<h1>{{ hello }}</h1>`,
})
export class AppComponent {}

// Prettier 3.2.5
const template = "foobar";

@component({
  [template]: `<h1>{{       hello }}</h1>`,
})
export class AppComponent {}
```

##### Use `"json"` parser for `tsconfig.json` by default ([#16012](prettier/prettier#16012) by [@sosukesuzuki](https://github.com/sosukesuzuki))

In [v2.3.0](https://prettier.io/blog/2024/01/12/3.2.0#new-jsonc-parser-added-15831httpsgithubcomprettierprettierpull15831-by-fiskerhttpsgithubcomfisker), we introduced `"jsonc"` parser which adds trialing comma **by default**.

When adding a new parser we also define how it will be used based on the [`linguist-languages`](https://www.npmjs.com/package/linguist-languages) data.

`tsconfig.json` is a special file used by [TypeScript](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html#using-tsconfigjson-or-jsconfigjson), it uses `.json` file extension, but it actually uses the [JSON with Comments](https://code.visualstudio.com/docs/languages/json#\_json-with-comments) syntax. However, we found that there are many third-party tools not recognize it correctly because of the confusing `.json` file extension.

We decide to treat it as a JSON file for now to avoid the extra configuration step.

To keep using the `"jsonc"` parser for your `tsconfig.json` files, add the following to your `.pretterrc` file

```json
{
  "overrides": [
    {
      "files": ["tsconfig.json", "jsconfig.json"],
      "options": {
        "parser": "jsonc"
      }
    }
  ]
}
```

<!-- prettier-ignore -->

```
```
##### [v3.2.4](https://github.com/prettier/prettier/blob/HEAD/CHANGELOG.md#324)

[diff](prettier/prettier@3.2.3...3.2.4)

##### Fix incorrect parser inference ([#15947](prettier/prettier#15947) by [@fisker](https://github.com/fisker))

Files like `.eslintrc.json` were incorrectly formatted as JSONC files.

<!-- prettier-ignore -->

```jsx
// Input
prettier --file-info .eslintrc.json
{ "ignored": false, "inferredParser": "jsonc" }

// Prettier 3.2.4
prettier --file-info .eslintrc.json
{ "ignored": false, "inferredParser": "json" }
```
##### [v3.2.3](https://github.com/prettier/prettier/blob/HEAD/CHANGELOG.md#323)

[diff](prettier/prettier@3.2.2...3.2.3)

##### Throw errors for invalid code ([#15881](prettier/prettier#15881) by [@fisker](https://github.com/fisker), [@Josh-Cena](https://github.com/Josh-Cena), [@auvred](https://github.com/auvred))

<!-- prettier-ignore -->

```ts
// Input
1++;

// Prettier 3.2.2
1++;

// Prettier 3.2.3
SyntaxError: Invalid left-hand side expression in unary operation (1:1)
> 1 | 1++;
    | ^
```

<!-- prettier-ignore -->

```ts
// Input
try {} catch (error = 1){}

// Prettier 3.2.2
try {
} catch (error) {}

// Prettier 3.2.3
SyntaxError: Catch clause variable cannot have an initializer. (1:23)
> 1 | try {} catch (error = 1){}
    |                       ^
```

##### Fix parser inference ([#15927](prettier/prettier#15927) by [@fisker](https://github.com/fisker))

<!-- prettier-ignore -->

```console
// Prettier 3.2.2
prettier --file-info tsconfig.json
{ "ignored": false, "inferredParser": "json" }

// Prettier 3.2.3
prettier --file-info tsconfig.json
{ "ignored": false, "inferredParser": "jsonc" }
```
##### [v3.2.2](https://github.com/prettier/prettier/blob/HEAD/CHANGELOG.md#322)

[diff](prettier/prettier@3.2.1...3.2.2)

##### Fix crash when parsing template literal CSS in a JSX style tag using a spread attribute ([#15896](prettier/prettier#15896) by [@eelco](https://github.com/eelco))

For example this code would crash before:

<!-- prettier-ignore -->

```jsx
<style {...spread}>{`.{}`}</style>
```

##### Fix formatting error on optional call expression and member chain ([#15920](prettier/prettier#15920) by [@sosukesuzuki](https://github.com/sosukesuzuki))

<!-- prettier-ignore -->

```jsx
// Input
a(() => {}, c?.d());

// Prettier 3.2.1
TypeError: Cannot read properties of undefined (reading 'type')

// Prettier 3.2.2
a(() => {}, c?.d());
```
##### [v3.2.1](https://github.com/prettier/prettier/blob/HEAD/CHANGELOG.md#321)

[diff](prettier/prettier@3.2.0...3.2.1)

##### Fix formatting error on member chain ([#15915](prettier/prettier#15915) by [@sosukesuzuki](https://github.com/sosukesuzuki))

<!-- prettier-ignore -->

```jsx
// Input
test().test2().test2(thing?.something);

// Prettier 3.2.0
TypeError: Cannot read properties of undefined (reading 'type')

// Prettier 3.2.1
test().test2().test2(thing?.something);

```
##### [v3.2.0](https://github.com/prettier/prettier/blob/HEAD/CHANGELOG.md#320)

[diff](prettier/prettier@3.1.1...3.2.0)

🔗 [Release Notes](https://prettier.io/blog/2024/01/13/3.2.0.html)
##### [v3.1.1](https://github.com/prettier/prettier/blob/HEAD/CHANGELOG.md#311)

[diff](prettier/prettier@3.1.0...3.1.1)

##### Fix config file search ([#15363](prettier/prettier#15363) by [@fisker](https://github.com/fisker))

Previously, we start search for config files from the filePath as a directory, if it happened to be a directory and contains config file, it will be used by mistake.

```text
├─ .prettierrc
└─ test.js         (A directory)
  └─ .prettierrc
```

```js
// Prettier 3.1.0
await prettier.resolveConfigFile(new URL("./test.js", import.meta.url));
// <CWD>/test.js/.prettierrc

// Prettier 3.1.1
await prettier.resolveConfigFile(new URL("./test.js", import.meta.url));
// <CWD>/.prettierrc
```

##### Skip explicitly passed symbolic links with `--no-error-on-unmatched-pattern` ([#15533](prettier/prettier#15533) by [@sanmai-NL](https://github.com/sanmai-NL))

Since Prettier v3, we stopped following symbolic links, however in some use cases, the symbolic link patterns can't be filtered out, and there is no way to prevent Prettier from throwing errors.

In Prettier 3.1.1, you can use `--no-error-on-unmatched-pattern` to simply skip symbolic links.

##### Consistently use tabs in ternaries when `useTabs` is `true` ([#15662](prettier/prettier#15662) by [@auvred](https://github.com/auvred))

<!-- prettier-ignore -->

```jsx
// Input
aaaaaaaaaaaaaaa
	? bbbbbbbbbbbbbbbbbb
	: ccccccccccccccc
	  ? ddddddddddddddd
	  : eeeeeeeeeeeeeee
	    ? fffffffffffffff
	    : gggggggggggggggg;

// Prettier 3.1.0
aaaaaaaaaaaaaaa
	? bbbbbbbbbbbbbbbbbb
	: ccccccccccccccc
	  ? ddddddddddddddd
	  : eeeeeeeeeeeeeee
	    ? fffffffffffffff
	    : gggggggggggggggg;

// Prettier 3.1.1
aaaaaaaaaaaaaaa
	? bbbbbbbbbbbbbbbbbb
	: ccccccccccccccc
		? ddddddddddddddd
		: eeeeeeeeeeeeeee
			? fffffffffffffff
			: gggggggggggggggg;
```

##### Improve config file search ([#15663](prettier/prettier#15663) by [@fisker](https://github.com/fisker))

The Prettier config file search performance has been improved by more effective cache strategy.

##### Fix unstable and ugly formatting for comments in destructuring patterns ([#15708](prettier/prettier#15708) by [@sosukesuzuki](https://github.com/sosukesuzuki))

<!-- prettier-ignore -->

```tsx
// Input
const {
  foo,
  // bar
  // baz
}: Foo = expr;

// Prettier 3.1.0
const {
  foo1,
} // bar
// baz
: Foo = expr;

// Prettier 3.1.0 second output
const {
  foo1, // bar
} // baz
: Foo = expr;

// Prettier 3.1.1
const {
  foo1,
  // bar
  // baz
}: Foo = expr;
```

##### Support "Import Attributes" ([#15718](prettier/prettier#15718) by [@fisker](https://github.com/fisker))

[TypeScript 5.3](https://devblogs.microsoft.com/typescript/announcing-typescript-5-3/#import-attributes) supports the latest updates to the [import attributes](https://github.com/tc39/proposal-import-attributes) proposal.

```tsx
import something from "./something.json" with { type: "json" };
```

##### Fix false claim in docs that cursorOffset is incompatible with rangeStart/rangeEnd ([#15750](prettier/prettier#15750) by [@ExplodingCabbage](https://github.com/ExplodingCabbage))

The cursorOffset option has in fact been compatible with rangeStart/rangeEnd for over 5 years, thanks to work by [@ds300](https://github.com/ds300). However, Prettier's documentation (including the CLI `--help` text) continued to claim otherwise, falsely. The documentation is now fixed.

##### Keep curly braces and `from` keyword in empty `import` statements ([#15756](prettier/prettier#15756) by [@fisker](https://github.com/fisker))

<!-- prettier-ignore -->

```js
// Input
import { } from 'foo';
import { /* comment */ } from 'bar';

// Prettier 3.1.0
import {} from "foo";
import /* comment */ "bar";

// Prettier 3.1.1
import {} from "foo";
import {} from /* comment */ "bar";
```

##### Keep empty import attributes and assertions ([#15757](prettier/prettier#15757) by [@fisker](https://github.com/fisker))

<!-- prettier-ignore -->

```js
// Input
import foo from "foo" with {};
import bar from "bar" assert {};

// Prettier 3.1.0
import foo from "foo";
import bar from "bar";

// Prettier 3.1.1
import foo from "foo" with {};
import bar from "bar" assert {};
```
@zanminkian

Copy link
Copy Markdown

Pardon me for speaking frankly, --no-error-on-unmatched-pattern is not a good option name. Why not --no-error-on-symlinks? If I don't read the source code, I won't understand the usage of this option. And it's also hard to tell the differences between --ignore-unkonwn.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants