⬅️ Back to Table of Contents

📄 enums

📊 Analysis Summary

Metric	Count
📑 Type Aliases	7
🎯 Enums	6

📚 Table of Contents

• Type Aliases
• Enums

🛠️ File Location:

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

Type Aliases

PredefinedFormatsString

type PredefinedFormatsString = keyof typeof PredefinedFormats;

UnderscoreOptionsString

type UnderscoreOptionsString = keyof typeof UnderscoreOptions;

SelectorsString

type SelectorsString = keyof typeof Selectors;

MetaSelectorsString

type MetaSelectorsString = keyof typeof MetaSelectors;

IndividualAndMetaSelectorsString

type IndividualAndMetaSelectorsString = MetaSelectorsString | SelectorsString;

ModifiersString

type ModifiersString = keyof typeof Modifiers;

TypeModifiersString

type TypeModifiersString = keyof typeof TypeModifiers;

---

Enums

enum PredefinedFormats

Enum Code

export enum PredefinedFormats {
  camelCase = 1,
  strictCamelCase,
  PascalCase,
  StrictPascalCase,
  snake_case,
  UPPER_CASE,
}

Members

Name	Value	Description
camelCase	1	not shown
strictCamelCase	auto	not shown
PascalCase	auto	not shown
StrictPascalCase	auto	not shown
snake_case	auto	not shown
UPPER_CASE	auto	not shown

enum UnderscoreOptions

Enum Code

export enum UnderscoreOptions {
  forbid = 1,
  allow,
  require,

  // special cases as it's common practice to use double underscore
  requireDouble,
  allowDouble,
  allowSingleOrDouble,
}

Members

Name	Value	Description
forbid	1	not shown
allow	auto	not shown
require	auto	not shown
requireDouble	auto	not shown
allowDouble	auto	not shown
allowSingleOrDouble	auto	not shown

enum Selectors

Enum Code

export enum Selectors {
  // variableLike
  variable = 1 << 0,
  function = 1 << 1,
  parameter = 1 << 2,

  // memberLike
  parameterProperty = 1 << 3,
  classicAccessor = 1 << 4,
  enumMember = 1 << 5,
  classMethod = 1 << 6,
  objectLiteralMethod = 1 << 7,
  typeMethod = 1 << 8,
  classProperty = 1 << 9,
  objectLiteralProperty = 1 << 10,
  typeProperty = 1 << 11,
  autoAccessor = 1 << 12,

  // typeLike
  class = 1 << 13,
  interface = 1 << 14,
  typeAlias = 1 << 15,
  enum = 1 << 16,
  typeParameter = 1 << 17,

  // other
  import = 1 << 18,
}

Members

Name	Value	Description
variable	1 << 0	not shown
function	1 << 1	not shown
parameter	1 << 2	not shown
parameterProperty	1 << 3	not shown
classicAccessor	1 << 4	not shown
enumMember	1 << 5	not shown
classMethod	1 << 6	not shown
objectLiteralMethod	1 << 7	not shown
typeMethod	1 << 8	not shown
classProperty	1 << 9	not shown
objectLiteralProperty	1 << 10	not shown
typeProperty	1 << 11	not shown
autoAccessor	1 << 12	not shown
class	1 << 13	not shown
interface	1 << 14	not shown
typeAlias	1 << 15	not shown
enum	1 << 16	not shown
typeParameter	1 << 17	not shown
import	1 << 18	not shown

enum MetaSelectors

Enum Code

export enum MetaSelectors {
  /* eslint-disable @typescript-eslint/prefer-literal-enum-member */
  default = -1,
  variableLike = 0 |
    Selectors.variable |
    Selectors.function |
    Selectors.parameter,
  memberLike = 0 |
    Selectors.classProperty |
    Selectors.objectLiteralProperty |
    Selectors.typeProperty |
    Selectors.parameterProperty |
    Selectors.enumMember |
    Selectors.classMethod |
    Selectors.objectLiteralMethod |
    Selectors.typeMethod |
    Selectors.classicAccessor |
    Selectors.autoAccessor,
  typeLike = 0 |
    Selectors.class |
    Selectors.interface |
    Selectors.typeAlias |
    Selectors.enum |
    Selectors.typeParameter,
  method = 0 |
    Selectors.classMethod |
    Selectors.objectLiteralMethod |
    Selectors.typeMethod,
  property = 0 |
    Selectors.classProperty |
    Selectors.objectLiteralProperty |
    Selectors.typeProperty,
  accessor = 0 | Selectors.classicAccessor | Selectors.autoAccessor,
  /* eslint-enable @typescript-eslint/prefer-literal-enum-member */
}

Members

Name	Value	Description
default	-1	not shown
variableLike	`0 | Selectors.variable | Selectors.function | Selecto...	not shown
memberLike	`0 | Selectors.classProperty | Selectors.objectLiteralP...	not shown
typeLike	`0 | Selectors.class | Selectors.interface | Selectors...	not shown
method	`0 | Selectors.classMethod | Selectors.objectLiteralMet...	not shown
property	`0 | Selectors.classProperty | Selectors.objectLiteralP...	not shown
accessor	0 \| Selectors.classicAccessor \| Selectors.autoAccessor	not shown

enum Modifiers

Enum Code

export enum Modifiers {
  // const variable
  const = 1 << 0,
  // readonly members
  readonly = 1 << 1,
  // static members
  static = 1 << 2,
  // member accessibility
  public = 1 << 3,
  protected = 1 << 4,
  private = 1 << 5,
  '#private' = 1 << 6,
  abstract = 1 << 7,
  // destructured variable
  destructured = 1 << 8,
  // variables declared in the top-level scope
  global = 1 << 9,
  // things that are exported
  exported = 1 << 10,
  // things that are unused
  unused = 1 << 11,
  // properties that require quoting
  requiresQuotes = 1 << 12,
  // class members that are overridden
  override = 1 << 13,
  // class methods, object function properties, or functions that are async via the `async` keyword
  async = 1 << 14,
  // default imports
  default = 1 << 15,
  // namespace imports
  namespace = 1 << 16,

  // make sure TypeModifiers starts at Modifiers + 1 or else sorting won't work
}

Members

Name	Value	Description
const	1 << 0	not shown
readonly	1 << 1	not shown
static	1 << 2	not shown
public	1 << 3	not shown
protected	1 << 4	not shown
private	1 << 5	not shown
'#private'	1 << 6	not shown
abstract	1 << 7	not shown
destructured	1 << 8	not shown
global	1 << 9	not shown
exported	1 << 10	not shown
unused	1 << 11	not shown
requiresQuotes	1 << 12	not shown
override	1 << 13	not shown
async	1 << 14	not shown
default	1 << 15	not shown
namespace	1 << 16	not shown

enum TypeModifiers

Enum Code

export enum TypeModifiers {
  boolean = 1 << 17,
  string = 1 << 18,
  number = 1 << 19,
  function = 1 << 20,
  array = 1 << 21,
}

Members

Name	Value	Description
boolean	1 << 17	not shown
string	1 << 18	not shown
number	1 << 19	not shown
function	1 << 20	not shown
array	1 << 21	not shown

---

Generated by Syntax Scribe