Skip to content

Latest commit

 

History

History
102 lines (64 loc) · 4.22 KB

README.md

File metadata and controls

102 lines (64 loc) · 4.22 KB
Raw

Swan

Swan is SWift static code ANanlyzer from xcode derived data.

프로젝트 목표

  • 클래스, 구조체, 함수, 프로토콜 참조를 분석합니다
  • 참조/호출 관계를 분석해서 그래프로 시각화합니다
  • 아키텍처 관점에서 모듈, 파일, 함수 단위 구조를 표시합니다 (아직 할 게 많아요ㅜㅜ)

Pecker 와 Sitrep 프로젝트에서 영감을 받았습니다. 명령 기반이 아니라 시각화에 촛점을 맞추고 있습니다. 지표를 뽑아내는 CLI 명령도 준비중입니다.

Swan 프로젝트는 애플의 오픈소스 IndexStoreDB를 활용해서 Xcode가 빌드한 인덱스 파일을 분석합니다. 그래서 프로젝트 빌드하는 Xcode 버전과 Swift 버전을 맞춰서 실행해야 합니다.

SwiftSyntax로 소스 파일을 분석하는 방식을 제거했습니다. 대신 xcodeproj 와 xcworkspace에 포함된 소스 파일들과 심볼들만 분석합니다.

Goals

  • Summary of Class, Function, Protocol references
  • Visualization for dependencies of references
  • Provides architecture's view of modules, files, functions

It inspired from Pecker and Sitrep.

Swan is built using Apple’s IndexStoreDB for analyzing.

Now, SwiftSyntax was removed for scanning source file in directories. Swan uses files and symbols in xcodeproj and xcworkspace.

Screenshot

  • Window for dragging project

Swan Window Screenshot

  • Result graph of SwanApp Project

Swan Window Screenshot

Features (한글)

  • 우선 Xcode 버전(스위프트 언어 버전에 맞춰서)에 맞춰서 프로젝트를 빌드하세요 (그래야 indexStore를 탐색할 수 있습니다)

  • Swan 앱을 실행하고 파인더에서 Xcode 프로젝트 파일을 드래그 앤 드롭하세요

  • 워크스페이스라면 프로젝트 단위로 indexStore를 읽어서 의존성 그래프를 그려줍니다

  • Graph 파일은 image/PDF 파일로 생성합니다

  • 단, Swan은 GraphViz 라는 오픈소스 도구를 사용합니다. 꼭 $PATH에 graphviz 도구를 설치하셔야 합니다. GraphViz 다운로드 바로가기 or brew install graphviz

  • First of all, Build your project (It makes indexStores for project to derived folder)

  • Just Drag and drop Xcode project file from Finder to Swan window

  • Draw Dependency graph of selected project or workspace

  • Open image/PDF for graph

  • Swan use GraphViz to draw graph. It should be installed graphviz in running $PATH. GraphViz Download or brew install graphviz

Downloads

Swan - Developer Build for Swift5.7 & Xcode 14

Swan - Developer Build for Swift5.6 & Xcode 13.3

Builds

  • 저장소를 클론해서 받으세요
  • swan.xcworkspace 워크스페이스 파일을 열고
  • SwanKit 프로젝트 설정에서 Package Dependencies 탭에 있는 패키지 버전 정보를 맞춥니다 예를 들어 스위프트 5.6으로 컴파일하는 Xcode 13.3 이라면, IndexStoreDB, swift-tools-support-core 패키지 버전 규칙을 release/5.6으로 변경해야 합니다
  • clone this repository
  • open the swan.xcworkspace
  • In Package Dependencies Tab for SwanKit Project, reset packages for IndexStoreDB version that are exactly same swift compiler version If you need to compile swift 5.6, IndexStoreDB, swift-tools-support-core package's version rule should be release/5.6.

Contributions

If you are interested in contributing Swan, submit ideas or submit Pull Request! It's developed fully opened.

License

Swan is under [MIT] License. See LICENSE file for more info.