eslintTypes.d.ts

/* eslint-disable @typescript-eslint/prefer-literal-enum-member */
/* eslint-disable no-bitwise */
/* eslint-disable @typescript-eslint/prefer-enum-initializers */
/* eslint-disable @typescript-eslint/member-ordering */
/* eslint-disable @typescript-eslint/naming-convention */
/* eslint-disable @typescript-eslint/no-unused-vars */
// https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/rules/naming-convention-utils/types.ts
// https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/rules/naming-convention-utils/enums.ts

export interface Selector {
    // format options
    format: PredefinedFormatsString[] | null;
    custom?: MatchRegex;
    leadingUnderscore?: UnderscoreOptionsString;
    trailingUnderscore?: UnderscoreOptionsString;
    prefix?: string[];
    suffix?: string[];

    // selector options
    selector: IndividualAndMetaSelectorsString | IndividualAndMetaSelectorsString[];
    modifiers?: ModifiersString[];
    types?: TypeModifiersString[];
    filter?: MatchRegex | string;
}

interface MatchRegex {
    regex: string;
    match: boolean;
}

enum PredefinedFormats {
    camelCase = 1,
    strictCamelCase,
    PascalCase,
    StrictPascalCase,
    snake_case,
    UPPER_CASE,
}
type PredefinedFormatsString = keyof typeof PredefinedFormats;

enum UnderscoreOptions {
    forbid = 1,
    allow,
    require,

    // special cases as it's common practice to use double underscore
    requireDouble,
    allowDouble,
    allowSingleOrDouble,
}
type UnderscoreOptionsString = keyof typeof UnderscoreOptions;

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,
}
type SelectorsString = keyof typeof Selectors;

enum MetaSelectors {
    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,
}
type MetaSelectorsString = keyof typeof MetaSelectors;
type IndividualAndMetaSelectorsString = MetaSelectorsString | SelectorsString;

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,
}
type ModifiersString = keyof typeof Modifiers;

enum TypeModifiers {
    boolean = 1 << 17,
    string = 1 << 18,
    number = 1 << 19,
    function = 1 << 20,
    array = 1 << 21,
}
type TypeModifiersString = keyof typeof TypeModifiers;