v0.1.0 (alpha) #1

TheOnePath · 2023-01-13T16:53:49Z

TheOnePath commented

2023-01-13 16:53:49 +00:00

This PR represents a stable implementation of presser.nvim.

PR marks the alpha release of presser.nvim (v0.1.0). Whilst experimental has been deemed stable, the development may still contain bugs and unfinished features. But presser.nvim functions as intended from the experimental branch.

This PR represents a stable implementation of presser.nvim. PR marks the alpha release of presser.nvim (v0.1.0). Whilst experimental has been deemed stable, the development may still contain bugs and unfinished features. But presser.nvim functions as intended from the experimental branch.

TheOnePath added 14 commits 2023-01-13 16:53:49 +00:00

Added context manager module 90b57ed4b1

Added a context manager for handling and managing windows/buffers
constructed by built-ins. This was handled by the `new()` function in
presser/init.lua but is now a dedicated module.

Renamed modules 8f88af8d69

Files were moved from top-level space into presser sub-directory.

Updated context_manager/init.lua a66d9ae62f

- Added diagram for global context manager (GCM) structure.
- Removed local func@get_ctx_head (unused).
- Updated func@M.update:
	- function takes 2 parameter arguments (see docstring).
	- constructs new record for the given context in the GCM to keep
	  record of a newly constructed window buffer.
	- function updates the GCM with the new record.
- Updated func@M.flush:
	- handles for new structure of records in the GCM.
	- see docstring for info.

Updated presser/init.lua 4d40f43a73

File has been moved to subdirectory.
Note: TBR = To Be Refactored/Restructured.

- changed `ctx` to `gcm` as import for context manager module.
	- gcm/GCM = global context manager
	- all associations with this variable have been updated
	  respectfully.
- func@new is no longer responsible for creating a new context in the
  GCM. This is now handled per built-in.
	- call to gcm@update now respects newly modified GCM structure.
- Added presser@move_next_buffer:
	- temporary function to experiment moving between buffers which
	  are marked as `allowed = true` in the GCM.
	- TBR.
- Added func@read_buffer:
	- reads the contents of all buffers in the GCM.
	- returns a table storing all collected buffer contents.
	- TBR.
- Added presser@execute:
	- temporary function which calls func@read_buffer and performs a
	  vim substitute as per the built-in presser@find_replace.
	 - TBR.
- Added func@start_buffer:
	- place the cursor in an initial buffer by name.
	- TBR. Should be func@put_cursor_in_buf (or similar).
- Updated keymap to store more keys for experimenting.
- Calculate the centre of the current window height (should check for
  split windows in future, or determine terminal size).
- Changed ordering of window creation. Windows created in order they are
  rendered.

Updated presser/utils.lua d1ab26196a

Updated M@clean_buf. If the type is not string or is nil, return empty string.

Moved to presser subdirectory 7908c64c00

Upated context_manager 686dbd9ae4

Added a getter function to return the current state of the global
context manager.

Refactored main init.lua file 7a126af17a

File has undergone refactor to reduce overall expected responsibility
which was temporary for kickstarting the extension.

The presser/init.lua script will now, and only now, be responsible for
handling and setting up configuration of presser itself (extensibility
to be concluded in future). Now, the script defines presser@setup()
which is to be called by a user in their Neovim config script. This
function currently defines one user command which allows for executing
the builtins@find_replace.

Most functions which were defined in table@presser have been migrated to
a new location presser/actions, defined in table@actions.

The function definition presser@find_replace has been migrated to
presser.builtins (in builtins@find_replace).

Consult other commits related to migrations for more info about specific
refactors.

Added new actions module 028b34bdda

All functions originally defined in presser/init.lua and part of
table@presser which were related to performing a specific action,
have be migrated to this file.

Function definitions have remained the same
	- presser@start_buffer has been renamed
	  actions@buf_put_cursor_at() to allow for more generic
	  use-cases which the function name did not imply. Call this
	  function to place the cursor into any buffer in the GCM by its
	  label name.

Added builtins/__modules.lua b14fadee45

Script defines all tools available by presser.nvim, which are
lazy-loaded and executed when called by the user.

Function presser@find_replace has undergone major refactorisation:
	- Keymaps have been updated to respect new codebase structure.
	- A new OOP implementation is being experimented for constructing
	  windows, giving future flexibility. Consult presser/steamers.lua.
	- Function now calls the class@streamers and invokes the
	  streamers@new() method. This constructs the windows/buffers which
	  was originally done via call to presser@new().
	- This function is NOT directly accessed, but via proxy
	  table@builtins which lazy-loads function.

Any new tools which are created for presser are to be defined in this
file and lazy-loaded. Module may be renamed in future for theming
consistency.

Added presser/builtins e1b2cb5de8

Module is responsible for implementing a lazy-loader for any new tool
which is defined in table@modules. This function makes use of a
lazy-loading strategy (needs citation).

Added streamer.lua 6b63ea6446

Steamers are akin to that of Telescope's Pickers. A "steamer" is the
class structure used by builtins to create new windows/buffers for the
user to interact with. This code was simply migrated across from
presser@new and refactored to adopt a class-like OOP paradigm.

steamers@new is a wrapper function accessed by builtins to invoke the
class constructor Steamers@new. Allows to greater control and
flexibility of window/buffer options.

Moved presser/ -> lua/presser/ 6e3e7f9d2d

Created new director lua/ and moved presser/ into the subdirectory.
This is to align with other standard developments of Neovim extensions.

Updated context_manager/init.lua 1dec350d04

TheOnePath commented

2023-01-13 16:55:49 +00:00

Informal review and merge. Repo migration to ClosedLess org in consideration. PRs will undergo standard review if migration is carried out in future.

TheOnePath force-pushed experimental from 1dec350d04 to f841a23dde

2023-01-13 17:18:57 +00:00

Compare

TheOnePath merged commit e61af8773b into main

2023-01-13 17:19:11 +00:00

TheOnePath referenced this issue from a commit

2023-01-13 17:19:11 +00:00

Merge pull request 'v0.1.0 (alpha)' (#1) from experimental into main

Sign in to join this conversation.

No reviewers

No Label

No Milestone

No project

No Assignees

1 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: ClosedLess/presser.nvim#1