Skip to content
This repository has been archived by the owner. It is now read-only.

mk-fg/codetag

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
do
 
 
 
 

codetag

Deprecation notice: stopped using this tool myself in favor of simplier and faster filetag script, so this repo is mostly abandoned, and likely have been for a while.

A tool to scan "development area" (paths with code projects in them) and attach tmsu tags to their files, according to several pre-defined taxonomies (e.g. source language, project hosting - github/bitbucket/etc and various other details).

End result should be tags "lang:go" + "scm:git" + "host:github" for "main.go" file in local clone of this repo and "lang:md" + "scm:git" + "hosted:github" for this (README.md) file.

One use of such tagging is to avoid grep-scan of a huge body of source code (incl. forks, sdks, temp build paths) and - especially for simple grep - huge body of other data, using something like tmsu files -0 lang:py hosted:github | xargs -0 grep some_code_feature (or ack/ag/pss if appropriate) instead to find something you wrote/seen a while ago and can't recall where exactly.

tmsu-provided fuse-fs might make it even easier.

There are a few code-indexing systems around in free software world, like ctags, which seem to be geared towards indexing source code contents, picking structural details from these, not towards just indexing code metadata.

Installation

First, install (or build) tmsu from here (single binary, see README there on how to build it from source).

Same as tmsu, this tool itself is written in Go, binaries of which don't require much runtime to be around (except for basics like libc) downloaded here (x86 ELF32) (usual warning about downloading binaries via http applies).

To build the thing from source using go packaging tools:

  • Install Go.

  • Easy option: use "go install" to pull in all the deps and build the tool:

      go install github.com/mk-fg/codetag
    

    This should produce no output and just exit with success. Compiled binary will be in the "$GOROOT/bin" path.

    That's it, all done.

  • Alternative to the above (aka the hard way): clone repo and build manually.

    • Fetch go package deps:

        go get -u github.com/vaughan0/go-logging
        go get -u github.com/kylelemons/go-gypsy/yaml
      

      Be sure to update these packages when trying to build a new codetag version.

    • Get the code: git clone https://github.com/mk-fg/codetag

    • Build the code:

        cd codetag
        make
      
    • Binary will be in the "bin/codetag" path, and can be installed to $PATH (if necessary) via usual means e.g. sudo install -m755 bin/codetag /usr/local/bin.

Usage

Tool uses configuration file to keep track of all the settings, which is searched (by default, if "--config" option is not used) in the following paths (in that order):

<binary path>.yaml
~/.codetag.yaml
/etc/codetag.yaml

So create configuration file in e.g. "~/.codetag.yaml" by copying codetag.yaml.dist from the repository.

Most important section is the first one - "paths". Path(s) there should be set to some "~/projects" directory(-ies) used for the code that should be taggged:

paths: ~/projects

Or, for several paths:

paths:
  - ~/projects
  - ~/src
  - ~/work

"taggers" section there will define tag namespaces and how tags in these should be generated. For example, "lang: lang_detect_paths" there will use "lang_detect_paths" plugin to set tags like "lang:py", based on path/filename patterns.

"logging" and "filtering" sections might be useful to keep track of errors and control noise (e.g. if used from cron, set log level to WARNING there, refer to go-logging docs for more details) or exclude large and irrelevant paths from tagging (e.g. insides of ".git" directories, as done there by default).

Refer to annotations in the example configuration file for reference on all the options there.

When done with config, just run the tool. It will run "tmsu" binary to attach detected tags to files within the scanned dirs.

Then, just use tmsu (examples/docs) as usual to get the list of files by tags, e.g.:

% tmsu files scm:git lang:go
src/codetag/log_setup/log_setup.go
src/codetag/main.go
src/codetag/taggers/taggers.go

More advanced usage might be:

# Remember where python's mutagen module was used
% tmsu files -0 lang:py | xargs -0 grep mutagen
src/beets/beets/mediafile.py:import mutagen
src/beets/beets/mediafile.py:import mutagen.mp3
...

# Find Makefile from some github project you've seen where *.coffee stuff gets converted
# See codetag.yaml.dist for host_tags with scm_config_git tagger
% tmsu files -0 lang:make host:github | xargs -0 grep coffee
src/planetscape/Makefile:all: package.json coffee sass jade node_modules/.keep
src/planetscape/Makefile:coffee: $(JS_FILES)
src/planetscape/Makefile:%.js: %.coffee
src/planetscape/Makefile:        coffee -c $<
src/planetscape/Makefile:.PHONY: coffee sass jade
...

Or use tmsu's awesome mount command:

% mkdir mp
% tmsu mount mp
% ls -l mp/tags/scm:git/lang:go
 drwxr-xr-x 0 fraggod fraggod    10 Feb  4 14:31 host:github
 drwxr-xr-x 0 fraggod fraggod     6 Feb  4 14:31 host:local
 lrwxr-xr-x 1 fraggod fraggod  2959 Feb  2 13:14 log_setup.12.go
 lrwxr-xr-x 1 fraggod fraggod 10395 Feb  4 12:50 main.14.go
 lrwxr-xr-x 1 fraggod fraggod  7833 Feb  4 11:05 taggers.16.go

And feel free to hack additional taggers, it's rather trivial - see taggers.go.

Hope that helps, have fun!

About

A tool to index and tag local code using tmsu (tmsu.org)

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages