feat(eslint-config): enable linting with type information #1098

BarryThePenguin · 2025-04-02T10:59:08Z

Updates the @hono/eslint-config to include typescript-eslint presets for linting with type information

changeset-bot · 2025-04-02T10:59:11Z

🦋 Changeset detected

Latest commit: be4c434

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

This PR includes changesets to release 1 package

Name	Type
@hono/eslint-config	Major

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

codecov-commenter · 2025-04-02T11:00:38Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.50%. Comparing base (9f3027a) to head (be4c434).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1098   +/-   ##
=======================================
  Coverage   79.50%   79.50%           
=======================================
  Files          77       77           
  Lines        2279     2279           
  Branches      577      577           
=======================================
  Hits         1812     1812           
  Misses        391      391           
  Partials       76       76

Flag	Coverage Δ
ajv-validator	`0.74% <ø> (-0.01%)`	⬇️
arktype-validator	`0.57% <ø> (-0.01%)`	⬇️
auth-js	`2.98% <ø> (-0.01%)`	⬇️
casbin	`1.44% <ø> (-0.01%)`	⬇️
class-validator	`0.83% <ø> (-0.01%)`	⬇️
clerk-auth	`0.92% <ø> (-0.01%)`	⬇️
cloudflare-access	`2.72% <ø> (-0.01%)`	⬇️
conform-validator	`1.09% <ø> (-0.01%)`	⬇️
effect-validator	`0.39% <ø> (-0.01%)`	⬇️
esbuild-transpiler	`0.96% <ø> (-0.01%)`	⬇️
event-emitter	`2.50% <ø> (-0.01%)`	⬇️
firebase-auth	`2.45% <ø> (-0.01%)`	⬇️
graphql-server	`4.12% <ø> (-0.01%)`	⬇️
hello	`0.17% <ø> (-0.01%)`	⬇️
medley-router	`0.43% <ø> (-0.01%)`	⬇️
node-ws	`2.36% <ø> (-0.01%)`	⬇️
oauth-providers	`26.28% <ø> (ø)`
oidc-auth	`9.96% <ø> (-0.01%)`	⬇️
otel	`0.87% <ø> (-0.01%)`	⬇️
prometheus	`1.57% <ø> (-0.01%)`	⬇️
react-renderer	`1.36% <ø> (-0.01%)`	⬇️
sentry	`0.74% <ø> (-0.01%)`	⬇️
standard-validator	`1.40% <ø> (-0.01%)`	⬇️
swagger-editor	`0.61% <ø> (-0.01%)`	⬇️
swagger-ui	`1.66% <ø> (-0.01%)`	⬇️
trpc-server	`0.52% <ø> (-0.01%)`	⬇️
tsyringe	`0.26% <ø> (-0.01%)`	⬇️
typebox-validator	`1.36% <ø> (-0.01%)`	⬇️
valibot-validator	`0.48% <ø> (-0.01%)`	⬇️
zod-openapi	`5.17% <ø> (ø)`
zod-validator	`0.57% <ø> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

BarryThePenguin · 2025-04-02T11:01:16Z

eslint.config.mjs

+  languageOptions: {
+    parserOptions: {
+      projectService: true,
+      tsconfigRootDir: import.meta.dirname,
+    },
+  },


This tells the typescript-eslint parser where to find the root tsconfig.json, and to use project references

BarryThePenguin · 2025-04-02T11:04:54Z

eslint.config.mjs

+  linterOptions: {
+    reportUnusedDisableDirectives: 'error',
+    reportUnusedInlineConfigs: 'error',
+  },


Additional linter options

reportUnusedDisableDirectives defaults to 'warn' and reportUnusedInlineConfigs defaults to 'off'

BarryThePenguin · 2025-04-02T11:10:44Z

eslint.config.mjs

+  rules: {
+    '@typescript-eslint/array-type': 'off',
+    '@typescript-eslint/await-thenable': 'off',
+    '@typescript-eslint/consistent-indexed-object-style': 'off',
+    '@typescript-eslint/consistent-type-definitions': 'off',
+    '@typescript-eslint/dot-notation': 'off',
+    '@typescript-eslint/no-base-to-string': 'off',
+    '@typescript-eslint/no-confusing-void-expression': 'off',
+    '@typescript-eslint/no-deprecated': 'off',
+    '@typescript-eslint/no-duplicate-type-constituents': 'off',
+    '@typescript-eslint/no-dynamic-delete': 'off',
+    '@typescript-eslint/no-floating-promises': 'off',
+    '@typescript-eslint/no-invalid-void-type': 'off',
+    '@typescript-eslint/no-misused-promises': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/no-redundant-type-constituents': 'off',
+    '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'off',
+    '@typescript-eslint/no-unnecessary-condition': 'off',
+    '@typescript-eslint/no-unnecessary-template-expression': 'off',
+    '@typescript-eslint/no-unnecessary-type-arguments': 'off',
+    '@typescript-eslint/no-unnecessary-type-assertion': 'off',
+    '@typescript-eslint/no-unnecessary-type-parameters': 'off',
+    '@typescript-eslint/no-unsafe-argument': 'off',
+    '@typescript-eslint/no-unsafe-assignment': 'off',
+    '@typescript-eslint/no-unsafe-call': 'off',
+    '@typescript-eslint/no-unsafe-enum-comparison': 'off',
+    '@typescript-eslint/no-unsafe-member-access': 'off',
+    '@typescript-eslint/no-unsafe-return': 'off',
+    '@typescript-eslint/no-useless-constructor': 'off',
+    '@typescript-eslint/non-nullable-type-assertion-style': 'off',
+    '@typescript-eslint/only-throw-error': 'off',
+    '@typescript-eslint/prefer-function-type': 'off',
+    '@typescript-eslint/prefer-includes': 'off',
+    '@typescript-eslint/prefer-nullish-coalescing': 'off',
+    '@typescript-eslint/prefer-optional-chain': 'off',
+    '@typescript-eslint/prefer-regexp-exec': 'off',
+    '@typescript-eslint/prefer-return-this-type': 'off',
+    '@typescript-eslint/require-await': 'off',
+    '@typescript-eslint/restrict-plus-operands': 'off',
+    '@typescript-eslint/restrict-template-expressions': 'off',
+    '@typescript-eslint/unbound-method': 'off',
+    '@typescript-eslint/unified-signatures': 'off',
+  },


I've initially disabled all the new rules to keep this PR small

I'd be happy to revisit each rule individually and decide if it's worth enabling or not. If a new rule is problematic, it can always be disabled in the shared eslint config

My personal preference is to have less configuration, and rely on tooling to make these decisions for me. But I understand that doesn't fit with how everyone works 😅

I've initially disabled all the new rules to keep this PR small

I like this approach. Fixing lint errors is troublesome, and the diffs will be huge. We don't have to do it.

BarryThePenguin · 2025-04-02T11:21:21Z

packages/eslint-config/index.js

+  ...tseslint.configs.strictTypeChecked,
+  ...tseslint.configs.stylisticTypeChecked,


There's a few shared configs to choose from.

Their suggestion is to enabling recommended-type-checked and stylistic-type-checked to start with. Then replacing recommended-type-checked with strict-type-checked if you're comfortable working with TypeScript.

BarryThePenguin · 2025-04-02T11:22:52Z

packages/graphql-server/tsconfig.bun.json

Includes bun_test files in the project

BarryThePenguin · 2025-04-02T11:23:40Z

tsconfig.repo-config-files.json

Includes project configuration files

…eslint-type-checked

yusukebe · 2025-04-07T10:25:19Z

.changeset/fifty-aliens-rhyme.md

@@ -0,0 +1,10 @@
+---
+'@hono/eslint-config': major


Yes. This change includes breaking change, so this is a major version up.

Feel free to ping me if you need help upgrading other projects that use @hono/eslint-config

yusukebe

LGTM!

yusukebe · 2025-04-07T10:29:32Z

@BarryThePenguin

Looks good! For this PR, let's just update @hono/eslint-config and fix the other lint errors later as you said.

feature(eslint): enable linting with type information

eb62c87

BarryThePenguin commented Apr 2, 2025

View reviewed changes

BarryThePenguin marked this pull request as ready for review April 2, 2025 11:25

yusukebe force-pushed the feature/typescript-eslint-type-checked branch from 50e796c to eb62c87 Compare April 7, 2025 10:20

Merge remote-tracking branch 'upstream/main' into feature/typescript-…

be4c434

…eslint-type-checked

yusukebe changed the title ~~feature(eslint): enable linting with type information~~ feat(eslint): enable linting with type information Apr 7, 2025

yusukebe reviewed Apr 7, 2025

View reviewed changes

yusukebe approved these changes Apr 7, 2025

View reviewed changes

yusukebe changed the title ~~feat(eslint): enable linting with type information~~ feat(eslint-config): enable linting with type information Apr 7, 2025

yusukebe merged commit 1fd8ebf into honojs:main Apr 7, 2025
32 checks passed

BarryThePenguin deleted the feature/typescript-eslint-type-checked branch April 7, 2025 10:31

github-actions bot mentioned this pull request Apr 7, 2025

Version Packages #1108

Merged

TimBarley pushed a commit to TimBarley/honojs-middleware that referenced this pull request Apr 9, 2025

feat(eslint-config): enable linting with type information (honojs#1098)

17df8a4

BarryThePenguin mentioned this pull request May 15, 2025

lint: array-type #1165

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(eslint-config): enable linting with type information #1098

feat(eslint-config): enable linting with type information #1098

Uh oh!

BarryThePenguin commented Apr 2, 2025

Uh oh!

changeset-bot bot commented Apr 2, 2025 •

edited

Loading

Uh oh!

codecov-commenter commented Apr 2, 2025 •

edited

Loading

Uh oh!

BarryThePenguin Apr 2, 2025

Uh oh!

BarryThePenguin Apr 2, 2025

Uh oh!

BarryThePenguin Apr 2, 2025

Uh oh!

yusukebe Apr 7, 2025

Uh oh!

BarryThePenguin Apr 2, 2025

Uh oh!

BarryThePenguin Apr 2, 2025

Uh oh!

BarryThePenguin Apr 2, 2025

Uh oh!

yusukebe Apr 7, 2025

Uh oh!

BarryThePenguin Apr 7, 2025

Uh oh!

yusukebe left a comment

Uh oh!

yusukebe commented Apr 7, 2025

Uh oh!

Uh oh!

Uh oh!

		...tseslint.configs.strictTypeChecked,
		...tseslint.configs.stylisticTypeChecked,

feat(eslint-config): enable linting with type information #1098

feat(eslint-config): enable linting with type information #1098

Uh oh!

Conversation

BarryThePenguin commented Apr 2, 2025

Uh oh!

changeset-bot bot commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

codecov-commenter commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yusukebe left a comment

Choose a reason for hiding this comment

Uh oh!

yusukebe commented Apr 7, 2025

Uh oh!

Uh oh!

Uh oh!

changeset-bot bot commented Apr 2, 2025 •

edited

Loading

codecov-commenter commented Apr 2, 2025 •

edited

Loading