feat: add ~System autocmd to controll the timing

Now default mappings are defined prior to user mappings so that user can
overwrite the default mappings if they want.

Author: lambdalisue

denops/fall/picker.ts

@@ -21,7 +21,10 @@ import { Scheduler } from "./lib/scheduler.ts";
 import { Cmdliner } from "./util/cmdliner.ts";
 import { isIncrementalMatcher } from "./util/predicate.ts";
 import { buildMappingHelpPages } from "./util/mapping.ts";
-import { emitPickerEnter, emitPickerLeave } from "./util/emitter.ts";
+import {
+  emitPickerEnterSystem,
+  emitPickerLeaveSystem,
+} from "./util/emitter.ts";
 import { CollectProcessor } from "./processor/collect.ts";
 import { MatchProcessor } from "./processor/match.ts";
 import { SortProcessor } from "./processor/sort.ts";
@@ -276,11 +279,11 @@ export class Picker<T extends Detail> implements AsyncDisposable {
       },
     );
 
-    // Emit 'FallPickerEnter/FallPickerLeave' autocmd
+    // Emit 'FallPickerEnterSystem/FallPickerLeaveSystem' autocmd
     stack.defer(async () => {
-      await emitPickerLeave(denops, this.#name);
+      await emitPickerLeaveSystem(denops, this.#name);
     });
-    await emitPickerEnter(denops, this.#name);
+    await emitPickerEnterSystem(denops, this.#name);
 
     return stack.move();
   }

denops/fall/util/emitter.ts

@@ -2,31 +2,33 @@ import type { Denops } from "jsr:@denops/std@^7.3.2";
 import { emit } from "jsr:@denops/std@^7.3.2/autocmd";
 
 /**
- * Save current cmap and emit `User FallPickerEnter:{name}` autocmd.
- *
- * The saved cmap will be restored by `emitPickerLeave`.
+ * Emit `User FallPickerEnterSystem:{name}` autocmd.
  */
-export async function emitPickerEnter(
+export async function emitPickerEnterSystem(
   denops: Denops,
   name: string,
 ): Promise<void> {
   try {
-    await emit(denops, "User", `FallPickerEnter:${name}`, { nomodeline: true });
+    await emit(denops, "User", `FallPickerEnterSystem:${name}`, {
+      nomodeline: true,
+    });
   } catch (err) {
-    console.warn(`[fall] Failed to emit FallPickerEnter:${name}`, err);
+    console.warn(`[fall] Failed to emit FallPickerEnterSystem:${name}`, err);
   }
 }
 
 /**
- * Restore saved cmap and emit `User FallPickerLeave:{name}` autocmd.
+ * Emit `User FallPickerLeaveSystem:{name}` autocmd.
  */
-export async function emitPickerLeave(
+export async function emitPickerLeaveSystem(
   denops: Denops,
   name: string,
 ): Promise<void> {
   try {
-    await emit(denops, "User", `FallPickerLeave:${name}`, { nomodeline: true });
+    await emit(denops, "User", `FallPickerLeaveSystem:${name}`, {
+      nomodeline: true,
+    });
   } catch (err) {
-    console.warn(`[fall] Failed to emit FallPickerLeave:${name}`, err);
+    console.warn(`[fall] Failed to emit FallPickerLeaveSystem:${name}`, err);
   }
 }

denops/fall/util/emitter_test.ts

@@ -1,7 +1,7 @@
 import { assertEquals } from "jsr:@std/assert@^1.0.6";
 import { DenopsStub } from "jsr:@denops/test@^3.0.4/stub";
 
-import { emitPickerEnter, emitPickerLeave } from "./emitter.ts";
+import { emitPickerEnterSystem, emitPickerLeaveSystem } from "./emitter.ts";
 
 Deno.test("emitPickerEnter", async (t) => {
   await t.step("emit 'User FallPickerEnter:{name}'", async () => {
@@ -12,7 +12,7 @@ Deno.test("emitPickerEnter", async (t) => {
         return Promise.resolve();
       },
     });
-    await emitPickerEnter(denops, "test");
+    await emitPickerEnterSystem(denops, "test");
     assertEquals(called, [
       ["do <nomodeline> User FallPickerEnter:test", {}],
     ]);
@@ -28,7 +28,7 @@ Deno.test("emitPickerLeave", async (t) => {
         return Promise.resolve();
       },
     });
-    await emitPickerLeave(denops, "test");
+    await emitPickerLeaveSystem(denops, "test");
     assertEquals(called, [
       ["do <nomodeline> User FallPickerLeave:test", {}],
     ]);

plugin/fall.vim

@@ -11,15 +11,6 @@ command! -nargs=0 FallCustom call fall#command#FallCustom#call()
 command! -nargs=0 FallCustomReload call fall#command#FallCustomReload#call()
 command! -nargs=0 FallCustomRecache call fall#command#FallCustomRecache#call()
 
-augroup fall_plugin
-  autocmd! *
-  autocmd User FallPickerEnter:* :
-  autocmd User FallPickerLeave:* :
-  autocmd User FallCustomLoaded :
-  autocmd User FallCustomRecached :
-  autocmd User FallPreviewRendered:* :
-augroup END
-
 if !exists('g:fall_custom_path')
   let g:fall_custom_path = has('nvim')
         \ ? expand(join([stdpath('config'), 'fall', 'custom.ts'], s:sep))

plugin/fall/autocmd.vim

@@ -0,0 +1,20 @@
+if exists('g:loaded_fall_autocmd')
+  finish
+endif
+let g:loaded_fall_autocmd = 1
+
+function! s:bypass(event) abort
+  let l:name = matchstr(expand('<amatch>'), '^.\+:\zs.*$')
+  execute printf('doautocmd <nomodeline> User %s:%s', a:event, l:name)
+endfunction
+
+augroup fall_plugin_autocmd
+  autocmd! *
+  autocmd User FallPickerEnterSystem:* ++nested call s:bypass('FallPickerEnter')
+  autocmd User FallPickerLeaveSystem:* ++nested call s:bypass('FallPickerLeave')
+  autocmd User FallPickerEnter:* :
+  autocmd User FallPickerLeave:* :
+  autocmd User FallCustomLoaded :
+  autocmd User FallCustomRecached :
+  autocmd User FallPreviewRendered:* :
+augroup END

plugin/fall/mapping.vim

@@ -108,6 +108,6 @@ if !get(g:, 'fall_disable_default_mapping')
 
   augroup fall_mapping_plugin
     autocmd!
-    autocmd User FallPickerEnter:* call s:map_picker()
+    autocmd User FallPickerEnterSystem:* call s:map_picker()
   augroup END
 endif