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

📎 .editorconfig support #1724

Closed
ematipico opened this issue Feb 1, 2024 · 27 comments · Fixed by #3343
Closed

📎 .editorconfig support #1724

ematipico opened this issue Feb 1, 2024 · 27 comments · Fixed by #3343
Assignees
Labels
A-Formatter Area: formatter S-Enhancement Status: Improve an existing feature S-Feature Status: new feature to implement S-Funding Status: open to funding and implemented by external contributors S-Help-wanted Status: you're familiar with the code base and want to help the project

Comments

@ematipico
Copy link
Member

ematipico commented Feb 1, 2024

Description

We would like to support the .editorconfig file.

Here's some thoughts about the feature:

  • the file .editorconfig should have higher priority over biome.json, but less priority over the CLI options
  • we could use https://docs.rs/rust-ini/latest/ini/ to parse the file
  • in a CLI setting, we should start looking for the file from the working directory, and use the auto_search to query the parent folders until we find one
    • biome.json and .editorconfig can be a different folders, so their resolution should be separate
  • in a LSP setting, we should start looking for the file fro mthe root directory of the project. and then use auto_search to query the parent folders until we find one
    • biome.json and .editorconfig can be a different folders, so their resolution should be separate
  • should this feature be opt-in or opt-out?

Upvote & Fund

  • We're using Polar.sh so you can upvote and help fund this issue.
  • We receive the funding once the issue is completed & confirmed by you.
  • Thank you in advance for helping prioritize & fund our backlog.
Fund with Polar
@ematipico ematipico added S-Help-wanted Status: you're familiar with the code base and want to help the project A-Formatter Area: formatter S-Enhancement Status: Improve an existing feature labels Feb 1, 2024
@ematipico ematipico changed the title 📎 .editoconfig support 📎 .editorconfig support Feb 1, 2024
@Conaclos
Copy link
Member

Conaclos commented Feb 1, 2024

the file .editorconfig should have higher priority over biome.json

I think this should be the reverse as prettier is doing. We should certainly convert internally the .editorconfig to a biome config and merge bione.json inside it?

@ematipico
Copy link
Member Author

I thought they were doing the opposite. Sounds good to me

@ematipico ematipico added the S-Feature Status: new feature to implement label Feb 5, 2024
@miafoo
Copy link

miafoo commented Feb 10, 2024

I just ran into this "problem" on my own project and it sounds like a great idea. I feel like it should be using .editorconfig rules by default, and anything you explicitly define in your biome.json file should override it and be opt-out by default.

@Deide
Copy link

Deide commented Feb 23, 2024

Yep, fantomas (for F#) has their config values inside .editorconfig too, and it's quite nice for those overlapping areas of concern.

@polar-sh polar-sh bot added the S-Funding Status: open to funding and implemented by external contributors label Feb 23, 2024
@kyr0
Copy link

kyr0 commented Feb 25, 2024

Yep, would be great if biome would read the .editorconfig and use it config, overriding the defaults of biome. But when the user is explicitly setting values in biome config, biome config values should win. This way, it would work for any project using editorconfig from the start, and still not cause regressions for any project not using editorconfig (but maybe having it still in the repo)

Schematically:

=> biome user settings win over
=> .editorconfig values win over
=> biome defaults

Might need deep-merges if we have section support for cases like:

# editorconfig.org

root = true

[*]
indent_style = space
indent_size = 4
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.{tsx}]
indent_size = 2
trim_trailing_whitespace = false

thedannywahl added a commit to thedannywahl/inst-app-template that referenced this issue Apr 10, 2024
align biome config to editorconfig until biome supports editorconfig biomejs/biome#1724
@dyc3
Copy link
Contributor

dyc3 commented May 13, 2024

I would like to pick this up.

It looks like prettier has a separate config option to enable support for .editorconfig: https://prettier.io/docs/en/configuration.html#editorconfig Do we want to match that? Or just support it automagically?

@ematipico
Copy link
Member Author

I would like to pick this up.

It looks like prettier has a separate config option to enable support for .editorconfig: prettier.io/docs/en/configuration.html#editorconfig Do we want to match that? Or just support it automagically?

I believe that option is set to true by default. I suppose this option should be set to true for Biome too.

@dyc3
Copy link
Contributor

dyc3 commented May 14, 2024

A quick status update: I have a working prototype, so I'm going to start cleaning it up a bit and submitting PRs today.

@dyc3
Copy link
Contributor

dyc3 commented May 18, 2024

Todo list of remaining tasks, mostly for myself.

Copy link
Member Author

Thank you @dyc3 for contributing to close this issue! ⭐

The rewards from this issue, totaling $50, has been shared with you.

What now?

  1. Create a Polar account
  2. See incoming rewards & setup Stripe to receive them
  3. Get payouts as backers finalize their payments

If you already have a Polar account setup, you don't need to do anything.

@kyr0
Copy link

kyr0 commented Jul 6, 2024

Well done, @dyc3 ! Thank you :)

@junaga
Copy link

junaga commented Jul 16, 2024

lfg, the future looks bright. imho bimo should also show some kind of warning if .editorconfig and biome options are both available. it should either be one or the other. checking a repo into biome should mean a configuration rewrite, from .editorconfig to biome config.

@junaga
Copy link

junaga commented Jul 16, 2024

oh and i think the docs need a fixup

@dyc3
Copy link
Contributor

dyc3 commented Jul 16, 2024

warning if .editorconfig and biome options are both available.

Do you mean if they have conflicting options? I'm a little confused on what you're looking for.

@nemchik
Copy link

nemchik commented Jul 16, 2024

I actually like the idea of there being a warning (not error) if there is a conflict between .editorconfig and biome.json

@ematipico
Copy link
Member Author

warning if .editorconfig and biome options are both available.

Do you mean if they have conflicting options? I'm a little confused on what you're looking for.

I think they mean in case the same option is specified in both places

@ematipico
Copy link
Member Author

oh and i think the docs need a fixup

The feature isn't available yet, officially. I'm sure @dyc3 will send a PR to update the documentation when we're close to the release

@nemchik
Copy link

nemchik commented Jul 16, 2024

warning if .editorconfig and biome options are both available.

Do you mean if they have conflicting options? I'm a little confused on what you're looking for.

I think they mean in case the same option is specified in both places

Adding to this;

In case the same option is specified in both places with non equivalent values.

If the values in both places are equivalent I don't think it's worth a warning (maybe still worth logging as something other than warning/error). Also, since there is a documented priority, I don't think a conflict should be an error (ex: errors can fail CI or pre-commit) but a warning makes sense to me.

@ematipico
Copy link
Member Author

I'm not really sure we should have any kind of warning, in any case.

The .editorconfig file can also be placed in places outside of the project. A user might want to use a certain set of options for ALL their projects. But then, each project can have slightly different options (for example, a work-related project VS a personal project).

It doesn't make much sense to have a warning in case that's the expected behaviour of the user. Plus, it's possible to fail CI with warnings with a certain option.

It could make sense to provide, maybe a verbose, info diagnostic.

@junaga
Copy link

junaga commented Jul 17, 2024

monorepo support without explicit opt-in?

@ematipico
Copy link
Member Author

monorepo support without explicit opt-in?

I am not really sure what you mean, but .editorconfig, usually, is unrelated to a monorepo. .editorconfig is usually a file placed at the root of a generic repository. Having a .editorconfig file inside each lib isn't the usual setup

@junaga
Copy link

junaga commented Jul 17, 2024

sorry i have no idea. i thought you were suggesting to have biome config nested in a .editorconfig workspace. are there really sensible situations where a project should have both configuration files set?

the way i see it biome is a different tool to opt into, a better one. I understand the paradigm of progressive enhancement - for supporting editor application here. i'm just asking if it makes sense here.

@ematipico
Copy link
Member Author

ematipico commented Jul 17, 2024

are there really sensible situations where a project should have both configuration files set?

Yes, there are! This very repository is an example. You might have files that Biome can't/doesn't handle, but the editor used by a company can handle them, and format them. In the wild, there might be some esoteric projects where you might have some expected files, e.g.: .ini, extensionless files e.g. makefile, .gitignore and more

@junaga
Copy link

junaga commented Jul 18, 2024

ah, okay that makes perfect sense, i just never formated those so far. thanks for the reply

