Change --filter to --find (#4087)

vertexproject · Jan 24, 2025 · 9cab054 · 9cab054
1 parent e5769ba
commit 9cab054
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/changes/cd12a6feba9161fe9651a4e3bf00bb04.yaml b/changes/cd12a6feba9161fe9651a4e3bf00bb04.yaml
@@ -1,5 +1,5 @@
 ---
-desc: Added ``--filter`` option to ``auth.perms.list`` to easily filter permission
+desc: Added ``--find`` option to ``auth.perms.list`` to easily filter permission
   results.
 prs: []
 type: feat

diff --git a/synapse/lib/stormlib/auth.py b/synapse/lib/stormlib/auth.py
@@ -584,20 +584,20 @@
         'name': 'auth.perms.list',
         'descr': 'Display a list of the current permissions defined within the Cortex.',
         'cmdargs': (
-            ('--filter', {'type': 'str', 'help': 'A search string for filtering permissions.'}),
+            ('--find', {'type': 'str', 'help': 'A search string for permissions.'}),
         ),
         'storm': '''
 
             for $pdef in $lib.auth.getPermDefs() {
                 $perm = $lib.str.join(".", $pdef.perm)
 
-                if $cmdopts.filter {
-                    $filter = $cmdopts.filter.lower()
+                if $cmdopts.find {
+                    $find = $cmdopts.find.lower()
                     $match = (
-                        $perm.lower().find($filter) != (null) or
-                        $pdef.desc.lower().find($filter) != (null) or
-                        $pdef.gate.lower().find($filter) != (null) or
-                        ($pdef.ex and $pdef.ex.lower().find($filter) != (null))
+                        $perm.lower().find($find) != (null) or
+                        $pdef.desc.lower().find($find) != (null) or
+                        $pdef.gate.lower().find($find) != (null) or
+                        ($pdef.ex and $pdef.ex.lower().find($find) != (null))
                     )
 
                     if (not $match) { continue }

diff --git a/synapse/tests/test_lib_stormlib_auth.py b/synapse/tests/test_lib_stormlib_auth.py
@@ -320,13 +320,13 @@ async def test_stormlib_auth(self):
             self.stormIsInPrint('Controls access to add a new view including forks.', msgs)
             self.stormIsInPrint('default: false', msgs)
 
-            msgs = await core.stormlist('auth.perms.list --filter macro.')
+            msgs = await core.stormlist('auth.perms.list --find macro.')
             self.stormIsInPrint('storm.macro.add', msgs)
             self.stormIsInPrint('storm.macro.admin', msgs)
             self.stormIsInPrint('storm.macro.edit', msgs)
             self.stormNotInPrint('node.add.<form>', msgs)
 
-            msgs = await core.stormlist('auth.perms.list --filter url')
+            msgs = await core.stormlist('auth.perms.list --find url')
             self.stormIsInPrint('storm.lib.telepath.open.<scheme>', msgs)
             self.stormIsInPrint('Controls the ability to open a telepath URL with a specific URI scheme.', msgs)
             self.stormNotInPrint('node.add.<form>', msgs)