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

feat(sdk): init sdk package with biome and a precommit hook #2599

Merged
merged 1 commit into from
Dec 3, 2024

Conversation

ga-reth
Copy link
Contributor

@ga-reth ga-reth commented Dec 2, 2024

initialise the SDK package with:

  • SDK subdir
  • typescript dependency
  • compilation / clean steps
  • gitignore
  • typed abi file
  • top level readme

issue: none

@ga-reth ga-reth requested a review from kevinhalliday December 2, 2024 16:32
Copy link
Contributor

@kevinhalliday kevinhalliday left a comment

Choose a reason for hiding this comment

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

Couple thoughts in comments.

Looks like we've got pre-commit hooks failing. Fix those. And then not would be a good time to introduce some ts precommit / ci hooks. typechecking, linting, formatting, tests

@@ -0,0 +1,3 @@
{
"type": "module"
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we need these (this and src/types/package.json)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

for the pnpm workspaces setup, the presence of each package.json indicates a new submodule within the workspace

@@ -0,0 +1,2 @@
packages:
- 'src'
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm good with using a workspace but like we said live, might be best just to start with single package until we have need for multiple

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sounds good, i'll revert to a more simple setup

@ga-reth
Copy link
Contributor Author

ga-reth commented Dec 2, 2024

hey @kevinhalliday i've dropped the workspaces stuff, and added compilation / clean steps, i'll add precommit stuff in a followup

@ga-reth ga-reth changed the title feat(sdk): init sdk package feat(sdk): init sdk package with biome and a precommit hook Dec 2, 2024
@ga-reth
Copy link
Contributor Author

ga-reth commented Dec 2, 2024

@kevinhalliday i've added biome for linting/formatting and a precommit hook

@ga-reth ga-reth merged commit 8cc493f into main Dec 3, 2024
19 checks passed
@ga-reth ga-reth deleted the gv/init-sdk-dir branch December 3, 2024 16:05
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.

2 participants