Skip to content

Latest commit

 

History

History
857 lines (647 loc) · 41.7 KB

CHANGELOG.md

File metadata and controls

857 lines (647 loc) · 41.7 KB
Raw

Rome changelog

[Unreleased]

CLI

Configuration

Editors

Formatter

Linter

Other changes

  • Fixed an issue where the noAssignInExpressions rule replaced the operator with an invalid token, which caused other lint rules to crash. #4464
  • Fix an issue that noUnusedVariables rule did not correctly detect exports when a variable and an interface had the same name #4468

Parser

VSCode

JavaScript APIs

12.1.0

CLI

Other changes

  • Refactored the underling argument parsing logic. Changed the look and feel of the help output. #4405.
  • The command rome check can accept input from stdin.
  • Add the argument --stdin-file-path to use when running rome check via stdin.
  • Add the argument --formatter-enabled to the command rome check to control the formatter via CLI.
  • Add the argument --linter-enabled to the command rome check to control the linter via CLI.
  • Add the argument --organize-imports-enabled to the command rome check to control the import sorting via CLI.
  • Add new command rome migrate the transform the configuration file rome.json when there are breaking changes.

Configuration

  • Add vcs property, to opt in the VCS integration:
    • vcs.enabled, to enable or not the integration;
    • vcs.clientKind, the supported clients;
    • vcs.useIgnoreFile, to ignore the files/paths inside the file;
    • vcs.root, an optional path to the root of the VCS;

Editors

Other changes

  • Fix an issue where the VSCode extension duplicates text when using VSCode git utilities #4338
  • Remove code assists from being added to the code actions when apply fixes;
  • When requesting code actions, ignored files should not throw errors. Fixes #4434

Formatter

Other changes

  • Fix an issue where formatting of JSX string literals property values were using incorrect quotes #4054
  • Changed import assertion grammar to the new import attribute assertion
- import "module" assert {}
+ import "module" with {}
  • Fix an issue where JSON formatter does not respect lineWidth for arrays #4351
  • Add support for decorators

Linter

New rules

Promoted rules

New rules are promoted, please check #4431 for more details.

Note that, noExtraSemicolons and noExtraLabels are renamed to noExtraSemicolon and noUselessLabel.

Other changes

  • Code actions are formatted using Rome's formatter. If the formatter is disabled, the code action is not formatted.
  • Fixed an issue that useShorthandArrayType rule did not handle nested ReadonlyArray types correctly and erroneously reported TsObjectType #4354.
  • noUndeclaredVariables detects globals based on the file type.
  • Fix an issue when noUndeclaredVariables incorrectly identifies AggregateError as an undeclared variable. #4365
  • Fix an issue that useLiteralKeys rule doesn't ignore valid uses of square bracket notation. #4370
  • Fix #4348 that caused noNonNullAssertion to emit incorrect code action
  • Fix #4410 that caused useButtonType to miss some cases
  • Fix false positive diagnostics that useCamelCase caused to default exported components
  • Fix false positive diagnostics that useCamelCase caused to private class members
  • Fix false positive diagnostics that useHookAtTopLevel caused to arrow functions, export default functions and function expressions.
  • Fix false positive diagnostics that useHookAtTopLevel caused to as or satisfies expression.
  • Fix false positive diagnostics that noHeadeScope caused to custom components
  • Fix false negative diagnostics that noNoninteractiveElementToInteractiveRole and noNoninteractiveTabindex caused to non-interactive elements.

Parser

Other changes

  • Allow module syntax in cts files
  • Changed import assertion grammar to the new import attribute assertion
- import "module" assert {}
+ import "module" with {}
  • Allow decorators before export and export default. #4252
  • Add support for Stage 3 decorators

VSCode

  • requireConfiguration is set to true by default

12.0.0

CLI

Breaking changes
  • Review how the traversal of the file system works. Now Rome won't navigate folders that are ignored. While this change is a bug fix, this could affect how the ignore entries are defined inside a project. We suggest to review them and make sure they still work.
  • --apply-suggested is now called --apply-unsafe
  • rome check --apply and rome check --apply-unsafe exits with non-zero code (error code) if there are still diagnostics to be addressed.
Other changes
  • rome check now checks import statements. This is an experimental feature that needs to be enabled via configuration. Import can be sorted using rome check --apply-unsafe
  • Rome is able to auto discover the configuration file. If Rome doesn't fine a configuration in the working directory, it will try to find one in the parent directories.
  • Add a new global options called --config-path. It tells Rome to try and discover a rome.json file in the given path. 
     rome format --config-path=../../other/path/
 rome check --config-path=../../other/path/

