Skip to content
This repository was archived by the owner on Jun 27, 2025. It is now read-only.

[FEAT] major refactoring #12

Merged
merged 1 commit into from
Jun 27, 2025
Merged

[FEAT] major refactoring #12

merged 1 commit into from
Jun 27, 2025

Conversation

darcyclarke
Copy link
Member

@darcyclarke darcyclarke commented Mar 28, 2025

This pull request introduces several important updates to improve the development workflow, documentation, and configuration of the VSR project. The most significant changes include the addition of contribution and issue templates, updates to the development and deployment processes, and enhancements to database management.

Features:

  • accept-integrity checking to tarball endpoints (is a fast path for lockfile/cache validation)
  • support proxying of configured upstream registry packages
  • support semver range filters for package packuments & manifests (ex. /express/^1.2.3 or /react/>=1 returns a single version/manifest if one matches & /express?versionRange=>1 will return all packages matching the range for packuments)
  • custom dist-tag support & validation (ex. npm dist-tag ... now works)
  • search support (ex. npm search ... now works)
  • package user access management (ex. npm access ... now works)
  • web login support (ex. npm login ... now works)
  • added drizzle orm & drizzle studio for local dev

These changes collectively enhance the development experience, improve documentation, and streamline workflows for contributors.

@darcyclarke darcyclarke added the enhancement New feature or request label Mar 28, 2025
@darcyclarke darcyclarke requested a review from Copilot March 28, 2025 21:49
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request introduces important workflow, documentation, and configuration enhancements to the VSR project. Key changes include the addition and update of contributing/issue/pull-request templates, improvements to the development and deployment processes (including database management and GitHub Actions workflows), and updates to API documentation for enhanced clarity.

Reviewed Changes

Copilot reviewed 49 out of 56 changed files in this pull request and generated no comments.

Show a summary per file
File Description
src/db/client.ts Adds helper functions and operations for type-safe database access
src/api.js Enhances API descriptions and response schemas
scripts/check-db.js Introduces a database checker script
scripts/build.mjs Removes obsolete build script
drizzle.config.ts Configures Drizzle Kit to locate the correct SQLite database file
config.js Updates proxy configuration settings
README.md Fixes typo and adds link to CONTRIBUTING guide
CONTRIBUTING.md and other templates Adds and updates documentation and templates
.github/workflows/publish.yml Adds a GitHub Actions workflow for project publishing
Other .github files Provides updated issue/feature/bug report templates and contribution guidance
Files not reviewed (7)
  • package.json: Language not supported
  • src/db/migrations/0000_faulty_ricochet.sql: Language not supported
  • src/db/migrations/0000_initial.sql: Language not supported
  • src/db/migrations/0001_uuid_validation.sql: Language not supported
  • src/db/migrations/drop.sql: Language not supported
  • src/db/migrations/meta/0000_snapshot.json: Language not supported
  • src/db/migrations/meta/_journal.json: Language not supported
Comments suppressed due to low confidence (2)

config.js:6

  • Changing the configuration from an array (PROXIES) to a boolean (PROXY) along with the addition of PROXY_URL could introduce breaking changes if other parts of the codebase expect an array for proxy settings. Please ensure that all references to proxy settings are updated accordingly.
export const PROXY = true

README.md:49

  • Corrected the typo 'tbe' to 'the' in the README to improve clarity.
# run the development script

@JustFly1984
Copy link

How close is this PR to merge and release?

@darcyclarke
Copy link
Member Author

darcyclarke commented Mar 31, 2025

@JustFly1984 it should be out this week it's taken a lot longer to roll this out (apologies).

@darcyclarke darcyclarke added the documentation Improvements or additions to documentation label May 21, 2025
@darcyclarke darcyclarke marked this pull request as ready for review June 27, 2025 15:42
@darcyclarke darcyclarke changed the title WIP: some major improvements [WIP] Major refactor Jun 27, 2025
@darcyclarke darcyclarke force-pushed the darcyclarke/refactoring branch 2 times, most recently from f1ecce1 to a71be0f Compare June 27, 2025 20:01
@darcyclarke darcyclarke changed the title [WIP] Major refactor [FEAT] major refactoring Jun 27, 2025
@darcyclarke darcyclarke force-pushed the darcyclarke/refactoring branch 2 times, most recently from a93a507 to 0d5ae30 Compare June 27, 2025 20:06
- remove dist
- add build scripts
- typescript transition
- proxying upstreams support
- database schema changes
- test suite
- updated documentation
- new configuration
- better logging
- net-new tracing
- better packument caching (stale-while-revalidate)
- search support
- dist tage & access control
- rate limiting
- better error handling
@darcyclarke darcyclarke force-pushed the darcyclarke/refactoring branch from 0e015da to 06ba347 Compare June 27, 2025 22:35
@darcyclarke darcyclarke merged commit 8204b40 into main Jun 27, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants