summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIan Cordasco <graffatcolmingov@gmail.com>2015-12-18 13:49:59 -0600
committerIan Cordasco <graffatcolmingov@gmail.com>2015-12-18 13:49:59 -0600
commitf013698072ccba9c2c188184840ce6bb13f9723f (patch)
tree791a3bf6dacc4f219c6cd8d7eefb95a07fd5a276
parentae1ad0e2bf15a3043326c008a7a7b048050dec49 (diff)
downloadflake8-f013698072ccba9c2c188184840ce6bb13f9723f.tar.gz
Update with extra info about plugins
-rw-r--r--DESIGN.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/DESIGN.rst b/DESIGN.rst
index 7cdada3..573e093 100644
--- a/DESIGN.rst
+++ b/DESIGN.rst
@@ -70,6 +70,9 @@ mccabe as "plugins", it will aggregate the errors returned by all of the
plugins and be able to "notify" other plugins that have chosen to listen for
errors so those plugins can auto-fix the problems in the file.
+We should also be considerate of allowing these plugins to be composable. Each
+plugin should have a way of defining its capabilities.
+
See https://gitlab.com/pycqa/flake8/issues/84
.. note:: Will probably need a Trie implementation for this
@@ -95,6 +98,10 @@ Support for Report Generation
Flake8 should support pluggable report formats. See also pluggable report
formats for https://github.com/openstack/bandit
+Report generation plugins may also choose to implement a way to store previous
+runs of flake8. As such these plugins should be designed to be composable as
+well.
+
.. _options-passing:
Support for Plugins Require Parsed Options