Contents

# Uncommunicative Module Name

## Introduction

An _Uncommunicative Module Name_ is a module name that doesn't communicate its
intent well enough. This code smell is a case of
[Uncommunicative Name](Uncommunicative-Name.md).

## Current Support in Reek

_Uncommunicative Module Name_ checks for:

* single-character names
* any name ending with a number

## Configuration

Reek's _Uncommunicative Module Name_ detector supports the [Basic Smell Options](Basic-Smell-Options.md), plus:

| Option         | Value       | Effect  |
| ---------------|-------------|---------|
| `reject` | array of regular expressions or strings | The set of patterns or names that Reek uses to check for bad names. Defaults to `[/^.$/, /[0-9]$/]`. |
| `accept` | array of regular expressions or strings | The set of patterns or names that Reek will accept (and not report) even if they match one of the `reject` expressions. Empty by default.|

An example configuration could look like this:

```Yaml
---
UncommunicativeModuleName:
  accept:
    - !ruby/regexp /lassy/
    - M
  reject:
    - !ruby/regexp /Helper/
```

Applying a configuration to a source file like this:

```Ruby
class Classy1; end # Should not be reported
class M; end # Should not be reported
class BaseHelper; end # Should be reported
```

Reek would report:

```
smelly.rb -- 1 warning:
  [3]:UncommunicativeModuleName: BaseHelper has the name 'BaseHelper' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Module-Name.md]
```

Version data entries

32 entries across 32 versions & 1 rubygems

Version	Path
reek-4.2.5	docs/Uncommunicative-Module-Name.md
reek-4.2.4	docs/Uncommunicative-Module-Name.md
reek-4.2.3	docs/Uncommunicative-Module-Name.md
reek-4.2.2	docs/Uncommunicative-Module-Name.md
reek-4.2.1	docs/Uncommunicative-Module-Name.md
reek-4.2.0	docs/Uncommunicative-Module-Name.md
reek-4.1.1	docs/Uncommunicative-Module-Name.md
reek-4.1.0	docs/Uncommunicative-Module-Name.md
reek-4.0.5	docs/Uncommunicative-Module-Name.md
reek-4.0.4	docs/Uncommunicative-Module-Name.md
reek-4.0.3	docs/Uncommunicative-Module-Name.md
reek-4.0.2	docs/Uncommunicative-Module-Name.md