Skip to content

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

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
merged 2 commits into from
Apr 7, 2025
Merged

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb62c87
feature(eslint): enable linting with type information
BarryThePenguin Apr 2, 2025
be4c434
Merge remote-tracking branch 'upstream/main' into feature/typescript-…
yusukebe Apr 7, 2025
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
10 changes: 10 additions & 0 deletions .changeset/fifty-aliens-rhyme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
'@hono/eslint-config': major
Copy link
Member

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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

---

Includes `typescript-eslint` presets for typed linting

- [`strict-type-checked`](https://typescript-eslint.io/users/configs#strict-type-checked)
- [`stylistic-type-checked`](https://typescript-eslint.io/users/configs#stylistic-type-checked)

See [Linting with Type Information](https://typescript-eslint.io/getting-started/typed-linting) for more information
58 changes: 57 additions & 1 deletion eslint.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,62 @@
import baseConfig from '@hono/eslint-config'
import { defineConfig, globalIgnores } from 'eslint/config'

export default defineConfig(globalIgnores(['.yarn', '**/dist']), {
export default defineConfig(globalIgnores(['.yarn', '**/coverage', '**/dist']), {
extends: baseConfig,

languageOptions: {
parserOptions: {
projectService: true,
tsconfigRootDir: import.meta.dirname,
},
},
Comment on lines +7 to +12
Copy link
Contributor Author

Choose a reason for hiding this comment

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

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


linterOptions: {
reportUnusedDisableDirectives: 'error',
reportUnusedInlineConfigs: 'error',
},
Comment on lines +14 to +17
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Additional linter options

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


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',
},
Comment on lines +19 to +61
Copy link
Contributor Author

Choose a reason for hiding this comment

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

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 😅

Copy link
Member

Choose a reason for hiding this comment

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

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.

})
8 changes: 3 additions & 5 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,13 @@
"@cloudflare/workers-types": "^4.20230307.0",
"@hono/eslint-config": "workspace:*",
"@ryoppippi/unplugin-typia": "^1.2.0",
"@types/bun": "^1.0.0",
"@types/node": "^20.17.28",
"@types/ws": "^8.18.0",
"@typescript-eslint/eslint-plugin": "^8.7.0",
"@typescript-eslint/parser": "^8.7.0",
"@vitest/coverage-istanbul": "^3.0.8",
"eslint": "^9.17.0",
"eslint": "^9.23.0",
"hono": "^4.7.5",
"npm-run-all2": "^6.2.2",
"prettier": "^2.7.1",
"prettier": "^3.5.3",
"tsup": "^8.4.0",
"typescript": "^5.8.2",
"vitest": "^3.0.8"
Expand Down
2 changes: 1 addition & 1 deletion packages/ajv-validator/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/ajv-validator",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/arktype-validator/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/arktype-validator",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/auth-js/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"noEmit": true,
"jsx": "react"
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
1 change: 0 additions & 1 deletion packages/bun-transpiler/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@
},
"devDependencies": {
"@arethetypeswrong/cli": "^0.17.4",
"@types/bun": "^1.0.0",
"publint": "^0.3.9",
"tsup": "^8.4.0",
"typescript": "^5.8.2",
Expand Down
2 changes: 1 addition & 1 deletion packages/bun-transpiler/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/bun-transpiler",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/casbin/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/casbin",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts", "vitest.setup.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/class-validator/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/class-validator",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-auth/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/clerk-auth",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/cloudflare-access/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/cloudflare-access",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/conform-validator/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/conform-validator",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/effect-validator/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/effect-validator",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/esbuild-transpiler/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/esbuild-transpiler",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
3 changes: 2 additions & 1 deletion packages/eslint-config/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ import tseslint from 'typescript-eslint'
export default [
js.configs.recommended,
nodePlugin.configs['flat/recommended'],
...tseslint.configs.recommended,
...tseslint.configs.strictTypeChecked,
...tseslint.configs.stylisticTypeChecked,
Comment on lines +10 to +11
Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

{
plugins: {
'@typescript-eslint': tseslint.plugin,
Expand Down
4 changes: 0 additions & 4 deletions packages/eslint-config/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,5 @@
"eslint-plugin-import-x": "^4.1.1",
"eslint-plugin-n": "^17.10.2",
"typescript-eslint": "^8.27.0"
},
"devDependencies": {
"eslint": "^9.23.0",
"typescript": "^5.3.3"
}
}
2 changes: 1 addition & 1 deletion packages/event-emitter/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/event-emitter",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
1 change: 0 additions & 1 deletion packages/firebase-auth/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@
"@arethetypeswrong/cli": "^0.17.4",
"firebase-tools": "^13.29.1",
"miniflare": "^3.20240208.0",
"prettier": "^3.2.5",
"publint": "^0.3.9",
"tsup": "^8.4.0",
"typescript": "^5.8.2",
Expand Down
2 changes: 1 addition & 1 deletion packages/firebase-auth/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/firebase-auth",
"noEmit": true
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
14 changes: 14 additions & 0 deletions packages/graphql-server/tsconfig.bun.json
View file
Open in desktop
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Includes bun_test files in the project

Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"outDir": "../../dist/out-tsc/packages/graphql-server",
"types": ["bun"]
},
"exclude": ["src/**/*.test.ts"],
"include": ["bun_test", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
}
]
}
3 changes: 3 additions & 0 deletions packages/graphql-server/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
{
"path": "./tsconfig.build.json"
},
{
"path": "./tsconfig.bun.json"
},
{
"path": "./tsconfig.spec.json"
}
Expand Down
2 changes: 1 addition & 1 deletion packages/graphql-server/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"types": ["vitest/globals"]
},
"exclude": ["bun_test"],

"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/hello/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/hello",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/medley-router/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/medley-router",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/node-ws/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/node-ws",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/oauth-providers/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/oauth-providers",
"types": ["vitest/globals"]
},
"include": ["mocks.ts", "**/*.test.ts"],
"include": ["mocks.ts", "**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/oidc-auth/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/oidc-auth",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/otel/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/oidc-auth",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/prometheus/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/prometheus",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/react-renderer/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"outDir": "../../dist/out-tsc/packages/react-renderer",
"types": ["vitest/globals"]
},
"include": ["**/*.test.tsx"],
"include": ["**/*.test.tsx", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/sentry/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/sentry",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/standard-validator/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/standard-validator",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/swagger-editor/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/swagger-editor",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
2 changes: 0 additions & 2 deletions packages/swagger-ui/src/option-renderer.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
/*eslint quotes: ["off", "single"]*/

import type { DistSwaggerUIOptions } from './swagger/renderer'
import { renderSwaggerUIOptions } from './swagger/renderer'

Expand Down
2 changes: 1 addition & 1 deletion packages/swagger-ui/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc/packages/swagger-ui",
"types": ["vitest/globals"]
},
"include": ["**/*.test.ts"],
"include": ["**/*.test.ts", "vitest.config.ts"],
"references": [
{
"path": "./tsconfig.build.json"
Expand Down
Loading
Loading