paint-brush
Code Smell 247 - Javascript Function Namingby@mcsee
171 reads

Code Smell 247 - Javascript Function Naming

by Maximiliano ContieriApril 16th, 2024
Read on Terminal Reader
Read this story w/o Javascript
tldt arrow

Too Long; Didn't Read

Some names in immature languages break the [bijection] principle. Avoid ambiguous or bad names. Wrap with your functions. Use mature languages. Don't use *replace()* instead of *replaceAll()* in your code. Use *replaceFirst()* if you need to change only the first occurrence.
featured image - Code Smell 247 - Javascript Function Naming
Maximiliano Contieri HackerNoon profile picture


TL;DR: Bad function names will lead you to defects

Problems

Solutions

  1. Avoid ambiguous or bad names
  2. Wrap with your functions
  3. Use mature languages

Context

Some names in immature languages break the bijection principle.

When you use them, you agree on some semantics that are not the actual behavior.

Consequently, you must know accidental implementations to avoid this defect.

Sample Code

Wrong

const pets = '😺🐶😺';
const justDogs = pets.replace('😺', '🐩');

const catsArePresent = justDogs.includes('😺');
// returns true

Right

const pets = '😺🐶😺';

const justDogs = pets.replaceAll('😺', '🐩');
// Or
const justDogs = pets.replace(/😺/g, '');

const catsArePresent = justDogs.includes('😺');
// returns false

Detection

  • [x]Automatic

You can search and forbid the usage of replace() in your code and define replaceFirst() if you need to change only the first occurrence

Tags

  • Naming

Level

  • [x]Beginner

AI Generation

All generators avoided this problem.

AI Detection

ChatGPT and Copilot use Regular Expressions to solve the problem.

Gemini and Claude failed to spot the mistake.

None of them use replaceAll() (introduced in ES2021)

Conclusion

Using replace() instead of replaceAll() would not fully achieve the intended result of replacing all occurrences.

It would only replace the first occurrence, potentially leading to incorrect behavior if there are multiple occurrences.

Relations

Code Smell 38 - Abstract Names

Code Smell 41 - Regular Expression Abusers

More Info

What exactly is a name - Part II Rehab

Disclaimer

Code Smells are my opinion.

Credits

Photo by Jari Hytönen on Unsplash


We must not blame programmers for their bugs. They belong to them only until the code is merged to the repository. After that, all bugs are ours!

Yegor Bugayenko

Software Engineering Great Quotes


This article is part of the CodeSmell Series.

How to Find the Stinky Parts of your Code