jamestomasino/burrow

burrow is a helper for building and managing a gopher hole

burrow's Issues

RSS generation using gnu specific find switch

Need to replace --not switch with something more portable.

Add version info as switch

Most likely change -v to be version info.

Move current -v to -d for debug mode

Add task to edit root gophermap

Should creating a phlog, recipe, or topic generate a link in the gophermap if none exists? I think so. I'll probably do that too in here.

Phlog fold

Add option to auto-fold entry upon completion. Provide var for width in config.

Make the autoindentation optional

Change the method of auto indentation to no longer look for a Links: section, but rather tabs. Wrap this in a boolean option.

Detect if editor is quit without saving and abort post

If you begin a phlog post and decide to abandon it, quitting the editor will continue to try and create the post. Add a mechanism for quitting without saving the file or otherwise signaling to burrow not to post.

Things to consider:

• what if you have saved the file while working, but still want to quit?
• is there any difference if you used a template file or not?
• if I quit, has the file still been created locally? Do I need to remove it? What if this was an edit, not a new post?

Edit posts should reformat to editable version

Leverage the same stack for creating posts to edit existing ones. Strip the leading "i" characters, reset the Links: divider, then edit away.

autoformat gophermaps breaks special gophernicus syntax

Gophernicus supports special gophermap directives like = * % and so on. These are not interpretted as links by burrow and are instead wrapped as type i, breaking them. Add detection for these and ignore as we do with gophermap links.

Move away from echo and replace with printf

echo isn't as portable as printf

Extend commands to menu driven system

Currently each command does only one thing. As features are added, rework the interface to provide a menu of options and a default so complex tasks can be done.

For instance, the phlog command could offer:

1 - New Phlog
2 - List Phlogs
3 - Edit Phlog (and subsequent menu provides a list to choose from)
4 - Delete Phlog

For first pass, simple text menus with numeric input should suffice. Investigate ncurses for menu system later.

RSS feed links incorrect

The link node is adding /./ and possibly the wrong type to the urls. Content is correct but not the nodes

Harden Makefile against bash completion errors

I don't know if all systems will have bash_completion support. The current Makefile is a little too optimistic about things. Add some error checking and fallbacks.

Add ability to install as non-root user

Allow for installation of program to an arbirtary directory. Explore what we can do with man page and bash_completion in this scenario.

Expand bash completion after "action"

After burrow phlog hitting <tab> should autocomplete with phlog entries by name. Similar functionality for explorations and recipebox as well.

Feature request: phlog command to insert phlog entries after gophermap preamble

Please can burrow have the option to insert phlog entries after preamble (such as banner text etc)?

As discussed on IRC, maybe by adding the latest entry either:

1. after the first block of 'i' lines, or
2. Probably better, before the first '0' or '1' line.

Optionally skip line endings in gophermaps

Gophernicus and motsognir can both fill in the host & port names of gophermaps automatically. Skipping the line endings can add portability if you use those servers or host on multiple servers. Make this an optional feature disabled by default.

Title Case RSS Phlog Entries

The former sed solution to title-case phlog titles turns out to be gnu specific.

sed 's/.*/\L&/; s/[a-z]*/\u&/g' 

Need to find a posix way of doing it. Probably awk with substrings and loops.

Makefile failing on FreeBSD due to bash completion and make version

Make just fell over on FreeBSD 12.0. These three steps worked:

1. Installing bash-completion via either pkg install bash-completion or via the shells/bash-completion port. (The first worked fine for me and was the simpler route).
2. Installing the GNU version of make via either pkg install gmake or the port devel/gmake.
3. Rather than running sudo make install, run sudo gmake install.

Maybe these could be added to the installation guidelines?

add edit-config action

Automatically search for a burrow config file and open it in $EDITOR

Gophermaps should have an "i" prefix for information lines

Stop generating with leading spaces and replace with a leading "i" to be RFC 1436 compliant.

Feature request: config can override date format

The config file could usefully hold an optional line such as date_format to allow overrides of the default US date order. This would be great for those of us preferring a 'day, DD Month YYYY" format or what-have-you.

Distinguish actions from switches

The actions passed as arguments and the switch options are repetitive. Remove the switch duplicates.

Add ability to categorize phlogs

getopt doesn't work on OSX

Probably the wrong version of getopt is being used. Investigate and fix to be more broadly compatible.

add ability to regenerate gophermaps

I ran into this after creating a phlog post, realizing the path was wrong, updating the configs and still seeing the wrong link.

POSIX compliant

Updated everything to be POSIX compliant. Possibly rewrite to /bin/sh instead of bash

Add chmod override config option

Add an option to specify a chmod for new posts & gophermaps. If it's set, after creating or updating a file chmod it automatically. This would be helpful for systems with odd umask settings.

Install fails to install bash completion on OSX

PKG_CONFIG environment variables don't exist in the same way as on Linux. Investigate and fix.

add support for both gnu or bsd stat

The implementation of each stat command is completely unique. Find a way to test for gnu and fall-back on bsd like we're doing for getopt.

server and port still written when config_gophermap_omitserver is used

I have not had much time to look into this, but when the config_gophermap_omitserver option is set, the server and port are still written into the phlog post itself.

It does seem to work in gophermap at the top of config_dir_phlog at least.

This causes issues when the server needs to send a different port to different clients (e.g. gophernicus running with both plain gopher and gopher over TLS)

cronjob 'update-git' throwing errors on getopt on SDF cluster

It may be a result of configuration on SDF or because cron runs in a non-interactive minimal shell. Needs investigating.