diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ec7a6c1769b..94eda080641 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1126bf30590..4cf684ac63c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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: `(deps): PKG@VERSION`, where `` 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. diff --git a/doc/coc-api.txt b/doc/coc-api.txt index f40f6a14c6d..bb55f305fa2 100644 --- a/doc/coc-api.txt +++ b/doc/coc-api.txt @@ -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/node@16.18 coc.nvim` in extension folder. + `npm install @types/node@16.18 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: diff --git a/doc/coc.txt b/doc/coc.txt index 3451689fcff..276f56120cb 100644 --- a/doc/coc.txt +++ b/doc/coc.txt @@ -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* @@ -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* @@ -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`