mirror of
https://github.com/unixorn/awesome-zsh-plugins
synced 2024-11-10 04:24:11 +00:00
style: ✅ Update codeclimate.yml
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:
parent
4c40422fe2
commit
7b0ba39967
2 changed files with 16 additions and 17 deletions
|
@ -1,15 +1,16 @@
|
||||||
---
|
---
|
||||||
engines:
|
version: "2"
|
||||||
|
plugins:
|
||||||
pep8:
|
pep8:
|
||||||
enabled: true
|
enabled: true
|
||||||
duplication:
|
duplication:
|
||||||
enabled: true
|
enabled: true
|
||||||
config:
|
config:
|
||||||
languages:
|
languages:
|
||||||
- "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,15 +27,12 @@ engines:
|
||||||
enabled: false
|
enabled: false
|
||||||
shellcheck:
|
shellcheck:
|
||||||
enabled: true
|
enabled: true
|
||||||
ratings:
|
exclude_patterns:
|
||||||
paths:
|
- .bundle/
|
||||||
- "**.md"
|
- benchmarks/**/*
|
||||||
exclude_paths:
|
- node_modules/**/*
|
||||||
- .bundle/
|
- bin/**/*
|
||||||
- benchmarks/**/*
|
- include/**/*
|
||||||
- node_modules/**/*
|
- lib/**/*
|
||||||
- bin/**/*
|
- License.md
|
||||||
- include/**/*
|
- spec/**/*
|
||||||
- lib/**/*
|
|
||||||
- License.md
|
|
||||||
- spec/**/*
|
|
||||||
|
|
|
@ -17,8 +17,9 @@ 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 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 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.
|
||||||
|
|
||||||
9. Don't forget to add a license. A lot of people won't use anything that doesn't have a license. [choosealicense.com](https://choosealicense.com) is a good tool to help you pick one if you don't already have something specific in mind.
|
9. Don't forget to add a license. A lot of people won't use anything that doesn't have a license. [choosealicense.com](https://choosealicense.com) is a good tool to help you pick one if you don't already have something specific in mind.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue