Skip to content

release v3.0.0 of eslint-config (dependency upgrades) #28

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.

Sign up for GitHub

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

Merged
ckeshava merged 10 commits into from
Jan 22, 2026
Merged

release v3.0.0 of eslint-config (dependency upgrades) #28

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f2cfc95
upgrade eslint-plugin-tsdoc from 0.4.0 to 0.5.0
ckeshava Jan 15, 2026
0f1c71a
increment the package version, owing to the dependency upgrade
ckeshava Jan 15, 2026
86610be
- Upgrade bump eslint-plugin-array-func from 4.0.0 to 5.1.0
ckeshava Jan 15, 2026
8a038f2
update Changelog with relevant details
ckeshava Jan 15, 2026
58570fb
update eslint.config: Limit the behavioral changes propagated to down…
ckeshava Jan 16, 2026
a5b8661
restrict the behavioral change of allowing anonymous imports to withi…
ckeshava Jan 16, 2026
75bab6b
bump the major version of this package
ckeshava Jan 16, 2026
b898c97
Update packages/eslint-config/CHANGELOG.md
ckeshava Jan 21, 2026
ca53908
allow greater peer flexibility by relaxing the minor version of eslin…
ckeshava Jan 21, 2026
f13ad20
Merge branch 'upgradeEslintPluginDep' of https://github.com/XRPLF/typ…
ckeshava Jan 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
208 changes: 189 additions & 19 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions packages/eslint-config/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [Unreleased]

## 2.1.0
- Upgrades `eslint-plugin-tsdoc` dependency from 0.4.0 to 0.5.0.
- Upgrades the dependency `eslint-plugin-array-doc` from 4.0.0 to 5.1.0. Due to this upgrade, the `eslint-config` had to be converted from CommonJS to an ESM compatible implementation. This is because the said dependency only works with ESM modules.
Comment thread
ckeshava marked this conversation as resolved.
Outdated

## 2.0.0
- Migrated ESLint, and it's related plugins to their latest major version. [Breaking Change]
- @xrplf/eslint-config version 2.0.0 now exports Flat configs that are equivalent to ^1.0.0 in terms of configuration rules barring some breaking changes there were introduced by ESLint itself, and other ESLint plugins that this shared config exported. See [V2_MIGRATION.md](./V2_MIGRATION.md). [Breaking Change]

Expand Down
34 changes: 17 additions & 17 deletions packages/eslint-config/base.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
const eslint = require('@eslint/js')
const globals = require('globals')
import eslint from '@eslint/js'
import globals from 'globals'

const typescriptEslint = require('./rules/@typescript-eslint')
const arrayFunc = require('./rules/array-func')
const comments = require('./rules/eslint-comments')
const bestPractices = require('./rules/eslint-core/best-practices')
const errors = require('./rules/eslint-core/errors')
const es6 = require('./rules/eslint-core/es6')
const strict = require('./rules/eslint-core/strict')
const style = require('./rules/eslint-core/style')
const variables = require('./rules/eslint-core/variables')
const importRules = require('./rules/import')
const jsdoc = require('./rules/jsdoc')
const node = require('./rules/node')
const prettier = require('./rules/prettier')
const tsdoc = require('./rules/tsdoc')
import typescriptEslint from './rules/@typescript-eslint.js'
import arrayFunc from './rules/array-func.js'
import comments from './rules/eslint-comments.js'
import bestPractices from './rules/eslint-core/best-practices.js'
import errors from './rules/eslint-core/errors.js'
import es6 from './rules/eslint-core/es6.js'
import strict from './rules/eslint-core/strict.js'
import style from './rules/eslint-core/style.js'
import variables from './rules/eslint-core/variables.js'
import importRules from './rules/import.js'
import jsdoc from './rules/jsdoc.js'
import node from './rules/node.js'
import prettier from './rules/prettier.js'
import tsdoc from './rules/tsdoc.js'

