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.

Sign up for GitHub

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

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

update the library to modern standards #14

wants to merge 22 commits into from

Conversation

@joshbaskaran
Copy link
Collaborator

@joshbaskaran joshbaskaran commented Jun 18, 2025 •
edited
Loading

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

@joshbaskaran
chore: create and update lockfiles
8d2218c 
Done using `npm install`
@joshbaskaran
feat: add typescript
f2bb0f0 
includes types for node
@joshbaskaran
chore: move prettier and eslint to dev deps
c172f50
@joshbaskaran
chore: migrate eslint config from json to mjs
53dfd67 
Based to requirements from eslint v9
@joshbaskaran
feat: migrate utils to typescript
d30c825
@joshbaskaran
feat: migrate to ts
abefcea 
replaces axios with built-in fetch API calls
@joshbaskaran
feat: migrate to TS
3c32ce7
@joshbaskaran
feat: migrate to TS
4e84acf 
includes fixes in mismatch of JSDoc string and function parameters
@joshbaskaran
chore: remove axios
a57ccf5 
No longer in use
@joshbaskaran
chore: ignore dist folder
d60b329
@joshbaskaran
chore: move index and browser entry points to src
7d88c5c
@joshbaskaran
feat: setup publishing with ts
cc38b10 
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
@joshbaskaran
feat: use bun for package management
ff0d4cc
@joshbaskaran
chore: remove old eslint config
8f044e9 
Current eslint version relies on the js config instead
@joshbaskaran
chore: ignore linting of dist
9d447fb
@joshbaskaran
feat: add scripts to lint and typecheck
ee8cdb7
@joshbaskaran
chore: remove old yarn based lint check
99b9d19 
This lint check is quite primitive. A new CI workflow is being written
in the next commit with more comprehensive checks
@joshbaskaran
feat: perform lint and type-check on PRs
65d6a18 
GH actions workflow to lint, type-check and build the project. Ensures
more robustness for cont. integration
@joshbaskaran
feat: add prettier formatting check script
15eccfc 
Helps with setting up the CI pipeline
@joshbaskaran
feat: add formatting check to CI pipeline
dba111b
@joshbaskaran
fix: fixed typo
f6f9fdf
@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
@joshbaskaran
feat: update workflow for publishing to npm
72bf40a 
- 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

Reviewers

@matuskalas matuskalas Awaiting requested review from matuskalas

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@joshbaskaran