Skip to content

Make @markdoc/markdoc a peer dependency #3

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 17, 2022
Merged

Make @markdoc/markdoc a peer dependency #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The first thing you'll need to do is install `@markdoc/next.js` and add it to yo

1. From your project, run this command to install `@markdoc/next.js`:
```sh
npm install @markdoc/next.js
npm install @markdoc/next.js @markdoc/markdoc
Copy link

Choose a reason for hiding this comment

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

when should we just change these instructions to be

npx create-next-app --with-markdoc

?

I guess when this is not in beta anymore?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

^ Once that command works 🙂

```
2. Open `next.config.js` and add the following code:

Expand Down
6 changes: 4 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,19 @@
"test": "jest"
},
"dependencies": {
"@markdoc/markdoc": "0.1.1",
"js-yaml": "^4.1.0"
},
"devDependencies": {
"@babel/core": "^7.16.12",
"@babel/plugin-transform-modules-commonjs": "^7.16.8",
"@markdoc/markdoc": "^0.1.1",
Copy link

Choose a reason for hiding this comment

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

do we need it as a dev dependency if it is a peer dependency?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

^ if we want to be able to use it in our tests we do.

"@types/jest": "^27.4.1",
"jest": "^27.5.1",
"ts-jest": "^27.1.3",
"typescript": "4.6.2"
},
"peerDependencies": {
"@markdoc/markdoc": "^0.1.1",
Copy link

Choose a reason for hiding this comment

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

we are still treating every version as unstable until v1.0.0 right?

(thinking of the case where a change is made to core markdoc and the next js plugin breaks because we forget to up this dependency)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We still have a lock file, so it won't grab the new version unless we update the lockfile, right?

Copy link

@matv-stripe matv-stripe May 16, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

I thought ^0.1.1 meant it would just pick the latest 0.*.*, but I could be wrong. (So if 0.2.0 adds a breaking change, it would break the next js plugin until it is updated)

Copy link

Choose a reason for hiding this comment

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

But I always forget the specifics of how this works

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah I think that is how it worked before lock files?

"next": "*",
"react": "*"
},
Expand Down