Skip to content

update the library to modern standards #14

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

Open
wants to merge 22 commits into
base: main
Choose a base branch
from

Conversation

joshbaskaran
Copy link
Collaborator

@joshbaskaran joshbaskaran commented Jun 18, 2025

The current stuff in this library is quite old and needs some TLC.

This PR aim to do the following:

  1. Migrate to TS - modern projects in the JS ecosystem have almost entirely moved on to TS. The changes here allow this library to be used with TS projects without the consumer having to annotate everything with any losing out on all the LSP support
  2. Update dependencies - The dependencies used here haven't been updates for quite some time and needs to be updated. The PR also aims to remove unnecessary dependencies and move some build time deps to dev dependencies to the prevent them from being bundled
  3. Use bun - mostly to replace npm and yarn for package management efficiency. It's significantly faster than both npm and yarn. (NB!: one is free to use any of npm, yarn, pnpm or bun locally. Bun is used here to enable faster and more efficient builds/ checks in the GH actions and workflows)
  4. Update GH actions workflows to bring them up to speed

Done using `npm install`
includes types for node
Based to requirements from eslint v9
replaces axios with built-in fetch API calls
includes fixes in mismatch of JSDoc string and function parameters
No longer in use
Includes setting up of rollup for building the required js and d.ts
files for browser and node usage
@joshbaskaran joshbaskaran requested a review from matuskalas June 18, 2025 07:41
Current eslint version relies on the js config instead
This lint check is quite primitive. A new CI workflow is being written
in the next commit with more comprehensive checks
GH actions workflow to lint, type-check and build the project. Ensures
more robustness for cont. integration
Helps with setting up the CI pipeline
@joshbaskaran joshbaskaran marked this pull request as ready for review June 18, 2025 08:33
@joshbaskaran joshbaskaran marked this pull request as draft June 18, 2025 08:34
- Updated the workflow to use bun+npm instead of yarn. Bun for effciency
and npm to publish

- changes from publish on push to publish on release. This change
requires a manual release in github to trigger this workflow
@joshbaskaran joshbaskaran marked this pull request as ready for review June 18, 2025 08:54
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.

1 participant