Sha256: a1b20ef9edf9002d768832cb2338850979fb74a2d9e3fc7f15b681df787db98e

Contents?: true

Size: 1.02 KB

Versions: 12

Compression:

Stored size: 1.02 KB

Contents

# Uncommunicative Module Name

## Introduction

An `Uncommunicative Module Name` is a module name that doesn't communicate its intent well enough.

Poor names make it hard for the reader to build a mental picture of what's going on in the code. They can also be mis-interpreted; and they hurt the flow of reading, because the reader must slow down to interpret the names.

## Current Support in reek

`Uncommunicative Module Name` checks for:

* 1-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 | The set of regular expressions that `reek` uses to check for bad names. Defaults to `[/^.$/, /[0-9]$/]`. |
| `accept` | array of strings or regular expressions | Name that will be accepted (not reported) even if they match one of the `reject` expressions. Defaults to `['Inline::C']`.|

Version data entries

12 entries across 12 versions & 1 rubygems

Version Path
reek-3.3.1 docs/Uncommunicative-Module-Name.md
reek-3.3.0 docs/Uncommunicative-Module-Name.md
reek-3.2.1 docs/Uncommunicative-Module-Name.md
reek-3.2 docs/Uncommunicative-Module-Name.md
reek-3.1 docs/Uncommunicative-Module-Name.md
reek-3.0.4 docs/Uncommunicative-Module-Name.md
reek-3.0.3 docs/Uncommunicative-Module-Name.md
reek-3.0.2 docs/Uncommunicative-Module-Name.md
reek-3.0.1 docs/Uncommunicative-Module-Name.md
reek-3.0.0 docs/Uncommunicative-Module-Name.md
reek-2.2.1 docs/Uncommunicative-Module-Name.md
reek-2.2.0 docs/Uncommunicative-Module-Name.md