⬅️ Back to Table of Contents

📄 format

📊 Analysis Summary

Metric	Count
🔧 Functions	9
📦 Imports	1
📊 Variables & Constants	1

📚 Table of Contents

• Imports
• Variables & Constants
• Functions

🛠️ File Location:

📂 packages/eslint-plugin/src/rules/naming-convention-utils/format.ts

📦 Imports

Name	Source
PredefinedFormats	./enums

---

Variables & Constants

Name	Type	Kind	Value	Exported
PredefinedFormatToCheckFunc...	Readonly< Record<PredefinedFormats, (...	const	{ [PredefinedFormats.camelCase]: isCamelCase, [PredefinedFormats.PascalCase]:...	✓

---

Functions

isPascalCase(name: string): boolean

Parameters:

• name string

Returns: boolean

Calls:

• name[0].toUpperCase
• name.includes

Code

function isPascalCase(name: string): boolean {
  return (
    name.length === 0 ||
    (name[0] === name[0].toUpperCase() && !name.includes('_'))
  );
}

isStrictPascalCase(name: string): boolean

Parameters:

• name string

Returns: boolean

Calls:

• name[0].toUpperCase
• hasStrictCamelHumps

Code

function isStrictPascalCase(name: string): boolean {
  return (
    name.length === 0 ||
    (name[0] === name[0].toUpperCase() && hasStrictCamelHumps(name, true))
  );
}

isCamelCase(name: string): boolean

Parameters:

• name string

Returns: boolean

Calls:

• name[0].toLowerCase
• name.includes

Code

function isCamelCase(name: string): boolean {
  return (
    name.length === 0 ||
    (name[0] === name[0].toLowerCase() && !name.includes('_'))
  );
}

isStrictCamelCase(name: string): boolean

Parameters:

• name string

Returns: boolean

Calls:

• name[0].toLowerCase
• hasStrictCamelHumps

Code

function isStrictCamelCase(name: string): boolean {
  return (
    name.length === 0 ||
    (name[0] === name[0].toLowerCase() && hasStrictCamelHumps(name, false))
  );
}

hasStrictCamelHumps(name: string, isUpper: boolean): boolean

Parameters:

• name string
• isUpper boolean

Returns: boolean

Calls:

• char.toUpperCase
• char.toLowerCase
• name.startsWith
• isUppercaseChar

Code

function hasStrictCamelHumps(name: string, isUpper: boolean): boolean {
  function isUppercaseChar(char: string): boolean {
    return char === char.toUpperCase() && char !== char.toLowerCase();
  }

  if (name.startsWith('_')) {
    return false;
  }
  for (let i = 1; i < name.length; ++i) {
    if (name[i] === '_') {
      return false;
    }
    if (isUpper === isUppercaseChar(name[i])) {
      if (isUpper) {
        return false;
      }
    } else {
      isUpper = !isUpper;
    }
  }
  return true;
}

isSnakeCase(name: string): boolean

Parameters:

• name string

Returns: boolean

Calls:

• name.toLowerCase
• validateUnderscores

Code

function isSnakeCase(name: string): boolean {
  return (
    name.length === 0 ||
    (name === name.toLowerCase() && validateUnderscores(name))
  );
}

isUpperCase(name: string): boolean

Parameters:

• name string

Returns: boolean

Calls:

• name.toUpperCase
• validateUnderscores

Code

function isUpperCase(name: string): boolean {
  return (
    name.length === 0 ||
    (name === name.toUpperCase() && validateUnderscores(name))
  );
}

validateUnderscores(name: string): boolean

Check for leading trailing and adjacent underscores

Raw JSDoc

/** Check for leading trailing and adjacent underscores */

Calls:

• name.startsWith

Code

function validateUnderscores(name: string): boolean {
  if (name.startsWith('_')) {
    return false;
  }
  let wasUnderscore = false;
  for (let i = 1; i < name.length; ++i) {
    if (name[i] === '_') {
      if (wasUnderscore) {
        return false;
      }
      wasUnderscore = true;
    } else {
      wasUnderscore = false;
    }
  }
  return !wasUnderscore;
}

Internal helpers

Declared inside another function in this file.

isUppercaseChar(char: string): boolean

Parameters:

• char string

Returns: boolean

Calls:

• char.toUpperCase
• char.toLowerCase

Code

function isUppercaseChar(char: string): boolean {
    return char === char.toUpperCase() && char !== char.toLowerCase();
  }

---

Generated by Syntax Scribe