Avoid Ambiguous Naming for Path Variables Problems Unclear variable purpose
Bijection Fault
Misleading context
Repetitive code
Harder maintenance
Reduced readability
Abbreviations
Increased cognitive load Solutions Honor the Bijection
Use precise names
Avoid ambiguity
Keep context clear
Extract reusable code
Follow naming conventions
Reify names with their rules Context When handling a single fileName or directoryPath, vague names like file or dirName create confusion. A file should represent a File
A fileName should represent the name of a file
fileContents should represent the content of a file
A fileHandler should represent a pointer to an external resource
dirName should be directoryPath Clear names like fileName for names and directoryPath for directories communicate each variable’s role. When you name a variable file, it can confuse others about its purpose. Does it store a file object or just the filename? When you name a variable dirName instead of directoryName it leads to ambiguity. Clear and descriptive variable names improve code readability and maintainability, especially in collaborative environments. Sample Code Wrong function importBoardGameScores(file) {
  if (file) {
    const data = fs.readFileSync(file, 'utf-8');
    // Process board game scores...
  }
}

function importDirectoryScores(dirName) {
  // 'dir' is an abbreviation
  const files = fs.readdirSync(dirName);
  files.forEach(file => {
    const data = fs.readFileSync(`${dirName}/${file}`, 'utf-8');
    // Process each file's board game scores...
  });
  }
} Right function importBoardGameScores(fileName) {
  if (fileName) {
    const data = fs.readFileSync(fileName, 'utf-8');
    // Process board game scores...
  }
}

function importDirectoryBoardGamesScores(directoryPath) {
    const fileNames = fs.readdirSync(directoryPath);
    // Note the variable holding filenames 
    // and not files
  
   fileNames.forEach(filename => {
        const fullPath = path.join(directoryPath, filename);
        const scores = importBoardGameScores(fullPath);
        allScores.push(scores);
   });
       
   return allScores.flat();
  
  
// You can also reify the concept of a filename
// And avoid repeating the rules everywhere
  
class Filename {
    value;
    
    constructor(value) {
        this.validateFilename(value);
        this.value = value;
    }

    validateFilename(value) {      
        const invalidCharacters = /[<>:"/\\|?*\x00-\x1F]/g;
        if (invalidCharacters.test(value)) {
            throw new Error
              ('Filename contains invalid characters');
        }

        if (/^[. ]+$/.test(value)) {
            throw new Error
              ('Filename cannot consist only of dots or spaces');
        }

        if (value.length > 255) {
            throw new Error
              ('Filename is too long');
        }
    }

    toString() {
        return this.value;
    }

    get value() {
        return this.value;
    }
} Detection [x]Semi-Automatic Look for generic names in code handling files or directory paths like file or dirName. Tags Naming Level [x]Beginner AI Generation AI models may default to ambiguous names like file or dirName without specific instructions. Adding descriptive naming and code extraction guidelines can improve the AI's output. AI Detection AI tools can fix this smell by using clear naming conventions and suggesting code extraction if prompted to avoid redundant code. Try Them! Remember: AI Assistants make lots of mistakes Without Proper Instructions

With Specific Instructions



ChatGPT

ChatGPT



Claude

Claude



Perplexity

Perplexity



Copilot

Copilot



Gemini

Gemini Conclusion By using precise names like fileName and directoryPath and extracting reusable methods, you improve code clarity and maintainability. These simple practices help reduce redundancy and keep your code understandable. Related Reading https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-vii-8dk31x0 Disclaimer: Code Smells are my opinion. Credit(s): Photo by Gabriel Heinzer on Unsplash Code should be written to be read by humans first, and machines second. Don Laabs https://hackernoon.com/400-thought-provoking-software-engineering-quotes?embedable=true This article is part of the CodeSmell Series: How to Find the Stinky Parts of your Code Avoid Ambiguous Naming for Path Variables Avoid Ambiguous Naming for Path Variables Avoid Ambiguous Naming for Path Variables Problems Unclear variable purpose Bijection Fault Misleading context Repetitive code Harder maintenance Reduced readability Abbreviations Increased cognitive load Unclear variable purpose Bijection Fault Bijection Misleading context Repetitive code Harder maintenance Reduced readability Abbreviations Abbreviations Increased cognitive load Solutions Honor the Bijection Use precise names Avoid ambiguity Keep context clear Extract reusable code Follow naming conventions Reify names with their rules Honor the Bijection Bijection Use precise names Avoid ambiguity Keep context clear Extract reusable code Follow naming conventions Reify names with their rules Context When handling a single fileName or directoryPath , vague names like file or dirName create confusion. fileName directoryPath file dirName A file should represent a File A fileName should represent the name of a file fileContents should represent the content of a file A fileHandler should represent a pointer to an external resource dirName should be directoryPath A file should represent a File file A fileName should represent the name of a file fileName fileContents should represent the content of a file fileContents A fileHandler should represent a pointer to an external resource fileHandler dirName should be directoryPath dirName directoryPath Clear names like fileName for names and directoryPath for directories communicate each variable’s role. fileName directoryPath When you name a variable file, it can confuse others about its purpose. Does it store a file object or just the filename? When you name a variable dirName instead of directoryName it leads to ambiguity. dirName Clear and descriptive variable names improve code readability and maintainability, especially in collaborative environments. Sample Code Wrong function importBoardGameScores(file) {
  if (file) {
    const data = fs.readFileSync(file, 'utf-8');
    // Process board game scores...
  }
}

function importDirectoryScores(dirName) {
  // 'dir' is an abbreviation
  const files = fs.readdirSync(dirName);
  files.forEach(file => {
    const data = fs.readFileSync(`${dirName}/${file}`, 'utf-8');
    // Process each file's board game scores...
  });
  }
} function importBoardGameScores(file) {
  if (file) {
    const data = fs.readFileSync(file, 'utf-8');
    // Process board game scores...
  }
}

