Skip to content

[Refactor] Refactor resolveFramework to use declarative .some() and .every() #8262

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

Open
gonzaloriestra wants to merge 1 commit into
base: main
Choose a base branch
from
+50 −18
Open

[Refactor] Refactor resolveFramework to use declarative .some() and .every() #8262

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 33 additions & 1 deletion packages/cli-kit/src/public/node/framework.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {resolveFramework} from './framework.js'
import {resolveFramework, _frameworks} from './framework.js'
import {inTemporaryDirectory, writeFile} from './fs.js'
import {joinPath} from './path.js'
import {describe, expect, test} from 'vitest'
Expand Down Expand Up @@ -131,4 +131,36 @@ describe('frontFrameworkUsed', () => {
expect(got).toEqual('unknown')
})
})

test('matches a custom framework if any detector in some matches and all in every match', async () => {
await inTemporaryDirectory(async (tmpDir) => {
// Given
_frameworks.push({
name: 'custom-framework',
detectors: {
some: [
{path: 'package.json', matchContent: '"custom-dep-1"'},
{path: 'package.json', matchContent: '"custom-dep-2"'},
],
every: [{path: 'package.json', matchContent: '"framework-core"'}],
},
})

try {
const packageJsonPath = joinPath(tmpDir, 'package.json')
const packageJson = {
dependencies: {'framework-core': '1.0.0', 'custom-dep-2': '1.0.0'},
}
await writeFile(packageJsonPath, JSON.stringify(packageJson))

// When
const got = await resolveFramework(tmpDir)

// Then
expect(got).toEqual('custom-framework')
} finally {
_frameworks.pop()
}
})
})
})
34 changes: 17 additions & 17 deletions packages/cli-kit/src/public/node/framework.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,23 +151,21 @@ const frameworks: Framework[] = [
export async function resolveFramework(rootDirectory: string): Promise<string> {
const fwConfigFiles: Record<string, string | undefined> = {}

const matchedFramework = frameworks.find(
(framework) =>
(!framework.detectors.some ||
framework.detectors.some.reduce(
(_previousDetectorsMatch: boolean, detector) =>
matchDetector(detector, loadFwConfigFile(rootDirectory, detector.path, fwConfigFiles)),
false,
)) &&
(!framework.detectors.every ||
framework.detectors.every.reduce(
(previousDetectorsMatch: boolean, detector) =>
previousDetectorsMatch
? matchDetector(detector, loadFwConfigFile(rootDirectory, detector.path, fwConfigFiles))
: false,
true,
)),
)
const matchedFramework = frameworks.find((framework) => {
const matchesSome =
!framework.detectors.some ||

@isaacroldan isaacroldan Aug 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looking at the frameworks definition, I think detectors.some is always undefined, should we simplify this? :thinking_face:

framework.detectors.some.some((detector) =>
matchDetector(detector, loadFwConfigFile(rootDirectory, detector.path, fwConfigFiles)),
)

const matchesEvery =
!framework.detectors.every ||
framework.detectors.every.every((detector) =>
matchDetector(detector, loadFwConfigFile(rootDirectory, detector.path, fwConfigFiles)),
)

return matchesSome && matchesEvery
})

return matchedFramework ? matchedFramework.name : 'unknown'
}
Expand Down Expand Up @@ -197,3 +195,5 @@ function loadFwConfigFile(
fwConfigFiles[fwConfigFileName] = rawContent
return fwConfigFiles
}

export const _frameworks = frameworks
Loading