refactor: Adding ability to convert field name from camelCase to CONSTANT_CASE if `varName` is not specified for `@EnvField` by ryanaidilp · Pull Request #42 · petercinibulk/envied

ryanaidilp · 2023-07-13T04:34:34Z

This pull request adds a new feature to the envied package, allowing the conversion of field names from camelCase to CONSTANT_CASE if the @EnvField annotation is not provided with a specific varName. The motivation behind this enhancement is to adhere to the Effective Dart rules of naming conventions, which specify that variables and field names should start with lowercase letters and use uppercase for the first letter of each subsequent word, such as firstName, secondName, and getAllColors.

With this new functionality, the envied package will automatically transform the field names into CONSTANT_CASE format when the @EnvField annotation is not explicitly assigned a varName. This conversion ensures compliance with the prescribed naming conventions, promoting consistency and readability in the codebase.

The implementation includes logic to detect when the @EnvField annotation is not provided with a varName and applies the necessary transformation to convert the field name from camelCase to CONSTANT_CASE. This feature adds flexibility and convenience to the package, enabling developers to adhere to the recommended naming conventions effortlessly.

This pull request aligns with the goals of the envied package by promoting best practices and making it easier for users to adopt effective coding standards. It contributes to the overall quality and maintainability of projects utilizing the envied package.

Thank you for considering this pull request. I am confident that this feature will enhance the functionality and usability of the envied package, benefiting developers who strive to follow the Effective Dart naming conventions.

techouse · 2023-11-05T18:59:16Z

Hi @ryanaidilp

Can you please resolve the merge conflicts with the main branch?

ryanaidilp · 2023-11-09T09:45:49Z

Hi @ryanaidilp

Can you please resolve the merge conflicts with the main branch?

Okay, resolving it now.

techouse · 2023-11-09T10:19:24Z

Couple of observations:

if this is a breaking change, it should not be a default behaviour but rather enabled by a flag
you might also want to use somehting like recase instead of rolling your own string conversions

import 'package:recase/recase.dart';

final String varName = 'camelCaseVariable'.constantCase; // becomes CAMEL_CASE_VARIABLE

ryanaidilp · 2023-11-09T12:00:31Z

Couple of observations:

if this is a breaking change, it should not be a default behaviour but rather enabled by a flag

you might also want to use somehting like recase instead of rolling your own string conversions
import 'package:recase/recase.dart';

final String varName = 'camelCaseVariable'.constantCase; // becomes CAMEL_CASE_VARIABLE

Thank you for your feedback! I appreciate your suggestions.

Regarding your first point, I've implemented your advice and added a flag to enable and disable this feature. It's no longer the default behavior.

Additionally, I've integrated the recase package for more robust string conversions.

I've already pushed these changes in my recent commit. Kindly review it, and feel free to let me know if you have any more suggestions or concerns. Your input is valuable to improve the package further.

petercinibulk · 2023-11-09T14:35:21Z

@ryanaidilp Sorry to make you have to handle conflicts again but we just pushed some updates that have conflicts with this PR

replace my own string helper with recase to convert string case to constant case

ryanaidilp · 2023-11-09T16:19:41Z

@ryanaidilp Sorry to make you have to handle conflicts again but we just pushed some updates that have conflicts with this PR

No worries at all! I've resolved the conflicts in my recent commits. Let me know if there's anything else needed.

techouse · 2023-11-09T17:01:27Z

No worries at all! I've resolved the conflicts in my recent commits. Let me know if there's anything else needed.

@ryanaidilp We merged #72 into origin/main earlier, so I resolved the merge conflicts for you. Check if everything is in order, please and if you're happy with it we can merge this into origin/main. 😇

ryanaidilp

LGTM 🚀. Thanks for the update! Everything looks good to me. Please go ahead and merge it into main. Appreciate your assistance! 😇

ryanaidilp changed the title ~~Adding ability to convert field name from camelCase to UPPER_SNAKE_CASE if varName is not specified for @EnvField~~ refactor: Adding ability to convert field name from camelCase to UPPER_SNAKE_CASE if varName is not specified for @EnvField Jul 13, 2023

