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

fix: add languageOptions to ChildContext #85

Merged
merged 7 commits into from
Jun 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/short-bees-sell.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"eslint-plugin-import-x": patch
---

add languageOptions to ChildContext
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
"dependencies": {
"@typescript-eslint/utils": "^7.4.0",
"debug": "^4.3.4",
"dequal": "^2.0.3",
"doctrine": "^3.0.0",
"eslint-import-resolver-node": "^0.3.9",
"get-tsconfig": "^4.7.3",
Expand Down
1 change: 1 addition & 0 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ export type ChildContext = {
settings: PluginSettings
parserPath?: string | null
parserOptions?: TSESLint.ParserOptions
languageOptions?: TSESLint.FlatConfig.LanguageOptions
path: string
filename?: string
}
Expand Down
66 changes: 48 additions & 18 deletions src/utils/export-map.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import path from 'node:path'

import type { TSESLint, TSESTree } from '@typescript-eslint/utils'
import debug from 'debug'
import { dequal } from 'dequal'
import type { Annotation } from 'doctrine'
import doctrine from 'doctrine'
import type { AST } from 'eslint'
Expand Down Expand Up @@ -1078,11 +1079,6 @@ export function recursivePatternCapture(
}
}

let parserOptionsHash = ''
let prevParserOptions = ''
let settingsHash = ''
let prevSettings = ''

/**
* don't hold full context object in memory, just grab what we need.
* also calculate a cacheKey, where parts of the cacheKey hash are memoized
Expand All @@ -1091,24 +1087,14 @@ function childContext(
path: string,
context: RuleContext | ChildContext,
): ChildContext {
const { settings, parserOptions, parserPath } = context

if (JSON.stringify(settings) !== prevSettings) {
settingsHash = hashObject({ settings }).digest('hex')
prevSettings = JSON.stringify(settings)
}

if (JSON.stringify(parserOptions) !== prevParserOptions) {
parserOptionsHash = hashObject({ parserOptions }).digest('hex')
prevParserOptions = JSON.stringify(parserOptions)
}
const { settings, parserOptions, parserPath, languageOptions } = context

return {
cacheKey:
String(parserPath) + parserOptionsHash + settingsHash + String(path),
cacheKey: makeContextCacheKey(context) + String(path),
settings,
parserOptions,
parserPath,
languageOptions,
kosmotema marked this conversation as resolved.
Show resolved Hide resolved
path,
filename:
'physicalFilename' in context
Expand All @@ -1117,6 +1103,50 @@ function childContext(
}
}

type OptionsVersionsCache = Record<
'settings' | 'parserOptions' | 'parser',
{ value: unknown; version: number }
>

const optionsVersionsCache: OptionsVersionsCache = {
settings: { value: null, version: 0 },
parserOptions: { value: null, version: 0 },
parser: { value: null, version: 0 },
}

function getOptionsVersion(key: keyof OptionsVersionsCache, value: unknown) {
const entry = optionsVersionsCache[key]

if (!dequal(value, entry.value)) {
entry.value = value
entry.version += 1
}

return String(entry.version)
}

function makeContextCacheKey(context: RuleContext | ChildContext) {
const { settings, parserPath, parserOptions, languageOptions } = context

let hash = getOptionsVersion('settings', settings)

const usedParserOptions = languageOptions?.parserOptions ?? parserOptions

hash += getOptionsVersion('parserOptions', usedParserOptions)

if (languageOptions) {
const { ecmaVersion, sourceType } = languageOptions
hash += String(ecmaVersion) + String(sourceType)
}

hash += getOptionsVersion(
'parser',
parserPath ?? languageOptions?.parser?.meta ?? languageOptions?.parser,
)

return hash
}

/**
* sometimes legacy support isn't _that_ hard... right?
*/
Expand Down
Loading