Skip to content

Commit

Permalink
chore(doc): rm yarn in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fannheyward committed Sep 1, 2023
1 parent 16cdb59 commit fbd9928
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 11 deletions.
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ jobs:

- name: Install Dependencies
run: |
npm i -g bytes
npm ci
sudo apt-get install -y xclip ripgrep exuberant-ctags
xclip -version
Expand Down
7 changes: 3 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,13 @@ If this seems like a lot or you aren't able to do all this setup, you might also
If you want to go the usual route and run the project locally, though:

- [Install Node.js](https://nodejs.org/en/download/)
- [Install Yarn](https://yarnpkg.com)
- [Fork the project](https://guides.github.com/activities/forking/#fork)

Then in your terminal:

- Add coc.nvim to your vim's rtp by `set runtimepath^=/path/to/coc.nvim`
- `cd path/to/your/coc.nvim`
- `yarn install`
- `npm install`
- Install [coc-tsserver](https://github.com/neoclide/coc-tsserver) by
`:CocInstall coc-tsserver` in your vim
- Install [coc-eslint](https://github.com/neoclide/coc-eslint) by
Expand Down Expand Up @@ -72,10 +71,10 @@ To contribute code:
- [Set up the project](#project-setup).
- Make any necessary changes to the source code.
- Include any [additional documentation](#contribute-documentation) the changes might need.
- Make sure the code doesn't have lint issue by command `yarn lint` in your
- Make sure the code doesn't have lint issue by command `npm run lint` in your
terminal.
- Write tests that verify that your contribution works as expected when necessary.
- Make sure all tests passed by command `yarn jest` in your terminal.
- Make sure all tests passed by command `npm test` in your terminal.
- Write clear, concise commit message(s) using [conventional-changelog format](https://github.com/conventional-changelog/conventional-changelog-angular/blob/master/convention.md).
- Dependency updates, additions, or removals must be in individual commits, and the message must use the format: `<prefix>(deps): PKG@VERSION`, where `<prefix>` is any of the usual `conventional-changelog` prefixes, at your discretion.
- Go to https://github.com/neoclide/coc.nvim/pulls and open a new pull request with your changes.
Expand Down
2 changes: 1 addition & 1 deletion doc/coc-api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ To manually create an extension, follow these step:
Recommended steps:

• Install types of NodeJS and coc.nvim by terminal command
`yarn install @types/[email protected] coc.nvim` in extension folder.
`npm install @types/[email protected] coc.nvim` in extension folder.
• Bundle the javascript files when using multiple node dependencies by
esbuild to save the time of installation. A typical build script looks
like:
Expand Down
9 changes: 3 additions & 6 deletions doc/coc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,6 @@ Neovim >= 0.4.0 or Vim >= 8.1.1719.

NodeJS https://nodejs.org/ >= 16.18.0.

Yarn https://yarnpkg.com/ required to build coc.nvim from typescript source
code.

==============================================================================
INSTALLATION *coc-installation*

Expand Down Expand Up @@ -142,8 +139,8 @@ To use Vim's native |packages| on Linux or MaxOS, use script like: >
curl --fail -L https://github.com/neoclide/coc.nvim/archive/release.tar.gz|tar xzfv -
nvim -c 'helptags ~/.local/share/nvim/site/pack/coc/start|q'
when using source code of coc.nvim, you'll have to install
https://yarnpkg.com/ and run `yarn install` in project root of coc.nvim.
when using source code of coc.nvim, you'll have to run `npm install` in project
root of coc.nvim.

==============================================================================
EXTENSIONS *coc-extensions*
Expand All @@ -165,7 +162,7 @@ See |coc-api-extension| for the guide to create coc.nvim extension.
Install extensions from git (not recommended):~

• Download the source code.
• In project root, install dependencies and compile the code by `yarn install`
• In project root, install dependencies and compile the code by `npm install`
(needed by most coc extensions).
• Add the project root to vim's runtimepath by `set runtimepath^=/path/to/project`

Expand Down

0 comments on commit fbd9928

Please sign in to comment.