feat!: rename to @vim-fall/custom and refine definitions

Author: lambdalisue

README.md

@@ -1,11 +1,11 @@
-# 🍂 fall-config
+# 🍂 fall-custom
 
-[![JSR](https://jsr.io/badges/@vim-fall/config)](https://jsr.io/@vim-fall/config)
+[![JSR](https://jsr.io/badges/@vim-fall/custom)](https://jsr.io/@vim-fall/custom)
 [![Deno](https://img.shields.io/badge/Deno%202.x-333?logo=deno&logoColor=fff)](#)
-[![Test](https://github.com/vim-fall/deno-fall-config/actions/workflows/test.yml/badge.svg)](https://github.com/vim-fall/deno-fall-config/actions/workflows/test.yml)
+[![Test](https://github.com/vim-fall/deno-fall-custom/actions/workflows/test.yml/badge.svg)](https://github.com/vim-fall/deno-fall-custom/actions/workflows/test.yml)
 [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
 
-Module to configure [Fall](https://github.com/vim-fall/fall.vim), a Vim/Neovim
+Library to customize [Fall](https://github.com/vim-fall/fall.vim), a Vim/Neovim
 fuzzy finder plugin powered by
 [Denops](https://github.com/vim-denops/denops.vim).
 

deno.jsonc

@@ -1,12 +1,12 @@
 {
-  "name": "@vim-fall/config",
+  "name": "@vim-fall/custom",
   "version": "0.0.0",
   "exports": {
     ".": "./mod.ts",
     "./action-picker": "./action_picker.ts",
     "./derivable": "./derivable.ts",
-    "./global-config": "./global_config.ts",
-    "./item-picker": "./item_picker.ts"
+    "./picker": "./picker.ts",
+    "./setting": "./setting.ts"
   },
   "publish": {
     "include": [

global_config.ts

@@ -1,10 +1,10 @@
 import type { Denops } from "@denops/std";
 import type {
-  DefineItemPickerFromCurator,
-  DefineItemPickerFromSource,
-} from "./item_picker.ts";
+  DefinePickerFromCurator,
+  DefinePickerFromSource,
+} from "./picker.ts";
 import type { RefineActionPicker } from "./action_picker.ts";
-import type { RefineGlobalConfig } from "./global_config.ts";
+import type { RefineSetting } from "./setting.ts";
 
 /**
  * The entrypoint for configuring the picker environment.
@@ -13,15 +13,15 @@ import type { RefineGlobalConfig } from "./global_config.ts";
  */
 export type Entrypoint = (params: {
   denops: Denops;
-  defineItemPickerFromSource: DefineItemPickerFromSource;
-  defineItemPickerFromCurator: DefineItemPickerFromCurator;
+  definePickerFromSource: DefinePickerFromSource;
+  definePickerFromCurator: DefinePickerFromCurator;
   refineActionPicker: RefineActionPicker;
-  refineGlobalConfig: RefineGlobalConfig;
+  refineSetting: RefineSetting;
 }) => void | Promise<void>;
 
 export type {
-  DefineItemPickerFromCurator,
-  DefineItemPickerFromSource,
-} from "./item_picker.ts";
+  DefinePickerFromCurator,
+  DefinePickerFromSource,
+} from "./picker.ts";
 export type { RefineActionPicker } from "./action_picker.ts";
-export type { RefineGlobalConfig } from "./global_config.ts";
+export type { RefineSetting } from "./setting.ts";

mod.ts

@@ -29,7 +29,7 @@ type Actions<T extends Detail = Detail, A extends string = string> =
  * @template T - The type of items in the picker.
  * @template A - The type representing the default action name.
  */
-export type ItemPickerParams<
+export type PickerParams<
   T extends Detail = Detail,
   A extends string = string,
 > = {
@@ -51,7 +51,7 @@ export type ItemPickerParams<
  * @template T - The type of items handled by the picker.
  * @template A - The type representing the default action name.
  */
-export type DefineItemPickerFromSource = <T extends Detail, A extends string>(
+export type DefinePickerFromSource = <T extends Detail, A extends string>(
   name: string,
   source: Derivable<Source<T>>,
   params: {
@@ -74,7 +74,7 @@ export type DefineItemPickerFromSource = <T extends Detail, A extends string>(
  * @template T - The type of items handled by the picker.
  * @template A - The type representing the default action name.
  */
-export type DefineItemPickerFromCurator = <T extends Detail, A extends string>(
+export type DefinePickerFromCurator = <T extends Detail, A extends string>(
   name: string,
   curator: Derivable<Curator<T>>,
   params: {
@@ -91,29 +91,17 @@ export type DefineItemPickerFromCurator = <T extends Detail, A extends string>(
 /**
  * Builds a function to define an item picker based on a source and matchers with the given map.
  *
- * @param itemPickerParamsMap - The map to store the defined item pickers.
+ * @param pickerParamsMap - The map to store the defined item pickers.
  * @returns The function to define an item picker based on a source and matchers.
  */
-export function buildDefineItemPickerFromSource(
-  itemPickerParamsMap: Map<string, ItemPickerParams<Detail>>,
-): DefineItemPickerFromSource {
-  function validatePickerName(name: string): void {
-    if (itemPickerParamsMap.has(name)) {
-      throw new Error(`Item picker "${name}" is already defined.`);
-    }
-    if (name.startsWith("@")) {
-      throw new Error(`Name "${name}" must not start with "@".`);
-    }
-  }
+export function buildDefinePickerFromSource(
+  pickerParamsMap: Map<string, PickerParams<Detail>>,
+): DefinePickerFromSource {
   return (
     name,
     source,
     params,
   ) => {
-    if (itemPickerParamsMap.has(name)) {
-      throw new Error(`Item picker "${name}" is already defined.`);
-    }
-    validatePickerName(name);
     const derivedParams = omitUndefinedAttributes({
       actions: deriveMap(params.actions) as Actions,
       defaultAction: params.defaultAction,
@@ -126,38 +114,28 @@ export function buildDefineItemPickerFromSource(
       coordinator: derive(params.coordinator),
       theme: derive(params.theme),
     });
-    validateActions(derivedParams.actions);
-    itemPickerParamsMap.set(name, {
+    pickerParamsMap.set(name, {
       ...derivedParams,
       name,
       source: derive(source),
-    } as ItemPickerParams<Detail, string>);
+    } as PickerParams<Detail, string>);
   };
 }
 
 /**
  * Builds a function to define an item picker based on a curator with the given map.
  *
- * @param itemPickerParamsMap - The map to store the defined item pickers.
+ * @param pickerParamsMap - The map to store the defined item pickers.
  * @returns The function to define an item picker based on a curator.
  */
-export function buildDefineItemPickerFromCurator(
-  itemPickerParamsMap: Map<string, ItemPickerParams<Detail>>,
-): DefineItemPickerFromCurator {
-  function validatePickerName(name: string): void {
-    if (itemPickerParamsMap.has(name)) {
-      throw new Error(`Item picker "${name}" is already defined.`);
-    }
-    if (name.startsWith("@")) {
-      throw new Error(`Name "${name}" must not start with "@".`);
-    }
-  }
+export function buildDefinePickerFromCurator(
+  pickerParamsMap: Map<string, PickerParams<Detail>>,
+): DefinePickerFromCurator {
   return (
     name,
     curator,
     params,
   ) => {
-    validatePickerName(name);
     const source = new CuratorSourceMatcher(derive(curator));
     const derivedParams = omitUndefinedAttributes({
       actions: deriveMap(params.actions) as Actions,
@@ -170,8 +148,7 @@ export function buildDefineItemPickerFromCurator(
       coordinator: derive(params.coordinator),
       theme: derive(params.theme),
     });
-    validateActions(derivedParams.actions);
-    itemPickerParamsMap.set(name, {
+    pickerParamsMap.set(name, {
       ...derivedParams,
       name,
       source,
@@ -231,11 +208,3 @@ function omitUndefinedAttributes<
     Object.entries(map).filter(([, v]) => v !== undefined),
   ) as R;
 }
-
-function validateActions(actions: Record<string, Action>): void {
-  Object.entries(actions).forEach(([name, _action]) => {
-    if (name.startsWith("@")) {
-      throw new Error(`Action name "${name}" must not start with "@".`);
-    }
-  });
-}

item_picker.ts renamed to picker.ts

@@ -0,0 +1,41 @@
+import type { Coordinator } from "@vim-fall/core/coordinator";
+import type { Theme } from "@vim-fall/core/theme";
+
+import { type Derivable, derive } from "./derivable.ts";
+
+/**
+ * Setting.
+ */
+export type Setting = {
+  coordinator: Coordinator;
+  theme: Theme;
+};
+
+/**
+ * Refines the setting, allowing customization of global coordinator and theme.
+ */
+export type RefineSetting = (
+  params: Readonly<{
+    coordinator?: Derivable<Coordinator>;
+    theme?: Derivable<Theme>;
+  }>,
+) => void;
+
+/**
+ * Builds a function that refines the setting based on the provided parameters.
+ *
+ * @param setting The setting to refine.
+ * @returns The function that refines the setting.
+ */
+export function buildRefineSetting(
+  setting: Setting,
+): RefineSetting {
+  return (params) => {
+    if (params.theme) {
+      setting.theme = derive(params.theme);
+    }
+    if (params.coordinator) {
+      setting.coordinator = derive(params.coordinator);
+    }
+  };
+}