Giter Site home page Giter Site logo

ruler's Introduction

CONSTRUCTION SITE - WORK IN PROGRESS - MIGHT END UP LIKE BER

ruler

Tool to track dependncies of software-projects

Metrics

  • Lines of source and Number of files per category

    • Test
    • Examples
    • Functionality
  • Resulting optimized binary size of the functionality including runtime-dependencies

  • Total install-size of dev-dependencies in Bytes (on top of alpine-linux docker image) -> Pushed to docker registry

  • Total install-size of external-dependencies -> Use docker image size if available

  • Number of service dependencies (size cannot be calculated)

  • Add file to repo -> Dockerfile.ruler

  • Use resulting docker image sizes for dev-dependencies and total optimized binary size with runtime

  • Cound lines of code / source lines based on three categories via simple tool

Dependency types

Dev-dependencies

  • Everything a contributor needs to install in order to contribute to the project
  • Typical examples: Testing frameworks, "devDependencies" section in package.json, build systems, compilers

Runtime-dependencies

  • Everything the user of a software component needs in order to use/run the component/application

External-dependencies

  • Software artifacts that do not reside in the same process (memory-address-space) of the component (e.g. databases, web-services, CDNs)

Service-dependencies

  • Software that is not available as source-code nor binary and can therefore not be measured except for its existence

Implicit-dependencies

  • e.g. operating system, are currently not measured

Goals

  • Manuals / best-practices to cont. measure and track the above mentioned metrics
  • Automated tooling to retrieve these metrics
  • Visualize the results for some open-source projects
  • Easy to use and integrate into existing projects -> Badges based on github repo urls
  • simple-go binary instead of bash script that calls docker history to export layer sizes + does line counting for the actual code.

Non-goals

See also

ruler's People

Contributors

cinemast avatar

Stargazers

Tristan Havelick avatar

Watchers

James Cloos avatar  avatar

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.