feat!: rename to @comapeo/schema
#260
Merged
Conversation
This file contains 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
EvanHahn
commented
Sep 16, 2024
| @@ -1,6 +1,6 @@ | |||
| ## Build steps | |||
|
|
|||
| 1. `npm run generate` will generate type definitions and encode/decode functions from `.proto` files, and generate type definitions from json schema files, and place them in `generated`. It will also generate validation functions from json schema files and place that in `dist`. | |||
| 1. `npm run build:generate` will generate type definitions and encode/decode functions from `.proto` files, and generate type definitions from json schema files, and place them in `generated`. It will also generate validation functions from json schema files and place that in `dist`. | |||
There was a problem hiding this comment.
Not strictly related, but this was incorrect.
|
|
||
| [](https://travis-ci.org/digidem/mapeo-schema) |
There was a problem hiding this comment.
I removed these badges. We don't use Travis CI or Standard style, and I didn't feel like updating the npm badge for a version that doesn't (yet) exist.
| const mapeoSchema = require('mapeo-schema') | ||
| // also | ||
| const validateObservation = require('mapeo-schema/validateObservation') | ||
| import { validate } from '@comapeo/schema' |
There was a problem hiding this comment.
Updated these code examples.
| @@ -53,34 +49,6 @@ const myObs: Observation = {...} | |||
|
|
|||
| [@digidem](https://github.com/digidem) | |||
|
|
|||
| ## Contributing | |||
There was a problem hiding this comment.
I removed this whole section because I think it's outdated.
| @@ -78,11 +78,6 @@ export function parseVersionId(versionId: string): VersionIdObject { | |||
| return { coreDiscoveryKey, index } | |||
| } | |||
|
|
|||
| /** | |||
| * @template {import('@mapeo/schema').MapeoDoc & { forks?: string[] }} T | |||
There was a problem hiding this comment.
This referred to @mapeo/schema, but it didn't actually do anything because this is a TypeScript file. Rather than update the reference, I just removed all of it.
tomasciccola
approved these changes
Sep 17, 2024
This was referenced Sep 17, 2024
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.
Closes #194.