Clean Code

[edTheGuy00]

This is not an issue but more of a proposition. I've used this library on two of my projects, great library. However, every time I look at the source code it's honestly a bit confusing.

Main Issue

There is more than 1,000 lines of code in one file, code is a bit messy, has too many nested ternary operators, makes it difficult to read and maintain.

Proposition

I propose to refactor and move out some code from the flutter_calendar_carousel.dart file into more reusable and maintainable widgets. For example,

  widget.showHeader
              ? Container(
                  margin: widget.headerMargin,
                  child: DefaultTextStyle( ........
                             .........................
                             .........................
                             .........................
                             .........................

We could move all this code into a separate widget class and just use

  widget.showHeader ? Header() : NotHeader()

The same can be done to various widgets used.

widget.weekFormat ? Calendar.weekView() : Calendar.monthView()

The project structure should look something like this.

    --flutter_calendar_carousel.dart
    --src/
       -header.dart
       -calendar.dart
       -day_widget.dart
       -default_styles.dart
        etc....

Benefits

1. Easier to read
2. Easier to debug
3. Easier to maintain
4. Testable widgets

[hyochan]

@edTheGuy00 This is absolutely great decision to go for refactoring. Everyone will appreciate your work. 👊

[hyochan]

@edTheGuy00 I've merged your PR. However, I won't close this issue yet because there seems 2 more to go from your statements.

• Separate Header, No Header
• Separate MonthView and WeekView

[edTheGuy00]

@hyochan Yes that's right. I'm still doing some work on it I can close this issue later on.

[KnockaertSven]

This is really minor so I figured I'd put it here:
-> weekdayTextStyle is written with a lowercase d

-> the other weekday props are written with a capital D , e.g. :
• showWeekDays
• weekDayMargin
• etc

I realise this may be nitpicking, but it'd be nice if it would be streamlined :)

[edTheGuy00]

@KnockaertSven sure I'll take a look at this

[edTheGuy00]

@hyochan @KnockaertSven I think it should be lowercase d weekdays not weekDays, would you agree? I can fix that on PR #77

[hyochan]

@edTheGuy00 Agree.

[github-actions]

This issue is stale because it has been open 90 days with no activity. Leave a comment or this will be closed in 7 days.