diff --git a/install.sh b/install.sh index fe2790c..36caa48 100644 --- a/install.sh +++ b/install.sh @@ -1,17 +1,11 @@ #!/bin/sh +[ "$1" ] || (echo 'Must provide node.js package manager' && exit) + git clone 'git@github.com:wix/import-cost.git' || (echo 'Failed to clone wix/import-cost' && exit) -echo 'Install import-cost with which package manager? [npm/yarn]' -read -r installer - -if [ "$installer" != 'npm' ] && [ "$installer" != 'yarn' ]; then - echo "Please enter either 'npm' or 'yarn'" - exit -fi - cd import-cost || exit -eval "$installer install" +$1 install cd .. cp index.js import-cost diff --git a/readme.md b/readme.md index 340406e..fdbef1e 100644 --- a/readme.md +++ b/readme.md @@ -1,17 +1,29 @@ # import-cost.nvim Display the costs of javascript imports inside neovim with the power of -[import-cost](https://github.com/wix/import-cost) +[import-cost](https://github.com/wix/import-cost/tree/master/packages/import-cost). ![preview](https://user-images.githubusercontent.com/62671086/210182400-defdb8d5-5d0a-42b6-a2b2-014272a7d7a7.png) ## Installation -1. Install regularly with your package manager -2. Run the install script inside the directory: +1. Install regularly with your neovim package manager +2. Run `install.sh` with your node.js package manager to setup import-cost: ```sh -sh install.sh +sh install.sh '' +``` + +For example, a config with [yarn](https://yarnpkg.com/) and [lazy.nvim](https://github.com/folke/lazy.nvim) +may look like the following: + +```lua +require('lazy').setup { + { + 'barrett-ruth/import-cost.nvim', + build = 'sh install.sh yarn' + } +} ``` ## Configuration @@ -23,3 +35,12 @@ require('import-cost').setup(opts) ``` See `:h import-cost` for more information + +## Acknowledgements + +1. [wix/import-cost](https://github.com/wix/import-cost/): provides the node + backend that calculates the import costs +2. [import-cost](https://marketplace.visualstudio.com/items?itemName=wix.vscode-import-cost): + the original VSCode plugin that started it all +3. [vim-import-cost](https://github.com/yardnsm/vim-import-cOst): showed me it + was possible to do in neovim!