Git Product home page Git Product logo

ecocode-ios's Introduction

Logo

Mobile apps running on top of battery-limited devices are more than others concerned by the reduction of their environmental footprint. Hence, we created ecoCode iOS, the version of ecoCode project fully dedicated to the iOS platform. It provides static code analyzers to highlight code structures that may have a negative ecological impact: energy over-consumption, "fatware", shortening devices' lifespan, etc.

ecoCode iOS is based on evolving catalogs of best practices. A SonarQube plugin then implements these catalogs as rules for scanning your projects. To learn more, take a look at the complete presentation (in french) or the presentation in a nutshell (in english).

License: GPL v3 Build

Technical Debt Coverage Maintainability Rating Reliability Rating Security Rating

🌿 SonarQube Plugin

ecoCode iOS SonarQube plugin is an "eco-responsibility" static code analyzer for iOS projects written in Swift. Its aim is to detect code smells indicating how the source code can be improved to reduce their environmental and social impact.

🛒 Distribution

Ready to use binaries are available from GitHub.

🚀 Quickstart

Requirements

  • Java JDK 11+
  • Maven 3.8 or later
  • A local SonarQube instance for local testing

Compile

./tool_compile.sh

Run (with Docker)

This implies to have a machine ready to run containerized applications. Please refer to Docker documentation: https://www.docker.com/.

# build Jar files for application
./tool_build.sh

# clean docker environment
./tool_docker-clean.sh

# initialize docker environment
./tool_docker-init.sh

# display logs from docker environment
./tool_docker-logs.sh

The tests instance of SonarQube with the plugin will then be available at: http://localhost:9000. Default credentials are admin/admin

Test

An iOS test project is available here/

🤝 Partners

Snapp’ Université de Pau Région Nouvelle-Aquitaine Solocal / PagesJaunes inside|app

🧩 Plugins version compatibility

Plugins Version SonarQube version
1.1.+ SonarQube 9.4.+ LTS to 10.0

🛠️ Contributing

If you want to contribute to the project, your help will be greatly appreciated.

Start right away by reading General contribution guide and the iOS specific contribution guide.

ecocode-ios's People

Contributors

dedece35 avatar zippy1978 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.