Skip to content
Draft
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/remove-cli-kit-minimatch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@shopify/cli-kit': patch
---

Remove the minimatch dependency from cli-kit glob matching.
1 change: 0 additions & 1 deletion packages/cli-kit/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,6 @@
"liquidjs": "10.26.0",
"lodash": "4.17.23",
"macaddress": "0.5.3",
"minimatch": "9.0.8",
"mrmime": "1.0.1",
"network-interfaces": "1.1.0",
"node-abort-controller": "3.1.1",
Expand Down
36 changes: 36 additions & 0 deletions packages/cli-kit/src/public/node/fs.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import {
copyDirectoryContents,
symlink,
fileRealPath,
matchGlob,
} from './fs.js'
import {joinPath, normalizePath} from './path.js'
import * as array from '../common/array.js'
Expand Down Expand Up @@ -319,6 +320,41 @@ describe('glob', () => {
})
})

describe('matchGlob', () => {
test('matches liquid file patterns with native Node glob semantics', () => {
expect(matchGlob('theme.liquid', '*.liquid')).toBe(true)
expect(matchGlob('layout/theme.liquid', '*.liquid')).toBe(false)
expect(matchGlob('layout/theme.liquid', '**/*.liquid')).toBe(true)
expect(matchGlob('assets/theme.css', '*.liquid')).toBe(false)
})

test('matches watch-style globs used by extension file watching', () => {
expect(matchGlob('src/main.rs', 'src/**/*.rs')).toBe(true)
expect(matchGlob('src/lib/main.rs', 'src/**/*.rs')).toBe(true)
expect(matchGlob('src/main.ts', 'src/**/*.rs')).toBe(false)
expect(matchGlob('/tmp/my-function/src/main.rs', '/tmp/my-function/src/**/*.rs')).toBe(true)
expect(matchGlob('/tmp/my-function/src/lib/main.rs', '/tmp/my-function/src/**/*.rs')).toBe(true)
})

test('matches project config selection globs', () => {
expect(matchGlob('extensions/my-ext/shopify.extension.toml', 'extensions/*/*.extension.toml')).toBe(true)
expect(matchGlob('extensions/nested/my-ext/shopify.extension.toml', 'extensions/*/*.extension.toml')).toBe(false)
expect(matchGlob('web/shopify.web.toml', '**/shopify.web.toml')).toBe(true)
})

test('supports matchBase for theme ignore patterns', () => {
expect(matchGlob('assets/theme.css', '*.css', {matchBase: true, noglobstar: true})).toBe(true)
expect(matchGlob('assets/theme.css', '*.liquid', {matchBase: true, noglobstar: true})).toBe(false)
})

test('supports noglobstar for theme ignore patterns', () => {
expect(
matchGlob('templates/customers/account.json', 'templates/**/*.json', {matchBase: true, noglobstar: true}),
).toBe(true)
expect(matchGlob('templates/404.json', 'templates/**/*.json', {matchBase: true, noglobstar: true})).toBe(false)
})
})

describe('detectEOL', () => {
test('detects the EOL of a file', async () => {
// Given
Expand Down
36 changes: 31 additions & 5 deletions packages/cli-kit/src/public/node/fs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@ import {

import {sep, join} from 'pathe'
import {findUp as internalFindUp, findUpSync as internalFindUpSync} from 'find-up'
import {minimatch} from 'minimatch'
import fastGlobLib from 'fast-glob'
// eslint-disable-next-line no-restricted-imports -- Node 22 native glob matching is not wrapped by cli-kit path helpers.
import * as nodePath from 'node:path'
import {
mkdirSync as fsMkdirSync,
readFileSync as fsReadFileSync,
Expand Down Expand Up @@ -688,19 +689,44 @@ export function findPathUpSync(
}

export interface MatchGlobOptions {
matchBase: boolean
noglobstar: boolean
matchBase?: boolean
noglobstar?: boolean
}

const {matchesGlob} = nodePath as typeof nodePath & {matchesGlob(path: string, pattern: string): boolean}

/**
* Matches a key against a glob pattern.
* @param key - The key to match.
* @param pattern - The glob pattern to match against.
* @param options - The options to refine the matching approach.
* @returns true if the key matches the pattern, false otherwise.
*/
export function matchGlob(key: string, pattern: string, options?: MatchGlobOptions): boolean {
return minimatch(key, pattern, options)
export function matchGlob(key: string, pattern: string, options: MatchGlobOptions = {}): boolean {
const effectivePattern = options.noglobstar ? patternWithoutGlobstars(pattern) : pattern

if (matchesGlob(key, effectivePattern)) return true

if (options.matchBase && !hasPathSeparator(effectivePattern)) {
return matchesGlob(baseName(key), effectivePattern)
}

return false
}

function patternWithoutGlobstars(pattern: string): string {
return pattern
.split(/([/\\])/)
.map((part) => (part === '**' ? '*' : part))
.join('')
}

function hasPathSeparator(path: string): boolean {
return path.includes('/') || path.includes('\\')
}

function baseName(path: string): string {
return path.split(/[/\\]/).pop() ?? path
}

/**
Expand Down
3 changes: 0 additions & 3 deletions pnpm-lock.yaml

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

Loading