Configuration

Other changes

  • Rome now uses the internal JSON parser to validate the configuration file. This means Rome won't exit anymore if there are issues with the rome.json file, instead it will apply its defaults to the sections that are incorrect.
  • Add javascript.organizeImports. This is an experimental feature and users need to opt-in.
{
  "organizeImports": {
    "enabled": true,
    "ignore": ["trickyFile.js"]
  }
}
  • Add linter.rules.all and linter.rules.[group].all. These options allow to enable or disable all rules, or all rules for a given group. all and recommended can't be both true.
{
  "linter": {
    "rules": {
      "all": true,
      "style" : {
        "all": false
      }
    }
  }
}

The previous example will enable all rules and disable all rules that belong to the style group.

Editors

Other changes
  • Add support to display diagnostics for JSON files.
  • Add support to format JSON files.
  • Pull diagnostics when parsing a rome.json file.
  • Imports sorting is not applied for files that are not supported or ignored.

Formatter

  • Add support for JSON files
  • Add support for TypeScript 4.7
  • Add support for TypeScript 5.0

Linter

New rules are promoted, please check #4239 for more details.

Parser

  • Support for TypeScript 4.7
  • Support for TypeScript 5.0

VSCode

Other changes
  • Add a new option called requireConfiguration. Enabling this option will force Rome to require a configuration file in your workspace/project. If Rome doesn't find a rome.json file, it won't emit diagnostics.

11.0.0

CLI

BREAKING CHANGES

  • the argument --no-colors has been removed, in favor of --color=off

Other changes

  • The init command now adds the $schema property to the generated rome.json file if rome is installed inside the node_modules folder. Follow this guide to add the $schema property manually in a project with an existing rome.json file.
  • A new --semicolons option that configures if the formatter prints semicolons at the end of every statement (default) or at the beginning of statements when necessary to prevent ASI failures.
  • Rome exits with an error code if it doesn't process any file.
  • Fixed how the maximum number of diagnostics is calculated #3869. Rome now prints the total number of errors caused in the files.
  • Rome now traverses symbolic links and emits warnings if it detects loops, and continues processing the next file during the directory traversal.
  • You can force color output using the new global --colors option with the value force. Forcing color output can be useful if you spawn Rome as a subprocess. Rome is spawned as a process;

Configuration

  • Added the JSON schema $schema property. The schema enables auto-completion by editors and... auto-completion and descriptions of all fields of the configuration file.
  • Added a new files.ignore option where users can ignore files across tools.

