summaryrefslogtreecommitdiff
path: root/plugins/django
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2021-09-27 13:03:58 -0600
committerTuowen Zhao <ztuowen@gmail.com>2021-09-27 13:03:58 -0600
commitc674485e6b4abe313469900997d893d2940ee843 (patch)
treed6ca6edaff3d81849489f31ca13b127acef89c75 /plugins/django
parent3c73976ef306d68a85d60c94be9a1dcdc33fa2bf (diff)
parent93ad3a88214b95f571e03c21f7d9bd76f9110938 (diff)
downloadzsh-c674485e6b4abe313469900997d893d2940ee843.tar.gz
zsh-c674485e6b4abe313469900997d893d2940ee843.tar.bz2
zsh-c674485e6b4abe313469900997d893d2940ee843.zip
Merge remote-tracking branch 'origin/master'
Diffstat (limited to 'plugins/django')
-rw-r--r--plugins/django/README.md38
-rw-r--r--plugins/django/django.plugin.zsh3
2 files changed, 10 insertions, 31 deletions
diff --git a/plugins/django/README.md b/plugins/django/README.md
index 1740e55e5..cfab43980 100644
--- a/plugins/django/README.md
+++ b/plugins/django/README.md
@@ -1,36 +1,12 @@
# Django plugin
-This plugin adds completion and hints for the [Django Project](https://www.djangoproject.com/) `manage.py` commands
-and options.
+This plugin adds completion for the [Django Project](https://www.djangoproject.com/) commands
+(`manage.py`, `django-admin`, ...).
-To use it, add `django` to the plugins array in your zshrc file:
+## Deprecation (2021-09-22)
-```zsh
-plugins=(... django)
-```
+The plugin used to provide completion for `./manage.py` and `django-admin`, but Zsh already provides
+a better, more extensive completion for those, so this plugin is no longer needed.
-## Usage
-
-```zsh
-$> python manage.py (press <TAB> here)
-```
-
-Would result in:
-
-```zsh
-cleanup -- remove old data from the database
-compilemessages -- compile .po files to .mo for use with gettext
-createcachetable -- creates table for SQL cache backend
-createsuperuser -- create a superuser
-dbshell -- run command-line client for the current database
-diffsettings -- display differences between the current settings and Django defaults
-dumpdata -- output contents of database as a fixture
-flush -- execute 'sqlflush' on the current database
-inspectdb -- output Django model module for tables in database
-loaddata -- install the named fixture(s) in the database
-makemessages -- pull out all strings marked for translation
-reset -- executes 'sqlreset' for the given app(s)
-runfcgi -- run this project as a fastcgi
-runserver -- start a lightweight web server for development
-...
-```
+Right now a warning message is shown, but in the near future the plugin will stop working altogether.
+So you can remove it from your plugins and you'll automatically start using Zsh's django completion.
diff --git a/plugins/django/django.plugin.zsh b/plugins/django/django.plugin.zsh
index c2d00c171..a07a30889 100644
--- a/plugins/django/django.plugin.zsh
+++ b/plugins/django/django.plugin.zsh
@@ -402,3 +402,6 @@ compdef _managepy django
compdef _managepy django-admin
compdef _managepy django-admin.py
compdef _managepy django-manage
+
+print -P "%F{yellow}The django plugin is deprecated in favor of Zsh's Django completion.
+%BPlease remove it from your plugins to stop using it.%b%f"