Skip to content

Commit

Permalink
changing word -> down
Browse files Browse the repository at this point in the history
  • Loading branch information
clpi committed Dec 15, 2024
1 parent 7653a6c commit f0cbf8a
Show file tree
Hide file tree
Showing 336 changed files with 3,405 additions and 1,906 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
**ext/ext
**.ropeproject/
**notes/
**note/
/luarocks
/lua_modules
/.luarocks
Expand Down
12 changes: 6 additions & 6 deletions Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@
# nvimf="--headless -u ./test/config/minit.lua --noplugin -c ''"

w:
./scripts/bin/word
./scripts/bin/down
wl:
./scripts/bin/wordls
./scripts/bin/downls

lnw:
ln -s ./scripts/bin/word ./word
ln -s ./scripts/bin/down ./down
lnwl:
ln -s ./scripts/bin/word-lsp ./word-lsp
ln -s ./scripts/bin/down-lsp ./down-lsp

iw: lnw
cp -r ./scripts/bin/word ${HOME}/.local/bin/
cp -r ./scripts/bin/down ${HOME}/.local/bin/
iwl: lnwl
cp -r ./scripts/bin/word-lsp ${HOME}/.local/bin/
cp -r ./scripts/bin/down-lsp ${HOME}/.local/bin/

i: iw iwl

Expand Down
48 changes: 24 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# word.lua - the _familiar_, organized future for neovim
# down.lua - the _familiar_, organized future for neovim