Editors

  • We also publish Rome to Open VSX.
  • The extension now resolves the Rome version installed in the node_modules folder.
  • Fixed an issue where diagnostics were not updated after a change to the configuration file (#3724)[rome#3724]
  • The LSP emits a new action where the user can suppress a rule.
  • The extension now allows sort imports

Formatter

BREAKING CHANGES

  • Fixed incompatibility issues with Prettier #3531
  • Fixed an issue where infinite parentheses were wrongly inserted #3735
  • Better formatting for jestEach templates

Other changes

  • Added support for omitting semicolons.

Linter

  • Fixed false positives emitted by noUselessFragments #3668
  • Fixed noArrayIndexKey where some cases were not detected #3670
  • Fixed false positives emitted by noConstAssign #3728
  • Fixed false positives emitted by noShoutyConstants #3867
  • Fixed false positives emitted by noUnusedVariables #3779
  • Fixed noUndeclaredVariables where some cases were not detected #3798
  • Fixed noUndeclaredVariables where types were incorrectly detected #3669

Rules

The following rules have been stabilized:

  • nursery/useFlatMap -> complexity/useFlatMap
  • nursery/useValidForDirection -> correctness/useValidForDirection
  • nursery/noExplicitAny -> suspicious/noExplicitAny
  • nursery/noConstAssign -> correctness/noConstAssign

These rules are all recommended, so they will be enabled by default. You can simply remove those entries from your configuration file if you had enabled them manually from the nursery group.

The following rules have been renamed:

  • a11y/useBlankTarget -> a11y/noBlankTarget
  • correctness/noMultipleSpacesInRegularExpressionLiterals -> complexity/noMultipleSpacesInRegularExpressionLiterals
  • style/useOptionalChain -> complexity/useOptionalChain
  • correctness/noUselessFragments -> complexity/noUselessFragments
  • correctness/noDelete -> performance/noDelete
  • correctness/useSingleCaseStatement -> style/useSingleCaseStatement
  • correctness/useWhile -> style/useWhile
  • correctness/noArguments -> style/noArguments
  • correctness/noAsyncPromiseExecutor -> suspicious/noAsyncPromiseExecutor
  • correctness/noCommentText -> suspicious/noCommentText
  • correctness/noCompareNegZero -> suspicious/noCompareNegZero
  • correctness/noDebugger -> suspicious/noDebugger
  • correctness/noDoubleEquals -> suspicious/noDoubleEquals
  • correctness/noShadowRestrictedNames -> suspicious/noShadowRestrictedNames
  • correctness/noSparseArray -> suspicious/noSparseArray
  • correctness/noUnsafeNegation -> suspicious/noUnsafeNegation
  • correctness/useValidTypeof -> suspicious/useValidTypeof
  • correctness/noArrayIndexKey -> suspicious/noArrayIndexKey
  • correctness/noCatchAssign -> suspicious/noCatchAssign
  • correctness/noDupeArgs -> suspicious/noDuplicateParameters
  • correctness/noFunctionAssign -> suspicious/noFunctionAssign
  • correctness/noImportAssign -> suspicious/noImportAssign
  • correctness/noLabelVar -> suspicious/noLabelVar
  • correctness/noRestrictedGlobals -> nursery/noRestrictedGlobals
  • nursery/noDupeKeys -> nursery/noDuplicateObjectKeys

If you were not changing the severity level of any of these rules in your configuration file, or suppressing a diagnostic emitted by those rules using suppression comments, you do not have to do anything. But if you did, Rome will now emit diagnostics for the parts of your configuration or suppression comments you need to update.

The following rules are no longer recommended:

  • style/noImplicitBoolean
  • style/noNegationElse
  • style/useBlockStatements
  • style/useShorthandArrayType
  • correctness/useSingleCaseStatement / style/useSingleCaseStatement
  • style/noShoutyConstants

The styling decisions imposed by these rules were not deemed to be idiomatic enough in the JavaScript ecosystem to be enabled by default. If you do want to enforce those rules in your project, you will have to enable them manually in you configuration file:

{
  "linter": {
    "rules": {
        "style": {
            "useBlockStatements": "warn"
        }
    }
  }
}

Finally, the following new rules have been introduced to the nursery group in this release:

Please give them a try by manually enabling them in your configuration and please share your feedback on the rule, diagnostics, and code fixes.

Parser

  • Added support for JSON;
  • Added support satisfies keyword;
  • Fixed parse for async used as label #3612
  • Fixed parse of export default function in d.ts files #3485
  • Improved the parsing of await in non-async contexts #2479

VSCode

  • Removed the "preview" label from the extension.
  • Improved logging when the extension can't connect to the server. #3920

JavaScript APIs

Breaking change

  • The concept of backend has been removed, in favor of the concept of distribution.
  • Removed the possibility to connect to the daemon, for the time being.
  • The APIs are asynchronous anymore.

Other changes

  • The package has been marked as unstable and in alpha state.

10.0.1

CLI

  • Respect the formatter / linter enabled flag from configuration (#3591)
  • Correctly account for diff diagnostics in the printed diagnostics count (#3595)

Formatter

  • Do not insert a trailing comma in import expressions (#3600)

Linter

  • Fixed false positives in noUselessFragments, noArrayIndexKey, noChildrenProp, noUselessFragments, noVoidElementsWithChildren, noDangerouslySetInnerHtml, noDangerouslySetInnerHtmlWithChildren, useValidAnchor, noRenderReturnValue, noUnusedVariables and useKeyWithClickEvents (#3592, #3619, #3599, #3626, #3620 & #3644)

Editors

  • Display the version of the language server in the status bar (#3616)

10.0.0

CLI

  • Added the new command rome version.
  • Added the new command rome rage.
  • Added the new command rome lsp-proxy.
  • Added the new option--version as an alias for rome version
  • Added a new argument --files-max-size to change the allowed size of files, in bytes.
  • Added a new argument --formatter-enabled to the command rome ci.
  • Added a new argument --linter-enabled to the command rome ci.
  • Added the new format option --trailing-comma to configure where to add trailing commas.
  • Correctly show the supported options for rome ci, closes #3456.
  • Fixed the command rome ci command to run the linter even if the formatter is disabled, closes #3495.
  • Fixed the messaging of some diagnostics, #3460.

Configuration

  • Added files.maxSize, to change the allowed size of files, in bytes.

Diagnostics

  • Fix false positive for unknown lint rule in suppression comments during formatting #3406.
  • Correctly handle empty lines when printing code diffs #3375.

Formatter

  • Added the new trailing comma option that configures where to add trailing commas. Supports the values: all, es5 and none; refer to the documentation to learn more.
  • Improved JSX formatting #3499, #3211, #3377
  • Better formatting of object destructing
  • Improved formatting of test calls
  • Fixed formatting of trailing comments in arrow functions

Linter

  • BREAKING CHANGE: some rules have been moved to new groups to better reflect their purpose. This may result in Rome failing to load your configuration or suppression comments that now refer to unknown rules. Please check out #3471 to learn more about the affected rules.
  • Fixed issues in the noUnreachable rule
  • Fixed false positive cases for noNegationElse #3141
  • Fixed false positive cases for noUnusedVariables #3169
  • Fixed an issue in our CFG #3390

New rules

Parser

  • Improved messaging of diagnostics, using our new infrastructure
  • Fixed an issue where diagnostics couldn't be printed in WASM #3349
  • Allow arguments in d.ts files #3388
  • Fix parsing of less than in optional call chains #3486
  • Fixed a case where export {"a"} from "b"; wasn't correctly parsed

VSCode

  • Make the "rename" command opt-in and use the VS Code provided "rename" feature that offers whole project renaming instead.
  • Added the new command Restart LSP Server
  • The LSP server is now able to listen to changes of rome.json and apply the new configuration

0.10.1

CLI

  • Fixed a poor diagnostic that was emitted when navigating a symbolic symbol #3329
  • Added a size limit when inspecting files #3330

Diagnostics

  • Do not print tabs and spaces for unchanged lines #3327

VSCode

  • Fixed the calculation of text diffs inside the LSP #3350

0.10.0

Core

  • Rome is now faster and uses less memory on macOS and Linux systems! #3237
  • We completely revamped our diagnostics! The new diagnostics allow us to give better information about the errors generated by Rome.
  • Greatly increased the performance of Rome's daemon, up to 300%! #3151

Configuration

You can now ignore folders and files using the Unix shell style patterns:

{
  "formatter": {
    "ignore": ["scripts/*.js"]
  },
  "linter": {
    "ignore": ["src/**.test.{ts,js}"]
  }
}

Formatter

  • Completely revamped how the formatter handles comments and their placement inside the code #3277
  • Improved formatting of intersection and unions types #3162
  • Improved formatting of member chains #3283
  • Improved formatting of call arguments #3290

Linter

  • BREAKING CHANGE: This release changes the naming of the lint rule groups with the goal to make them language agnostic and avoid confusion among users and contributors. were named after a language, and this caused confusion among users and contributors. Please check our website to know better about the new groups. The new groups are heavily inspired from clippy
  • Added a new group called nursery, this group incubates new rules that are being developed.
  • Added a new group called style, this group incubates rules that orbits around styling.
  • Added a new group called correctness, this group incubates rules that orbits catching possible bugs.
  • Fixed a code action for useBlockStatements #3199
  • Improved the rule useCamelCase #3190 #3210
  • Fixed invalid code action for useOptionalChain #3257
  • Fixed bugs in noUnusedVariables #3170, #3316

New rules

Parser

  • Fixed an issue where the parser was not emitting a diagnostic on a certain TypeScript syntax #3115

VSCode

  • The setting lspBin can be also expressed as relative path
  • The rules have been added to the configuration schema, allowing users to receive autocomplete when editing the rome.json for the rules section

0.9.2

CLI

  • Fixes an issue where arguments were not correctly picked up and applied to the formatter #3175

0.9.1

CLI

  • Fixes a regression where the arguments passed via CLI were ignored #3175
  • Fixes a regression where the command rome ci was not correctly reading the configuration #3167

VSCode

  • Windows: fixes an issue where the extension could not load the configuration file #3182

0.9.0

CLI

  • You can now format content from standard input when using the command rome format:
echo "function f() { return {} }" | rome format --stdin-file-path example.js

the argument --stdin-file-path is mandatory when formatting from standard in. The path should represent a file name with its extension.

  • Added --apply-suggested argument to the rome check command, to apply suggested and safe fixes. Suggested fixes should be considered unstable and applied with care.
  • Added the rome start and rome stop commands to control the Rome daemon server process.
  • Added the --use-server global flag to the command line to make the CLI connect to a running instance of the Rome daemon server.

Configuration

  • BREAKING CHANGE: removed the second "rules" field from a field group.
{
  "linter": {
    "enabled": true,
    "rules": {
      "js": {
+        "noDebugger": "off"
-        "rules": {
-          "noDebugger": "off"
-        },
      }
    }
  }
}
  • fixed a problem that was incorrectly turning off rules in certain circumstances

Formatter

Significantly improved formatting and prettier compatibility of:

  • JSX #3144
  • Conditional expression and conditional types #2427
  • Function signatures #2993, #2990
  • Return and throw statements #2986
  • Logical and binary expressions #3079
  • Templates #3063
  • Arrow expression chains #3122
  • Member expression assignments #3061
  • Array expressions #3126
  • Parenthesized expressions and types, including inserting parentheses to improve readability #3057, #3083, #3108
  • Doc comments #3129

Linter

VSCode

  • fixed an issue where it wasn't possible to format newly created files 3006
  • added a status bar 3139

0.8.0

CLI

  • Added --max-diagnostics argument to the command rome check.
  • The maximum number of diagnostics printed is now 20, use --max-diagnostics to change the default.
  • Added a new command rome init.

Configuration

  • You can create a configuration file called rome.json to customize Rome's default options. This will work from both CLI and LSP.

Formatter

  • You can now use the configuration file rome.json to change Rome's defaults:

    Example:

    {
  "root": true,
  "formatter": {
    "indentStyle": "space"
  }
}

  • Fixed some edge cases where the comment suppressions were not working as expected.

Linter

The linter is now marked as "alpha" and it can be used to lint code from the CLI and from the LSP.

VSCode

  • BREAKING CHANGE: Removed the majority of settings that were available in the extension, use the configuration file rome.json to change the Rome's defaults.
  • The extension now allows to rename variables;

0.7.0

CLI

  • Added --no-colors argument.

Formatter

  • JSX and TSX are now formatted by default! Make sure to enable Rome as default formatter in the VSCode extension.
  • Improved the consistency of formatting of various statements:
    • call arguments;
    • object property members;
    • variable declarations;
    • object patterns;
    • class property members;
  • Fixed a bunch of issues in the TypeScript formatting.

Linter

  • Added the new --apply argument to the rome check command;
  • New rules added to the linter, check the website;

0.6.1

Fixes a regression introduced in the rome format command (#2670)

0.6.0

Formatter

  • BREAKING CHANGES: the command rome format --ci has been removed, use rome ci instead.

Improved the compatibility with Prettier (check #2403 for more details)

  • TypeScript's formatting is better in line with what Prettier does.
  • Better formatting of string literals. Removing unnecessary quotes in string literals and quotes from member names. Correctly choose the correct quote based on quantity of quotes inside a literal: 
    // original code
let a = {
  "something": 3
}
let b = "cool isn\'t it";
let c = "\"content\" ' ";

// formatted code
let a = {
  something: 3
}
let b = "cool isn't it";
let c = '"content" \' ';
  • Better formatting of various statements
  • Improved the performance of the formatter an average of 20%-30%! Check the relevant PRs 1, 2, 3, 4, 5 if you're interested in what the team did.

To reach better compatibility with Prettier, the team had to revise the foundation of our printer, which caused some regressions around how comments are printed. These are known issues that we plan to close by next release.

Linter

We've built the foundation of our linter. At the moment is only opt-in, and it contains only a bunch of rules. Safe fixes are not enabled yet via CLI.

Refer to the website to learn how to start using it.

0.5.0

  • BREAKING CHANGES: the format command doesn't write on disk by default. Now the command prints on terminal.

    Migration: add the --write argument when calling rome format

    rome format --write

  • Added a new option called --quote-style to the formatter. This option is also available on VSCode.

0.4.0

Rome has been rewritten in Rust!

The great majority of the previous functionality won't work anymore, as we rewrote the whole software from scratch.

Rome, for now, exposes a new formatter that has been revisited and, is way faster compared to its former version!

To install it, use the next tag on npm:

npm i rome@next

Or follow our getting started section for more details.