Homebrew formula

[sbryngelson]

PR Type

Enhancement, Documentation

---

Description

• Add shorthand syntax for MFC command execution

  • Auto-detect case files and prepend 'run' command
  • Support both mfc case.py and mfc run case.py forms

• Update help text and examples with new syntax

• Improve user experience with simplified command interface

• Update CI workflow to use new shorthand syntax

---

Diagram Walkthrough

flowchart LR
  A["User Input Detection"] -->|Case file detected| B["Auto-prepend 'run'"]
  A -->|Explicit 'run' command| C["Execute normally"]
  B --> D["Execute MFC"]
  C --> D
  D --> E["Run simulation"]

Loading

File Walkthrough

Relevant files

Enhancement

mfc.rb Implement auto-detection for shorthand MFC syntax                packaging/homebrew/mfc.rb Add shorthand syntax mfc to help text alongside explicit mfc run Implement smart detection logic to auto-prepend 'run' when first argument is a Python file or existing file Update usage examples to demonstrate new shorthand syntax with options Simplify caveats section to highlight shorthand form as primary usage method +14/-5    homebrew.yml Update CI workflow to use shorthand syntax                              .github/workflows/homebrew.yml Update test case execution to use new shorthand syntax mfc "$TESTDIR/case.py" Update comment to reflect auto-detection behavior of wrapper +2/-2

---

[qodo-merge-pro]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 PR contains tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Possible Issue The auto-prepend logic for 'run' treats any existing path or any string ending with '.py' as a case file, which could unintentionally rewrite commands or collide with future subcommands; validate behavior when the first arg is a non-existent '.py' string, a directory ending with '.py', or when additional subcommands are added later. # Smart detection: if first arg looks like a case file, auto-prepend "run" if [[ "${SUBCMD}" =~ .py$ ]] || [[ -f "${SUBCMD}" ]]; then ARGS=("run" "${ARGS[@]}") SUBCMD="run" fi UX Consistency Help text and caveats now advertise shorthand 'mfc <case.py>' and 'mfc run <case.py>'; ensure all other docs/scripts remain consistent to avoid confusion and verify error messages guide users correctly when non-'run' subcommands are used. if [[ ${#ARGS[@]} -eq 0 ]] || [[ "${SUBCMD}" == "--help" ]] || [[ "${SUBCMD}" == "-h" ]]; then cat <<'HHELP' MFC (Homebrew) #{version} Usage: mfc <case.py> [options] mfc run <case.py> [options] Examples: mfc case.py -n 2 mfc run case.py -n 2 -t pre_process simulation

[qodo-merge-pro]

High-level Suggestion

The PR adds a shorthand for the run subcommand, which is inconsistent with the main developer tool's CLI. To ensure a consistent user experience, this implicit behavior should be removed, requiring the explicit mfc run <case.py> command. [High-level, importance: 7]

Solution Walkthrough:

Before:

# In mfc wrapper script
ARGS=("$@")
SUBCMD="${ARGS[0]}"

# Smart detection: if first arg looks like a case file, auto-prepend "run"
if [[ "${SUBCMD}" =~ .py$ ]] || [[ -f "${SUBCMD}" ]]; then
  ARGS=("run" "${ARGS[@]}")
  SUBCMD="run"
fi

if [[ "${SUBCMD}" != "run" ]]; then
  echo "mfc (Homebrew): only 'run' is supported..."
  exit 2
fi
# ... proceed to execute 'run' command

After:

# In mfc wrapper script
ARGS=("$@")
SUBCMD="${ARGS[0]}"

# No smart detection. 'run' must be explicit.

if [[ "${SUBCMD}" != "run" ]]; then
  echo "mfc (Homebrew): only 'run' is supported..."
  echo "Use 'mfc run <case.py>'"
  exit 2
fi
# ... proceed to execute 'run' command

[qodo-merge-pro]

Suggestion: Modify the case file detection logic to handle command-line options placed before the filename. The current implementation only checks the first argument, which fails in this common scenario. [possible issue, importance: 7]

Suggested change

	# Smart detection: if first arg looks like a case file, auto-prepend "run"
	if [[ "${SUBCMD}" =~ .py$ ]] || [[ -f "${SUBCMD}" ]]; then
	ARGS=("run" "${ARGS[@]}")
	SUBCMD="run"
	fi
	# Smart detection: if 'run' is not specified, find a case file and prepend 'run'
	if [[ "${SUBCMD}" != "run" ]]; then
	for arg in "${ARGS[@]}"; do
	# If we find an argument that is a file and not an option, prepend "run"
	if [[ ! "${arg}" =~ ^- ]] && ([[ "${arg}" =~ \.py$ ]] || [[ -f "${arg}" ]]); then
	ARGS=("run" "${ARGS[@]}")
	SUBCMD="run"
	break
	fi
	done
	fi

[Copilot]

Pull Request Overview

This PR adds smart detection to the Homebrew formula's wrapper script, allowing users to omit the run subcommand when invoking MFC with a case file (e.g., mfc case.py instead of mfc run case.py). The changes update documentation, help text, and CI workflow to reflect this new convenience feature.

Key Changes

• Implemented auto-detection logic that prepends run when the first argument appears to be a case file
• Updated help text, caveats, and examples to showcase the shorthand syntax
• Modified CI workflow to test the new shorthand invocation

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
packaging/homebrew/mfc.rb	Added smart detection logic to auto-prepend run subcommand; updated help text, error messages, and caveats to document the shorthand syntax
.github/workflows/homebrew.yml	Updated test to use the new shorthand syntax mfc case.py instead of mfc run case.py

[Copilot]

The regex pattern .py$ is missing the escape for the dot, which means it will match any character followed by "py" at the end, not specifically ".py" files. The pattern should be \.py$ to properly match Python files.

This could cause false positives where strings ending with any character + "py" (e.g., "xpy", "1py") would incorrectly trigger the auto-detection.

Suggested change

	if [[ "${SUBCMD}" =~ .py$ ]] || [[ -f "${SUBCMD}" ]]; then
	if [[ "${SUBCMD}" =~ \.py$ ]] || [[ -f "${SUBCMD}" ]]; then

[Copilot]

The file existence check [[ -f "${SUBCMD}" ]] is too broad and will trigger auto-detection for any file, not just Python case files. This means commands like mfc myfile.txt would incorrectly be transformed to mfc run myfile.txt.

Consider making the check more specific, e.g., [[ "${SUBCMD}" =~ \.py$ ]] || [[ "${SUBCMD}" =~ \.py$ && -f "${SUBCMD}" ]], or simply rely only on the file extension check since Python case files should always end in .py.

Suggested change

	if [[ "${SUBCMD}" =~ .py$ ]] || [[ -f "${SUBCMD}" ]]; then
	if [[ "${SUBCMD}" =~ \.py$ ]]; then