function importDirectoryScores(dirName) {
  // 'dir' is an abbreviation
  const files = fs.readdirSync(dirName);
  files.forEach(file => {
    const data = fs.readFileSync(`${dirName}/${file}`, 'utf-8');
    // Process each file's board game scores...
  });
  }
} Right function importBoardGameScores(fileName) {
  if (fileName) {
    const data = fs.readFileSync(fileName, 'utf-8');
    // Process board game scores...
  }
}

function importDirectoryBoardGamesScores(directoryPath) {
    const fileNames = fs.readdirSync(directoryPath);
    // Note the variable holding filenames 
    // and not files
  
   fileNames.forEach(filename => {
        const fullPath = path.join(directoryPath, filename);
        const scores = importBoardGameScores(fullPath);
        allScores.push(scores);
   });
       
   return allScores.flat();
  
  
// You can also reify the concept of a filename
// And avoid repeating the rules everywhere
  
class Filename {
    value;
    
    constructor(value) {
        this.validateFilename(value);
        this.value = value;
    }

    validateFilename(value) {      
        const invalidCharacters = /[<>:"/\\|?*\x00-\x1F]/g;
        if (invalidCharacters.test(value)) {
            throw new Error
              ('Filename contains invalid characters');
        }

        if (/^[. ]+$/.test(value)) {
            throw new Error
              ('Filename cannot consist only of dots or spaces');
        }

        if (value.length > 255) {
            throw new Error
              ('Filename is too long');
        }
    }

    toString() {
        return this.value;
    }

    get value() {
        return this.value;
    }
} function importBoardGameScores(fileName) {
  if (fileName) {
    const data = fs.readFileSync(fileName, 'utf-8');
    // Process board game scores...
  }
}

function importDirectoryBoardGamesScores(directoryPath) {
    const fileNames = fs.readdirSync(directoryPath);
    // Note the variable holding filenames 
    // and not files
  
   fileNames.forEach(filename => {
        const fullPath = path.join(directoryPath, filename);
        const scores = importBoardGameScores(fullPath);
        allScores.push(scores);
   });
       
   return allScores.flat();
  
  
// You can also reify the concept of a filename
// And avoid repeating the rules everywhere
  
class Filename {
    value;
    
    constructor(value) {
        this.validateFilename(value);
        this.value = value;
    }

    validateFilename(value) {      
        const invalidCharacters = /[<>:"/\\|?*\x00-\x1F]/g;
        if (invalidCharacters.test(value)) {
            throw new Error
              ('Filename contains invalid characters');
        }

        if (/^[. ]+$/.test(value)) {
            throw new Error
              ('Filename cannot consist only of dots or spaces');
        }

        if (value.length > 255) {
            throw new Error
              ('Filename is too long');
        }
    }

    toString() {
        return this.value;
    }

    get value() {
        return this.value;
    }
} Detection [x]Semi-Automatic [x] Semi-Automatic [x] Look for generic names in code handling files or directory paths like file or dirName . file dirName Tags Naming Naming Level [x]Beginner [x] Beginner [x] AI Generation AI models may default to ambiguous names like file or dirName without specific instructions. file dirName Adding descriptive naming and code extraction guidelines can improve the AI's output. AI Detection AI tools can fix this smell by using clear naming conventions and suggesting code extraction if prompted to avoid redundant code. Try Them! Try Them! Remember: AI Assistants make lots of mistakes Remember: AI Assistants make lots of mistakes Without Proper Instructions

With Specific Instructions



ChatGPT

ChatGPT



Claude

Claude



Perplexity

Perplexity



Copilot

Copilot



Gemini

Gemini Without Proper Instructions

With Specific Instructions ChatGPT

ChatGPT Claude

Claude Perplexity

Perplexity Copilot

Copilot Gemini

Gemini Without Proper Instructions With Specific Instructions Without Proper Instructions Without Proper Instructions With Specific Instructions With Specific Instructions ChatGPT ChatGPT ChatGPT ChatGPT ChatGPT ChatGPT ChatGPT ChatGPT Claude Claude Claude Claude Claude Claude Claude Claude Perplexity Perplexity Perplexity Perplexity Perplexity Perplexity Perplexity Perplexity Copilot Copilot Copilot Copilot Copilot Copilot Copilot Copilot Gemini Gemini Gemini Gemini Gemini Gemini Gemini Gemini Conclusion By using precise names like fileName and directoryPath and extracting reusable methods, you improve code clarity and maintainability. fileName directoryPath These simple practices help reduce redundancy and keep your code understandable. Related Reading https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-vii-8dk31x0 https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-vii-8dk31x0 Disclaimer: Code Smells are my opinion. Disclaimer: Code Smells are my opinion . opinion Credit(s): Photo by Gabriel Heinzer on Unsplash Credit(s): Photo by Gabriel Heinzer on Unsplash Gabriel Heinzer Unsplash Code should be written to be read by humans first, and machines second. Code should be written to be read by humans first, and machines second. Don Laabs Don Laabs https://hackernoon.com/400-thought-provoking-software-engineering-quotes?embedable=true https://hackernoon.com/400-thought-provoking-software-engineering-quotes?embedable=true This article is part of the CodeSmell Series: How to Find the Stinky Parts of your Code This article is part of the CodeSmell Series: How to Find the Stinky Parts of your Code How to Find the Stinky Parts of your Code

This story contains new, firsthand information uncovered by the writer.

Code Smell 279 - Loop Premature Optimization

Refactoring 018 - How to Replace a Singleton

Buy My Book

Share your ideas with me!

Read My Stories

Buy Me a Coffee

Too Long; Didn't Read

Make resilience your competitive advantage

Code Smell 278 - DirName and File

About Author

Comments

TOPICS

THIS ARTICLE WAS FEATURED IN

Related Stories

Untitled Story

Code Smell 309 - Query Parameter API Versioning

106 Stories To Learn About Clean Code

100 Pieces of Programming Advice from the Book Clean Code by Robert Martin

110 Stories To Learn About Refactoring

3 Things Coding And Prose Writing Have In Common According To Cory House

Code Smell 309 - Query Parameter API Versioning

106 Stories To Learn About Clean Code

100 Pieces of Programming Advice from the Book Clean Code by Robert Martin

110 Stories To Learn About Refactoring

3 Things Coding And Prose Writing Have In Common According To Cory House

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps