Refactor. Maybe something from that will be helpful #42

AgatZan · 2024-09-02T00:14:05Z

refactor(utils): remove useless Slash(), make const instead ( also maybe just global os_sep )
refactor(utils): remove initDir.
Because users need to read the README and think about the path, if they ignore it, their problem. It's better than notify every <cmd>Sratch<cr> that you are using an existing directory. Or like case cash to somewhere and check the hash. ¯\(ツ)/¯
fix(utils): get width/height using vim.api.win instead deprecated option or hacky option_value
fix(windows.utils): requireDir when create uuidgen doesnt exist in windows by default, so instead just os.time. Timestamp unique ¯\(ツ)/¯
feat(telescope): add local keys
feat(config): MANUAL_INPUT now user customizable
perf(utils): instead using fn use vim.uv. It's necessary to profile, but something tells me that recursion is not even fast.
chore: consistent everywhere return M instead at one place return {...funcs} at another place return M.
chore(type): fix Scratch.WindowCMD at config,
feat(api): Refactor all API. 1 call function inline, because why do they exist?(except for rather bulky ones, like utils.scandir) Move something from one file to another.
- feat(config): instead of creating bicycles using win_conf from nvim_win_open
- For example all open_*_scratch now findBy* and placed in default_finder.
- Now users can specify they own input/selector examples in default_providers.lua. I think it's "shoot a cannon at sparrows", but better than hardcoding.

…ains

AgatZan · 2024-09-02T00:19:06Z

lua/scratch/utils.lua

    style = "minimal",
    border = "single",
-    title = "",
+    title = title,


i think it was forgotten

…config @see: nvim_win_open() {config}

AgatZan · 2024-09-03T23:06:36Z

lua/scratch/actor.lua

+function M:scratchByName(filename, win_conf, content, local_keys, cursor)
+  local abs_path = self.base_dir .. filename
+  local fto = {}
+  for i in filename:gmatch("([^%.]+)") do


string.split by separator (in this place it ".")

AgatZan · 2024-09-03T23:08:43Z

lua/scratch/actor.lua

+---@return string[]
+function M:get_all_filetypes()
+  local combined_filetypes = {}
+  local cash = {}


Instead of sneaking through all combined_filetypes each time we append an item, just caching with ~O(1)

AgatZan · 2024-09-03T23:13:18Z

lua/scratch/actor.lua

+  coroutine.wrap(function()
+    local ft = selector_filetype(filetypes)
+    self:scratchByType(ft, win_conf, content, local_keys, cursor)
+  end)()


inspired by https://github.com/mfussenegger/nvim-dap/blob/66d33b7585b42b7eac20559f1551524287ded353/lua/dap/ui.lua#L55

For situations like vim.ui or something else, I don't know a better way.

AgatZan · 2024-09-03T23:17:16Z

lua/scratch/actor.lua

+end
+
+-- ---@param opts Scratch.LocalKey[]
+-- function M:scratchOpen(opts)


I think it's useless to set up some built-ins this way. If a user wants to use one of them, he must call one of them. And specify these way it's to sign to update this every time u add. In a good way, it would be nice to just give a draft of what to look like without passing unnecessary openers.

AgatZan · 2024-09-03T23:18:46Z

lua/scratch/default_finder.lua

+  -- table.sort(files, function(a, b)
+  -- 	return vim.fn.getftime(scratch_file_dir .. vim.g.os_sep .. a)
+  -- 		> vim.fn.getftime(scratch_file_dir .. vim.g.os_sep .. b)
+  -- end)


The user can want to specify their own comparator or even not sort.

AgatZan · 2024-09-03T23:19:39Z

lua/scratch/default_finder.lua

+end
+
+---@param base_dir string path to scandir
+function M.findByFzf(base_dir)


I don't use it. So I don't know how it works.

AgatZan · 2024-09-03T23:20:41Z

lua/scratch/default_finder.lua

@@ -0,0 +1,94 @@
+local M = {}


All of this is unnecessary, so it can be commented and put in the doc.

AgatZan · 2024-09-03T23:21:11Z

lua/scratch/default_providers.lua

@@ -0,0 +1,49 @@
+local utils = require("scratch.utils")


same like default_finder

AgatZan · 2024-09-03T23:22:43Z

lua/scratch/init.lua

@@ -0,0 +1,48 @@
+local M = {}


actor.lua can be placed here without any problems.

AgatZan · 2024-09-03T23:24:23Z

lua/scratch/telescope_actions.lua

@@ -0,0 +1,39 @@
+local M = {}


i don't change this it's. My fault and git skill issue

AgatZan · 2024-09-03T23:26:08Z

lua/scratch/telescope_actions.lua

+    end
+    local config_data = config.getConfig()
+    local scratch_file_dir = config_data.base_dir
+    local p = Path:new({ scratch_file_dir, file_name, sep = vim.g.os_sep })


I think `vim.g.os_sep' is the best way of doing that. I don't know why it is not std const. It can be found in so many ways, but why do even all people need to create a bicycle? Thinking out loud.

AgatZan · 2024-09-04T00:43:20Z

lua/scratch/actor.lua

@@ -30,7 +30,7 @@ end
 ---@param win_conf? vim.api.keyset.win_config
 ---@param content? string[]
 function M:scratchByType(ft, win_conf, content, local_keys, cursor)
-  local abs_path = self.base_dir .. utils.gen_filename(ft)
+  local abs_path = self.base_dir .. utils.get_abs_path(ft)


Also can be replaced by user customizable version

…etails.filename_generator

AgatZan · 2024-09-06T22:28:36Z

lua/scratch/utils.lua

-  vim.api.nvim_buf_set_name(buf, abs_path)
+  --- BUG: if buffer exist throw error, so need find existed buffer with that name
+  --- TODO: REFACTOR THAT
+  local suc = pcall(vim.api.nvim_buf_set_name, buf, abs_path)


I don't really know if it needs to be fixed or not. Because this function is called when creating a new file.

This reverts commit c7f6492.

LintaoAmons · 2024-09-07T08:55:16Z

plugin/scratch_plugin.lua

-vim.api.nvim_create_user_command("ScratchOpen", scratch_api.openScratch, {})
-vim.api.nvim_create_user_command("ScratchOpenFzf", scratch_api.fzfScratch, {})
-vim.api.nvim_create_user_command("ScratchWithName", scratch_api.scratchWithName, {})
+vim.api.nvim_create_user_command("ScratchOpen", function()


ScratchOpen is supposed to use user's configured picker to find and open scratchFiles(file_picker = "fzflua",, they can choose from telescope， fzf-lua and the default vim.ui).
But after refactor, this configuration is not working as how it works before.

the point here is that in this case, if scratchOpen is used, it will be exclusively with pre-installed ones. It will be easy to make file_picker type like "fzf"|"telescope"|"native"|fun(scratch_file_dir:string)
And then make

function M:scratchOpen() local typ = type(self.file_picker) if typ == "string" require("scratch.default_finder." .. self.file_picker)(self.scratch_file_dir) elseif typ == "function" self.file_picker(self.scratch_file_dir) else vim.notify("Incorrect type") end end

And if they don't suit? I'll have to write it myself and they will do as I describe below. The same functionality can be implemented. By making file_picker a function, but in this case the question is whether it is necessary in the config.

For me, you can just put them in a separate file, ala default_finders.lua or something else. You call with only 1 parameter scratch_file_dir you anyway get access to config, so i don't really know why not just. require('default_finders').native(vim.g.scratch_config.scratch_file_dir)

LintaoAmons · 2024-09-07T08:58:46Z

plugin/scratch_plugin.lua

+vim.api.nvim_create_user_command("ScratchOpen", function()
+  require("scratch.default_finder").findByNative(vim.g.scratch_actor.scratch_file_dir)
+end, {})
+vim.api.nvim_create_user_command("ScratchOpenFzf", function()


ScratchOpenFzf should Grep the contents of scratch files and open a selected file.

Maybe I should rename it to ScratchOpenGrep

LintaoAmons · 2024-09-07T09:04:19Z

plugin/scratch_plugin.lua

+}
+local Actor = require("scratch.actor")
+---@type Scratch.Actor
+vim.g.scratch_actor = vim.g.scratch_actor or setmetatable(default_config, Actor)


I'm not very fond of set a metatable to a config, which to me, looks like turn a config into a object instance.

I would accept to init a actor with a config pass to it's constructor method.

LintaoAmons · 2024-09-07T09:05:48Z

plugin/scratch_plugin.lua

+  require("scratch.default_finder").findByTelescope(vim.g.scratch_actor.scratch_file_dir)
+end, {})
+vim.api.nvim_create_user_command("ScratchWithName", function()
+  vim.g.scratch_actor:scratchWithName()


I tried to call vim.g.scratch_actor:method_name() but seems all of those methods are nil.

Is it works on your side? or am I missing some extra config?

I don't know why but when u set metatable it don't insert method into 'vim.g`, so 2 way to fix.

Manually add all methods. vim.g.scratch_actor.method1 = Actor.method1...(or just vim.g.scratch_actor.methods=Actor). But I don't know how it will work.

Use require('scratch').setup() don't assign vim.g .

