Find Related Files

Finds files related to the current file based on user-defined configuration rules.

• Adds a Show Related Files command (findrelated.show) with a shortcut of alt+r to show a quick pick menu of files related to the active file

Basic support for the following languages/frameworks is built-in:

• c, c++, c#
• asp.net
• asp.net mvc
• aurelia

Please open new Github issues with any rules you'd like included in the built-in ruleset.

Screenshot

Built-in rulesets

[
    {
        "name": "c/c++",
        "rules": [
            {
                "pattern": "(.*)\\.(?:c|cpp)$",
                "locators": ["$1.h"]
            },
            {
                "pattern": "(.*)\\.h$",
                "locators": ["{$1.c,$1.cpp}"]
            }
        ]
    },
    {
        "name": "csharp",
        "rules": [
            {
                "pattern": "(.*)\\.(?:cs|resx|settings)$",
                "locators": ["$1.designer.cs"]
            },
            {
                "pattern": "(.*)\\.designer\\.cs$",
                "locators": ["{$1.cs,$1.resx,$1.settings}"]
            }
        ]
    },
    {
        "name": "aspnet",
        "rules": [
            {
                "pattern": "(.*)\\.(?:aspx|ascx|asax|ashx|asmx)$",
                "locators": ["{$0.cs,$0.designer.cs}"]
            },
            {
                "pattern": "(.*)\\.(aspx|ascx|asax|ashx|asmx)(\\.designer)?(\\.cs)$",
                "locators": ["{$1.$2,$1$3$4}"]
            }
        ]
    },
    {
        "name": "aspnet-mvc",
        "rules": [
            {
                "pattern": "(.*)\/views\/(.*?)(?:\/.*)?\\.cshtml$",
                "locators": ["$1/**/Controllers/**/$2Controller.cs"]
            },
            {
                "pattern": "(.*)/controllers/(.*)/?(.*)controller\\.cs$",
                "locators": ["$1/**/Views/**/$2/**/*.cshtml"]
            }
        ]
    },
    {
        "name": "aurelia",
        "rules": [
            {
                "pattern": "(.*)\\.html$",
                "locators": ["{$1.ts,$1.js}"]
            },
            {
                "pattern": "(.*)\\.(?:ts|js)$",
                "locators": ["$1.html"]
            }
        ]
    }
]

pattern - specifies a regex pattern to which this rule applies; Capture groups can be used as replacements in the locators locators - specifies the list of glob pattern locators that will be used to search for related files; $[0-9] can be use as replacement tokens from the capture groups in the pattern

Extension Settings

Name	Description
findrelated.rulesets	Defines rulesets that can be used find related files; Will be merged with findrelated.workspaceRulesets and built-in rulesets
findrelated.workspaceRulesets	Defines workspace-specific rulesets that can be used find related files; Will be merged with findrelated.rulesets and built-in rulesets
findrelated.applyRulesets	Specifies the rulesets to use to find related files
findrelated.applyWorkspaceRules	Specifies the workspace-specific rulesets to use to find related files
findrelated.autoOpen	Specifies whether to automatically open the related file if there is only 1 result
findrelated.openPreview	Specifies whether or not to open the related file in a preview tab

Extension API

Find Related Files exports an API that can be used to expand its capabilities.

Example

let findRelated = extensions.getExtension('eamodio.find-related');
let api = findRelated.exports;

let subscription1 = api.registerRuleset('static-rule', [
    {
        pattern: /* string -- regex pattern here */,
        locators: [/* string -- glob patterns here */]
    }
]);

let subscription2 = api.registerRuleset('dynamic-rule', [
    {
        match: (fileName: string) => /* matching logic here -- return a boolean */,
        provideRelated: (fileName: string, document: TextDocument, rootPath: string) => {
            return Promise.resolve([/* related uris here */]);
        }
    }
]);

// To remove a registered ruleset, just dispose its subscription
subscription1.dispose();
subscription2.dispose();

Known Issues

None