<a href="https://neovim.io"> ![Neovim](https://img.shields.io/badge/Neovim%200.10+-brightgreen?style=for-the-badge) </a>
<a href="/LICENSE"> ![License](https://img.shields.io/badge/license-GPL%20v3-brightgreen?style=for-the-badge)</a>
![LuaRocks](https://img.shields.io/luarocks/v/clpi/word.lua)
![LuaRocks](https://img.shields.io/luarocks/v/clpi/down.lua)

---

> [!Important]
>
> `word.lua` is **BEGINNING DEVELOPMENT**
> `down.lua` is **BEGINNING DEVELOPMENT**
<!--toc:start-->

- [word - the _familiar_, organized future for neovim](#word-the-familiar-organized-future-for-neovim)
- [down - the _familiar_, organized future for neovim](#down-the-familiar-organized-future-for-neovim)
- [Introduction](#introduction)
- [Requirements](#requirements)
- [Quickstart](#quickstart)
Expand All @@ -25,9 +25,9 @@

## Introduction

- `word.lua` is a [neovim](#) plugin intended to bring the extensibility of [org-mode](#) or [neorg](github.com/nvim-neorg/neorg) with the **comfort** of [markdown](#).
- `down.lua` is a [neovim](#) plugin intended to bring the extensibility of [org-mode](#) or [neorg](github.com/nvim-neorg/neorg) with the **comfort** of [markdown](#).

- In its [current state](#), `word.lua` is in the beginning stages of development, currently functionining as a markdown-based version of [neorg](#), with many planned features to come
- In its [current state](#), `down.lua` is in the beginning stages of development, currently functionining as a markdown-based version of [neorg](#), with many planned features to come

- we want to be able to take notes like developers, without leaving behind all the ecosystem benefits of markdown.

Expand All @@ -37,7 +37,7 @@

> [!Note]
>
> `word.lua` must have at least [neovim 0.10+](https://neovim.io)
> `down.lua` must have at least [neovim 0.10+](https://neovim.io)
## Quickstart

Expand All @@ -48,18 +48,18 @@

```lua
{
"clpi/word.lua",
"clpi/down.lua",
lazy = false,
version = "*"
branch = "master",
config = function(_, opts)
require("word").setup({
require("down").setup({
mod = {
config = {},
workspace = {
config = {
workspaces = {
default = "~/word",
default = "~/down",
notes = "~/notes"
}
}
Expand Down Expand Up @@ -96,9 +96,9 @@ Plug "nvim-treesitter/treesitter.nvim"
Plug "nvim-lua/plenary.nvim",
Plug "MunifTanjim/nui.nvim",
Plug "pysan3/pathlib.nvim"
Plug "clpi/word.lua", {
Plug "clpi/down.lua", {
\ "branch" : "master",
\ "do" : ':lua require([[word]]).setup({
\ "do" : ':lua require([[down]]).setup({
\ mod = {
\ config = {},
\ workspace = {
Expand Down Expand Up @@ -130,7 +130,7 @@ Plugin "pysan3/pathlib.nvim"
Plugin 'nvim-telescope/telescope.nvim'
Plugin "nvim-lua/plenary.nvim",
Plugin "MunifTanjim/nui.nvim",
Plugin 'clpi/word.lua'
Plugin 'clpi/down.lua'
```

</details>
Expand All @@ -152,7 +152,7 @@ call dein#add("nvim-lua/plenary.nvim")
call dein#add("MunifTanjim/nui.nvim")
call dein#add('pysan3/pathlib.nvim')
call dein#add('nvim-telescope/telescope.nvim')
call dein#add('clpi/word.lua')
call dein#add('clpi/down.lua')
```

</details>
Expand All @@ -171,7 +171,7 @@ call dein#add('clpi/word.lua')
```lua
use {
"clp/word.lua",
"clp/down.lua",
requires = {
"nvim-telescope/telescope.nvim",
"nvim-lua/plenary.nvim",
Expand All @@ -181,7 +181,7 @@ use {
tag = "*",
branch = 'master',
config = function()
require("word").setup({
require("down").setup({
mod = {
config = {},
workspace = {
Expand Down Expand Up @@ -213,7 +213,7 @@ use {
```lua
{
"clp/word.lua",
"clp/down.lua",
}
```

Expand Down Expand Up @@ -243,7 +243,7 @@ use {
-- Setup the initial config
-- with workspace 'home' at ~/home
-- and make it default
require("word").setup({ ---@type word.mod.Config
require("down").setup({ ---@type down.mod.Config
mod = {
config = {},
workspace = {
Expand Down Expand Up @@ -287,25 +287,25 @@ require("word").setup({ ---@type word.mod.Config
## Credits

`word.lua` is a project by [clpi](github.com/clpi) and is licensed under the [MIT](./LICENSE) license. For information about **contributing**, please consult the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
`down.lua` is a project by [clpi](github.com/clpi) and is licensed under the [MIT](./LICENSE) license. For information about **contributing**, please consult the [CONTRIBUTING.md](./CONTRIBUTING.md) file.

special thanks goes to [nvim-neorg/neorg](https://github.com/nvim-neorg/neorg) for providing the inspiration and basis of this project.

---

thank you and keep updated!

- [The `word.lua` book](https://word.cli.st)
- [The `word.lua` wiki](https://github.com/clpi/word.lua/wiki)
- [`word.lua` on luarocks](https://luarocks.org/inits/clpi/word.lua)
- [`word.lua` on dotfyle](https://dotfyle.com/plugins/clpi/word.lua)
- [The `down.lua` book](https://down.cli.st)
- [The `down.lua` wiki](https://github.com/clpi/down.lua/wiki)
- [`down.lua` on luarocks](https://luarocks.org/inits/clpi/down.lua)
- [`down.lua` on dotfyle](https://dotfyle.com/plugins/clpi/down.lua)

<!-- <div align="center"> -->
<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- </div> -->

```lua
---@type word.mod.Config
---@type down.mod.Config

```
10 changes: 5 additions & 5 deletions TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

- [ ] Fix the calendar UI element when pulled up with notes or "calendar" command
- [ ] Fix and conform types across the board
- [ ] Remove `wordinc` and `worddec` commands
- [ ] Make word autocmd markdown load only when in recognized workspace
- [ ] Make the following commands only load on word workspace markdown autocmd:
- [ ] Remove `downinc` and `downdec` commands
- [ ] Make down autocmd markdown load only when in recognized workspace
- [ ] Make the following commands only load on down workspace markdown autocmd:
- [ ] `link`
- [ ] `sync`
- [ ] `rename`
Expand All @@ -16,7 +16,7 @@
- [ ] `tag`
- [ ] Consider not having `config` be a quasi-necessary default loader for all other builtin modules, instead load them by default and allow some way for this behavior to not be invoked.
- [ ] (easy) Change schema of modules so config is under module's schema itself,
instead of having it under `[module].config` - [ ] If necessary, then make inter-module config accessibility under `[module].config` instead of `module.config.public`
instead of having it under `[module].config` - [ ] If necessary, then make inter-module config accessibility under `[module].config` instead of `module.config`
- [ ] (easy) Change config to be under
- [ ] (easy) Consider removing `[module].load` `[module].maps` `[module].opts` `[module].cmds` and merge all into `[module].setup` due to redundancy
- [ ] (easy) Remove all lingering instances of `[module].data.data` and merge into `[module].data`
Expand Down Expand Up @@ -181,4 +181,4 @@ require("nvim-treesitter.configs").setup({

- [ ] `...`
- [ ] Scope indentation?
- [ ] `.wd` [word] syntax support/hl
- [ ] `.wd` [down] syntax support/hl
8 changes: 4 additions & 4 deletions book/book.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[book]
title = "The word.lua book"
description = "Goes over the word.lua extension for neovim"
title = "The down.lua book"
description = "Goes over the down.lua extension for neovim"
authors = ["Chris Pecunies"]
language = "en"
multilingual = false
Expand All @@ -27,8 +27,8 @@ copy-fonts = true
# additional-js = "book.js"
smart-punctuation = true
no-section-label = false
git-repository-url = 'github.com/clpi/word.lua'
edit-url-template = "https://github.com/clpi/word.lua/edit/master/book/{path}"
git-repository-url = 'github.com/clpi/down.lua'
edit-url-template = "https://github.com/clpi/down.lua/edit/master/book/{path}"
git-repository-icon = "fa-github"
input-404 = "404.md"

Expand Down
6 changes: 3 additions & 3 deletions book/lua/module/example.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
local word = require("word")
local down = require("down")

local mod, config, util = word.mod, word.config, word.util
local mod, config, util = down.mod, down.config, down.util

local M = mod.create("user.example", {
--- @brief submodules
Expand Down Expand Up @@ -30,7 +30,7 @@ M.setup = function()
end

---@class (exact) example.Config
M.config.public = {
M.config = {
--- @brief module config
--- the public facing config for this module that can be
--- set by the user from its default values here.
Expand Down
2 changes: 1 addition & 1 deletion book/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Summary

Welcome -- to the `word.lua` book. I hope this helps!
Welcome -- to the `down.lua` book. I hope this helps!

- [Intro](./intro.md)
- [Philosophy](./philosophy.md)
Expand Down
2 changes: 1 addition & 1 deletion book/src/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# `word.lua` Book Index
# `down.lua` Book Index

## About

Expand Down
12 changes: 6 additions & 6 deletions book/src/intro.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# word.lua
# down.lua

## Intro

`word.lua` is a simple ORM for Lua. It is designed to be simple to use and
`down.lua` is a simple ORM for Lua. It is designed to be simple to use and

## Is it for you?

Expand All @@ -14,7 +14,7 @@

## Other resources

- [GitHub](https://github.com/clpi/word.lua)
- [Sourcehut](https://git.sr.ht/~clpi/word.lua)
- [Luarocks](https://luarocks.org/modules/clpi/word.lua)
- [Dotfyle](https://dotfyle.com/plugins/clpi/word.lua)
- [GitHub](https://github.com/clpi/down.lua)
- [Sourcehut](https://git.sr.ht/~clpi/down.lua)
- [Luarocks](https://luarocks.org/modules/clpi/down.lua)
- [Dotfyle](https://dotfyle.com/plugins/clpi/down.lua)
6 changes: 3 additions & 3 deletions book/src/modules/example.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
## Example custom module

```lua
local word = require("word")
local down = require("down")

local mod, config, util = word.mod, word.config, word.util
local mod, config, util = down.mod, down.config, down.util

local M = mod.create("user.example", {
--- @brief submodules
Expand Down Expand Up @@ -33,7 +33,7 @@ M.setup = function()
end

---@class (exact) example.Config
M.config.public = {
M.config = {
--- @brief module config
--- the public facing config for this module that can be
--- set by the user from its default values here.
Expand Down
6 changes: 3 additions & 3 deletions book/src/modules/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
## Example custom module

```lua
local word = require("word")
local down = require("down")

local mod, config, util = word.mod, word.config, word.util
local mod, config, util = down.mod, down.config, down.util

local M = mod.create("user.example", {
--- @brief submodules
Expand Down Expand Up @@ -35,7 +35,7 @@ M.setup = function()
end

---@class (exact) example.Config
M.config.public = {
M.config = {
--- @brief module config
--- the public facing config for this module that can be
--- set by the user from its default values here.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
10 changes: 5 additions & 5 deletions word-scm-1.rockspec → down-scm-1.rockspec
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ rockspec_format = "3.0"
version = MODREV .. SPECREV
branch = "master"
tag = "v0.1.1-alpha"
package_name = "word.lua"
package_name = "down.lua"
github_url = "https://github.com/"
.. maintainer
.. "/"
Expand All @@ -49,7 +49,7 @@ github_git_url = "git://github.com/"
.. ".git"
maintainer_url = "https://github.com/" .. maintainer_user
maintainer_email = "clp@clp.is"
homepage = "https://word.cli.st"
homepage = "https://down.cli.st"
maintainer = "Chris Pecunies <" .. maintainer_email .. ">"

source = {
Expand Down Expand Up @@ -111,9 +111,9 @@ build = {
modules = {},
install = {
bin = {
wordls = "scripts/bin/wordls",
word_lsp = "scripts/bin/word-lsp",
word = "scripts/bin/word",
downls = "scripts/bin/downls",
down_lsp = "scripts/bin/down-lsp",
down = "scripts/bin/down",
},
},
copy_directories = {
Expand Down
Loading

0 comments on commit f0cbf8a

Please sign in to comment.