Buffer autoreload on external file change event

alerticus · March 1, 2019, 1:38pm

Hello! Thanks for the great software! I like the look of the built-in text editor, but also would like to use an external editor (namely, RubyMine). I see, it’s possible to load file into buffer, but this action then needs to be done after each edit-save, which feels a bit tedious. Maybe there is an option for monitoring file changes (e.g. inotify) or some other way to automate this? (e.g. bash, AppleScript)
It would be cool to autoload file and maybe even autoplay after that!

Bubo · March 1, 2019, 3:34pm

I don’t know anything about this software but there is an Atom plugin that works well to play with SP.

alerticus · March 1, 2019, 4:43pm

Thanks! This was enough clue for implementing it via OSC::Client.

github.com

AlexanderPavlenko/sonic-pi-works/blob/master/autoreload.rb

#!/usr/bin/env ruby

require 'osc-ruby'
require 'listen'

target = ARGV[0].to_s
unless File.exists?(target)
  fail "Usage: ./autoreload.rb FILENAME"
end

client   = OSC::Client.new('localhost', 4557)
listener = Listen.to(
  File.dirname(target),
  only: /#{Regexp.quote(File.basename(target))}/
) do
  puts "#{Time.now} reloading #{target}"
  client.send(OSC::Message.new('/stop-all-jobs'))
  sleep 0.5
  client.send(OSC::Message.new('/run-code', '0', File.read(target)))
end

This file has been truncated. show original

Bubo · March 1, 2019, 5:05pm

Wow. Very nice! Is it easy to implement some kind of intelligent auto-completion using RubyMine? (Some kind of extended version of the auto-completion in the vanilla-IDE)

alerticus · March 1, 2019, 5:29pm

Since Sonic Pi syntax is Ruby, I guess it would be enough to create stubs (kinda like “C headers” files) for indexing it. That’s how it’s done for the standard library:

=begin
This is a machine generated stub using stdlib-doc for <b>module Enumerable</b>
Sources used:  ruby-2.3.7
Created by IntelliJ Ruby Stubs Generator.
=end

# ...docs...
module Enumerable
  # ...docs...
  def to_a(*args)
    #This is a stub, used for indexing
  end
...

alerticus · March 1, 2019, 8:31pm

I was able to extract YARD docs from sources!
Careful, it’s ~7000 lines

github.com

AlexanderPavlenko/sonic-pi-works/blob/master/stubs/yard.rb

# Get all sample names
# Return a list of all the sample names available
# @accepts_block false
# @introduced 2.0.0
def all_sample_names()
  #This is a stub, used for indexing
end

# Ensure arg is valid
# Raises an exception if the argument is either nil or false.
# @param _arg [anything]
# @accepts_block false
# @introduced 2.8.0
# @example
#   # Simple assertions
#   assert true   # As true is neither nil or false, this assertion passes
#   assert 1      # Similarly, 1 passes
#   assert "foo" # As do string
#   assert false  # This will raise an exception
#

This file has been truncated. show original

xorik · December 27, 2020, 11:33pm

Hi @alerticus . I’ve added the file to my project, but it seems autocomplete in RubyMine still not working.

I want to make a video how to use sonic pi with idea IDE, and show how to automatically play current file in sonic pi on save.

Topic		Replies	Views
Sync_file to automatically sense changes to a file, then reload it Feature Requests	0	396	June 18, 2021
Edit sonic-pi code in my own editor? Support, Help & Resources	3	228	December 25, 2023
Loading Ruby gems for use within a Sonic Pi buffer Development	10	2142	March 25, 2021
Running Sonic Pi code from Atom text editor Creations & Ideas	5	2848	June 3, 2018
Not Enough Lines Support, Help & Resources	2	442	November 24, 2019

Buffer autoreload on external file change event

Related Topics