/a-tree

Github review helper (Code browsing & Pull requests reviewing)

Primary LanguageJavaScriptMIT LicenseMIT

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