Flutter freezed v4.0.0 #47

Parables · 2023-01-16T08:44:23Z

Description

The motivation for this version started when @endigo identified some bugs with the plugin.

As a quick resolution, I suggested this solution .

Then it hit me... I took a look at the schema @endigo mentioned and realized how big it was, I tried implementing my initial suggestion on that schema and ended up with a bloated config file spanning close to 500 lines just for some minor configurations.

I was working on a project at that time and was writing pure CSS. It was then that I began to wonder how certain CSS properties have multiple syntaxes. Taking inspiration from the flexibility CSS offers, I began experimenting with RegExp to be used for configuring the plugin.

Initially, I thought I was going too far with this but I stubbornly persisted... +3 months of sleepless nights debugging and tons of refactoring later, comes this PR which hopefully might inspire other plugins too.

Documentation is still in progress and video tutorials will soon follow once this PR gets merged.

Looking forward to your usual collaboration @charlypoly, @Urigo and all the team at the Guild

Related # (issue)
Replaces #8350 and #14

Type of change

Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

How Has This Been Tested?

All modules have a corresponding test file that verifies the generated output.

Install the dependencies with yarrn
run yarn test

Test Environment:

OS: Garuda Linux
@graphql-codegen/...: latest
NodeJS: latest

Checklist:

I have followed the CONTRIBUTING doc and the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
[] I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published in downstream modules

TypeNamePattern are used to configure the class and its factories whiles the FieldNamePattern is used to configure the parameters. New plugin-config interface

Using tuples instead of Records, we sacrifice IDE auto-complete and bloated config for positional(poor IDE support) but compact config New interface

config-value provides some methods that parses the config and returns ready-to-consume values in the various blocks

…e domains applying DDD concepts: moved every function into its appropirate domain dropped support for customDecorators, FreezedFactoryBlockRepository class renamed to NodeRepository class, FreezedConfigValue class renamed to Config classs

The previous version mutated properties of the class to generated the output. This made it very difficult to write tests without running the whole plugin and good luck tracking bugs and wrong generated output. This rewrite used functions everywhere for everything. Being static methods, you can test each independently without having to create a full instance of the class. Using value objects eliminates the use of primitive values plus ensures that we have a valid value everytime.

changeset-bot · 2023-01-16T08:44:26Z

🦋 Changeset detected

Latest commit: b6c4b01

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@graphql-codegen/flutter-freezed	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Parables · 2023-01-16T08:49:09Z

Sincere gratitude to @auaicn and @endigo and everyone who has helped along the way 🥂

Parables · 2023-01-16T15:27:48Z

@charlypoly @Urigo we have a green flag ... over to you

saihaj · 2023-01-17T18:58:59Z

hey @Parables can you create a changeset #47 (comment)

Parables · 2023-01-17T19:41:49Z

Sure, I will that around 10pm GMT

.changeset/chatty-teachers-repeat.md

Parables · 2023-01-18T07:27:29Z

@saihaj done as requested

Parables · 2023-01-18T07:34:13Z

@saihaj I have to correct some typos and grammatical errors in the guide but I have to do that at school as I am already running late. Give me about 1 hour 30 mins to get to school so that we can continue

Parables · 2023-01-18T07:35:21Z

And please how do I fix the prettier error?

Parables · 2023-01-18T08:43:55Z

@saihaj I am back, what else do you need me to do?

saihaj · 2023-01-18T20:19:18Z

@saihaj I am back, what else do you need me to do?

@Parables can you run yarn prettier so CI is happy then I can merge and release this.

Parables · 2023-01-19T03:54:06Z

@Parables can you run yarn prettier so CI is happy then I can merge and release this.

Done that but there are no changes to be committed here on my local branch.

However, when I run yarn to install the dependencies, other packages were modified.

I didn't commit them because it was not my intention to modify them.

Any other solution?

fromJsonToJson will be implented in the next release

saihaj · 2023-01-19T21:14:17Z

@Parables can you run yarn prettier so CI is happy then I can merge and release this.

Done that but there are no changes to be committed here on my local branch.

However, when I run yarn to install the dependencies, other packages were modified.

I didn't commit them because it was not my intention to modify them.

Any other solution?

weird I pulled this branch and ran prettier and it was just this plugin b6c4b01

Parables · 2023-01-20T01:28:49Z

Thanks very much @saihaj. I couldn't have figured out this issue on my own.

The guide for this plugin on the website to has been updated.

Everything is ready now for release.

saihaj · 2023-01-20T06:27:18Z

hmm so something went wrong with CI publish flow. So will investigate it @Parables

Parables · 2023-01-20T06:40:57Z

Thanks very much for your dedication @saihaj

