Add minor mode; make VS code emu obsolete; v0.1.3

Author: elizagamedev

README.md

@@ -1,14 +1,14 @@
 # unity.el
 
-This package provides some Emacs integration with the Unity game engine. Most
-notably, it provides the ability to open source files from Unity in Emacs or
-Emacsclient while still generating the solution and project files for use with
-`lsp-mode`.
+This package provides some Emacs integration with the Unity game engine. It
+installs hooks/advice for smoother interop with certain Unity quirks. It's
+intended to be used along-side
+[rider2emacs](https://github.com/elizagamedev/rider2emacs) so that Unity will
+open source files in Emacs and generate the appropriate solution/project files
+necessary for LSP integration.
 
-Additionally, this package can install hooks/advice for smoother interop with
-certain Unity quirks. **Note that these (optional) integrations are experimental
-and potentially destructive**; see the `unity-setup` section for more
-information.
+**Note that these integrations are potentially destructive**; see the
+`unity-mode` section for more information.
 
 ## Installation
 
@@ -18,17 +18,35 @@ extend your load path. I recommend
 
 ```elisp
 (straight-use-package
- '(unity :type git :host github :repo "elizagamedev/unity.el"
-         :files ("*.el" "*.c")))
-(add-hook 'after-init-hook #'unity-build-code-shim)
-(add-hook 'after-init-hook #'unity-setup)
+ '(unity :type git :host github :repo "elizagamedev/unity.el"))
+(add-hook 'after-init-hook #'unity-mode)
 ```
 
-## Configuration
+## Usage
 
-`unity.el` exposes two functions, `unity-build-code-shim` and `unity-setup`.
+### `unity-mode`
 
-### `unity-build-code-shim`
+When active, this mode installs hooks, advice, etc. necessary for smoother
+Emacs/Unity interop. Currently this is limited to advising `rename-file` and
+`delete-file` so that `.meta` files are automatically moved and deleted
+alongside their associated files.
+
+While it's unlikely that there are any disasterous bugs lurking in the advice
+functions, given that these are destructive operations, *please be mindful* if
+you are enabling `unity-mode`. Always use revision control.
+
+### `rider2emacs`
+
+unity.el is intended to be used alongside
+[rider2emacs](https://github.com/elizagamedev/rider2emacs), which provides Unity
+with the ability to open files in Emacs and generate project files for use with
+OmniSharp LSP. See its documentation for details.
+
+### `unity-build-code-shim` (Obsolete)
+
+*The functionality described in this section has been superseded with
+[rider2emacs](https://github.com/elizagamedev/rider2emacs), but is left here in
+its original text for posterity.*
 
 Unity does not generate project or solution files unless the external text
 editor is recognized as Visual Studio, Visual Studio Code, or MonoDevelop.
@@ -63,14 +81,3 @@ absolute path. An example of "External Script Editor Args" might look like:
 ```sh
 /usr/local/bin/emacsclient -n +$(Line):$(Column) $(File)
 ```
-
-### `unity-setup`
-
-This function installs any hooks, advice, etc. necessary for smoother
-Emacs/Unity interop. Currently this is limited to advising `rename-file` and
-`delete-file` so that `.meta` files are automatically moved and deleted
-alongside their associated files.
-
-While it's unlikely that there are any disasterous bugs lurking in the advice
-functions, given that these are destructive operations, *please be mindful* if
-you are calling `unity-setup`. Always use revision control.

unity.el

@@ -1,29 +1,79 @@
 ;;; unity.el --- Unity integration for Emacs -*- lexical-binding:t -*-
 
-;; Version: 0.1.2
+;; Version: 0.1.3
 ;; Author: Eliza Velasquez
 ;; Created: 30 May 2021
 ;; Keywords: unity
 ;; URL: https://github.com/elizagamedev/unity.el
 
 ;;; Commentary:
 
-;; This package provides some Emacs integration with the Unity game engine.
-;; Most notably, it provides the ability to open source files from Unity in
-;; Emacs or Emacsclient while still generating the solution and project files
-;; for use with `lsp-mode'.
-;;
-;; Additionally, this package can install hooks/advice for smoother interop with
-;; certain Unity quirks.
+;; This package provides some Emacs integration with the Unity game engine.  It
+;; installs hooks/advice for smoother interop with certain Unity quirks.  It's
+;; intended to be used along-side rider2emacs [1] so that Unity will open source
+;; files in Emacs and generate the appropriate solution/project files necessary
+;; for LSP integration.
 ;;
 ;; See README.md for more information.
+;;
+;; [1] https://github.com/elizagamedev/rider2emacs
 
 ;;; Code:
 
 (defgroup unity nil
   "Unity game engine integration."
   :group 'external)
 
+(defun unity--project-path-p (path)
+  "Return t if PATH is in a Unity project."
+  (let ((case-fold-search t))
+    (if (string-match-p "/assets/" path) t)))
+
+(defun unity--rename-file-advice (file newname &optional ok-if-already-exists)
+  "Advice function for `rename-file' for renaming Unity files.
+
+FILE, NEWNAME, and OK-IF-ALREADY-EXISTS are documented by `rename-file'."
+  (when (and (unity--project-path-p file)
+             (unity--project-path-p newname))
+    (let ((meta-file (concat file ".meta")))
+      (when (file-exists-p meta-file)
+        (rename-file meta-file (concat newname ".meta")
+                     ok-if-already-exists)))))
+
+(defun unity--delete-file-advice (file &optional trash)
+  "Advice function for `delete-file' for deleting Unity files.
+
+FILE and TRASH are documented by `rename-file'."
+  (when (unity--project-path-p file)
+    (let ((meta-file (concat file ".meta")))
+      (when (file-exists-p meta-file)
+        (delete-file meta-file trash)))))
+
+;;;###autoload
+(define-minor-mode unity-mode
+  "Integrate Emacs with the Unity game engine editor."
+  :init-value nil
+  :lighter " Unity"
+  :global t
+  :group 'unity
+  (if unity-mode
+      (progn
+        (advice-add #'rename-file :after #'unity--rename-file-advice)
+        (advice-add #'delete-file :after #'unity--delete-file-advice))
+    (advice-remove #'rename-file #'unity--rename-file-advice)
+    (advice-remove #'delete-file #'unity--delete-file-advice)))
+
+;;;###autoload
+(defun unity-setup ()
+  "Activate Unity.el integration.
+
+Deprecated; use `unity-mode' instead."
+  (interactive)
+  (unity-mode 1))
+(make-obsolete #'unity-setup #'unity-mode "0.1.3")
+
+;;; Obsolete Visual Studio Code definitions follow.
+
 (defcustom unity-var-directory
   (expand-file-name (convert-standard-filename "var/unity/")
                     user-emacs-directory)
@@ -61,30 +111,14 @@ See https://docs.microsoft.com/en-us/cpp/build/building-on-the-command-line."
   :type 'string
   :group 'unity)
 
-(defun unity--project-path-p (path)
-  "Return t if PATH is in a Unity project."
-  (let ((case-fold-search t))
-    (if (string-match-p "/assets/" path) t)))
-
-(defun unity--rename-file-advice (file newname &optional ok-if-already-exists)
-  "Advice function for `rename-file' for renaming Unity files.
-
-FILE, NEWNAME, and OK-IF-ALREADY-EXISTS are documented by `rename-file'."
-  (when (and (unity--project-path-p file)
-             (unity--project-path-p newname))
-    (let ((meta-file (concat file ".meta")))
-      (when (file-exists-p meta-file)
-        (rename-file meta-file (concat newname ".meta")
-                     ok-if-already-exists)))))
-
-(defun unity--delete-file-advice (file &optional trash)
-  "Advice function for `delete-file' for deleting Unity files.
-
-FILE and TRASH are documented by `rename-file'."
-  (when (unity--project-path-p file)
-    (let ((meta-file (concat file ".meta")))
-      (when (file-exists-p meta-file)
-        (delete-file meta-file trash)))))
+(dolist (var '(unity-var-directory
+               unity-code-shim-source-directory
+               unity-cc
+               unity-vcvarsall-file
+               unity-vcvarsall-arch))
+  (make-obsolete-variable var
+                          "Prefer rider2emacs instead of Visual Studio Code emulation."
+                          "0.1.3"))
 
 (defun unity--code-binary-file ()
   "Return the file name of the code shim binary."
@@ -156,12 +190,15 @@ interactively."
           (switch-to-buffer-other-window subprocess-buffer)
           (special-mode))))))
 
-;;;###autoload
-(defun unity-setup ()
-  "Activate Unity.el integration."
-  (interactive)
-  (advice-add #'rename-file :after #'unity--rename-file-advice)
-  (advice-add #'delete-file :after #'unity--delete-file-advice))
+(dolist (f '(unity--code-binary-file
+             unity--build-code-shim-unix
+             unity--build-code-shim-windows
+             unity-build-code-shim))
+  (make-obsolete f
+                 "Prefer rider2emacs instead of Visual Studio Code emulation."
+                 "0.1.3"))
+
+;;; Postlude
 
 (provide 'unity)