ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Related Files

by fabiokr ST2/ST3

A Sublime Text 2/3 plugin to list related files

Details

  • 2 2014.10.30.15.27.39
    3 1.0.1
  • github.​com
  • github.​com
  • 5 years ago
  • 16 minutes ago
  • 7 years ago

Installs

  • Total 2K
  • Win 634
  • OS X 1K
  • Linux 384
Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7 Sep 6 Sep 5 Sep 4 Sep 3 Sep 2 Sep 1 Aug 31 Aug 30 Aug 29 Aug 28 Aug 27 Aug 26 Aug 25 Aug 24 Aug 23 Aug 22 Aug 21 Aug 20 Aug 19 Aug 18 Aug 17 Aug 16 Aug 15 Aug 14 Aug 13 Aug 12 Aug 11 Aug 10 Aug 9 Aug 8 Aug 7 Aug 6 Aug 5 Aug 4 Aug 3
Windows 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0
OS X 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 0 0 0 0 0 0 0 1 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

Sublime Text 3 - Related Files Plugin

Screenshot

This plugin provides a quick list of related files to the currently open file.

My main use case is to list related files under a Ruby on Rails project. For example, for an opened “app/controllers/examples_controller.rb”, related files would be “app/helpers/examples_helper.rb”, “app/views/examples/**”, and “spec/controllers/examples_controller_spec.rb”.

This plugin was inspired by the existing Open Related and Rails Related Files.

I wanted something between the two of them (a quick list of results that could be setup for any kinds of projects, not only Rails), so I created my own.

Key Shortcut

The default shortcut is mapped to “ctrl+super+p”. To change it to something more suitable for your needs, you can easily change that by copying the following and replacing the “keys” to your desired key combination:

{ "keys": ["ctrl+super+p"], "command": "related_files"}

Configuration

The plugins comes configured to lookup Rails related files, but you can add your own setups. Let's see an existing example:

// Test/specs for ruby files
".+\/(app|lib)\/(.+).rb":
  [
    "spec/$2_spec.rb",
    "test/$2_test.rb"
  ]

The configuration has two parts: the key, which is a regular expression to match against the currently open file, and a list of globs to map the related files.

You can use the $1, $2, etc. on the glob strings to be replace by the extracted parts from the regex.

In addition to global configs, you can also have per project configs. To add that, in a sublime project file (project-name.sublime-project), add this:

{
  "settings":
  {
    "RelatedFiles": {
      "patterns": {
        // you project patterns
      }
    }
  }
}