waku-org / js-waku

JavaScript implementation of Waku v2
https://js.waku.org
Apache License 2.0
169 stars 42 forks source link

chore: standardise exports to camel case #1933

Open danisharora099 opened 7 months ago

danisharora099 commented 7 months ago

This is a change request

Problem

We currently have camel case as well as snake case exports within our codebase:

image

Proposed Solutions

Standardise it to use camel case

Notes

varunsh20 commented 7 months ago

Can I start working on it?

weboko commented 7 months ago

of course @varunsh20 ! ping me if you need any help with it

danisharora099 commented 7 months ago

sounds good -- let's confirm the scope of this issue before we move forward.

@waku-org/js-waku-developers are we deciding to stick with camel case? also related: our file names are done in snake-case. how do we feel about that change? @weboko

varunsh20 commented 7 months ago

image

there are already functions defined in these modules with the same name in camel casing, shall I rename those functions or rename the module name along with camel casing?

weboko commented 7 months ago

are we deciding to stick with camel case?

we already are using camel case almost everywhere for our code (as you noted - not files or packages tought)

our file names are done in snake-case

I think we can keep files for later to be changed, maybe as follow up @danisharora099


@varunsh20 good observation. To me it seems fine to rename waku_filter or other similar exports of a module to wakuFilterModule

cc @waku-org/js-waku-developers

varunsh20 commented 7 months ago

Please review it and let me know if any changes are required.

weboko commented 6 months ago

@varunsh20 apologies for such long reply as our team had some activities this month. Ping if your are willing to complete this task or interested in contributing more!

danisharora099 commented 6 months ago

@varunsh20 I had left a review on your PR https://github.com/waku-org/js-waku/pull/1934#issuecomment-2044647535

danisharora099 commented 6 months ago

Hey @varunsh20 are you still interested in addressing comments on the PR? Mostly seems good, just need to ensure CI passes.

danisharora099 commented 5 months ago

Up for grabs again