module.exports = [
export default [
eslint.configs.recommended,
...errors,
...bestPractices,
Expand Down
9 changes: 6 additions & 3 deletions packages/eslint-config/eslint.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
const baseConfig = require('./base')
import baseConfig from './base.js'

module.exports = [
export default [
...baseConfig,
{
languageOptions: {
Expand All @@ -19,14 +19,17 @@ module.exports = [
'import/unambiguous': 'off',
'import/no-commonjs': 'off',
'import/no-unused-modules': 'off',
// ESM requires .js extensions for relative imports
'import/extensions': [
'error',
'ignorePackages',
{
js: 'never',
js: 'always',

@Patel-Raj11 Patel-Raj11 Jan 15, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since, this is a behaviour change, I would suggest that we import the package from this PR locally into xrpl.js to make sure that linting passes or evaluate how much work needs to be done to fix linting errors that occurs after this change.

@ckeshava ckeshava Jan 16, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have ensured that this behavioral change only affects the files located inside this specific package. No downstream users of this package are affected by this change due to the regex used in the files section of eslint config file.

@ckeshava ckeshava Jan 16, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated in 75bab6b

@Patel-Raj11 Patel-Raj11 Jan 16, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see it's only suppressed for this repo.

No downstream users of this package are affected by this change due to the regex used in the files section of eslint config file.

The regex applies only for this repo. Did we try importing the package from this branch into xrpl.js to check if it works fine?

@ckeshava ckeshava Jan 16, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, I will do that in some time and get back to you. I wasn't sure how to import an unpublished package (this new version of typescript-style repo) into xrpl.js

@Patel-Raj11 Patel-Raj11 Jan 16, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When importing a package locally, I would first delete node_modules and package-lock.json and install it fresh.

We can import it something like this:

 "@xrplf/eslint-config": "file:<PACKAGE_PATH>"

@ckeshava ckeshava Jan 16, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks

@ckeshava ckeshava Jan 20, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is the PR that uses the new versions of dependencies: XRPLF/xrpl.js#3187

The linter passes for this PR (on my local computer, it might not clear the CI) and all the unit tests pass.

@Patel-Raj11 Patel-Raj11 Jan 20, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool! I guess package-lock.json in this PR is outdated based on package version. Should regenerate it.

mjs: 'always',
},
],
// Allow anonymous default exports in ESLint config files
'import/no-anonymous-default-export': 'off',
},
},
]
6 changes: 3 additions & 3 deletions packages/eslint-config/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const base = require('./base')
const react = require('./rules/react')
import base from './base.js'
import react from './rules/react.js'

module.exports = [...react, ...base]
export default [...react, ...base]
6 changes: 3 additions & 3 deletions packages/eslint-config/loose-base.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const base = require('./base')
const common = require('./rules/common')
import base from './base.js'
import common from './rules/common.js'

module.exports = [
export default [
...base,
{
rules: {
Expand Down
6 changes: 3 additions & 3 deletions packages/eslint-config/loose.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const looseBase = require('./loose-base')
const react = require('./rules/react')
import looseBase from './loose-base.js'
import react from './rules/react.js'

module.exports = [...react, ...looseBase]
export default [...react, ...looseBase]
7 changes: 4 additions & 3 deletions packages/eslint-config/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "@xrplf/eslint-config",
"version": "2.0.0",
"version": "2.1.0",
"type": "module",
"description": "The XRPL Foundation's base TypeScript ESLint config, following our styleguide",
"keywords": [
"eslint",
Expand Down Expand Up @@ -33,15 +34,15 @@
"eslint": "^9.0.0",
"eslint-config-prettier": "^10.0.0",
"eslint-import-resolver-typescript": "^4.0.0",
"eslint-plugin-array-func": "^4.0.0",
"eslint-plugin-array-func": "^5.1.0",

@Patel-Raj11 Patel-Raj11 Jan 20, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: We should keep peerDependencies ^5.0.0 for greater compatibility.

@ckeshava ckeshava Jan 21, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok f13ad20

"eslint-plugin-import": "^2.32.0",
"eslint-plugin-jsdoc": "^52.0.0",
"eslint-plugin-jsx-a11y": "^6.0.0",
"eslint-plugin-n": "^17.0.0",
"eslint-plugin-prettier": "^5.0.0",
"eslint-plugin-react": "^7.0.0",
"eslint-plugin-react-hooks": "^5.0.0",
"eslint-plugin-tsdoc": "^0.4.0",
"eslint-plugin-tsdoc": "^0.5.0",

@Patel-Raj11 Patel-Raj11 Jan 16, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^0.5.0 would make @xrplf/eslint-config release a breaking change. Consumers with eslint-plugin-tsdoc < 0.5.0 won't be able to install @xrplf/eslint-config. So when we release this, we should do major version bump of @xrplf/eslint-config

@ckeshava ckeshava Jan 16, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

75bab6b

"globals": "^16.0.0",
"prettier": "^3.0.0",
"typescript": ">=4.8.4",
Expand Down
Loading