living_document 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd6766fedfe5bb15663673387072f43334a43fe590b5651721439c16c9b6d5d8
-  data.tar.gz: c561e58301674a99838f44c7b14b12474708dc3182b7efc1df6c6572315135bb
+  metadata.gz: 3680ab9cf85cc909a679c876a1dcdc5ce3f5e870419efa17770208f4c7359bb5
+  data.tar.gz: 76edf601a178c8afc1d88040f591a4b8e4026282bdf5d4dec3c4b415f36af01e
 SHA512:
-  metadata.gz: bf6d65cf5d6e555dfd490e5bc7275d818a4713670995ec26c8794102cd9d069a28abd73eadba0975c2aacda87a2d4fca1f5e32de0df3d30fcbced4e622053c45
-  data.tar.gz: ebc0761b7f74e662d7eb7b32cb6509926504237c7437b47be53b20dd14074a6fda5a8d529eb4ae1a335f56d2e7bed1b3cb0f49c6b5fb225e8194184f4f5ff221
+  metadata.gz: 5173bd8e3e6d4c96017db480009272e8016af8b2735281ccafbef5a673ed079dd0163a43bea963222e603a8be84e5cf0081c641dc92fbb68fd0bf0da295e9bc5
+  data.tar.gz: 2ebc0946d141e3b18b5d84cc792ce88d88f1f749745294efa566f6074a23063665596064e8a672e9c5cf504343261bf8d0af8ee0dd0003da0e7634c87ea9e8b4

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v2.1.0 (2025-02-05)
+- Offer to create the provided target file, if it doesn't yet exist.
+- Document compatibility with VS Code and NeoVim.
+- Automatically open the target file in editor, if `$EDITOR` is set.
+
 ## v2.0.0 (2025-02-05)
 - **BREAKING:** Use `rb-inotify` (not `listen`) to watch for file changes. This means that the gem is now only compatible with Linux.
 - Support listening to files outside of the current directory.

data/Gemfile.lock

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: .
   specs:
-    living_document (2.0.0)
+    living_document (2.1.0)
       activesupport (>= 6)
       memo_wise (>= 1.7)
       rb-inotify (>= 0.11.1)
@@ -211,7 +211,7 @@ CHECKSUMS
   irb (1.15.1) sha256=d9bca745ac4207a8b728a52b98b766ca909b86ff1a504bcde3d6f8c84faae890
   json (2.9.1) sha256=d2bdef4644052fad91c1785d48263756fe32fcac08b96a20bb15840e96550d11
   language_server-protocol (3.17.0.4) sha256=c484626478664fd13482d8180947c50a8590484b1258b99b7aedb3b69df89669
-  living_document (2.0.0)
+  living_document (2.1.0)
   logger (1.6.5) sha256=c3cfe56d01656490ddd103d38b8993d73d86296adebc5f58cefc9ec03741e56b
   memo_wise (1.10.0) sha256=ae40ff8e7799697ff5d59d739b8766f76be22eba69c7c8468edb42ab83c94c3f
   method_source (1.1.0) sha256=181301c9c45b731b4769bc81e8860e72f9161ad7d66dd99103c9ab84f560f5c5

data/README.md

@@ -39,6 +39,9 @@ In other words, the special markers `###` and `# =>` tell LivingDocument to eval
    * [Linux only <g-emoji class="g-emoji" alias="warning">⚠️</g-emoji>](#️-linux-only-️)
    * [Installation](#installation)
    * [Usage](#usage)
+   * [Editor compatibility](#editor-compatibility)
+      * [VS Code](#vs-code)
+      * [NeoVim](#neovim)
    * [Markdown support](#markdown-support)
    * [Time is frozen](#time-is-frozen)
    * [Development](#development)
@@ -46,7 +49,7 @@ In other words, the special markers `###` and `# =>` tell LivingDocument to eval
    * [License](#license)
 
 <!-- Created by https://github.com/ekalinin/github-markdown-toc -->
-<!-- Added by: david, at: Wed Feb  5 09:31:36 PM CST 2025 -->
+<!-- Added by: david, at: Wed Feb  5 11:12:42 PM CST 2025 -->
 
 <!--te-->
 
@@ -102,6 +105,28 @@ puts('This is one great string!')
 
 Then, edit the file and save it again. You'll see that the `# => ` comments are automatically and immediately updated to reflect your edits.
 
+## Editor compatibility
+
+### VS Code
+
+LivingDocument should work with VS Code "out of the box".
+
+### NeoVim
+
+For LivingDocument to work with NeoVim, you will need to add config like this to your `init.lua`:
+
+```lua
+-- Auto-reload files changed outside NeoVim.
+vim.opt.autoread = true
+-- Preserve inodes when saving / modify files in place.
+vim.opt.backupcopy = 'yes'
+-- Check for changes when switching buffers, cursor idles, or NeoVim regains focus.
+vim.api.nvim_create_autocmd({ "BufEnter", "CursorHold", "CursorHoldI", "FocusGained" }, {
+  command = "if mode() != 'c' | checktime | endif",
+  pattern = { "*" },
+})
+```
+
 ## Markdown support
 
 LivingDocument can also handle Markdown code, which is especially convenient when developing

data/exe/livdoc

@@ -2,6 +2,7 @@
 
 # frozen_string_literal: true
 
+require 'io/console'
 require 'optparse'
 require 'rb-inotify'
 
@@ -34,6 +35,26 @@ def evaluate_code_and_update_source_file(file_path, evaluation_reason:)
 
   puts('waiting for changes.')
 end
+
+def ask_to_create_file_if_needed(expanded_path)
+  if !File.exist?(expanded_path)
+    puts(<<~QUESTION)
+      The target file (#{expanded_path}) does not exist.
+      Would you like living_document to create it? [y]n
+    QUESTION
+
+    case $stdin.getch
+    when 'n', "\u0003" # Ctrl-C
+      puts('Okay, then, exiting.')
+      exit(0)
+    when 'y', "\r"
+      FileUtils.touch(expanded_path)
+    else
+      puts("\nThat's not an option.\n\n")
+      ask_to_create_file_if_needed(expanded_path)
+    end
+  end
+end
 # rubocop:enable Style/TopLevelMethodDefinition
 
 file_path = ARGV[0]
@@ -44,6 +65,13 @@ if file_path.nil?
 end
 
 expanded_path = File.expand_path(file_path)
+
+ask_to_create_file_if_needed(expanded_path)
+
+if system('[ -n "$EDITOR" ]')
+  system("$EDITOR #{expanded_path}")
+end
+
 notifier = INotify::Notifier.new
 last_file_update = Time.now
 

data/lib/living_document/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LivingDocument
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: living_document
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - David Runger