{ filetype_details = {}, filetypes = { "lua", "js", "py", "sh" }, localKeys = {}, manual_text = "MANUAL_INPUT", scratch_file_dir = "/Users/lintao/.cache/nvim-lintao\\scratch.nvim\\", win_config = { border = "single", col = 5, height = 26, relative = "editor", row = 2, style = "minimal", title = "", width = 107 } } Error executing Lua callback: ...ts/oatnil/release/scratch.nvim/plugin/scratch_plugin.lua:23: attempt to call method 'scratchWithFt' (a nil value) stack traceback: ...ts/oatnil/release/scratch.nvim/plugin/scratch_plugin.lua:23: in function <...ts/oatnil/release/scratch.nvi m/plugin/scratch_plugin.lua:19>

I'm still getting this error msg

I don't know. I have error when occurred .setup() because vim.tbl_deep_extend needed table, but or user_config or vim.g.scratch_config is nil. When i make :lua vim.print(vim.g.scratch_config) it exist. Something with plugin/, maybe?

Theoretically 0 mistakes, but...

Probably i don't know lua but, wat?

local foo = {} function foo.a() print("bbbb") end foo.key = "value" local mt = { __index = foo } local bar = setmetatable({ __index = foo }, foo) bar.key2 = "value2" print(bar.key) -- nil bar.a() -- errr

local foo = {} function foo.a() print("bbbb") end foo.key = "value" local mt = { __index = foo } local bar = setmetatable({}, mt) --- that changed bar.key2 = "value2" print(bar.key) -- value print(mt.key) -- but nil bar.a() -- bbbb

Maybe there is a reason for it. So the best way to fix it is. Actor:new()

By the way, i remade api.lua so all work can be done using it with vim.g.scratch_config

LintaoAmons · 2024-09-08T03:34:05Z

Hi @AgatZan

I appreciate the effort put into this task, but I would like to outline some requirements for the changes to be accepted:

Seamless User Experience: Since this is a significant refactor, it is essential that the changes do not disrupt the existing user experience. The final implementation should be fully compatible with what users are accustomed to.
Incremental Improvement: We don’t need to achieve the ideal final state in a single implementation. If any aspects of the refactor aren’t perfect at this stage, we can address them in future pull requests (PRs).
Plugin File Structure: It is crucial to maintain the existing plugin file structure. Specifically, we must keep plugin/scratch_plugin.lua, as I consider it the entry point of the plugin. Additionally, lua/scratch/init.lua should remain as the namespace, and lua/scratch/config/ will house configuration-related files.

… to `scratch/config.lua`

AgatZan · 2024-09-08T13:50:07Z

Seamless User Experience

Incremental Improvement

Plugin File Structure

As I wrote earlier, I do not understand exactly the above solution with a choice of pre-installed file_finders and window_cmd, so the main goal of PR was to fix it and refactor function structure that i found strange. I think I'm done with it.
I don't really understand it. I make changes and fix bugs that these changes make.
I look at nvim man and also don't understand what plugin stands for and when I append something to that with the lazy.nvim plug-manager in dev mode, it always throws an error.. Only one thing that is written about it is that it is for vim plugins. In the same piggy bank and the need to duplicate function names in init.lua maybe the same way is just move all API to api.lua. And I think the necessity of it is dictated by a non-consistent functional structure.

Anyway, I respect your decision and that's why I included "maybe something will be helpful" in the title of the PR

AgatZan added 10 commits September 1, 2024 23:30

refactor(utils): replace slash to constant, normalize module

b62aaf7

fix(utils): depracated api_nvim_get_option

4acb0bb

refactor(utils): using API instead get_option

5a7d13d

