The inline_edit.vim from nikarc

View Code? Open in Web Editor NEW

Edit code that's embedded within other code

Ruby 1.43% Shell 0.53% Vim Script 90.80% HTML 6.14% Vue 1.09%

inline_edit.vim's Introduction

Problem

Editing javascript within HTML is annoying. To generalize, editing code that's embedded in some different code is annoying.

Solution

Given the following example:

<script type="text/javascript">
  $(document).ready(function() {
    $('#foo').click(function() {
      alert('OK');
    });
  })
</script>

Execute :InlineEdit within the script tag. A proxy buffer is opened with only the javascript. Saving the proxy buffer updates the original one. You can reindent, lint, slice and dice as much as you like.

Check the docs for more information, see the examples directory for some example files to try it on.

If you like the plugin, consider rating it on vim.org.

What does it work for?

Javascript and CSS within HTML

<head>
  <script type="text/javascript">
    $(document).ready(function() {
      $('#foo').click(function() {
        alert('OK');
      });
    })
  </script>

  <style>
    body {
      color: blue;
      background-color: red;
    }
  </style>
</head>

SQL within ruby (matches "<<-SQL")

def some_heavy_query
  execute <<-SQL
    SELECT * FROM users WHERE something = 'other';
  SQL
end

Code within fenced markdown blocks

  Some text.

  ``` ruby
  def foo
    puts "OK"
  end
  ```

  ``` python
  def foo():
      print("OK")
  ```

  Some other text.

Django blocks in templates (Thanks to @Vladimiroff)

{%  block content %}
<h1>{{ section.title }}</h1>

{% for story in story_list %}
<h2>
  <a href="{{ story.get_absolute_url }}">
    {{ story.headline|upper }}
  </a>
</h2>
<p>{{ story.tease|truncatewords:"100" }}</p>
{% endfor %}
{% endblock %}

Heredocs in shellscript (Thanks to @fewaffles)

cat <<-RUBY
  #! /usr/bin/env ruby

  puts "OK"
RUBY

cat <<PYTHON
  #! /usr/bin/env python3

  print("OK")
PYTHON

Vue Single File Components

<template>
  <p>{{ greeting }} World!</p>
</template>

<script>
module.exports = {
  data: function () {
    return {
      greeting: 'Hello'
    }
  }
}
</script>

<style scoped>
p {
  font-size: 2em;
  text-align: center;
}
</style>