search

dekimir / postgres-searchbox

Enables react-instantsearch to work directly on PostgreSQL tables
Other
14 stars 1 forks source link

Feature/tests #3

Closed data-envoy closed 1 year ago

data-envoy commented 1 year ago

I've made the following changes:

Refactor for better DX Add docker-compose and jest for tests Write tests that cover current functionality. Create column and index to run w/o psql

For your consideration to merge.

I had to move quick because it's for my day job. If I had more time I would chat about changes, but in this case I used my best judgement to make progress at an acceptable pace.

I'll move to pagination next.

dekimir commented 1 year ago

This is a great addition; thank you, @data-envoy :)

data-envoy commented 1 year ago

Thanks for the review and merge.

When I was working on the project I noticed 2 things that I missed, and I the addition of one or both could improve code quality.

An auto-formatter like prettier. And, Typescript.

What do you think?

dekimir commented 1 year ago

When I was working on the project I noticed 2 things that I missed, and I the addition of one or both could improve code quality.

An auto-formatter like prettier. And, Typescript.

What do you think?

I'd love to use TypeScript. I just didn't bother learning how to properly turn it on in an npm package.

I'm not opposed to an auto-formatter, either, unless its results are overly ugly. ;)

data-envoy commented 1 year ago

WRT Typescript... I never publish packages 😅 but do usuall have a build script in package.json that compiles the TS to JS in a dist folder. Then the exports need to point to dist/.

What is your current process to publish?

I should be able to port to TS and verify here with my npm account.

dekimir commented 1 year ago

What is your current process to publish?

I run npm publish in the src/ directory. Before this PR, I ran npm publish in the root. ;)

I should be able to port to TS and verify here with my npm account.

Yes, when more people start using this package, we'll absolutely need a process like that to catch accidental breakages.