Code Monkey home page Code Monkey logo

cleaner's Introduction

cleaner

CodeScene Code Health

Cleaner ist der Versuch der technischen Unterstützung folgenden gerade in Arbeit befindlichen A3's.

obsidian://open?vault=Training2&file=A3s%2FA3%20Probleml%C3%B6sungstemplate

Es handelt sich um ein Experiment für ein Werkzeug, dass technologische und strukturelle Drift und Innovation sichtbar machen und dem entgegen wirken kann.

  • Es soll eine Übersicht über unerwünschte Abweichungen darstellen.
  • Ggf. noch unbekannte Muster erkennen und nachfragen.
  • Ein nächstes einfaches Refactoring aufstellen, so dass man Lösungen schrittweise in den neuen Lösungsstandard überführen kann.

Geprüfte Regeln

  1. Nur erlaubte Usings. (nuget-Pakete müssen explizit erlaubt werden)
  2. IOSP: If-Statements dürfen keine Expressions enthalten
  3. Linq: Es sind nur Ketten bis zu 2 Steps erlaubt, damit die Lesbarkeit der Ketten gewährleistet ist.
  4. Methodenlänge: Methoden dürfen nur 10 Zeilen lang sein.
  5. NotImplementedException: Code darf keine NotImplementedExceptions beinhalten
  6. Public Properties dürfen keine public setter haben (immutability)
  7. Dateien dürfen insgesamt nicht länger als 500 Zeilen sein.
  8. Dateien dürfen nur eine Deklaration (class, interface, enum, struct) beinhalten
  9. Dateien sollten immer nach dem innerhalb deklarierten Typ heißen
  10. Keine public properties mit generic lists als Typ, auch wenn sie nur getter haben.
  11. Keine public fields.
  12. Keine Out / Ref Parameter verwenden.
  13. Das .Net-interne Konfigurationsmanagement sollte nicht verwendet werden.
  14. SQL ist nur in Klassen erlaubt, die auf *Repository enden.
  15. Klassen die auf *Repository enden sollten nicht von anderen Klassen abgeleitet sein.
  16. Klassen, die auf *Repository enden haben mindestens einen IDataAccessor-Konstruktor-Parameter
  17. Methoden, die if statements enthalten, die tiefer als 2 Ebenen verschachtelt sind.

Noch mehr Ideen für Regeln

  1. Es gibt bestimmte Standard-Bibliotheken, die immer verwendet werden sollten. (Core, Frontend falls UI...)
  2. ? Klassen, die auf *Repository enden werden alle über eine gemeinsame Factory erstellt
  3. Wir verwenden ausschließlich den Logger aus der Core-Bibliothek.
  4. Jede Anwendung muss in der Program.cs in der Main-Funktion eine bestimmte Sequenz an Befehlen enthalten.
  5. Es sind nur bestimmte .Net-Versionen erlaubt.
  6. Alle Referenzen sollten aktuell sein. (Nuget)
  7. Alle Referenzen sollten aktuell sein. (Eigenes Artefaktsystem)
  8. ? Struktur-Regeln? Was sollte wo sein?
  9. ? Keine Enums
  10. ? Keine switch-Statements
  11. ? Isolations-Regeln: Vielleicht kann man Regeln formulieren, die es wahrscheinlich machen, dass man Themen in Subnamespaces zusammenfasst, statt nach Klassenarten zu sortieren.
  12. Wenn CSS vorhanden ist, sollte es sich nur um max. das Frontend-Framework und 1-2 zusätzliche CSS-Dateien handeln.
  13. Wenn Javascript vorhanden ist, sollten keine Vendor-Pakete eingebaut sein (das ist Aufgabe des Frontend Frameworks)
  14. Kein Typescript. R. C++. (Explizite Liste erlaubter und nicht erlaubter Dateitypen?)
  15. At the upmost execution level there should be a catch all for exceptions and it should be implemented in a way, that those exceptions are logged.
  16. ? Jedes Git-Repository sollte explizit als entweder "aktiv zu warten" oder "nicht aktiv zu warten" klassifiziert sein (an einem gemeinsamen Ort)
  17. ? Für aktiv zu wartende Git-Repositories sollte bei den Anforderungen ein MOC-* existieren.
  18. #region verbieten

cleaner's People

Contributors

stho32 avatar

Watchers

 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.