Initial plugin architecture set up #43

desyncr · 2016-11-29T23:53:11Z

Moved most helper functions (prompt_geometry_colorize, prompt_geometry_hash_color, prompt_geometry_seconds_to_human_time, prompt_geometry_setup_async_prompt) to lib/ directory.
Created plugins/ directory with default plugins: git, exec_time
Move most variables/flags to it's plugin file
It does support custom prompts! Example.
It does works :D

TODO

Unregister/shutdown functions
Avoid registering a plugin multiple times
Enforce code/naming conventions
Update README.md
Review backward compatibility

Fixes #42

desyncr · 2016-12-01T16:00:33Z

geometry.zsh

 PROMPT_GEOMETRY_SHOW_RPROMPT=${PROMPT_GEOMETRY_SHOW_RPROMPT:-true}
+PROMPT_GEOMETRY_RPROMPT_ASYNC=${PROMPT_GEOMETRY_RPROMPT_ASYNC:-true}
+PROMPT_GEOMETRY_ENABLE_PLUGINS=${PROMPT_GEOMETRY_ENABLE_PLUGINS:-true}


This configuration is probably unnecessary, having PROMPT_GEOMETRY_SHOW_RPROMPT.

What is the first variable supposed to do?

PROMPT_GEOMETRY_SHOW_RPROMPT is used to activate or deactive the rprompt, meanwhile PROMPT_GEOMETRY_ENABLE_PLUGINS activates the plugins (internal and custom). The issue is -currently- the rprompt only shows plugins.

desyncr · 2016-12-01T16:01:17Z

lib/async.zsh

@@ -0,0 +1,33 @@
+# Misc configurations
+GEOMETRY_ASYNC_PROMPT_TMP_FILENAME=${GEOMETRY_ASYNC_PROMPT_TMP_FILENAME:-/tmp/geometry-prompt-git-info-}


Change default tmp file name.

desyncr · 2016-12-01T16:59:12Z

lib/async.zsh

