inherd / coco

An effective DevOps analysis and auto-suggest tool。Coco 是一个研发效能分析工具，如团队发展现状（根据架构复杂度及行数变更）、团队演进、历史分析等。生成可视化报告及对应的改进建议。

Coco

(aka coconut, juice), an automatic DevOps metrics analysis tool.

case studies: Coco cases

Online Demos:

• Element-Plus
• Nginx
• Redis

OS: macOS, Windows, GNU/Linux

Usage

0. install or download Coco components from release, and download ctags: windows
1. use coco init to generate config file
2. config coco.yml
3. optional: use coco plugins to download plugins
4. run Coco
   • coco, gather data from source
   • visual, visualization of data
   • suggest, generate suggestion
5. download plugins (optional)
   • coco_container，container analysis
   • coco_pipeline，pipeline analysis
   • coco_struct，model analysis by ctags
   • coco_swagger，Swagger API Analysis

visual URL:

• all: http://127.0.0.1:8000/
• explorer: http://127.0.0.1:8000/explorer.html

Offline usage:

1. download coco, visual e``xec file
2. download coco_plugins_xxxx with platform
3. extract coco_plugins_xxxx to plugins dir

Coco Usage

coco 0.5.3

USAGE:
    coco [OPTIONS] [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -b, --branches <branches>            With all branches [default: true]
        --commits <commits>              With all commits [default: true]
    -c, --config-file <config-file>      Config file .yml [default: coco.yml]
    -d, --debug <debug>                  Debug mode [default: false]
    -f, --file-history <file-history>    Scan file change list from git & cloc [default: false]
    -y, --git-years <git-years>          Set git commits scan years, default 1, [default: 1.0]
    -t, --tags <tags>                    With all tags [default: true]

SUBCOMMANDS:
    help       Prints this message or the help of the given subcommand(s)
    init       Create default coco.yml files
    plugins    Download plugins from GitHub

sample:

coco --file-history=true --git-years=3

coco.yml

配置 (config in Chinese)

示例：

# 代码库
repos:
  - url: https://github.com/coco-rs/coco.fixtures
  - url: https://github.com/coco-rs/coco.fixtures2
  - url: .
    languages: [Rust]
  - url: https://github.com/datum-lang/scie
  - url: https://github.com/projectfluent/fluent-rs
    languages: [Rust, JavaScript]                     # set languages for struct analysis

plugins:
  - name: swagger
  - name: struct
    config:
      - key: ctags                       # set location for macOS ctags path
        value: /usr/local/bin/ctags
        
git:
  local: true # true will use `git clone`, false will use libgit2

Documents

Development

See in DEVELOPMENT.md

Online video

Bilibili: 研发效能分析工具 Coco 第一次线上讨论

Roadmap

analysis and reporter

analysis

• git analysis
  • branch
  • changes
  • commits
• cloc analysis
  • summary
  • file arch
• framework analysis
• architecture analysis
  • file/directory organization

reporter

• html reporter
• json output
• query api?

suggest and case study

Tech

• AST Parser: include_parser/mod.rs
• Web Server: light_server.rs
• CLI: visual.rs, coco.rs, suggest.rs

Todo

• git analysis
  • merge code from coca
  • local repo support
  • project calendar view https://observablehq.com/@d3/calendar-view
  • change
    • line change
    • changed file
    • commit number
  • git branch analysis
    • branch history
    • branch visual. such as https://app.gfc.io/github/nvie/gitflow
      • ahead vs behind https://github.com/BenoitZugmeyer/git-branches-overview
  • git commit time analysis
    • storage all commits
    • working night count
• cloc analysis
  • spike cloc tools Tokei
  • history cloc changes
  • commit cloc changes
• framework analysis.
  • framework detector
  • merge from scie-detector
  • framework output
  • tech stack generate
  • cloud native
• module analysis
  • base framework for directory
    • gitignore support
  • code flower
  • include analysis
    • code parser: pest
    • languages support.
• team analysis
  • join time & life time
    • 以加入时间开始度量平均提交：上手成本分析
    • 平均加入时长
    • 成员加入时间点
  • member growth
  • count system size & learning curve
• commit analysis
  • commit times analysis (hours)
  • rule regex support in config
  • participle（分词）
  • tags generate
• suggestion API
  • document manage system
  • suggest to ledge
  • suggest to cases
  • suggest to coco.server?
    • online suggest ?
    • link daily checking
  • architecture design rules
• architecture
  • tech stack version check (more than 3 years ?)
    • Maven Center
    • NPM Server
    • Go Server
• tools
  • tools config identify
  • tools suggest (identify old tools)
  • cloud-native config
• case study
  • homepage: https://github.com/inherd/cases
  • auto clone and auto deploy
• todo scan
  • merge from coca
• multiple platform support
  • macOS
  • GNU/Linux
  • Windows
    • fix tests
    • make it works
• C4 Model
  • PUML for call chain
    • symbol design - IsA, Use-In-The-Interface, Uses-In-The-Implementation
• plugin
  • struct analysis
    • ctags
    • visual
    • uml
  • swagger
  • Jenkinsfile
  • Dockerfile

Visual and Reporter

• visual api
  • static files server
    • http server: actix_web
    • static server: Rust Embed
  • export assets
  • cli prompt for projects
  • query JSON API
  • CLI JSON API
• visual web
  • spike d3.js code organization
  • typescript with frontend framework
    • use Deno ?
  • architecture
    • first demo
    • code flower 1, D3.js code flower
    • circle
  • git
    • branch history
  • commits in years/month
    • examples: gilot average committer in month
    • changes in years/month
      • Stacked Area Chart
  • graph support for velocity
    • code commits by daily
    • PR times by daily
  • story velocity
    • commit message analysis
    • story spend days
  • advanced code flower, Polyglot Code Explorer
    • source code: https://github.com/kornysietsma/polyglot-code-explorer/tree/master/src
    • Weighted Voronoi diagram
    • Age since last change
    • Creation date
    • Unique changers
    • Temporal Coupling
• reporter
  • framework
  • cloc
  • git
  • architecture

DevOps pipeline

• Jenkinsfile of Coco's examples

Tech Debt Integration

• Git 2
  • Code check with: https://github.com/kornysietsma/polyglot-code-scanner
• Integration Sonarqube ?
  • Our 10-Point Technical Debt Assessment

Documents

Refs: Libgit2 Documents

FAQ

How to install in macOS?

Step1

Download Coco to your Mac from release

Step2

Move it(Coco) to your preferred directory,such as:

mkdir ~/.coco
mv ~/Downloads/coco_macos ~/.coco/

Step3

Set up an alias to make it easier to use,such as:

export 'alias coco="~/.coco/coco_macos"' >> ~/.zshrc

Step4

Try to use execute it by alias coco:

coco -h

If it show no permission,you can execute the following command:

chmod -R u=rwx,g=rw,o=r ~/.coco/coco_macos

Then retry:

coco -h

Good luck!

Thanks

License

ctags analysis based on https://github.com/dalance/ptags with MIT, see in src

ctags parser rewrite from Golang's https://github.com/ruben2020/tags2uml with Apache License.

@ 2020~2021 This code is distributed under the MIT license. See LICENSE in this directory.

coco's Issues

Windows crash

Describe the bug

the code execution cannot proceed because vcruntime140.dll was not found

Steps to reproduce (please include code)

run exe and popup

Environment

• OS: Windows 10

Failed: CocoError: cause by: unzip error

Describe the bug

A clear and concise description of what the bug is.

Steps to reproduce (please include code)

./coco_linux.coco_linux plugins
create plugins dir success
download from https://github.com/inherd/coco/releases/download/v0.5.4/coco_plugins_linux.zip
Failed: CocoError: cause by: unzip error

Environment

• coco version 0.5.4
• Rust version unknow
• OS: [e.g. Linux]

how to install Coco from release on mac

I don't know how to install it on mac. Should I use coco_macos? I don't know how to do it.

Flink仓库分析报错文件名或扩展名太长

Describe the bug

A clear and concise description of what the bug is.
Flink仓库分析报错文件名或扩展名太长。

Steps to reproduce (please include code)

执行步骤:

PS C:\Users\ovo\Documents\workspace\report\git> .\coco-windows.exe
target dir: ".coco\\github.com\\apache\\spark"
target dir: ".coco\\github.com\\apache\\flink"
thread '<unnamed>' panicked at 'failed to clone: failed to stat 'C:/Users/ovo/Documents/workspace/report/git/.coco/github.com/apache/flink/flink-connectors/flink-connector-files/src/test/resources/bucket-state-migration-test/full-no-in-progress-v1-template/bucket/test-bucket/.part-0-0.inprogress.a88d5993-77bc-44ce-880b-9f2a43b59ab4': 文件名或扩展名太长。
; class=Os (2); code=Exists (-4)', src\infrastructure\git\git_repository.rs:35:17
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

配置文件:

---
repos: 
  - url: https://github.com/apache/spark
  - url: https://github.com/apache/flink
    languages: [Java,Scale]

Environment

• coco version 0.5.4
• Rust version unknow
• OS: [Windows 10]