summaryrefslogtreecommitdiff
path: root/dotbot/plugin.py
diff options
context:
space:
mode:
authorAnton Khirnov <anton@khirnov.net>2020-11-15 16:25:57 +0100
committerAnton Khirnov <anton@khirnov.net>2020-11-15 16:25:57 +0100
commit79c9c0747e876c0b97a4fb3fe91fa9825e462722 (patch)
treeff298dd32dfccfde9921d0ac2c48bc36113a55c6 /dotbot/plugin.py
parent5ffd208bdb85215cc7c5ba6f2903bfa7756aa945 (diff)
Add a dry run mode.
Diffstat (limited to 'dotbot/plugin.py')
-rw-r--r--dotbot/plugin.py5
1 files changed, 4 insertions, 1 deletions
diff --git a/dotbot/plugin.py b/dotbot/plugin.py
index 5e2c923..2d12636 100644
--- a/dotbot/plugin.py
+++ b/dotbot/plugin.py
@@ -18,10 +18,13 @@ class Plugin(object):
'''
return directive == self._directive
- def handle(self, directive, data):
+ def handle(self, directive, data, dry_run = False):
'''
Executes the directive.
Returns true if the Plugin successfully handled the directive.
+
+ When dry_run is True, the plugin will not perform any actions, only
+ return False when there is nothing to do, True otherwise.
'''
raise NotImplementedError