Skip to content

CLI: Allow Linter and Formatter CLIs to accept multiple inputs #807

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
marcoroth merged 1 commit into from
Nov 8, 2025
Merged

CLI: Allow Linter and Formatter CLIs to accept multiple inputs #807

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
259 changes: 119 additions & 140 deletions javascript/packages/formatter/src/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,12 @@ const pluralize = (count: number, singular: string, plural: string = singular +

export class CLI {
private usage = dedent`
Usage: herb-format [file|directory|glob-pattern] [options]
Usage: herb-format [files|directories|glob-patterns...] [options]

Arguments:
file|directory|glob-pattern File to format, directory to format all configured files within,
glob pattern to match files, or '-' for stdin (omit to format all configured files in current directory)
files|directories|glob-patterns Files, directories, or glob patterns to format, or '-' for stdin
Multiple arguments are supported (e.g., herb-format file1.erb file2.erb dir/)
Omit to format all configured files in current directory

Options:
-c, --check check if files are formatted without modifying them
Expand Down Expand Up @@ -126,6 +127,11 @@ export class CLI {
process.exit(0)
}

if (positionals.includes('-') && positionals.length > 1) {
console.error("Error: Cannot mix stdin ('-') with file arguments")
process.exit(1)
}

const file = positionals[0]
const startPath = file || process.cwd()

Expand Down Expand Up @@ -314,165 +320,85 @@ export class CLI {
const output = result.endsWith('\n') ? result : result + '\n'

process.stdout.write(output)
} else if (file) {
let isDirectory = false
let isFile = false
let pattern = file

try {
const stats = statSync(file)
isDirectory = stats.isDirectory()
isFile = stats.isFile()
} catch {
// Not a file/directory, treat as glob pattern
}
} else if (positionals.length > 0) {
const allFiles: string[] = []

const filesConfig = config.getFilesConfigForTool('formatter')
let hasErrors = false

if (isDirectory) {
const files = await config.findFilesForTool('formatter', resolve(file))
for (const pattern of positionals) {
try {
const files = await this.resolvePatternToFiles(pattern, config, isForceMode)

if (files.length === 0) {
console.log(`No files found in directory: ${resolve(file)}`)
process.exit(0)
}
if (files.length === 0) {
const isLikelySpecificFile = !pattern.includes('*') && !pattern.includes('?') &&
!pattern.includes('[') && !pattern.includes('{')

let formattedCount = 0
let unformattedFiles: string[] = []

for (const filePath of files) {
const displayPath = relative(process.cwd(), filePath)

try {
const source = readFileSync(filePath, "utf-8")
const result = formatter.format(source)
const output = result.endsWith('\n') ? result : result + '\n'

if (output !== source) {
if (isCheckMode) {
unformattedFiles.push(displayPath)
} else {
writeFileSync(filePath, output, "utf-8")
console.log(`Formatted: ${displayPath}`)
}
formattedCount++
if (isLikelySpecificFile) {
continue
} else {
console.log(`No files found matching pattern: ${pattern}`)
process.exit(0)
}
} catch (error) {
console.error(`Error formatting ${displayPath}:`, error)
}
}

if (isCheckMode) {
if (unformattedFiles.length > 0) {
console.log(`\nThe following ${pluralize(unformattedFiles.length, 'file is', 'files are')} not formatted:`)
unformattedFiles.forEach(file => console.log(` ${file}`))
console.log(`\nChecked ${files.length} ${pluralize(files.length, 'file')}, found ${unformattedFiles.length} unformatted ${pluralize(unformattedFiles.length, 'file')}`)
process.exit(1)
} else {
console.log(`\nChecked ${files.length} ${pluralize(files.length, 'file')}, all files are properly formatted`)
}
} else {
console.log(`\nChecked ${files.length} ${pluralize(files.length, 'file')}, formatted ${formattedCount} ${pluralize(formattedCount, 'file')}`)
allFiles.push(...files)
} catch (error: any) {
console.error(`Error: ${error.message}`)
hasErrors = true
break
}
}

process.exit(0)
} else if (isFile) {
const testFiles = await glob(file, {
cwd: process.cwd(),
ignore: filesConfig.exclude || []
})

if (testFiles.length === 0) {
if (!isForceMode) {
console.error(`⚠️ File ${file} is excluded by configuration patterns.`)
console.error(` Use --force to format it anyway.\n`)
process.exit(0)
} else {
console.error(`⚠️ Forcing formatter on excluded file: ${file}`)
console.error()
}
}
if (hasErrors) {
process.exit(1)
}

const source = readFileSync(file, "utf-8")
const result = formatter.format(source)
const output = result.endsWith('\n') ? result : result + '\n'

if (output !== source) {
if (isCheckMode) {
console.log(`File is not formatted: ${file}`)
process.exit(1)
} else {
writeFileSync(file, output, "utf-8")
console.log(`Formatted: ${file}`)
}
} else if (isCheckMode) {
console.log(`File is properly formatted: ${file}`)
}
const files = [...new Set(allFiles)]

if (files.length === 0) {
console.log(`No files found matching patterns: ${positionals.join(', ')}`)
process.exit(0)
}

try {
const files = await glob(pattern, { ignore: filesConfig.exclude || [] })

if (files.length === 0) {
try {
statSync(file)
} catch {
if (!file.includes('*') && !file.includes('?') && !file.includes('[') && !file.includes('{')) {
console.error(`Error: Cannot access '${file}': ENOENT: no such file or directory`)

process.exit(1)
}
}

console.log(`No files found matching pattern: ${resolve(pattern)}`)
let formattedCount = 0
let unformattedFiles: string[] = []

process.exit(0)
}
for (const filePath of files) {
const displayPath = relative(process.cwd(), filePath)

let formattedCount = 0
let unformattedFiles: string[] = []

for (const filePath of files) {
try {
const source = readFileSync(filePath, "utf-8")
const result = formatter.format(source)
const output = result.endsWith('\n') ? result : result + '\n'

if (output !== source) {
if (isCheckMode) {
unformattedFiles.push(filePath)
} else {
writeFileSync(filePath, output, "utf-8")
console.log(`Formatted: ${filePath}`)
}

formattedCount++
}
} catch (error) {
console.error(`Error formatting ${filePath}:`, error)
}
}
try {
const source = readFileSync(filePath, "utf-8")
const result = formatter.format(source)
const output = result.endsWith('\n') ? result : result + '\n'

if (isCheckMode) {
if (unformattedFiles.length > 0) {
console.log(`\nThe following ${pluralize(unformattedFiles.length, 'file is', 'files are')} not formatted:`)
unformattedFiles.forEach(file => console.log(` ${file}`))
console.log(`\nChecked ${files.length} ${pluralize(files.length, 'file')}, found ${unformattedFiles.length} unformatted ${pluralize(unformattedFiles.length, 'file')}`)
process.exit(1)
if (output !== source) {
if (isCheckMode) {
unformattedFiles.push(displayPath)
} else {
console.log(`\nChecked ${files.length} ${pluralize(files.length, 'file')}, all files are properly formatted`)
writeFileSync(filePath, output, "utf-8")
console.log(`Formatted: ${displayPath}`)
}
} else {
console.log(`\nChecked ${files.length} ${pluralize(files.length, 'file')}, formatted ${formattedCount} ${pluralize(formattedCount, 'file')}`)
formattedCount++
}
} catch (error) {
console.error(`Error formatting ${displayPath}:`, error)
}
}

} catch (error) {
console.error(`Error: Cannot access '${file}':`, error)

process.exit(1)
if (isCheckMode) {
if (unformattedFiles.length > 0) {
console.log(`\nThe following ${pluralize(unformattedFiles.length, 'file is', 'files are')} not formatted:`)
unformattedFiles.forEach(file => console.log(` ${file}`))
console.log(`\nChecked ${files.length} ${pluralize(files.length, 'file')}, found ${unformattedFiles.length} unformatted ${pluralize(unformattedFiles.length, 'file')}`)
process.exit(1)
} else {
console.log(`\nChecked ${files.length} ${pluralize(files.length, 'file')}, all files are properly formatted`)
}
} else {
console.log(`\nChecked ${files.length} ${pluralize(files.length, 'file')}, formatted ${formattedCount} ${pluralize(formattedCount, 'file')}`)
}

process.exit(0)
} else {
const files = await config.findFilesForTool('formatter', process.cwd())

Expand Down Expand Up @@ -537,4 +463,57 @@ export class CLI {

return Buffer.concat(chunks).toString("utf8")
}

private async resolvePatternToFiles(pattern: string, config: Config, isForceMode: boolean | undefined): Promise<string[]> {
let isDirectory = false
let isFile = false

try {
const stats = statSync(pattern)
isDirectory = stats.isDirectory()
isFile = stats.isFile()
} catch {
// Not a file/directory, treat as glob pattern
}

const filesConfig = config.getFilesConfigForTool('formatter')

if (isDirectory) {
const files = await config.findFilesForTool('formatter', resolve(pattern))
return files
} else if (isFile) {
const testFiles = await glob(pattern, {
cwd: process.cwd(),
ignore: filesConfig.exclude || []
})

if (testFiles.length === 0) {
if (!isForceMode) {
console.error(`⚠️ File ${pattern} is excluded by configuration patterns.`)
console.error(` Use --force to format it anyway.\n`)
process.exit(0)
} else {
console.error(`⚠️ Forcing formatter on excluded file: ${pattern}`)
console.error()
return [pattern]
}
}

return [pattern]
}

const files = await glob(pattern, { ignore: filesConfig.exclude || [] })

if (files.length === 0) {
try {
statSync(pattern)
} catch {
if (!pattern.includes('*') && !pattern.includes('?') && !pattern.includes('[') && !pattern.includes('{')) {
throw new Error(`Cannot access '${pattern}': ENOENT: no such file or directory`)
}
}
}

return files
}
}
Loading
Loading