Blogs » Manage project alternate files

28 Jan 2020

• Causes and purposes
• Basic usage

Causes and purposes

At first, when managing the SpaceVim project, every time you edited a module source file, you always need to pay attention to the following things:

1. Whether the relevant documents exist, whether they need to be modified, whether there are Chinese and English versions of documents in the project, and whether the contents are consistent.
2. Test whether the file exists and whether it needs to be modified.

In view of the above two points, the following requirements are derived:

1. When editing a source file, quickly jump to the source file where the document is located;
2. When editing Chinese documents, quickly jump to English documents and vice versa;
3. When editing the source file, quickly jump to the test file and vice versa;

At present, this plugin built into SpaceVim basically implements the above functions, in order to quickly jump between related files.

Basic usage

SpaceVim provides a built-in alternate file manager, the command is :A.

To use this feature, you can create a .project_alt.json file in the root of your project. for example:

{
  "autoload/SpaceVim/layers/lang/*.vim": {"doc": "docs/layers/lang/{}.md"},
}

after adding this configuration, when edit autoload/SpaceVim/layers/lang/java.vim, you can use :A doc switch to docs/layers/lang/java.md