+
+    TRAPUSR1() {
+        # read from temp file
+        RPROMPT="$(<${GEOMETRY_ASYNC_PROMPT_TMP_FILENAME}$$)"


Remove tmp file.

Do you have any ideas regarding an alternative for tmp files? I can see piping doing the job but is it that much necessary?

Well, there is zsh-async.

desyncr · 2016-12-01T16:59:55Z

lib/plugin.zsh

+geometry_plugin_setup() {
+  for plugin in $GEOMETRY_PROMPT_DEFAULT_PROMPTS; do
+      source "$GEOMETRY_ROOT/plugins/$plugin.zsh"
+      geometry_plugin_register $plugin


Probably better to leave plugin to self-register

I'd prefer having a plugin self-register.

desyncr · 2016-12-01T17:00:16Z

lib/plugin.zsh

+# Register a plugin
+geometry_plugin_register() {
+  local plugin=$1
+  if [[ $plugin == "" ]]; then


Use argument count

desyncr · 2016-12-01T17:01:37Z

lib/time.zsh

+  local seconds=$(( total_seconds % 60 ))
+
+  if $PROMPT_GEOMETRY_GIT_TIME_SHORT_FORMAT; then
+    if (( days > 0 )); then


Move each if branch into it's own functions.

desyncr · 2016-12-01T17:02:52Z

plugins/README.md

@@ -0,0 +1,5 @@
+# Geometry plugins


Add example plugin structure

Add setup return values definition

Add render return values definition

I have a README almost ready, was working for the current version. Just need to adapt it. Can you change the base branch to something like 2.0 instead of master? That way I can contribute as well.

Alright, I'm gonna create v2 branch and target this PR to it.

Done. It was created from master. I guess we can already merge this feature branch and continue working on v2.

desyncr · 2016-12-01T17:04:48Z

geometry.zsh

+source "$GEOMETRY_ROOT/lib/plugin.zsh"
+source "$GEOMETRY_ROOT/lib/time.zsh"
+source "$GEOMETRY_ROOT/lib/color.zsh"
+source "$GEOMETRY_ROOT/lib/grep.zsh"


Not sure about this. Should we have a compilation script to bundle everything into geometry?

I'd rather have that. And have it make sure we only source it once.

Do you mean to use source instead of a makefile-like approach?

Oh, I thought you meant sourcing them all. A Makefile-like approach would have to be on install, wouldn't it?

On a build step. Maybe it's too cumbersome as of now. I'm gonna leave it as it is, sourcing them as currently implemented.

desyncr · 2016-12-01T17:14:25Z

lib/async.zsh

+GEOMETRY_ASYNC_PROMPT_TMP_FILENAME=${GEOMETRY_ASYNC_PROMPT_TMP_FILENAME:-/tmp/geometry-prompt-git-info-}
+
+GEOMETRY_ASYNC_PROMPT_PROC=0
+prompt_geometry_setup_async_prompt() {


Rename to geometry_async_setup?

👍 agreed

desyncr · 2016-12-01T17:14:49Z

lib/color.zsh

@@ -0,0 +1,20 @@
+# Define how to colorize before the variables
+prompt_geometry_colorize() {


Rename to geometry_color_colorize?

Not sure. color_colorize doesn't read well to me. Since we keep using this function throughout the prompt why not a shorthand name? Even if it's -g-color, just to save characters.

geometry_color_colorize would follow the format geometry_<lib>_<function>. I could also add, as an alias, a -g-color function.

Second option seems nice.

frm · 2016-12-01T23:07:36Z

Really liking the way this is going. Great job!

I'd recommend, like I said in another comment, putting the PR on a different branch. That way I and someone who would like to help can jump in easily.

A lot of comments you had there could be in a TODO list, together with the list already on the PR description. I'd like to have some issues and improvements flagged for people looking for their first PR. Props for flagging some issues, really helps with that.

frm · 2016-12-02T15:10:01Z

lib/time.zsh

  local days=$(( total_seconds / 60 / 60 / 24 ))
  local hours=$(( total_seconds / 60 / 60 % 24 ))
  local minutes=$(( total_seconds / 60 % 60 ))
  local seconds=$(( total_seconds % 60 ))

-  if $PROMPT_GEOMETRY_GIT_TIME_SHORT_FORMAT; then
+  # It looks redundant but it seems it's not
+  if [[ $long_format == true ]]; then


Do we need == true ?

Not sure tbh. I tried [[ $long_format ]] and it messed up. Gonna take a look later today to see what was going on.

desyncr · 2016-12-02T15:52:01Z

Gonna merge to develop. I'm not squashing commits as of now to keep the changelog.

All development regarding plugins should be done in a feature branch branched off v2.

Initial plugin architecture set up

e0b5d99

desyncr added the enhancement label Nov 29, 2016

desyncr assigned desyncr and frm Nov 29, 2016

desyncr added 5 commits November 30, 2016 14:51

Enhance code structure. Better plugin code separation.

0c455ae

Separate async mode from git plugin. Fixed exec_time plugin.

9c34cfb

Moved grep function to lib

a2cb235

Add missing zsh/datetime

8706652

Fix exec_time plugin issue with multiple enter key pressed

93c268e

desyncr commented Dec 1, 2016

View reviewed changes

Refactor async library and fix coding style

247c95b

desyncr changed the base branch from master to v2 December 2, 2016 01:58

desyncr added 9 commits December 1, 2016 23:06

Make plugins self-register. Added geometry_plugin_list function.

40f62ff

Add plugin separator configuration

3f11b73

Avoid multiple plugin registration

af822c9

Refactor time library

289d3a4

Add unregister/shutdown methods

2a97cb7

Moved time lib configuration variables

240e9d7

Fix error index with time lib

aea1858

Fix time short/long format functions

e2cf1bd

Fix plugin registration duplicate check

69e4bc2

frm reviewed Dec 2, 2016

View reviewed changes

frm approved these changes Dec 2, 2016

View reviewed changes

Add function alias for prompt_geometry_colorize as -g-color

737d68d

desyncr merged commit 84a05a7 into geometry-zsh:v2 Dec 2, 2016

desyncr mentioned this pull request Dec 9, 2016

Option to add custom prefix/postfix to PROMPT #24

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial plugin architecture set up #43

Initial plugin architecture set up #43

desyncr commented Nov 29, 2016 •

edited

Loading

desyncr Dec 1, 2016

frm Dec 1, 2016 •

edited

Loading

desyncr Dec 2, 2016

desyncr Dec 1, 2016

desyncr Dec 1, 2016

frm Dec 1, 2016

desyncr Dec 2, 2016

desyncr Dec 1, 2016

frm Dec 1, 2016

desyncr Dec 2, 2016

desyncr Dec 1, 2016

desyncr Dec 1, 2016

desyncr Dec 1, 2016

frm Dec 1, 2016

desyncr Dec 2, 2016

desyncr Dec 2, 2016

desyncr Dec 1, 2016

frm Dec 1, 2016

desyncr Dec 2, 2016 •

edited

Loading

frm Dec 2, 2016

desyncr Dec 2, 2016

desyncr Dec 1, 2016

frm Dec 1, 2016

desyncr Dec 1, 2016

frm Dec 1, 2016

desyncr Dec 2, 2016

frm Dec 2, 2016

frm commented Dec 1, 2016

frm Dec 2, 2016

desyncr Dec 2, 2016

desyncr commented Dec 2, 2016

		@@ -0,0 +1,33 @@
		# Misc configurations
		GEOMETRY_ASYNC_PROMPT_TMP_FILENAME=${GEOMETRY_ASYNC_PROMPT_TMP_FILENAME:-/tmp/geometry-prompt-git-info-}

		@@ -0,0 +1,20 @@
		# Define how to colorize before the variables
		prompt_geometry_colorize() {

Initial plugin architecture set up #43

Initial plugin architecture set up #43

Conversation

desyncr commented Nov 29, 2016 • edited Loading

TODO

Choose a reason for hiding this comment

frm Dec 1, 2016 • 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

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

desyncr Dec 2, 2016 • 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

frm commented Dec 1, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

desyncr commented Dec 2, 2016

desyncr commented Nov 29, 2016 •

edited

Loading

frm Dec 1, 2016 •

edited

Loading

desyncr Dec 2, 2016 •

edited

Loading