Exclude Mocks in Go to Implementation

A Visual Studio Code extension to exclude mock files when using "Go to Implementation" in Go projects.

---

Description

This extension improves the default Go to Implementation behavior in Visual Studio Code for Go projects by filtering out mock files (e.g., *_mock.go, mocks/*) from navigation results. It is ideal for projects using mock generators like gomock or custom mock directories.

---

Key Features

• ✅ Filters files based on customizable glob patterns (e.g., **/*_mock.go, **/mocks/**/*.go).
• ✅ Customize mock file patterns via settings.json.
• ✅ Displays a pick list if multiple valid implementations exist.
• ✅ Replaces the native Go to Implementation command (ctrl+f12 or cmd+f12 for mac) without disrupting normal usage.

---

Installation

From Visual Studio Code Marketplace (Recommended)

1. Open Visual Studio Code.
2. Open the Extensions Panel (Ctrl + Shift + X or Cmd + Shift + X).
3. Search for Exclude Mocks in Go to Implementation.
4. Click Install.

Manual (For Development)

1. Clone the repository:

   git clone https://github.com/ZihxS/exclude-mocks-go-to-impl.git

2. Navigate to the directory:

   cd exclude-mocks-go-to-impl

3. Install dependencies:

   npm install

4. Build the project:

   npm run compile

5. Run the extension in debug mode:
   • Open the folder in VS Code.
   • Press F5 to launch the extension host.

---

Usage

1. Open a .go file in Visual Studio Code.
2. Click on an interface method or function signature.
3. Press (ctrl+f12 or cmd+f12 for mac) to trigger Go to Implementation.
4. The extension will:
   • Fetch implementation locations from the language server (e.g., gopls).
   • Filter out mock files based on configured patterns.
   • Navigate to the result or show a pick list.

---

Configuration

Customize mock file patterns in settings.json:

{
  "excludeMockFiles.patterns": [
    "**/*_mock.go",     // Files ending with _mock.go
    "**/mock/**/*.go",  // Files in mock directories
    "**/mocks/**/*.go", // Files in mocks directories
    "**/mock_*.go"      // Files starting with mock_ followed by any characters
  ]
}

Example Custom Patterns:

{
  "excludeMockFiles.patterns": [
    "**/test/**",       // Files in test directories
    "**/testdata/**",   // Files in test directories
    "**/stubs/**/*.go", // Files in stubs directories
    "**/generated/*.go" // Auto-generated files
  ]
}

---

Dependencies

• gopls: Go language server supporting Go to Implementation.
• minimatch: For flexible glob pattern matching.

---

Contributing

Contributions are welcome! Here's how to get started:

1. Fork this repository.
2. Create a feature branch: git checkout -b new-feature.
3. Commit your changes: git commit -am 'Add new feature'.
4. Push to the branch: git push origin new-feature.
5. Submit a Pull Request.

---

License

MIT © Muhammad Saleh Solahudin

---

Issues or Suggestions?

Report bugs or request features at: https://github.com/ZihxS/exclude-mocks-go-to-impl/issues

---

Keywords

Go, Golang, VSCode, Mock, Go to Implementation, gopls, Mock Generator, Interface Navigation

---

Notes

• Works only for Go files (editorLangId == 'go').
• Does not interfere with built-in commands for other languages.

---

Example Output

Before (Without Extension)

interfaces.go:10: func DoSomething()
→ Implementations found:
  - service.go
  - mocks/mock_service.go
  - testdata/fake_service.go

After (With Extension)

interfaces.go:10: func DoSomething()
→ Implementations found:
  - service.go