Sha256: ae941f8ed0ce25adf497c2213dff8eb1667f6b6fd82465ff7fbd0bd4b371a5ab

Contents?: true

Size: 1 KB

Versions: 15

Compression:

Stored size: 1 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 names as strings | List of names that will be accepted (not reported) even if they match one of the `reject` expressions. Empty by default.|

Version data entries

15 entries across 15 versions & 1 rubygems

Version Path
reek-4.0.0.pre1 docs/Uncommunicative-Module-Name.md
reek-3.11 docs/Uncommunicative-Module-Name.md
reek-3.10.2 docs/Uncommunicative-Module-Name.md
reek-3.10.1 docs/Uncommunicative-Module-Name.md
reek-3.10.0 docs/Uncommunicative-Module-Name.md
reek-3.9.1 docs/Uncommunicative-Module-Name.md
reek-3.9.0 docs/Uncommunicative-Module-Name.md
reek-3.8.3 docs/Uncommunicative-Module-Name.md
reek-3.8.2 docs/Uncommunicative-Module-Name.md
reek-3.8.1 docs/Uncommunicative-Module-Name.md
reek-3.8.0 docs/Uncommunicative-Module-Name.md
reek-3.7.1 docs/Uncommunicative-Module-Name.md
reek-3.7.0 docs/Uncommunicative-Module-Name.md
reek-3.6.1 docs/Uncommunicative-Module-Name.md
reek-3.6.0 docs/Uncommunicative-Module-Name.md