Giter VIP home page Giter VIP logo

a-tree's Introduction

A-Tree - Github review helper

Chrome web store

๐Ÿš€ Quick Features

  • Tree view for both Github files and pull requests
  • Some handy tools for code review (collapse/expand files, mark all files as viewed, etc.)
  • Quick search files like VSCode does (command + i or ctrl + i, customizable)
  • Switch commits via hotkeys
  • Support SPA for Github Pages
  • Support Dark theme
  • Support private and Enterprise repositories

๐Ÿ“ About A-Tree

Screenshots

A-Tree preview Open context menu to access files & toggle PR files
Search files in both code & PR pages Switch PR in a menu quickly

Authentication

  • Private repositories: token required
  • Enterprise Github: token, SSO* required (see F&Q below)

Feature list

  • Tree
    • SPA browsing
    • Support Dark theme
    • Support large repositories / PRs
  • Context Menu
    • Copy full file content
    • Copy path
    • Download file
    • Mark all files as viewed (PR)
    • Mark all files as not viewed (PR)
    • Expand all viewed files (PR)
    • Collapse all viewed files (PR)
  • File search in both code & PR pages
  • Menus
    • Pull request list
    • Commit list
  • Hotkey
    • Switch next / previous commit
    • Open file search modal

Permission requirements

  • contextMenus

    For Github enterprise users, we provide a simple way to enable our extension via right click.

F&Q

  • How to enable extension for Github Enterprise pages

    After you install the extension, right-click on any Github Enterprise pages, then click the Enable a-tree in this domain.

    For some Enterprise users, you may need to enable SSO, check the official documentation.

  • Why the extension shows in some unexpected pages

    If you encounter this problem, please help us improve our extension via creating issues, it will be nice to have the url included.

  • How to create personal access token

    1. Follow this official guide
    2. Select repo checkbox
    3. Copy the token into the extension SETTING
  • Why we need token

    1. To access private or enterprise repositories
    2. Github limits requests to 60/hours without token
  • How to solve the API rate limit exceeded issue with enterprise account

    Please refer to the official documentation

  • How to trace code in a more efficient way

    If you need to trace the code between files, we would recommend that use the powerful built-in online VS Code in Github (open via shortcut .)

๐Ÿ’ป Development

Setup

git clone https://github.com/shinenic/a-tree.git
cd a-tree
yarn

Develop with real online Github pages

Useful when you want to test the interaction between extension and Github pages, but have to update the extension manually.

yarn dev

After the build finished, install the /dist folder

Develop in the local and dummy pages

Useful when you want to develop the pure UI without navigation and DOM mutation, support React hot-reload.

  1. Start mock API server via Mockoon

    a. With GUI Download Mockoon and import the json for necessary APIs

    b. With command lines

      npm install -g @mockoon/cli
    
      yarn mockoon:start
    
      yarn mockoon:stop

    Default settings - port: 5567 - cors: enable (https://mockoon.com/docs/latest/cors/)

  2. Start webpack server

    yarn dev:local
    

Build extension

yarn build:prod

The path of extension will be /build

Helper

Quick extension reload for development: Extensions Reloader

Note. Still need to reinstall the unpacked folder manually if manifest.json or background.js changed

a-tree's People

Contributors

kkzleo avatar shinenic avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

grimmer0125

a-tree's Issues

[Feature] integrate with file icon

Is your feature request related to a problem? Please describe.
I want file icon in tree view like this
image

Describe the solution you'd like
Could you integrate file-icon-js into this extension?

Describe alternatives you've considered

Additional context

[Feature] Addition of the Code of Conduct & the Contributing guideline

Your project is pretty decent, but some addition to it would make it even better. Such as, If you add the Code of Conduct to the root branch and also add a Contribution guideline, then that would make the project more engaging.

If you want, then I can submit a PR including the Code of Conduct.

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.