CrossClj

0.2.3 docs

SourceDocs



RECENT
    VARS
    add-note
    conn
    ensure-db
    file->entity
    fixtures
    get-all-notes
    get-all-repos
    get-notes
    get-repo
    hash-note
    highlight-path
    import-repo
    note->key
    remove-note
    remove-repo
    repo-path
    schema-tx
    source-files
    valid-filepath

    « Index of all namespaces of this project

    (add-note filepath line-number content type)
    Insert a note in the database.
    
    (ensure-db uri repo-path highlight-path)
    (file->entity file repo-path)
    Given a File, convert it to the appropriate db entity ready to be
    added.
    (get-all-notes)
    Get all notes currently in the database.
    
    (get-all-repos)
    Get a list of all repos in the database.
    
    (get-notes user project)(get-notes filepath)
    Given a filepath, return the notes associated with that file.
    
    Given a user and project, return all notes associated with the project.
    
    The notes are database entities with keys that correspond to
    attributes defined in the database schema. See
    'resources/data/schema.edn' for details.
    (get-repo user name)
    Given the user and name of a repo, return a database entity id
    representing the repository.
    (hash-note filepath line-number type)
    Return what should a db-unique hash for a note.
    
    NOTE: the note 'type' is the key in the 'note->key' map.
    (highlight-path)
    Get the highlight path set for this instance.
    
    (import-repo uri user name files repo-path)
    Import a git repository into the database.
    
    (remove-note filepath line-number type)
    Retract a note from the database.
    
    (remove-repo user project)
    Given a user/org name and a project name, remove all traces of a
    repo from the database. Idempotent - removing a nonexistent repo
    does nothing.
    (repo-path)
    Get the repo path set for this instance.
    
    (source-files user name)
    Given a user and project name, return a sorted list of the analyzed
    files in the repository. For now, this is just the Clojure files.
    (valid-filepath filepath)
    Checks whether the filepath is known in the database. Returns a
    boolean.