-
Notifications
You must be signed in to change notification settings - Fork 1
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: code cleanup and re-org #154
Conversation
- Remove code replaced by new DataStore, DataType and IndexWriter implementations - Skip failing tests for now - Move all code to `src` folder to prepare for compiling typescript declaration files for package publishing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couple of minor questions but otherwise lgtm!
Didn't want to comment on all potentially generated files, but would be helpful to have first-line comments for those files to indicate that they're generated, so we don't accidentally attempt to manually update them in the future
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is this a generated file? if so, is there a way to add a comment here to indicate that?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. Not sure. Let's address in a separate issue (this PR doesn't change this file)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
would test.todo
be more appropriate for these or does it not really matter?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll just remember for now, will be working on this next week.
* main: chore: remove todo comments (#159)
implementations
src
folder to prepare for compiling typescriptdeclaration files for package publishing
Why move everything into
src
? For publishing we need to compile Typescript declarations (.d.ts
). It's difficult to manage outputting these alongside the source files, it's easier to manage if all declarations go in adist
folder. However if there are JS files that need type-checked in the top-level project folder, then Typescript config can be a pain. Typescript is easiest to configure when all code that needs to be compiled is in a single folder, for whichsrc
makes the most sense.