feat: Copied core part from vim-fall

Author: lambdalisue

.github/workflows/jsr.yml

@@ -0,0 +1,27 @@
+name: jsr
+
+env:
+  DENO_VERSION: 1.x
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: denoland/setup-deno@v1
+        with:
+          deno-version: ${{ env.DENO_VERSION }}
+      - name: Publish
+        run: |
+          deno run -A jsr:@david/publish-on-tag@0.1.4

.github/workflows/test.yml

@@ -0,0 +1,81 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  check:
+    strategy:
+      matrix:
+        runner:
+          - ubuntu-latest
+        deno_version:
+          - "1.x"
+          - "2.x"
+    runs-on: ${{ matrix.runner }}
+    steps:
+      - run: git config --global core.autocrlf false
+        if: runner.os == 'Windows'
+      - uses: actions/checkout@v4
+      - uses: denoland/setup-deno@v1.1.4
+        with:
+          deno-version: "${{ matrix.deno_version }}"
+      - uses: actions/cache@v4
+        with:
+          key: deno-${{ hashFiles('**/*') }}
+          restore-keys: deno-
+          path: |
+            /home/runner/.cache/deno/deps/https/deno.land
+      - name: Lint check
+        run: deno lint
+      - name: Format check
+        run: deno fmt --check
+      - name: Type check
+        run: deno task check
+
+  test:
+    strategy:
+      matrix:
+        runner:
+          - windows-latest
+          - macos-latest
+          - ubuntu-latest
+        deno_version:
+          - "1.x"
+          - "2.x"
+    runs-on: ${{ matrix.runner }}
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: denoland/setup-deno@v1.1.4
+        with:
+          deno-version: "${{ matrix.deno_version }}"
+
+      - name: Test
+        run: deno task test:coverage
+        timeout-minutes: 15
+
+      - run: |
+          deno task coverage --lcov > coverage.lcov
+
+      - uses: codecov/codecov-action@v4
+        with:
+          os: ${{ runner.os }}
+          files: ./coverage.lcov
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  jsr-publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: denoland/setup-deno@v1
+        with:
+          deno-version: ${{ env.DENO_VERSION }}
+      - name: Publish (dry-run)
+        run: |
+          deno publish --dry-run

.gitignore

@@ -0,0 +1,3 @@
+.tool-versions
+.coverage
+deno.lock

.gitmessage

@@ -0,0 +1,21 @@
+
+# **Conventional Commits**
+#
+# <type>[optional scope]: <description>
+#
+# feat:      feature (minor)
+# deps:      dependencies (minor/patch)
+# fix:       bug fix (patch)
+# refactor:  refactoring code
+# test:      test fix; no code change
+# docs:      documentation fix; no code change
+# style:     formatting, missing semi colons, etc; no code change
+# chore:     updating build tasks, package manager configs, etc; no code change
+#
+# **Install**
+#
+#   git config commit.template .gitmessage
+#
+# **Reference**
+#
+# - https://www.conventionalcommits.org/en/v1.0.0/

LICENSE

@@ -0,0 +1,20 @@
+Copyright 2024 Alisue <lambdalisue@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

README.md

@@ -0,0 +1,16 @@
+# 🍂 fall-core
+
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+Core types for [Fall](https://github.com/vim-fall/fall), a Vim/Neovim Fuzzy
+Finder plugin powered by [Denops](https://github.com/vim-denops/denops.vim).
+
+> [!WARNING]
+>
+> This module is for internal use only. It is not intended to be used by others.
+
+## License
+
+The code in this repository follows the MIT license, as detailed in
+[LICENSE](./LICENSE). Contributors must agree that any modifications submitted
+to this repository also adhere to the license.

_typeutil.ts

@@ -0,0 +1 @@
+export type Promish<T> = T | Promise<T>;

action.ts

@@ -0,0 +1,35 @@
+import type { Denops } from "@denops/std";
+
+import type { Promish } from "./_typeutil.ts";
+import type { IdItem } from "./item.ts";
+
+export type InvokeParams<T> = {
+  /**
+   * The item under the cursor.
+   */
+  readonly item?: IdItem<T> | undefined;
+  /**
+   * The selected items.
+   */
+  readonly selectedItems?: readonly IdItem<T>[] | undefined;
+  /**
+   * The filtered items.
+   */
+  readonly filteredItems: readonly IdItem<T>[];
+};
+
+export type Action<T> = {
+  /**
+   * Invoke the action.
+   *
+   * @param denops The Denops instance.
+   * @param params The parameters for invoking the action.
+   * @param options The options.
+   * @returns If the picker should not be closed, return `true`.
+   */
+  invoke(
+    denops: Denops,
+    params: InvokeParams<T>,
+    options: { signal?: AbortSignal },
+  ): Promish<void | true>;
+};

coordinator.ts

@@ -0,0 +1,35 @@
+import type { Border, Theme } from "./theme.ts";
+
+export type Size = {
+  width: number;
+  height: number;
+};
+
+export type Dimension = Size & {
+  col: number;
+  row: number;
+};
+
+export type Style = {
+  input: Border;
+  list: Border;
+  preview?: Border;
+};
+
+export type Layout = {
+  input: Dimension;
+  list: Dimension;
+  preview?: Dimension;
+};
+
+export type Coordinator = {
+  /**
+   * Style of the picker components.
+   */
+  style(theme: Theme): Style;
+
+  /**
+   * Layout of the picker components.
+   */
+  layout(screen: Size): Layout;
+};

curator.ts

@@ -0,0 +1,30 @@
+import type { Denops } from "@denops/std";
+
+import type { IdItem } from "./item.ts";
+
+export type CurateParams = {
+  /**
+   * The arguments passed to the picker.
+   */
+  readonly args: readonly string[];
+  /**
+   * User input query.
+   */
+  readonly query: string;
+};
+
+export type Curator<T> = {
+  /**
+   * Curate items.
+   *
+   * @param denops The Denops instance.
+   * @param params The parameters to curate items.
+   * @param options The options.
+   * @param options.signal The signal to cancel the operation.
+   */
+  curate(
+    denops: Denops,
+    params: CurateParams,
+    options: { signal?: AbortSignal },
+  ): AsyncIterableIterator<IdItem<T>>;
+};