Mirrors/awesome-zsh-plugins
2
0
Fork 0
mirror of https://github.com/unixorn/awesome-zsh-plugins synced 2024-11-22 01:13:02 +00:00
Code Issues Projects Releases Packages Wiki Activity

style: ✅ Update codeclimate.yml

Browse source 
Fix: 'exclude_paths' has been deprecated, 'engines' has been deprecated, 'exclude_paths' has been deprecated, 'ratings' has been deprecated.

Linted with new configuration (1 file): Writing_Plugins_and_Themes.md

Signed-off-by: Salvydas Lukosius <sall@w-ss.io>
This commit is contained in:
Salvydas Lukosius 2022-02-15 10:21:56 +00:00
parent 4c40422fe2
commit 7b0ba39967
No known key found for this signature in database
GPG key ID: AE8268784EBEDC12
2 changed files with 16 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
.codeclimate.yml
View file

@ -1,5 +1,6 @@
--- ---
engines: version: "2"
plugins:
pep8: pep8:
enabled: true enabled: true
duplication: duplication:
@ -9,7 +10,7 @@ engines:
- "python" - "python"
fixme: fixme:
enabled: true enabled: true
exclude_paths: exclude_patterns:
- config/engines.yml - config/engines.yml
markdownlint: markdownlint:
enabled: true enabled: true
@ -26,10 +27,7 @@ engines:
enabled: false enabled: false
shellcheck: shellcheck:
enabled: true enabled: true
ratings: exclude_patterns:
paths:
- "**.md"
exclude_paths:
- .bundle/ - .bundle/
- benchmarks/**/* - benchmarks/**/*
- node_modules/**/* - node_modules/**/*

1
Writing_Plugins_and_Themes.md
View file

@ -17,6 +17,7 @@ Here are some suggestions to make installing and using your plugin/theme as simp
7. If your plugin adds any of its subdirectories to the user's `fpath`, make sure those subdirectories only contain function definition files. This allows for frameworks to correctly [zcompile all functions](http://zsh.sourceforge.net/Doc/Release/Functions.html#Autoloading-Functions). Please don't make your plugin add its root directory to the `fpath` - this will cause problems with `zcompile`. 7. If your plugin adds any of its subdirectories to the user's `fpath`, make sure those subdirectories only contain function definition files. This allows for frameworks to correctly [zcompile all functions](http://zsh.sourceforge.net/Doc/Release/Functions.html#Autoloading-Functions). Please don't make your plugin add its root directory to the `fpath` - this will cause problems with `zcompile`.
8. Leave ZSH settings alone. 8. Leave ZSH settings alone.
- If you're using `setopt` to override the user's existing settings, you _will_ break someone's workflow. If you feel you absolutely must tweak `setopt` settings, make sure there's an easy way to disable your overrides - consider looking for a file named `~/.YOURPLUGIN_disable_SETTINGSNAME`. - If you're using `setopt` to override the user's existing settings, you _will_ break someone's workflow. If you feel you absolutely must tweak `setopt` settings, make sure there's an easy way to disable your overrides - consider looking for a file named `~/.YOURPLUGIN_disable_SETTINGSNAME`.
- If you're touching the magic ZSH settings variables like `HISTSIZE`, _only do it if the variable is unset_. Wrap it in a `if [[ -z "$VARNAME" ]]; then` block so you don't step on a user's existing settings. - If you're touching the magic ZSH settings variables like `HISTSIZE`, _only do it if the variable is unset_. Wrap it in a `if [[ -z "$VARNAME" ]]; then` block so you don't step on a user's existing settings.