Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/balpan-rs/balpan
Simple CLI Tool that supports your onboarding for a journey on source code.
https://github.com/balpan-rs/balpan
Last synced: 3 months ago
JSON representation
Simple CLI Tool that supports your onboarding for a journey on source code.
- Host: GitHub
- URL: https://github.com/balpan-rs/balpan
- Owner: balpan-rs
- Created: 2023-05-31T17:47:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-19T12:08:10.000Z (10 months ago)
- Last Synced: 2024-08-01T13:35:54.085Z (6 months ago)
- Language: Rust
- Size: 331 KB
- Stars: 37
- Watchers: 1
- Forks: 7
- Open Issues: 21
-
Metadata Files:
- Readme: README.ko.md
Awesome Lists containing this project
- awesome-ccamel - balpan-rs/balpan - Simple CLI Tool that supports your onboarding for a journey on source code. (Rust)
README
Balpan CLI
오픈소스 생태계에 기여하고자 하는 사람들의 온보딩을 돕는 "발판"
오픈소스 프로젝트의 가독성을 높이고, 누구나 기여할 수 있도록 하자
[](https://www.rust-lang.org/)
## Table of Contents
- [Introduction](#introduction)
- [Installation](#installation)
- [Requirements](#requirements)
- [Install using homebrew](#brew)
- [Install using cargo](#cargo)
- [Quickstart](#quickstart)
- [Features](#features)
- [Supported Language](#supported-languages)
- [`balpan init`](#balpan-init)
**balpan**은 오픈소스 생태계에 기여하고자 하는 사람들의 온보딩을 돕는 **발판** 이라는 의미로 시작했습니다. ([🔗](https://m.khan.co.kr/national/national-general/article/202109152114035#c2b))
**balpan**은 [treesitter](https://tree-sitter.github.io)를 이용해서 소스코드를 트리 구조로 분석하여 시각화하고, 능동적으로 소스코드를 읽는 사람들에게는 좀 더 진입장벽을 낮추는 것을 목표로 합니다.
책을 읽을 때도 줄을 치면서 읽듯이, 소스코드를 읽을때도 역시 책갈피 관리하듯이 읽을 수 있도록 하는 것부터 시작합니다.
### Disclaimer
* 트리시터를 설치하는 문제를 부분적으로 해결하기 위해 [helix](https://github.com/helix-editor/helix) 소스코드의 일부를 사용했습니다.
* 관련 코드: [config.rs](https://github.com/malkoG/balpan/blob/main/src/config.rs), [grammar.rs](https://github.com/malkoG/balpan/blob/main/src/grammar.rs), [lib.rs](https://github.com/malkoG/balpan/blob/main/src/lib.rs)
- OS: Linux/macOS
- Cargo (cargo를 이용해서 설치하는 경우)
```bash
$ brew install malkoG/x/balpan
```
* ⚠️ 당장은 homebrew brew를 이용해서 설치하는 경우 `0.1.1` 릴리즈만 설치될 수 있습니다.
* 릴리즈를 출시할때마다 homebrew에 배포하는 과정을 자동화하는 방법은 알아보고 있는 중입니다.
```bash
$ cargo install --path .
```
**balpan**의 모든 명령어들은 소스코드를 트리구조의 형태로 분석하기 위해 treesitter 기반으로 생성된 파서를 이용합니다.
**balpan**의 각 명령어를 사용하기 전에 분석하고자 하는 리포지토리의 홈 디텍토리에서 아래의 명령어를 실행해주세요.
```bash
$ balpan init
```
당장은 지원하는 언어가 많이 없지만, 트리시터가 지원하는 언어라면 모두 지원할 수 있도록 하는 것을 지향합니다.
- Rust
- Python
- Ruby
