Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add name to config #294

Merged
merged 3 commits into from
Mar 7, 2025
Merged

Add name to config #294

merged 3 commits into from
Mar 7, 2025

Conversation

FloEdelmann
Copy link
Contributor

@FloEdelmann FloEdelmann commented Oct 23, 2024

Adding a name is recommended by ESLint: https://eslint.org/docs/latest/use/configure/configuration-files#configuration-naming-conventions

It helps a lot when debugging ESLint configs with Config Inspector.

I went with config-prettier instead of just prettier to distinguish the config and the plugin.

Copy link

changeset-bot bot commented Oct 23, 2024

🦋 Changeset detected

Latest commit: 486095d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
eslint-config-prettier Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@JounQin JounQin force-pushed the main branch 2 times, most recently from aecad88 to 9160ca2 Compare January 13, 2025 15:11
@JounQin JounQin enabled auto-merge (squash) January 13, 2025 15:21
@JounQin
Copy link
Member

JounQin commented Jan 13, 2025

image

This seems a breaking change.

@JounQin JounQin merged commit 8dbbd6d into prettier:main Mar 7, 2025
13 checks passed
@JounQin JounQin mentioned this pull request Mar 7, 2025
@FloEdelmann FloEdelmann deleted the patch-1 branch March 7, 2025 09:26
@JounQin
Copy link
Member

JounQin commented Mar 7, 2025

// before
import eslintConfigPrettier from "eslint-config-prettier";

// after
import eslintConfigPrettier from "eslint-config-prettier/flat";

renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request Mar 8, 2025
| datasource | package                | from   | to     |
| ---------- | ---------------------- | ------ | ------ |
| npm        | eslint-config-prettier | 10.0.1 | 10.1.1 |


## [v10.1.1](https://github.com/prettier/eslint-config-prettier/blob/HEAD/CHANGELOG.md#1011)

##### Patch Changes

-   [#309](prettier/eslint-config-prettier#309) [`eb56a5e`](prettier/eslint-config-prettier@eb56a5e) Thanks [@JounQin](https://github.com/JounQin)! - fix: separate the `/flat` entry for compatibility

    For flat config users, the previous `"eslint-config-prettier"` entry still works, but `"eslint-config-prettier/flat"` adds a new `name` property for [config-inspector](https://eslint.org/blog/2024/04/eslint-config-inspector/), we just can't add it for the default entry for compatibility.

    See also [#308](prettier/eslint-config-prettier#308)

    ```ts
    // before
    import eslintConfigPrettier from "eslint-config-prettier";

    // after
    import eslintConfigPrettier from "eslint-config-prettier/flat";
    ```


## [v10.1.0](https://github.com/prettier/eslint-config-prettier/blob/HEAD/CHANGELOG.md#1010)

##### Minor Changes

-   [#306](prettier/eslint-config-prettier#306) [`56e2e34`](prettier/eslint-config-prettier@56e2e34) Thanks [@JounQin](https://github.com/JounQin)! - feat: migrate to exports field


## [v10.0.3](https://github.com/prettier/eslint-config-prettier/blob/HEAD/CHANGELOG.md#1003)

##### Patch Changes

-   [#294](prettier/eslint-config-prettier#294) [`8dbbd6d`](prettier/eslint-config-prettier@8dbbd6d) Thanks [@FloEdelmann](https://github.com/FloEdelmann)! - feat: add name to config

-   [#280](prettier/eslint-config-prettier#280) [`cba5737`](prettier/eslint-config-prettier@cba5737) Thanks [@zanminkian](https://github.com/zanminkian)! - feat: add declaration file


## [v10.0.2](https://github.com/prettier/eslint-config-prettier/blob/HEAD/CHANGELOG.md#1002)

##### Patch Changes

-   [#299](prettier/eslint-config-prettier#299) [`e750edc`](prettier/eslint-config-prettier@e750edc) Thanks [@Fdawgs](https://github.com/Fdawgs)! - chore(package): explicitly declare js module type
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request Mar 8, 2025
| datasource | package                | from   | to     |
| ---------- | ---------------------- | ------ | ------ |
| npm        | eslint-config-prettier | 10.0.1 | 10.1.1 |


## [v10.1.1](https://github.com/prettier/eslint-config-prettier/blob/HEAD/CHANGELOG.md#1011)

##### Patch Changes

-   [#309](prettier/eslint-config-prettier#309) [`eb56a5e`](prettier/eslint-config-prettier@eb56a5e) Thanks [@JounQin](https://github.com/JounQin)! - fix: separate the `/flat` entry for compatibility

    For flat config users, the previous `"eslint-config-prettier"` entry still works, but `"eslint-config-prettier/flat"` adds a new `name` property for [config-inspector](https://eslint.org/blog/2024/04/eslint-config-inspector/), we just can't add it for the default entry for compatibility.

    See also [#308](prettier/eslint-config-prettier#308)

    ```ts
    // before
    import eslintConfigPrettier from "eslint-config-prettier";

    // after
    import eslintConfigPrettier from "eslint-config-prettier/flat";
    ```


## [v10.1.0](https://github.com/prettier/eslint-config-prettier/blob/HEAD/CHANGELOG.md#1010)

##### Minor Changes

-   [#306](prettier/eslint-config-prettier#306) [`56e2e34`](prettier/eslint-config-prettier@56e2e34) Thanks [@JounQin](https://github.com/JounQin)! - feat: migrate to exports field


## [v10.0.3](https://github.com/prettier/eslint-config-prettier/blob/HEAD/CHANGELOG.md#1003)

##### Patch Changes

-   [#294](prettier/eslint-config-prettier#294) [`8dbbd6d`](prettier/eslint-config-prettier@8dbbd6d) Thanks [@FloEdelmann](https://github.com/FloEdelmann)! - feat: add name to config

-   [#280](prettier/eslint-config-prettier#280) [`cba5737`](prettier/eslint-config-prettier@cba5737) Thanks [@zanminkian](https://github.com/zanminkian)! - feat: add declaration file


## [v10.0.2](https://github.com/prettier/eslint-config-prettier/blob/HEAD/CHANGELOG.md#1002)

##### Patch Changes

-   [#299](prettier/eslint-config-prettier#299) [`e750edc`](prettier/eslint-config-prettier@e750edc) Thanks [@Fdawgs](https://github.com/Fdawgs)! - chore(package): explicitly declare js module type
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.

2 participants