refactor(utils): comment lenght(#is default table len), simplify cont…

2f5d311

…ains

refactor(utils): scandir using luav

752d57e

refactor!: remove vim.g.scratch think about plugin/

98c7778

revert(global)

4d840d4

fix(utils): remove initDir

727d9a7

refactor(init): remove vim.g

facb472

fix(actor): self.manual_text

bb1264b

AgatZan commented Sep 2, 2024

View reviewed changes

lua/scratch/utils.lua Outdated

style = "minimal",

border = "single",

title = "",

title = title,

Copy link

Contributor Author

AgatZan Sep 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think it was forgotten

AgatZan added 5 commits September 3, 2024 03:09

fix(api): create using api

a38b49f

fix(type): compare with exist |\n feat(window): window_cmd -> window_…

1cd36eb

…config @see: nvim_win_open() {config}

refactor! + feat(input,selector)

ce833e3

clenup

8be1031

refactor!, feat(input, select)!

6ae4390

AgatZan commented Sep 3, 2024

View reviewed changes

lua/scratch/init.lua

@@ -0,0 +1,48 @@

local M = {}

Copy link

Contributor Author

AgatZan Sep 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actor.lua can be placed here without any problems.

AgatZan commented Sep 3, 2024

View reviewed changes

AgatZan added 2 commits September 4, 2024 03:37

fix(actor): miss self

acbf979

fix(actor): scratchByType miss filename generator name

c018570

AgatZan commented Sep 4, 2024

View reviewed changes

AgatZan added 3 commits September 6, 2024 22:51

revert(type): base_dir -> scratch_file_dir,\nfeat(config): filetype_d…

36f7652

…etails.filename_generator

chore(type): add missed type anotation in utils.gen_file_path

039765a

fix(utils): open exist file in buffer error

c7f6492

AgatZan commented Sep 6, 2024

View reviewed changes

Revert "fix(utils): open exist file in buffer error"

356e87f

This reverts commit c7f6492.

LintaoAmons reviewed Sep 7, 2024

View reviewed changes

AgatZan added 11 commits September 7, 2024 15:09

fix(actor): all scratch* func with now use opts.arg.

c773e9b

fix(cmd): correct with current api

8ed8acc

fix(utils): scandir \\(now \) before filename

f7da5be

refactor(config): now default cmd in setup

77e8b7f

refactor(api): now api-way actor-way

a0866dc

fix(config): error with vim.g

d7c94e4

fix(config): dumb way but work

bbd6741

refactor(config): remove duplicate in init.lua

7395b8b

refactor(config): remove plugin/

a3cfb44

refactor(config): remove log

5ac8b30

fix(type): Scratch.ActorConfig now optional

3b5045d

refactor(config): move default setup to plugin/ move default config…

45915ac

… to `scratch/config.lua`

AgatZan added 6 commits September 8, 2024 22:34

feat-draft(perf): compilation file-finder

05eab84

fix(utils):put_cursor not found fix

b21b0c6

fix!: only actor

fa67cfa

fix(config): return default win_cwd and file_picker option at config

bd27d16

fix(settup): getSelectedText() now work correct

36e8fe9

fix(init): get_selected text problem

bd21b33

AgatZan closed this Nov 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor. Maybe something from that will be helpful #42

Refactor. Maybe something from that will be helpful #42

AgatZan commented Sep 2, 2024 •

edited

Loading

AgatZan Sep 2, 2024

AgatZan Sep 3, 2024

AgatZan Sep 3, 2024 •

edited

Loading

AgatZan Sep 3, 2024

AgatZan Sep 3, 2024

AgatZan Sep 3, 2024

AgatZan Sep 3, 2024

AgatZan Sep 3, 2024

AgatZan Sep 3, 2024

AgatZan Sep 3, 2024

AgatZan Sep 3, 2024

AgatZan Sep 3, 2024 •

edited

Loading

AgatZan Sep 4, 2024

AgatZan Sep 6, 2024 •

edited

Loading

LintaoAmons Sep 7, 2024

AgatZan Sep 7, 2024 •

edited

Loading

LintaoAmons Sep 7, 2024

LintaoAmons Sep 7, 2024

LintaoAmons Sep 7, 2024

AgatZan Sep 7, 2024 •

edited

Loading

LintaoAmons Sep 7, 2024

AgatZan Sep 7, 2024 •

edited

Loading

AgatZan Sep 7, 2024 •

edited

Loading

LintaoAmons commented Sep 8, 2024

AgatZan commented Sep 8, 2024 •

edited

Loading

Refactor. Maybe something from that will be helpful #42

Refactor. Maybe something from that will be helpful #42

Conversation

AgatZan commented Sep 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AgatZan Sep 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AgatZan Sep 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AgatZan Sep 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AgatZan Sep 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AgatZan Sep 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AgatZan Sep 7, 2024 • edited Loading

Choose a reason for hiding this comment

AgatZan Sep 7, 2024 • edited Loading

Choose a reason for hiding this comment

LintaoAmons commented Sep 8, 2024

AgatZan commented Sep 8, 2024 • edited Loading

AgatZan commented Sep 2, 2024 •

edited

Loading

AgatZan Sep 3, 2024 •

edited

Loading

AgatZan Sep 3, 2024 •

edited

Loading

AgatZan Sep 6, 2024 •

edited

Loading

AgatZan Sep 7, 2024 •

edited

Loading

AgatZan Sep 7, 2024 •

edited

Loading

AgatZan Sep 7, 2024 •

edited

Loading

AgatZan Sep 7, 2024 •

edited

Loading

AgatZan commented Sep 8, 2024 •

edited

Loading