ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

refactor(global): remove yarn in favor for npm

Browse Source 
re #2087
This commit is contained in:
Dominik Biedebach
2022-05-10 15:30:14 +02:00
committed by Dominik
parent 5bc77081b7
commit 80de6cdf18
9 changed files with 73 additions and 7856 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/overview/contributing.md
View File

@@ -20,19 +20,19 @@ tiptap would be nothing without its lively community. Contributions have always
Make sure to open an issue and outline your idea first. We’ll get back to you quickly and let you know if there is a chance we can merge your contribution.
## Set up the development environment
It’s not too hard to tinker around with the official repository. You’ll need [Git](https://github.com/git-guides/install-git), [Node](https://nodejs.org/en/download/) and [Yarn](https://classic.yarnpkg.com/en/docs/install/#mac-stable) installed. Here is what you need to do then:
It’s not too hard to tinker around with the official repository. You’ll need [Git](https://github.com/git-guides/install-git), [Node and NPM](https://nodejs.org/en/download/) installed. Here is what you need to do then:
1. Copy the code to your local machine: `$ git clone git@github.com:ueberdosis/tiptap.git`
2. Install dependencies: `$ yarn install`
3. Start the development environment: `$ yarn start`
2. Install dependencies: `$ npm install`
3. Start the development environment: `$ npm run start`
4. Open http://localhost:3000 in your favorite browser.
5. Start playing around!
## Our code style
There is an eslint config that ensures a consistent code style. To check for errors, run `$ yarn run lint`. That’ll be checked when you send a pull request, too. Make sure it’s passing, before sending a pull request.
There is an eslint config that ensures a consistent code style. To check for errors, run `$ npm run lint`. That’ll be checked when you send a pull request, too. Make sure it’s passing, before sending a pull request.
## Testing for errors
Your pull request will automatically execute all our existing tests. Make sure that they all pass, before sending a pull request. Run all tests locally with `$ yarn run test` or run single tests (e. g. when writing new ones) with `$ yarn run test:open`.
Your pull request will automatically execute all our existing tests. Make sure that they all pass, before sending a pull request. Run all tests locally with `$ npm run test` or run single tests (e. g. when writing new ones) with `$ npm run test:open`.
## Further questions
Any further questions? Create a new issue or discussion in the repository. We’ll get back to you.

14
docs/overview/upgrade-guide.md
View File

@@ -35,19 +35,9 @@ npm install @tiptap/vue-2 @tiptap/starter-kit
```
## Keep Tiptap v2 up to date
We are constantly releasing updates to Tiptap. Did you know there’s an easy-to-use command to update your dependencies with Yarn?
We are constantly releasing updates to Tiptap.
```bash
yarn upgrade-interactive
```
You can add the `--latest` flag, to show all possible upgrades – even if they don’t follow the versioning you’ve set in your package.json.
```bash
yarn upgrade-interactive --latest
```
Unfortunately, for npm there is no integrated tool, but you can use the `npm-check` package:
Unfortunately, for npm there is no integrated tool to easily update your dependencies, but you can use the `npm-check` package:
```bash
npm install -g npm-check