barrett/import-cost.nvim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

readme: acknowledgements

Browse source
This commit is contained in:
Barrett Ruth 2023-01-02 16:43:14 -06:00
parent 20478055b5
commit 85c2659ea3
2 changed files with 28 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

12
install.sh
View file

@ -1,17 +1,11 @@
#!/bin/sh #!/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) 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 cd import-cost || exit
eval "$installer install" $1 install
cd .. cd ..
cp index.js import-cost cp index.js import-cost

29
readme.md
View file

@ -1,17 +1,29 @@
# import-cost.nvim # import-cost.nvim
Display the costs of javascript imports inside neovim with the power of 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) ![preview](https://user-images.githubusercontent.com/62671086/210182400-defdb8d5-5d0a-42b6-a2b2-014272a7d7a7.png)
## Installation ## Installation
1. Install regularly with your package manager 1. Install regularly with your neovim package manager
2. Run the install script inside the directory: 2. Run `install.sh` with your node.js package manager to setup import-cost:
```sh ```sh
sh install.sh sh install.sh '<your-package-manager>'
```
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 ## Configuration
@ -23,3 +35,12 @@ require('import-cost').setup(opts)
``` ```
See `:h import-cost` for more information 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!