Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cli: replace 'module' by 'plugin' #1742

Merged
merged 1 commit into from
Nov 23, 2019
Merged

cli: replace 'module' by 'plugin' #1742

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions sopel/cli/run.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,9 +160,9 @@ def add_legacy_options(parser):
dest='mod_wizard',
help=(
"Run the configuration wizard, but only for the "
"module configuration options "
"plugin configuration options "
"(deprecated, and will be removed in Sopel 8; "
"use ``sopel configure --modules`` instead)"))
"use ``sopel configure --plugins`` instead)"))
parser.add_argument('-v', action="store_true",
dest='version_legacy',
help=(
Expand Down Expand Up @@ -222,10 +222,10 @@ def build_parser():
'a new configuration file or to update an existing one.',
help='Sopel\'s Wizard tool')
parser_configure.add_argument(
'--modules',
'--plugins',
action='store_true',
default=False,
dest='modules',
dest='plugins',
help='Check for Sopel plugins that require configuration, and run '
'their configuration wizards.')
utils.add_common_arguments(parser_configure)
Expand Down Expand Up @@ -437,7 +437,7 @@ def command_start(opts):
def command_configure(opts):
"""Sopel Configuration Wizard"""
configpath = utils.find_config(opts.configdir, opts.config)
if opts.modules:
if opts.plugins:
utils.plugins_wizard(configpath)
else:
utils.wizard(configpath)
Expand Down Expand Up @@ -561,7 +561,7 @@ def command_legacy(opts):
if opts.mod_wizard:
tools.stderr(
'WARNING: option --configure-modules is deprecated; '
'use `sopel configure --modules` instead')
'use `sopel configure --plugins` instead')
utils.plugins_wizard(configpath)
return

Expand Down
10 changes: 5 additions & 5 deletions sopel/cli/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ def wizard(filename):
"to create your configuration file (%s):\n" % filename)
config.core_section.configure(settings)
if settings.option(
'Would you like to see if there are any modules '
'Would you like to see if there are any plugins '
'that need configuring'
):
_plugins_wizard(settings)
Expand Down Expand Up @@ -155,7 +155,7 @@ def _plugins_wizard(settings):
usable_plugins = plugins.get_usable_plugins(settings)
for plugin, is_enabled in usable_plugins.values():
if not is_enabled:
# Do not configure non-enabled modules
# Do not configure non-enabled plugins
continue

name = plugin.name
Expand Down Expand Up @@ -185,9 +185,9 @@ def enumerate_configs(config_dir, extension='.cfg'):

>>> from sopel import cli, config
>>> os.listdir(config.DEFAULT_HOMEDIR)
['config.cfg', 'extra.ini', 'module.cfg', 'README']
['config.cfg', 'extra.ini', 'plugin.cfg', 'README']
>>> cli.enumerate_configs(config.DEFAULT_HOMEDIR)
['config.cfg', 'module.cfg']
['config.cfg', 'plugin.cfg']
>>> cli.enumerate_configs(config.DEFAULT_HOMEDIR, '.ini')
['extra.ini']

Expand Down Expand Up @@ -221,7 +221,7 @@ def find_config(config_dir, name, extension='.cfg'):
>>> os.listdir()
['local.cfg', 'extra.ini']
>>> os.listdir(config.DEFAULT_HOMEDIR)
['config.cfg', 'extra.ini', 'module.cfg', 'README']
['config.cfg', 'extra.ini', 'plugin.cfg', 'README']
>>> run_script.find_config(config.DEFAULT_HOMEDIR, 'local.cfg')
'local.cfg'
>>> run_script.find_config(config.DEFAULT_HOMEDIR, 'local')
Expand Down
8 changes: 4 additions & 4 deletions test/cli/test_cli_run.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,11 +318,11 @@ def test_build_parser_configure():
assert isinstance(options, argparse.Namespace)
assert hasattr(options, 'config')
assert hasattr(options, 'configdir')
assert hasattr(options, 'modules')
assert hasattr(options, 'plugins')

assert options.config == 'default'
assert options.configdir == config.DEFAULT_HOMEDIR
assert options.modules is False
assert options.plugins is False


def test_build_parser_configure_config():
Expand All @@ -345,8 +345,8 @@ def test_build_parser_configure_configdir():
def test_build_parser_configure_modules():
parser = build_parser()

options = parser.parse_args(['configure', '--modules'])
assert options.modules is True
options = parser.parse_args(['configure', '--plugins'])
assert options.plugins is True


def test_get_configuration(tmpdir):
Expand Down