ryanaidilp force-pushed the main branch from edcc78a to 14aa4d3 Compare November 9, 2023 10:51

ryanaidilp requested review from petercinibulk and techouse as code owners November 9, 2023 10:51

ryanaidilp added 16 commits November 10, 2023 00:06

feat(casing): add variable name casing

501f7f5

fix(conflict): resolve conflict in generator.dart

7d44072

test: fix failed unit test

e2e2574

fix(example): fix example env

b626bf6

chore(packages): install recase

f920677

refactor(generator): replace my own string helper with recase

4a80395

replace my own string helper with recase to convert string case to constant case

refactor(envied): add useConstantCase flag to envied base

d5d38c1

test(envied): add test for the useConstantCase flag

f57cb40

refactor(envied_field): add useConstantCase flag

1091f79

test(envied_field): add test for useConstantCase on EnviedField

214c773

refactor(generator): add check for useConstantCase flag

ca1a87e

test(generator): update generator test to test useConstantCase flag

85a5b48

test(example.env): update env.example test

8bba1e4

refactor(example): update example app to accomodate new changes

64df593

fix(typo): fix typo in env name casing

132e9e9

test(generator): fix failed test in generator

0b51ce9

ryanaidilp force-pushed the main branch from 0858303 to 0b51ce9 Compare November 9, 2023 16:18

ryanaidilp changed the title ~~refactor: Adding ability to convert field name from camelCase to UPPER_SNAKE_CASE if varName is not specified for @EnvField~~ refactor: Adding ability to convert field name from camelCase to CONSTANT_CASE if varName is not specified for @EnvField Nov 9, 2023

techouse self-assigned this Nov 9, 2023

techouse added the enhancement New feature or request label Nov 9, 2023

Merge branch 'main' into main

c8ac8dd

techouse approved these changes Nov 9, 2023

View reviewed changes

ryanaidilp commented Nov 10, 2023

View reviewed changes

techouse merged commit b4ed8d7 into petercinibulk:main Nov 10, 2023

This was referenced Nov 10, 2023

feat: add Enum support #73

Merged

chore: release v0.5.2 #76

Merged

Navigation Menu

Repository navigation

refactor: Adding ability to convert field name from camelCase to CONSTANT_CASE if `varName` is not specified for `@EnvField` - #42

refactor: Adding ability to convert field name from camelCase to CONSTANT_CASE if `varName` is not specified for `@EnvField`#42
techouse merged 17 commits into
petercinibulk:mainfrom
ryanaidilp:main

ryanaidilp commented Jul 13, 2023 •

edited

Loading

Uh oh!

techouse commented Nov 5, 2023

Uh oh!

ryanaidilp commented Nov 9, 2023

Uh oh!

techouse commented Nov 9, 2023 •

edited

Loading

Uh oh!

ryanaidilp commented Nov 9, 2023 •

edited

Loading

Uh oh!

petercinibulk commented Nov 9, 2023

Uh oh!

ryanaidilp commented Nov 9, 2023

Uh oh!

techouse commented Nov 9, 2023 •

edited

Loading

Uh oh!

ryanaidilp left a comment •

edited

Loading

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

ryanaidilp commented Jul 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

techouse commented Nov 5, 2023

Uh oh!

ryanaidilp commented Nov 9, 2023

Uh oh!

techouse commented Nov 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ryanaidilp commented Nov 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

petercinibulk commented Nov 9, 2023

Uh oh!

ryanaidilp commented Nov 9, 2023

Uh oh!

techouse commented Nov 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ryanaidilp left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ryanaidilp commented Jul 13, 2023 •

edited

Loading

techouse commented Nov 9, 2023 •

edited

Loading

ryanaidilp commented Nov 9, 2023 •

edited

Loading

techouse commented Nov 9, 2023 •

edited

Loading

ryanaidilp left a comment •

edited

Loading