Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[chore] common-utils module #2773

Merged
merged 2 commits into from
Nov 20, 2024
Merged

[chore] common-utils module #2773

merged 2 commits into from
Nov 20, 2024

Conversation

igorDykhta
Copy link
Collaborator

@igorDykhta igorDykhta commented Nov 20, 2024

  • separate common utils module, utils without heavy dependencies

Signed-off-by: Ihor Dykhta <dikhta.igor@gmail.com>
@igorDykhta igorDykhta requested review from ilyabo and ibgreen November 20, 2024 01:53
Copy link

netlify bot commented Nov 20, 2024

Deploy Preview for keplergl2 ready!

Name Link
🔨 Latest commit be8c8d9
🔍 Latest deploy log https://app.netlify.com/sites/keplergl2/deploys/673d4645ff1c520008b52473
😎 Deploy Preview https://deploy-preview-2773--keplergl2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Signed-off-by: Ihor Dykhta <dikhta.igor@gmail.com>
Copy link
Collaborator

@ilyabo ilyabo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@igorDykhta igorDykhta merged commit 13b469d into master Nov 20, 2024
12 checks passed
@igorDykhta igorDykhta deleted the igr/common-utils-module branch November 20, 2024 17:48
Copy link
Collaborator

@ibgreen ibgreen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something called common-utils quickly tends to become a "trash can" of unrelated things.

I do see a bunch of data-type-utils in there, and it seems to wrap type-analyzer in a couple of places which I personally think is a good direction.

Should each module have a README describing what it does?
Should it have any documentation?
Should it have any tests?

@@ -18,6 +18,7 @@
"workspaces": [
"./src/types",
"./src/constants",
"./src/common-utils",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: I wish we could change the top level src to modules or packages... src/<module>/src is kind of confusing...

import {range} from 'd3-array';
import {isHexWkb, notNullorUndefined} from './data';

export const ACCEPTED_ANALYZER_TYPES = [
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Can we add a TSDoc comment in front of every type, function, field/member/method?

In this comment maybe state what it would mean for a type not to be accepted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants