Demo Naming Conventions Readability

jeremy@MACSTUDIO Express-login-demo % claude

* Welcome to Claude Code!

/help for help, /status for your current setup

cwd: /Users/jeremy/Repos/Claude Code Course/Express-login-demo

> Try "write a test for <filepath>"

? for shortcuts

> Evaluate our code for readability and naming.

Review:

1. NAMING CONVENTIONS
    - Variables: descriptive vs cryptic (e.g., 'u' vs 'user')
    - Functions: verb-based, clear intent
    - Classes: noun-based, single responsibility
    - Constants: UPPER_CASE consistency
    - Private methods: underscore convention

2. NAMING CONSISTENCY
    - camelCase vs snake_case mixing
    - Abbreviation consistency
    - Domain terminology usage
    - British vs American spelling

3. CODE READABILITY
    - Self-documenting code
    - Need for comments (too many = code smell)
    - Magic numbers/strings
    - Complex boolean expressions
    - Ternary operator abuse

4. FUNCTION SIGNATURES
    - Parameter count (>3 is a smell)
    - Boolean parameters (avoid)
    - Optional parameter handling
    - Return type clarity

Create a naming convention guide based on findings.

## Provide:
A structured finding report
A scale of 1/10 on how important each finding is
Remediation: precise code-level fix or config change (snippets welcome) if possible

## Constraints & style:
Be concrete and cite exact code locations and identifiers.
Prefer minimal, drop-in fix snippets over prose.
Do not invent files or functions that aren't present; if context is missing, mark as Unable to verify and say what code would prove it.

Search(pattern: "const\s+\w+\s*=", output_mode: "content")
└ Found 4493 lines (ctrl+r to expand)

Search(pattern: "\\b\d+\\b", glob: "*.js", output_mode: "content")
└ Found 17474 lines (ctrl+r to expand)

Search(pattern: "^.*\(*\..*\)\s*=>\s*|\*function.*\(*\..*\)\s*{", glob: "*.js", output_mode: "content")
└ Found 7577 lines (ctrl+r to expand)

Write(audits/NAMING_READABILITY_AUDIT.md)
└ Wrote 289 lines to audits/NAMING_READABILITY_AUDIT.md

// server.js:7
const PORT = process.env.PORT || 3000;

// routes/auth.js:29-30
const userQuery = 'SELECT id, email, name, password FROM users WHERE email = $1';
const userResult = await pool.query(userQuery, [email]);

// routes/auth.js:40
const isPasswordValid = await bcrypt.compare(password, user.password);

// server.js:13
app.get('/', (req, res) => {
  // ...
});

// server.js
function homeHandler(req, res) {
  // ...
}
app.get('/', homeHandler);

// BEFORE
// routes/auth.js:16
router.post('/login', async (req, res) => {
  const { email, password } = req.body;
  // ...
});

// AFTER
// routes/auth.js:16
async function loginHandler(req, res) {
  const { email, password } = req.body;
  // ...
}
router.post('/login', loginHandler);

// routes/auth.js:38-46
const user = userResult.rows[0];
const isPasswordValid = await bcrypt.compare(password, user.password);

if (!isPasswordValid) {
  return res.status(401).json({
    error: 'Invalid credentials'
  });
}

// config/constants.js
module.exports = {
  DEFAULT_PORT: 3000,
  PASSWORD_MIN_LENGTH: 8,
  HTTP_STATUS: {
    OK: 200,
    BAD_REQUEST: 400,
    UNAUTHORIZED: 401,
    NOT_FOUND: 404,
    SERVER_ERROR: 500
  }
};

// server.js
const { DEFAULT_PORT } = require('./config/constants');
const PORT = process.env.PORT || DEFAULT_PORT;

// Instead of nested conditionals
if (isActive && hasPermission && !isExpired) { ... }

// Prefer
function canAccess(resource, user) { /* descriptive predicates */ }
if (canAccess(resource, user)) { ... }

// routes/auth.js:17
async (req, res) => {
  const { email, password } = req.body;
  // ...
}

// BEFORE
function createUser(name, sendWelcomeEmail) { ... }

// AFTER
function createUser(name, options = { sendWelcomeEmail: true }) { ... }