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

chore: setup library #1

Merged
merged 8 commits into from
Jul 26, 2024
Merged

chore: setup library #1

merged 8 commits into from
Jul 26, 2024

Conversation

peterpeterparker
Copy link
Member

@peterpeterparker peterpeterparker commented Jul 26, 2024

Motivation

This PR sets up the bundling of a JS library for both browser and NodeJS contexts. It includes the following features:

  • Building: esbuild for building the library and tsc for declarations
  • Testing: Uses Vitest for tests
  • Linting: Integrates ESLint for checking code best practices
  • CI/CD: Adds GitHub Actions to perform automated checks and tests on each PR
  • Publishing: Provides actions to publish the library to npm, supporting both official and next versions

The PR also provides a template for PR.

Notes

The setup is similar to many repositories of libraries within the Gix team. To avoid replicating the setup and prevent code duplication, we should consider creating a template or tool for the foundation, some day 😄.

Copy link
Contributor

@ulan ulan left a comment

Choose a reason for hiding this comment

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

Amazing, thanks a lot for the help!

@peterpeterparker peterpeterparker merged commit 46122bb into main Jul 26, 2024
7 checks passed
@peterpeterparker peterpeterparker deleted the chore/setup-library branch July 26, 2024 07:29
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