Make example folder self-contained #340
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
orangain
commented
Feb 11, 2024
Comment on lines
-31
to
-33
| "run-example": "node build/cli -c ./example/.schemalintrc", | ||
| "start-example-db": "docker run -d --name dvd-rental -p 54321:5432 kristiandupont/dvdrental-image", | ||
| "stop-example-db": "docker stop dvd-rental", |
There was a problem hiding this comment.
These scripts have been moved to example/package.json. If you are using the scripts to run the example against a local version of the library, I would revert this change.
example/package.json
Outdated
| "author": "", | ||
| "license": "ISC", | ||
| "devDependencies": { | ||
| "schemalint": "^1.1.0" |
There was a problem hiding this comment.
Maybe this should just be version "*"?
There was a problem hiding this comment.
I agree with you. Using "*" would save us the trouble of keeping up with the latest version. Update in 954dd48.
|
Let me know if you agree with my comment, if not I am happy to just merge this. |
|
🙏 |
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.
Motivation
Currently, the instructions for running the example folder use the npm scripts that is defined in the parent folder. This makes it a bit difficult for a user to copy the contents in the example folder to their project and run it.
Instead, I would propose to create a
package.jsonfile in the example folder and define the npm scripts in it. I would also propose that theschmealintlibrary be installed from the npm registry in the example folder.This way, the user can simply copy the contents of the example folder to their project and run it. I believe this will make it easier for the user to start using the library.