Extract the selection into a new file

README
Issues 2

vim-xtract

Extract the selection into a new file

vim-xtract helps you split up large files into smaller files. Great for refactoring.

Installation

Add rstacruz/vim-xtract using your favorite Vim plugin manager. For vim-plug, that's:

Plug 'rstacruz/vim-xtract'

Usage

Select a few lines. You can use a visual selection (V) or using text objects (vapap...). Then press:

:Xtract newfilename⏎

This extracts from the current file into a new file newfilename.js in the same directory, keeping the extension of the current file.

Copying headers

You can copy the files headers and leave an import statement behind (eg, import X from './X').

:'<,'>Xtract FILENAME N

'<,'> — the range of the body
FILENAME — the new file (no extension)
N — number of lines in the header (optional)

Example

Let's say you have a file like this index.js below. We want to extract the header (first 3 lines) and a function body (last 3 lines) into a new file, MyComponent.js.

[index.js]
 1   // @flow
 2   import React from 'react'
 3
 4   export function App () {
 5     return <MyComponent />
 6   }
 7
 8   export function MyComponent () {
 9     return <div></div>
10   }

Select the body first (lines 8 to 10) using V, then type:

:Xtract MyComponent 3⏎

This copies lines 1-3 into a new buffer (the header) and 8-10 right after it (the block). The resulting files will look like these:

 [index.js]
  // @flow
  import React from 'react'
+ import MyComponent from './MyComponent'

  export function App () {
    return <MyComponent />
  }
-
- export function MyComponent () {
-   return <div></div>
- }

 [MyComponent.js]
+ // @flow
+ import React from 'react'
+
+ export function MyComponent () {
+   return <div></div>
+ }

Updating placeholders

Edit g:xtract_placeholders to update the string it leaves behind:

let g:xtract_placeholders = {
\ "javascript": "import %s from './%s'",
\ "jsx": "import %s from './%s'",
\ "scss": "@import './%s';",
\ "sass": "@import './%s'",
\ }

Thanks

ricostacruz.com · GitHub @rstacruz · Twitter @rstacruz

0 Open More issues

Closed

Robust path handling and universal placeholder support

@rstacruz, I've been quite enjoying using your vim-xtract plugin. I like how it assists in code refactoring by replacing the extracted text with an import statement in the correct programming language and implicitly assumes the same file extension as the original file.

However, my frequent use case is extracting file parts to a new file at a path starting with my home directory, so I quickly discovered that it creates a folder named ~ in the current working directory instead of treating tilde as the usual alias. Although I'm usually pretty confident whether to cut the blue wire or the red wire, I felt rather uneasy adding anything similar to rm -rf \~ to my command history.

I hope you're fond of the improvements I've made, which include the ability to discern a relative path from an absolute path, more sophisticated behavior with respect to file extensions and reinstatement of generic placeholder inclusion, which seems to have disappeared with the introduction of header yanking support in dbd233350d347fb7ad17b66819ce30c0d7925ba2.

opened Jan 8, 2018 by specious 8

Closed