saihaj · 2023-01-21T09:31:28Z

/theguild newsletter

saihaj · 2023-01-22T19:59:59Z

released @Parables https://github.com/dotansimha/graphql-code-generator-community/releases/tag/release-1674417409150

Parables · 2023-01-23T01:49:52Z

Thank you all so much for the support.

This release wouldn't be possible without you:

@saihaj
@charlypoly
@Urigo
@endigo
@n1ru4l
@auaicn
@gabsn
@Ayiks
@everyone

Cheers 🥂

Parables added 8 commits January 16, 2023 02:20

feat(config): ✨ added patterns for granular configuration

332f929

TypeNamePattern are used to configure the class and its factories whiles the FieldNamePattern is used to configure the parameters. New plugin-config interface

feat(config): 💥 refactored plugin-config to use Patterns

8a9248d

Using tuples instead of Records, we sacrifice IDE auto-complete and bloated config for positional(poor IDE support) but compact config New interface

test(config): ✅ added config-value with some tests

f7507f1

config-value provides some methods that parses the config and returns ready-to-consume values in the various blocks

fix(core logic): 🎨 fixed broken indentation

780eeb9

refactor(plugin): 🔥 refactoring, code cleanup and integration testing

7986fa0

feat: 🚀 ready for v4.0.0

8b6bc7f

Parables added 3 commits January 16, 2023 08:53

fix: 🚑 fixed issue with CI

7752c6a

fix: 🚑 fixed ESM & CJS integrity issue

414e2e0

fix: 🚑 minor fix

1bb26d0

added changeset documentation

bd50772

saihaj reviewed Jan 18, 2023

View reviewed changes

.changeset/chatty-teachers-repeat.md Outdated Show resolved Hide resolved

Parables added 2 commits January 18, 2023 07:29

added missing url

92e2669

minor fix

e30a612

minor fix

778758d

saihaj approved these changes Jan 18, 2023

View reviewed changes

Parables added 2 commits January 19, 2023 05:41

docs(config): 🔥 removed fromJsonToJson config option

3637295

fromJsonToJson will be implented in the next release

Merge branch 'dotansimha:main' into flutter-freezed-v4.0.0

f5b1cc6

style: prettier:

b6c4b01

saihaj merged commit f562006 into dotansimha:main Jan 20, 2023

github-actions bot mentioned this pull request Jan 22, 2023

Upcoming Release Changes #62

Merged

Parables deleted the flutter-freezed-v4.0.0 branch January 27, 2023 17:46

pete-otaqui mentioned this pull request Dec 19, 2023

config.schema.json not valid dotansimha/graphql-code-generator#9749

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Flutter freezed v4.0.0 #47

Flutter freezed v4.0.0 #47

Parables commented Jan 16, 2023

changeset-bot bot commented Jan 16, 2023 •

edited

Loading

Parables commented Jan 16, 2023

Parables commented Jan 16, 2023

saihaj commented Jan 17, 2023

Parables commented Jan 17, 2023

Parables commented Jan 18, 2023

Parables commented Jan 18, 2023

Parables commented Jan 18, 2023

Parables commented Jan 18, 2023

saihaj commented Jan 18, 2023

Parables commented Jan 19, 2023 •

edited

Loading

saihaj commented Jan 19, 2023

Parables commented Jan 20, 2023

saihaj commented Jan 20, 2023

Parables commented Jan 20, 2023

saihaj commented Jan 21, 2023

saihaj commented Jan 22, 2023

Parables commented Jan 23, 2023 •

edited

Loading

Flutter freezed v4.0.0 #47

Flutter freezed v4.0.0 #47

Conversation

Parables commented Jan 16, 2023

Description

Type of change

How Has This Been Tested?

Checklist:

changeset-bot bot commented Jan 16, 2023 • edited Loading

🦋 Changeset detected

Parables commented Jan 16, 2023

Parables commented Jan 16, 2023

saihaj commented Jan 17, 2023

Parables commented Jan 17, 2023

Parables commented Jan 18, 2023

Parables commented Jan 18, 2023

Parables commented Jan 18, 2023

Parables commented Jan 18, 2023

saihaj commented Jan 18, 2023

Parables commented Jan 19, 2023 • edited Loading

saihaj commented Jan 19, 2023

Parables commented Jan 20, 2023

saihaj commented Jan 20, 2023

Parables commented Jan 20, 2023

saihaj commented Jan 21, 2023

saihaj commented Jan 22, 2023

Parables commented Jan 23, 2023 • edited Loading

changeset-bot bot commented Jan 16, 2023 •

edited

Loading

Parables commented Jan 19, 2023 •

edited

Loading

Parables commented Jan 23, 2023 •

edited

Loading