alexandresoro added a commit to alexandresoro/ouca that referenced this issue Sep 13, 2024
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@biomejs/biome](https://biomejs.dev) ([source](https://github.com/biomejs/biome/tree/HEAD/packages/@biomejs/biome)) |  | minor | `1.8.3` -> `1.9.0` |
| [@biomejs/biome](https://biomejs.dev) ([source](https://github.com/biomejs/biome/tree/HEAD/packages/@biomejs/biome)) | devDependencies | minor | [`1.8.3` -> `1.9.0`](https://renovatebot.com/diffs/npm/@biomejs%2fbiome/1.8.3/1.9.0) |

---

### Release Notes

<details>
<summary>biomejs/biome (@&#8203;biomejs/biome)</summary>

### [`v1.9.0`](https://github.com/biomejs/biome/blob/HEAD/CHANGELOG.md#v190-2024-09-12)

[Compare Source](biomejs/biome@c28d597...b260d5b)

##### Analyzer

-   Implement the [semantic model for CSS](biomejs/biome#3546). Contributed by [@&#8203;togami2864](https://github.com/togami2864)

##### CLI

##### New features

-   Add `--graphql-linter-enabled` option, to control whether the linter should be enabled or not for GraphQL files. Contributed by [@&#8203;ematipico](https://github.com/ematipico)

-   New EXPERIMENTAL `search` command. The search command allows you to search a Biome project using [GritQL syntax](https://biomejs.dev/reference/gritql).

    GritQL is a powerful language that lets you do *structural* searches on your codebase. This means that trivia such as whitespace or even the type of strings quotes used will be ignored in your search query. It also has many features for querying the structure of your code, making it much more elegant for searching code than regular expressions.

    While we believe this command may already be useful to users in some situations (especially when integrated in the IDE extensions!), we also had an ulterior motive for adding this command: We intend to utilize GritQL for our plugin efforts, and by allowing our users to try it out in a first iteration, we hope to gain insight in the type of queries you want to do, as well as the bugs we need to focus on.

    For now, the `search` command is explicitly marked as EXPERIMENTAL, since many bugs remain. Keep this in mind when you try it out, and please [let us know](https://github.com/biomejs/biome/issues) your issues!

    Note: GritQL escapes code snippets using backticks, but most shells interpret backticks as command invocations. To avoid this, it's best to put *single quotes* around your Grit queries.

    ```shell
    biome search '`console.log($message)`' # find all `console.log` invocations
    ```

    Contributed by [@&#8203;arendjr](https://github.com/arendjr) and [@&#8203;BackupMiles](https://github.com/BackupMiles)

-   The option `--max-diagnostics` now accept a `none` value, which lifts the limit of diagnostics shown. Contributed by [@&#8203;ematipico](https://github.com/ematipico)
    -   Add a new reporter `--reporter=gitlab`, that emits diagnostics for using the [GitLab Code Quality report](https://docs.gitlab.com/ee/ci/testing/code_quality.html#implement-a-custom-tool).

        ```json
        [
          {
            "description": "Use === instead of ==. == is only allowed when comparing against `null`",
            "check_name": "lint/suspicious/noDoubleEquals",
            "fingerprint": "6143155163249580709",
            "severity": "critical",
            "location": {
              "path": "main.ts",
              "lines": {
                "begin": 4
              }
            }
          }
        ]
        ```

        Contributed by [@&#8203;NiclasvanEyk](https://github.com/NiclasvanEyk)

-   Add new options to the `lsp-proxy` and `start` commands:

    -   `--log-path`: a directory where to store the daemon logs. The commands also accepts the environment variable `BIOME_LOG_PATH`.
    -   `--log-prefix-name`: a prefix that's added to the file name of the logs. It defaults to `server.log`. The commands also accepts the environment variable `BIOME_LOG_PREFIX_NAME`.

    [@&#8203;Contributed](https://github.com/Contributed) by [@&#8203;ematipico](https://github.com/ematipico)

##### Enhancements

-   When a `--reporter` is provided, and it's different from the default one, the value provided by via `--max-diagnostics` is ignored and **the limit is lifted**. Contributed by [@&#8203;ematipico](https://github.com/ematipico)

-   `biome init` now generates a new config file with more options set.
    This change intends to improve discoverability of the options and to set the more commonly used options to their default values.
    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   The `--verbose` flag now reports the list of files that were evaluated, and the list of files that were fixed.
    The **evaluated** files are the those files that can be handled by Biome, files that are ignored, don't have an extension or have an extension that Biome can't evaluate are excluded by this list.
    The **fixed** files are those files that were handled by Biome and *changed*. Files that stays the same after the process are excluded from this list.

    ```shell
     VERBOSE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

      ℹ Files processed:

      - biome/biome.json
      - biome/packages/@&#8203;biomejs/cli-win32-arm64/package.json
      - biome/packages/tailwindcss-config-analyzer/package.json

     VERBOSE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

      ℹ Files fixed:

      - biome/biome/packages/tailwindcss-config-analyzer/src/generate-tailwind-preset.ts
    ```

    Contributed by [@&#8203;ematipico](https://github.com/ematipico)

-   Allow passing `nursery` to the `--only` and `--skip` filters.

    The `--only` option allows you to run a given rule or rule group.
    The `--skip` option allows you to skip the execution of a given group or a given rule.

    Previously, it was not possible to pass `nursery`.
    This restriction is now removed, as it may make sense to skip the nursery rules that a project has enabled.

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   The CLI now returns an error code when calling a command in `stdin` mode, and the contents of the files aren't fixed. For example, the following example will result in an error code of `1` because the `lint` command triggers some lint rules:

    ```shell
    echo "let x = 1" | biome lint --stdin-file-path=stdin.js
    ```

    Contributed by [@&#8203;ematipico](https://github.com/ematipico)

##### Bug fixes

-   `biome lint --write` now takes `--only` and `--skip` into account ([#&#8203;3470](biomejs/biome#3470)). Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   Fix [#&#8203;3368](biomejs/biome#3368), now the reporter `github` tracks the diagnostics that belong to formatting and organize imports. Contributed by [@&#8203;ematipico](https://github.com/ematipico)

-   Fix [#&#8203;3545](biomejs/biome#3545), display a warning, 'Avoid using unnecessary Fragment,' when a Fragment contains only one child element that is placed on a new line. Contributed by [@&#8203;satojin219](https://github.com/satojin219)

-   Migrating from Prettier or ESLint no longer overwrite the `overrides` field from the configuration ([#&#8203;3544](biomejs/biome#3544)). Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   Fix JSX expressions for `noAriaHiddenOnFocusable` ([#&#8203;3708](biomejs/biome#3708)). Contributed by [@&#8203;anthonyshew](https://github.com/anthonyshew)

-   Fix edge case for `<canvas>` elements that use `role="img"` ([#&#8203;3728](biomejs/biome#3728)). Contributed by [@&#8203;anthonyshew](https://github.com/anthonyshew)

-   Fix [#&#8203;3633](biomejs/biome#3633), where diagnostics where incorrectly printed if the code has errors. Contributed by [@&#8203;ematipico](https://github.com/ematipico)

-   Allow `aria-label` on heading to prevent `useHeadingContent` diagnostic ([#&#8203;3767](biomejs/biome#3767)). Contributed by [@&#8203;anthonyshew](https://github.com/anthonyshew)

-   Fix edge case [#&#8203;3791](biomejs/biome#3791) for rule `noFocusedTests` being used with non-string-like expressions ([#&#8203;3793](biomejs/biome#3793)). Contributed by [@&#8203;h-a-n-a](https://github.com/h-a-n-a)

-   Fix optional ARIA properties for `role="separator"` in `useAriaPropsForRole` ([#&#8203;3856](biomejs/biome#3856)). Contributed by [@&#8203;anthonyshew](https://github.com/anthonyshew)

##### Configuration

-   Add support for loading configuration from `.editorconfig` files ([#&#8203;1724](biomejs/biome#1724)).

    Configuration supplied in `.editorconfig` will be overridden by the configuration in `biome.json`. Support is disabled by default and can be enabled by adding the following to your formatter configuration in `biome.json`:

    ```json
    {
      "formatter": {
        "useEditorconfig": true
      }
    }
    ```

    Contributed by [@&#8203;dyc3](https://github.com/dyc3)

-   `overrides` from an extended configuration is now merged with the `overrides` of the extension.

    Given the following shared configuration `biome.shared.json`:

    ```json5
    {
      "overrides": [
        {
          "include": ["**/*.json"],
          // ...
        }
      ]
    }
    ```

    and the following configuration:

    ```json5
    {
      "extends": ["./biome.shared.json"],
      "overrides": [
        {
          "include": ["**/*.ts"],
          // ...
        }
      ]
    }
    ```

    Previously, the `overrides` from `biome.shared.json` was overwritten.
    It is now merged and results in the following configuration:

    ```json5
    {
      "extends": ["./biome.shared.json"],
      "overrides": [
        {
          "include": ["**/*.json"],
          // ...
        },
        {
          "include": ["**/*.ts"],
          // ...
        }
      ]
    }
    ```

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

##### Editors

-   Fix [#&#8203;3577](biomejs/biome#3577), where the update of the configuration file was resulting in the creation of a new internal project. Contributed by [@&#8203;ematipico](https://github.com/ematipico)

-   Fix [#&#8203;3696](biomejs/biome#3696), where `biome.jsonc` was incorrectly parsed with incorrect options. Contributed by [@&#8203;ematipico](https://github.com/ematipico)

##### Formatter

-   The CSS formatter is enabled by default. Which means that you don't need to opt-in anymore using the configuration file `biome.json`:

    ```diff
    {
    -  "css": {
    -    "formatter": {
    -      "enabled": true
    -    }
    -  }
    }
    ```

    Contributed by [@&#8203;ematipico](https://github.com/ematipico)

-   Add parentheses for nullcoalescing in ternaries.

    This change aligns on [Prettier 3.3.3](https://github.com/prettier/prettier/blob/main/CHANGELOG.md#333).
    This adds clarity to operator precedence.

    ```diff
    - foo ? bar ?? foo : baz;
    + foo ? (bar ?? foo) : baz;
    ```

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   Keep the parentheses around `infer ... extends` declarations in type unions and type intersections ([#&#8203;3419](biomejs/biome#3419)). Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   Keep parentheses around a `yield` expression inside a type assertion.

    Previously, Biome removed parentheses around some expressions that require them inside a type assertion.
    For example, in the following code, Biome now preserves the parentheses.

    ```ts
    function* f() {
      return <T>(yield 0);
    }
    ```

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   Remove parentheses around expressions that don't need them inside a decorator.

    Biome now matches Prettier in the following cases:

    ```diff
      class {
    -   @&#8203;(decorator)
    +   @&#8203;decorator
        method() {}
      },
      class {
    -   @&#8203;(decorator())
    +   @&#8203;decorator()
        method() {}
      },
      class {
        @&#8203;(decorator?.())
        method() {}
      },
    ```

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   Keep parentheses around objects preceded with a `@satisfies` comment.

    In the following example, parentheses are no longer removed.

    ```ts
    export const PROPS = /** @&#8203;satisfies {Record<string, string>} */ ({
      prop: 0,
    });
    ```

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

##### Linter

##### Promoted rules

New rules are incubated in the nursery group.
Once stable, we promote them to a stable group.

The following CSS rules are promoted:

-   [a11y/useGenericFontNames](https://biomejs.dev/linter/rules/use-generic-font-names/)
-   [correctness/noInvalidDirectionInLinearGradient](https://biomejs.dev/linter/rules/no-invalid-direction-in-linear-gradient/)
-   [correctness/noInvalidGridAreas](https://biomejs.dev/linter/rules/no-invalid-grid-areas/)
-   [correctness/noInvalidPositionAtImportRule](https://biomejs.dev/linter/rules/no-invalid-position-at-import-rule/)
-   [correctness/noUnknownFunction](https://biomejs.dev/linter/rules/no-unknown-function/)
-   [correctness/noUnknownMediaFeatureName](https://biomejs.dev/linter/rules/no-unknown-media-feature-name/)
-   [correctness/noUnknownProperty](https://biomejs.dev/linter/rules/no-unknown-property/)
-   [correctness/noUnknownUnit](https://biomejs.dev/linter/rules/no-unknown-unit/)
-   [correctness/noUnmatchableAnbSelector](https://biomejs.dev/linter/rules/no-unmatchable-anb-selector/)
-   [suspicious/noDuplicateAtImportRules](https://biomejs.dev/linter/rules/no-duplicate-at-import-rules/)
-   [suspicious/noDuplicateFontNames](https://biomejs.dev/linter/rules/no-duplicate-font-names/)
-   [suspicious/noDuplicateSelectorsKeyframeBlock](https://biomejs.dev/linter/rules/no-duplicate-selectors-keyframe-block/)
-   [suspicious/noEmptyBlock](https://biomejs.dev/linter/rules/no-empty-block/)
-   [suspicious/noImportantInKeyframe](https://biomejs.dev/linter/rules/no-important-in-keyframe/)
-   [suspicious/noShorthandPropertyOverrides](https://biomejs.dev/linter/rules/no-shorthand-property-overrides/)

The following JavaScript rules are promoted:

-   [a11y/noLabelWithoutControl](https://biomejs.dev/linter/rules/no-label-without-control/)
-   [a11y/useFocusableInteractive](https://biomejs.dev/linter/rules/use-focusable-interactive/)
-   [a11y/useSemanticElements](https://biomejs.dev/linter/rules/use-semantic-elements/)
-   [complexity/noUselessStringConcat](https://biomejs.dev/linter/rules/no-useless-string-concat/)
-   [complexity/noUselessUndefinedInitialization](https://biomejs.dev/linter/rules/no-useless-undefined-initialization/)
-   [complexity/useDateNow](https://biomejs.dev/linter/rules/use-date-now/)
-   [correctness/noUndeclaredDependencies](https://biomejs.dev/linter/rules/no-undeclared-dependencies/)
-   [correctness/noInvalidBuiltinInstantiation](https://biomejs.dev/linter/rules/no-invalid-builtin-instantiation/)
-   [correctness/noUnusedFunctionParameters](https://biomejs.dev/linter/rules/no-unused-function-parameters/)
-   [correctness/useImportExtensions](https://biomejs.dev/linter/rules/use-import-extensions/)
-   [performance/useTopLevelRegex](https://biomejs.dev/linter/rules/use-top-level-regex/)
-   [style/noDoneCallback](https://biomejs.dev/linter/rules/no-done-callback/)
-   [style/noYodaExpression](https://biomejs.dev/linter/rules/no-yoda-expression/)
-   [style/useConsistentBuiltinInstantiation](https://biomejs.dev/linter/rules/use-consistent-builtin-instantiation/)
-   [style/useDefaultSwitchClause](https://biomejs.dev/linter/rules/use-default-switch-clause/)
-   [style/useExplicitLengthCheck](https://biomejs.dev/linter/rules/use-explicit-length-check/)
-   [style/useThrowNewError](https://biomejs.dev/linter/rules/use-throw-new-error/)
-   [style/useThrowOnlyError](https://biomejs.dev/linter/rules/use-throw-only-error/)
-   [suspicious/noConsole](https://biomejs.dev/linter/rules/no-console/)
-   [suspicious/noEvolvingTypes](https://biomejs.dev/linter/rules/no-evolving-types/)
-   [suspicious/noMisplacedAssertion](https://biomejs.dev/linter/rules/no-misplaced-assertion/)
-   [suspicious/noReactSpecificProps](https://biomejs.dev/linter/rules/no-react-specific-props/)
-   [suspicious/useErrorMessage](https://biomejs.dev/linter/rules/use-error-message/)
-   [suspicious/useNumberToFixedDigitsArgument](https://biomejs.dev/linter/rules/use-number-to-fixed-digits-argument/)

##### Deprecated rules

-   `correctness/noInvalidNewBuiltin` is deprecated. Use [correctness/noInvalidBuiltinInstantiation](https://biomejs.dev/linter/rules/no-invalid-builtin-instantiation/) instead.
-   `style/useSingleCaseStatement` is deprecated. Use [correctness/noSwitchDeclarations](https://biomejs.dev/linter/rules/no-switch-declarations/) instead.
-   `suspicious/noConsoleLog` is deprecated. Use [suspicious/noConsole](https://biomejs.dev/linter/rules/no-console/) instead.

##### New features

-   Implement [css suppression action](biomejs/biome#3278). Contributed by [@&#8203;togami2864](https://github.com/togami2864)

-   Add support for GraphQL linting. Contributed by [@&#8203;ematipico](https://github.com/ematipico)

-   Add [nursery/noCommonJs](https://biomejs.dev/linter/rules/no-common-js/). Contributed by [@&#8203;minht11](https://github.com/minht11)

-   Add [nursery/noDuplicateCustomProperties](https://biomejs.dev/linter/rules/no-duplicate-custom-properties/). Contributed by [@&#8203;chansuke](https://github.com/chansuke)

-   Add [nursery/noEnum](https://biomejs.dev/linter/rules/no-enum/). Contributed by [@&#8203;nickfla1](https://github.com/nickfla1)

-   Add [nursery/noDynamicNamespaceImportAccess](https://biomejs.dev/linter/no-dynamic-namespace-import-access/). Contributed by [@&#8203;minht11](https://github.com/minht11)

-   Add [nursery/noIrregularWhitespace](https://biomejs.dev/linter/rules/no-irregular-whitespace). Contributed by [@&#8203;michellocana](https://github.com/michellocana)

-   Add [nursery/noRestrictedTypes](https://biomejs.dev/linter/no-restricted-types/). Contributed by [@&#8203;minht11](https://github.com/minht11)

-   Add [nursery/noSecrets](https://biomejs.dev/linter/rules/no-secrets/). Contributed by [@&#8203;SaadBazaz](https://github.com/SaadBazaz)

-   Add [nursery/noUselessEscapeInRegex](https://biomejs.dev/linter/rules/no-useless-escape-in-regex/). Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   Add [nursery/noValueAtRule](https://biomejs.dev/linter/rules/no-value-at-rule/). Contributed by [@&#8203;rishabh3112](https://github.com/rishabh3112)

-   Add [nursery/useAriaPropsSupportedByRole](https://biomejs.dev/linter/rules/use-aria-props-supported-by-role/). Contributed by [@&#8203;ryo-ebata](https://github.com/ryo-ebata)

-   Add [nursery/useConsistentMemberAccessibility](https://biomejs.dev/linter/rules/use-consistent-member-accessibility/). Contributed by [@&#8203;seitarof](https://github.com/seitarof)

-   Add [nursery/useStrictMode](https://biomejs.dev/linter/rules/use-strict-mode/). Contributed by [@&#8203;ematipico](https://github.com/ematipico)

-   Add [nursery/useTrimStartEnd](https://biomejs.dev/linter/rules/use-trim-start-end/). Contributed by [@&#8203;chansuke](https://github.com/chansuke)

-   Add [nursery/noIrregularWhitespace](https://biomejs.dev/linter/rules/no-irreguluar-whitespace/). Contributed by [@&#8203;DerTimonius](https://github.com/DerTimonius)

##### Enhancements

-   Rename `nursery/noUnknownSelectorPseudoElement` to `nursery/noUnknownPseudoElement`. Contributed by [@&#8203;togami2864](https://github.com/togami2864)

-   The CSS linter is now enabled by default. Which means that you don't need to opt-in anymore using the configuration file `biome.json`:

    ```diff
    {
    -  "css": {
    -    "linter": {
    -      "enabled": true
    -    }
    -  }
    }
    ```

    Contributed by [@&#8203;ematipico](https://github.com/ematipico)

-   The JavaScript linter recognizes TypeScript 5.5 and 5.6 globals. Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   [noBlankTarget](https://biomejs.dev/linter/rules/no-blank-target/) now supports an array of allowed domains.

    The following configuration allows `example.com` and `example.org` as blank targets.

    ```json
    "linter": {
      "rules": {
        "a11y": {
          "noBlankTarget": {
          "level": "error",
            "options": {
               "allowDomains": ["example.com", "example.org"]
              }
            }
          }
        }
      }
    ```

    Contributed by [@&#8203;Jayllyz](https://github.com/Jayllyz)

-   [noConsole](https://biomejs.dev/linter/rules/no-console/) now accepts an option that specifies some allowed calls on `console`. Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   Add an `ignoreNull` option for [noDoubleEquals](https://biomejs.dev/linter/rules/no-double-equals/).

    By default the rule allows loose comparisons against `null`.
    The option `ignoreNull` can be set to `false` for reporting loose comparison against `null`.

    Contributed by [@&#8203;peaBerberian](https://github.com/peaBerberian).

-   [noDuplicateObjectKeys](https://biomejs.dev/linter/rules/no-duplicate-object-keys/) now works for JSON and JSONC files. Contributed by [@&#8203;ematipico](https://github.com/ematipico)

-   [noInvalidUseBeforeDeclaration](https://biomejs.dev/linter/rules/no-invalid-use-before-declaration) now reports direct use of an enum member before its declaration.

    In the following code, `A` is reported as use before its declaration.

    ```ts
    enum E {
      B = A << 1,
      A = 1,
    }
    ```

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   [noNodejsModules](https://biomejs.dev/linter/rules/no-nodejs-modules/) now ignores imports of a package which has the same name as a Node.js module. Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   [noNodejsModules](https://biomejs.dev/linter/rules/no-nodejs-modules/) now ignores type-only imports ([#&#8203;1674](biomejs/biome#1674)).

    The rule no longer reports type-only imports such as:

    ```ts
    import type assert from "assert";
    import type * as assert2 from "assert";
    ```

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   [noRedundantUseStrict](https://biomejs.dev/linter/rules/no-redundant-use-strict/) no longer reports `"use strict"` directives when the `package.json` marks explicitly the file as a script using the field `"type": "commonjs"`. Contributed by [@&#8203;ematipico](https://github.com/ematipico)

-   [noStaticOnlyClass](https://biomejs.dev/linter/rules/no-static-only-class/) no longer reports a class that extends another class ([#&#8203;3612](biomejs/biome#3612)). Contributed by [@&#8203;errmayank](https://github.com/errmayank)

-   [noUndeclaredVariables](https://biomejs.dev/linter/rules/no-undeclared-variables/) no longer reports a direct reference to an enum member ([#&#8203;2974](biomejs/biome#2974)).

    In the following code, the `A` reference is no longer reported as an undeclared variable.

    ```ts
    enum E {
      A = 1,
      B = A << 1,
    }
    ```

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   [noUndeclaredVariables](https://biomejs.dev/linter/rules/no-undeclared-variables/) recognized Svelte 5 runes in Svelte components and svelte files.

    Svelte 5 introduced runes.
    The rule now recognizes Svelte 5 runes in files ending with the `.svelte`, `.svelte.js` or `.svelte.ts` extensions.

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   [noUnusedVariables](https://biomejs.dev/linter/rules/no-unused-variables/) now checks TypeScript declaration files.

    This allows to report a type that is unused because it isn't exported.
    Global declarations files (declarations files without exports and imports) are still ignored.

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   [useFilenamingConvention](https://biomejs.dev/linter/rules/use-filenaming-convention) now supports [unicase](https://en.wikipedia.org/wiki/Unicase) letters.

    [unicase](https://en.wikipedia.org/wiki/Unicase) letters have a single case: they are neither uppercase nor lowercase.
    Biome now accepts filenames in unicase.
    For example, the filename `안녕하세요` is now accepted.

    We still reject a name that mixes unicase characters with lowercase or uppercase characters.
    For example, the filename `A안녕하세요` is rejected.

    This change also fixes [#&#8203;3353](biomejs/biome#3353).
    Filenames consisting only of numbers are now accepted.

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   [useFilenamingConvention](https://biomejs.dev/linter/rules/use-filenaming-convention) now supports Next.js/Nuxt/Astro dynamic routes ([#&#8203;3465](biomejs/biome#3465)).

    [Next.js](https://nextjs.org/docs/pages/building-your-application/routing/dynamic-routes#catch-all-segments), [SolidStart](https://docs.solidjs.com/solid-start/building-your-application/routing#renaming-index), [Nuxt](https://nuxt.com/docs/guide/directory-structure/server#catch-all-route), and [Astro](https://docs.astro.build/en/guides/routing/#rest-parameters) support dynamic routes such as `[...slug].js` and `[[...slug]].js`.

    Biome now recognizes this syntax. `slug` must contain only alphanumeric characters.

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   [useExportType](https://biomejs.dev/linter/rules/use-export-type/) no longer reports empty `export` ([#&#8203;3535](biomejs/biome#3535)).

    An empty `export {}` allows you to force TypeScript to consider a file with no imports and exports as an EcmaScript module.
    While `export type {}` is valid, it is more common to use `export {}`.
    Users may find it confusing that the linter asks them to convert it to `export type {}`.
    Also, a bundler should be able to remove `export {}` as well as `export type {}`.
    So it is not so useful to report `export {}`.

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

##### Bug fixes

-   [noControlCharactersInRegex](https://www.biomejs.dev/linter/rules/no-control-characters-in-regex) now corretcly handle `\u` escapes in unicode-aware regexes.

    Previously, the rule didn't consider regex with the `v` flags as unicode-aware regexes.
    Moreover, `\uhhhh` was not handled in unicode-aware regexes.

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   [noControlCharactersInRegex](https://www.biomejs.dev/linter/rules/no-control-characters-in-regex) now reports control characters and escape sequence of control characters in string regexes. Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   `noExcessiveNestedTestSuites`: fix an edge case where the rule would alert on heavily nested zod schemas. Contributed by [@&#8203;dyc3](https://github.com/dyc3)

-   `noExtraNonNullAssertion` no longer reports a single non-null assertion enclosed in parentheses ([#&#8203;3352](biomejs/biome#3352)). Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   [noMultipleSpacesInRegularExpressionLiterals](https://biomejs.dev/linter/rules/no-multiple-spaces-in-regular-expression-literals/) now correctly provides a code fix when Unicode characters are used. Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   [noRedeclare](https://biomejs.dev/linter/rules/no-redeclare/) no longer report redeclartions for lexically scoped function declarations [#&#8203;3664](biomejs/biome#3664).

    In JavaScript strict mode, function declarations are lexically scoped:
    they cannot be accessed outside the block where they are declared.

    In non-strict mode, function declarations are hoisted to the top of the enclosing function or global scope.

    Previously Biome always hoisted function declarations.
    It now takes into account whether the code is in strict or non strict mode.

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   [noUndeclaredDependencies](https://biomejs.dev/linter/rules/no-undeclared-dependencies/) now ignores self package imports.

    Given teh following `package.json`:

    ```json
    {
      "name": "my-package",
      "main": "index.js"
    }
    ```

    The following import is no longer reported by the rule:

    ```js
    import * as mod from "my-package";
    ```

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   Fix \[[#&#8203;3149](biomejs/biome#3149)] crashes that occurred when applying the `noUselessFragments` unsafe fixes in certain scenarios. Contributed by [@&#8203;unvalley](https://github.com/unvalley)

-   [noRedeclare](https://biomejs.dev/linter/rules/no-redeclare/) no longer reports a variable named as the function expression where it is declared. Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   `useAdjacentOverloadSignatures` no longer reports a `#private` class member and a public class member that share the same name ([#&#8203;3309](biomejs/biome#3309)).

    The following code is no longer reported:

    ```js
    class C {
      #f() {}
      g() {}
      f() {}
    }
    ```

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   [useAltText](https://www.biomejs.dev/linter/rules/use-alt-text) n olonger requests alt text for elements hidden from assistive technologies ([#&#8203;3316](biomejs/biome#3316)). Contributed by [@&#8203;robintown](https://github.com/robintown)

-   [useNamingConvention](https://biomejs.dev/linter/rules/use-naming-convention/) now accepts applying custom convention on abstract classes. Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   [useNamingConvention](https://biomejs.dev/linter/rules/use-naming-convention/) no longer suggests an empty fix when a name doesn't match strict Pascal case ([#&#8203;3561](biomejs/biome#3561)).

    Previously the following code led `useNamingConvention` to suggest an empty fix.
    The rule no longer provides a fix for this case.

    ```ts
    type AAb = any
    ```

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   [useNamingConvention](https://biomejs.dev/linter/rules/use-naming-convention/) no longer provides fixes for global TypeScript declaration files.

    Global TypeScript declaration files have no epxorts and no imports.
    All the declared types are available in all files of the project.
    Thus, it is not safe to propose renaming only in the declaration file.

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   [useSortedClasses](https://biomejs.dev/linter/rules/use-sorted-classes/) lint error with Template literals ([#&#8203;3394](biomejs/biome#3394)). Contributed by [@&#8203;hangaoke1](https://github.com/hangaoke1)

-   [useValidAriaValues](https://biomejs.dev/linter/rules/use-valid-aria-values/) now correctly check property types ([3748](biomejs/biome#3748)).

    Properties that expect a string now accept arbitrary text.
    An identifiers can now be made up of any characters except ASCII whitespace.
    An identifier list can now be separated by any ASCII whitespace.

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

##### Parser

##### Enhancements

-   The JSON parser now allows comments in `turbo.json` and `jest.config.json`. Contributed by [@&#8203;Netail](https://github.com/Netail) and [@&#8203;Conaclos](https://github.com/Conaclos)

-   The JSON parser now allows comments in files with the `.json` extension under the `.vscode` and `.zed` directories.

    Biome recognizes are well known JSON files that allows comments and/or trailing commas.
    Previously, Biome did not recognize JSON files under the `.vscode` and the `.zed` directories as JSON files that allow comments.
    You had to configure Biome to recognize them:

    ```json
    {
      "overrides": [
        {
          "include": ["**/.vscode/*.json", "**/.zed/*.json"],
          "json": { "parser": { "allowComments": true } }
        }
      ]
    }
    ```

    This override is no longer needed!
    Note that JSON files under the `.vscode` and the `.zed` directories don't accept trailing commas.

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

##### Bug fixes

-   The CSS parser now accepts emoji in identifiers ([3627](biomejs/biome#3627)).

    The following code is now correctly parsed:

    ```css
    p {
      --🥔-color: red;
      color: var(--🥔-color);
    }
    ```

    Contributed by [@&#8203;Conaclos](https://github.com/Conaclos)

-   Fix [#&#8203;3287](biomejs/biome#3287) nested selectors with pseudo-classes. Contributed by [@&#8203;denbezrukov](https://github.com/denbezrukov)

-   Fix [#&#8203;3349](biomejs/biome#3349) allow CSS multiple ampersand support. Contributed by [@&#8203;denbezrukov](https://github.com/denbezrukov)

    ```css
    .class {
      && {
        color: red;
      }
    }
    ```

-   Fix [#&#8203;3410](biomejs/biome#3410) by correctly parsing break statements containing keywords.
    ```js
    out: while (true) {
      break out;
    }
    ```
    Contributed by [@&#8203;ah-yu](https://github.com/ah-yu)

-   Fix [#&#8203;3464](biomejs/biome#3464) by enabling JSX in `.vue` files that use the `lang='jsx'` or `lang='tsx'` attribute. Contributed by [@&#8203;ematipico](https://github.com/ematipico)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these updates again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC43Ny4zIiwidXBkYXRlZEluVmVyIjoiMzguNzcuMyIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiZGVwZW5kZW5jaWVzIl19-->

Co-authored-by: Alexandre Soro <[email protected]>
Reviewed-on: https://git.tristess.app/alexandresoro/ouca/pulls/110
Co-authored-by: renovate <[email protected]>
Co-committed-by: renovate <[email protected]>
@difosfor
Copy link

So is the Biome formatter supposed to completely support .editorconfig? Because it seems like it does not support trim_trailing_whitespace = true. And it also doesn't seem to pick up on the indent_style = space in mine. Should I create an issue?

@dyc3
Copy link
Contributor

dyc3 commented Oct 11, 2024

Editorconfig support is not enabled by default until 2.0. I think trim_trailing_whitespace should already be handled by the formatter. Feel free to file an issue with a repro.

@difosfor
Copy link

difosfor commented Oct 11, 2024

I enabled it in the config under formatter using "useEditorconfig": true, but it doesn't seem to work. I'll double check and create an issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Formatter Area: formatter S-Enhancement Status: Improve an existing feature S-Feature Status: new feature to implement S-Funding Status: open to funding and implemented by external contributors S-Help-wanted Status: you're familiar with the code base and want to help the project
Projects
None yet
Development

Successfully merging a pull request may close this issue.

9 participants