Repository navigation
docs(packages): fix core description and add keywords to all packages - #191
Merged
Merged
Conversation
The @next-model/core description was stale leftover from an AWS-focused
fork ("AWS Data API model layer package ... to use in lambda") and its
keywords advertised connector-specific tech (pg, aws, data api, serverless)
that don't belong on the storage-agnostic core. Rewrite it as the typed,
promise-based ORM it actually is, and replace the keywords accordingly.
Also:
- Improve two terse/awkward descriptions (knex-connector, aurora-data-api).
- Add a consistent keywords scheme to all 19 packages that had none, for
npm discoverability (shared base + package-specific terms).
Contributor
Coverage report
Posted by |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
The
@next-model/corepackage description was stale — leftover from an old AWS-focused fork:Its keywords were similarly misleading, advertising connector-specific tech (
pg,postgres,mysql,data api,aws,serverless) that has no business on the storage-agnostic core.This PR corrects the core metadata and, while there, brings every published package's
package.jsonmetadata up to standard.Changes
core — the headline fix:
A typed, promise-based ORM for TypeScript. Declare models with a factory, chain immutable query scopes, manage associations, and plug in any storage via the Connector interface — with validators, callbacks, soft deletes, and a built-in in-memory connector.next-model, orm, typescript, model, database, query-builder, active-record, migrations, validation, esm(dropped the connector-specific/AWS terms).Improved two terse/awkward descriptions:
knex-connector: now names Knex 3 and the supported dialects.aurora-data-api-connector: now describes the RDS Data API / Aurora Serverless v1 targeting and the connection-less, Lambda-friendly design.Keywords added to all 19 packages that had none — a consistent scheme (shared
next-model/ormbase + package-specific terms like driver, framework, or DB name) for npm discoverability.The other 16 descriptions were already accurate against the README and are unchanged.
Verification
package.jsonfiles parse as valid JSON.biome formatreports no changes needed (matches repo style).^3.2.10, Aurora Serverless v1 via RDS Data API, core tagline matches its own README.Scope: only the 20 published packages under
packages/. Thedemos/andexamples/packages areprivatewith no descriptions and are out of scope.