Code Monkey home page Code Monkey logo

prism's Introduction

Prism

Prism grows Github streak with your private repository commits. It works like prism (glass).

Usage

Preparation

Before you use, following tasks must be completed.

  1. Specify your favorite directory for storing prism task files as export ZSH_PLUGIN_PRISM_PATH=${HOME}/.prism in your .zshenv
  2. Specify your favorite log store repository as export ZSH_PLUGIN_PRISM_HUB_REPOSITORY=prism_hub in your .zshenv
# .zshenv (Example)

export ZSH_PLUGIN_PRISM_PATH=${HOME}/.prism
export ZSH_PLUGIN_PRISM_HUB_REPOSITORY=prism_hub
  1. Create directory ZSH_PLUGIN_PRISM_PATH
  2. Make hub repository ZSH_PLUGIN_PRISM_HUB_REPOSITORY in Github, and clone it into ZSH_PLUGIN_PRISM_PATH (or do it manually)
  3. Initialize hub repository with empty file named log
  4. Add one-line export ZSH_PLUGIN_PRISM_HUB_REPOSITORY=${HOME}/.prism/prism_hub into your .zshenv
  5. Add hook in your .zshrc as follows
# .zshrc

FPATH=path/to/prism/src:$FPATH
autoload -Uz prism
function prism-preexec() { prism --preexec $* }
function prism-precmd() { prism --precmd }
add-zsh-hook preexec prism-preexec
add-zsh-hook precmd  prism-precmd

Register

Before you use, you must register your project for target of observation

  1. In your repository, run prism -a for register your repository

Un-register

  1. In your repository, run prism -d for un-register your repository

Update streak information in Github

  1. You must push repository information to Github. prism --push

Note

This plugin wants to use variable ZSH_PLUGIN_PRISM_COMMIT_FLAG for checking of commit status. Please do not make conflicts.

License

See LICENSE.

Contributions

Now, this projcet needs more options, bug-fixing, support Antigen etc.

prism's People

Contributors

kmhjs avatar

Watchers

 avatar

prism's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.