diff --git a/.codeclimate.yml b/.codeclimate.yml index 8818823..c6dc027 100644 --- a/.codeclimate.yml +++ b/.codeclimate.yml @@ -1,15 +1,16 @@ --- -engines: +version: "2" +plugins: pep8: enabled: true duplication: enabled: true config: languages: - - "python" + - "python" fixme: enabled: true - exclude_paths: + exclude_patterns: - config/engines.yml markdownlint: enabled: true @@ -26,15 +27,12 @@ engines: enabled: false shellcheck: enabled: true -ratings: - paths: - - "**.md" -exclude_paths: - - .bundle/ - - benchmarks/**/* - - node_modules/**/* - - bin/**/* - - include/**/* - - lib/**/* - - License.md - - spec/**/* + exclude_patterns: + - .bundle/ + - benchmarks/**/* + - node_modules/**/* + - bin/**/* + - include/**/* + - lib/**/* + - License.md + - spec/**/* diff --git a/Writing_Plugins_and_Themes.md b/Writing_Plugins_and_Themes.md index 73f5704..9846e0c 100644 --- a/Writing_Plugins_and_Themes.md +++ b/Writing_Plugins_and_Themes.md @@ -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`. 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.