{py:mod}abx_plugin_ripgrep_search.config

:allowtitles:

Module Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`RipgrepConfig <abx_plugin_ripgrep_search.config.RipgrepConfig>`
  -

Data

:class: autosummary longtable
:align: left

* - {py:obj}`RIPGREP_CONFIG <abx_plugin_ripgrep_search.config.RIPGREP_CONFIG>`
  - ```{autodoc2-docstring} abx_plugin_ripgrep_search.config.RIPGREP_CONFIG
    :summary:
    ```

API

:canonical: abx_plugin_ripgrep_search.config.RipgrepConfig

Bases: {py:obj}`abx_spec_config.base_configset.BaseConfigSet`

````{py:attribute} RIPGREP_BINARY
:canonical: abx_plugin_ripgrep_search.config.RipgrepConfig.RIPGREP_BINARY
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} abx_plugin_ripgrep_search.config.RipgrepConfig.RIPGREP_BINARY
```

````

````{py:attribute} RIPGREP_IGNORE_EXTENSIONS
:canonical: abx_plugin_ripgrep_search.config.RipgrepConfig.RIPGREP_IGNORE_EXTENSIONS
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} abx_plugin_ripgrep_search.config.RipgrepConfig.RIPGREP_IGNORE_EXTENSIONS
```

````

````{py:attribute} RIPGREP_ARGS_DEFAULT
:canonical: abx_plugin_ripgrep_search.config.RipgrepConfig.RIPGREP_ARGS_DEFAULT
:type: typing.List[str]
:value: >
   'Field(...)'

```{autodoc2-docstring} abx_plugin_ripgrep_search.config.RipgrepConfig.RIPGREP_ARGS_DEFAULT
```

````

````{py:attribute} RIPGREP_SEARCH_DIR
:canonical: abx_plugin_ripgrep_search.config.RipgrepConfig.RIPGREP_SEARCH_DIR
:type: pathlib.Path
:value: >
   None

```{autodoc2-docstring} abx_plugin_ripgrep_search.config.RipgrepConfig.RIPGREP_SEARCH_DIR
```

````

````{py:attribute} RIPGREP_TIMEOUT
:canonical: abx_plugin_ripgrep_search.config.RipgrepConfig.RIPGREP_TIMEOUT
:type: int
:value: >
   'Field(...)'

```{autodoc2-docstring} abx_plugin_ripgrep_search.config.RipgrepConfig.RIPGREP_TIMEOUT
```

````

:canonical: abx_plugin_ripgrep_search.config.RIPGREP_CONFIG
:value: >
   'RipgrepConfig(...)'

```{autodoc2-docstring} abx_plugin_ripgrep_search.config.RIPGREP_CONFIG
```