Skip to content

Commit 71a559f

Browse files
committed
Add project skeleton
1 parent 83b854e commit 71a559f

File tree

9 files changed

+138
-0
lines changed

9 files changed

+138
-0
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.tool-versions
2+
.coverage
3+
.deps
4+
deno.lock

.gitmessage

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
2+
3+
# Guide (v1.0)
4+
#
5+
# 👍 :+1: Apply changes.
6+
#
7+
# 🌿 :herb: Add or update things for tests.
8+
# ☕ :coffee: Add or update things for developments.
9+
# 📦 :package: Add or update dependencies.
10+
# 📝 :memo: Add or update documentations.
11+
#
12+
# 🐛 :bug: Bugfixes.
13+
# 💋 :kiss: Critical hotfixes.
14+
# 🚿 :shower: Remove features, codes, or files.
15+
#
16+
# 🚀 :rocket: Improve performance.
17+
# 💪 :muscle: Refactor codes.
18+
# 💥 :boom: Breaking changes.
19+
# 💩 :poop: Bad codes needs to be improved.
20+
#
21+
# How to use:
22+
# git config commit.template .gitmessage
23+
#
24+
# Reference:
25+
# https://github.com/lambdalisue/emojiprefix

LICENSE

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Copyright 2024 Alisue <[email protected]>
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is
8+
furnished to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19+
SOFTWARE.
20+

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# 🍂 fall.vim
2+
3+
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
4+
[![vim help](https://img.shields.io/badge/vim-%3Ah%20fall-orange.svg)](doc/fall.txt)
5+
6+
Fall (_fall.vim_) is an abbreviation for "Filter All," another fuzzy finder
7+
designed for Vim and Neovim and implemented in [Denops].
8+
9+
**Alpha version. Please note that any changes, including those that may be
10+
backward incompatible, will be implemented without prior announcements.**
11+
12+
[Denops]: https://github.com/vim-denops/denops.vim
13+
14+
## Requirements
15+
16+
Users must install [Deno].
17+
18+
[Deno]: https://deno.land
19+
20+
## Installation
21+
22+
To install [Denops] and this plugin using your preferred plugin manager, such as
23+
[vim-plug], add the following lines to your Vim configuration:
24+
25+
```vim
26+
Plug 'vim-denops/denops.vim'
27+
Plug 'lambdalisue/fall.vim'
28+
```
29+
30+
[vim-plug]: https://github.com/junegunn/vim-plug
31+
32+
## Similar Projects
33+
34+
- [ddu.vim](https://github.com/Shougo/ddu.vim)<br>A highly customizable and
35+
extensible fuzzy finder for Vim/Neovim written in Denops.
36+
- [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)<br>The de
37+
facto standard fuzzy finder for Neovim.
38+
- [ctrlp.vim](https://github.com/ctrlpvim/ctrlp.vim)<br>A classic and famous
39+
fuzzy finder for Vim.
40+
41+
## License
42+
43+
The code in this repository follows the MIT license, as detailed in
44+
[LICENSE](./LICENSE). Contributors must agree that any modifications submitted
45+
to this repository also adhere to the license.

deno.jsonc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"lock": false,
3+
"exclude": ["docs/**", ".deps/**", ".coverage/**"],
4+
"tasks": {
5+
"test": "deno test -A --parallel --shuffle --doc",
6+
"test:coverage": "deno task test --coverage=.coverage",
7+
"check": "deno check ./**/*.ts",
8+
"coverage": "deno coverage .coverage --exclude=testdata/",
9+
"upgrade": "deno run -q -A https://deno.land/x/[email protected]/cli.ts ./**/*.ts",
10+
"upgrade:commit": "deno task -q upgrade --commit --prefix :package: --pre-commit=fmt"
11+
}
12+
}

denops/fall/main.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
import type { Denops } from "https://deno.land/x/[email protected]/mod.ts";
2+
3+
export function main(denops: Denops): void {
4+
}

doc/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/tags

doc/fall.txt

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
*fall.txt* Filter All
2+
3+
Author: Alisue <[email protected]>
4+
License: MIT License (See LICENSE)
5+
6+
7+
=============================================================================
8+
CONTENTS *fall-contents*
9+
10+
INTRODUCTION |fall-introduction|
11+
12+
13+
=============================================================================
14+
INTRODUCTION *fall-introduction*
15+
16+
Fall (*fall.vim*) is a yet another fuzzy finder for Vim/Neovim written
17+
in Denops.
18+
19+
Denops: https://github.com/vim-denops/denops.vim
20+
21+
22+
=============================================================================
23+
vim:tw=78:fo=tcq2mM:ts=8:ft=help:norl

plugin/fall.vim

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
if exists('g:loaded_fall')
2+
finish
3+
endif
4+
let g:loaded_fall = 1

0 commit comments

Comments
 (0)