madlambda / acme

acme utils

ACME tools

This project aims to provide an easy way to have cool tools to integrate on ACME, like code formatting, going to definitions of functions, etc.

The idea is to do this on the ACME spirit, integrating with external tools. So this is basically a collection of tools to use on ACME.

Dependencies

You will need the latest stable version of nash and Go to install and use the tools here.

You also need go get to install binaries that can be found on your operating system (like adding $GOPATH/bin on your $PATH, or whatever works for you).

Install

Just run:

./install.sh

We try to apply a pretty nifty idea from the ACME paper here:

Acmes context rules find the appropriate binaries in
/acme/edit rather than /bin ;  the effect is to turn
/acme/edit into a  toolbox containing tools and instructions
(the guide file) for their use.

In fact, the source for these tools is also there,
in the directory /acme/edit/src . 

This setup allows some control of the file name space
for binary programs; not only does it group related programs,
it permits the use of common names for uncommon jobs.

For example,the single-letter names would be unwise in 
directory in everyone's search path;
here they are only visible when  running editing commands.

But instead of using /acme/edit we use $PLAN9/acme/edit. This does not seem to be a problem since defining a PLAN9 environment is expected to install plan9port.

If you really don't like the idea you can run:

./install.sh <somedir>

And it will install the tools there.

Tools

So what tools comes in this project ?

Formatting

We have formatting available for the following languages:

• Go
• Nash

Just running fmt should automatically work. If you are having problems with fmt you can use:

• gof for Go code
• nashf for Nash code

Go

After installing you will have access to all the functionality described here. We provide more familiar aliases like:

• godoc = A doc
• godef = A def
• goref = A refs
• goren = A rn
• gocs = A cs
• gopeers = A peers
• goshare = A share

Git

For people who need to commit and push every small stable step they give there is the gitcp command that, given a message, will commit all changes with that message and already push it too.

Example:

gitcp 'my awesome message'

And it is done =D. This doc has been commited using this, so it works =P.