navigation

Naming

Namespace: FSharpLint.Rules.Helper
Parent: FSharpLint.Rules.Helper
Declared Types
Type Description
AccessControlLevel

Specifies access control level as described in https://docs.microsoft.com/en-us/dotnet/fsharp/language-reference/access-control . Higher levels also include lower levels, so e.g. identifier marked with Public is also accessible in Internal and Private scopes. Public scope is the widest, then goes Internal, then Private.

GetIdents<'T>

Declared Modules
Module Description
QuickFixes

Values and Functions
Name Description
isPascalCase

Signature: identifier:string -> bool
isCamelCase

Signature: identifier:string -> bool
toAstNodeRule

Signature: namingRule:RuleMetadata -> RuleMetadata
isActivePattern

Signature: identifier:Ident -> bool
activePatternIdentifiers

Signature: identifier:Ident -> string []
getAccessControlLevel

Signature: syntaxArray:Node [] -> i:int -> AccessControlLevel
isAttribute

Signature: name:string -> attributes:SynAttributes -> bool

Is an attribute with a given name? e.g. check for Literal attribute.

isLiteral

Signature: SynAttributes -> bool
isExtern

Signature: SynAttributes -> bool
isMeasureType

Signature: SynAttributes -> bool
isNotUnionCase

Signature: checkFile:FSharpCheckFileResults -> ident:Ident -> bool
isInterface

Signature: typeDef:SynTypeDefnRepr -> bool
checkAccessibility

Signature: currentAccessibility:AccessControlLevel -> _arg1:SynAccess option -> AccessControlLevel
isModule

Signature: moduleKind:SynModuleOrNamespaceKind -> bool
isImplicitModule

Signature: SynModuleOrNamespace -> bool

Is module name implicitly created from file name?

getPatternIdents

Signature: accessibility:AccessControlLevel -> getIdents:GetIdents<'T> -> argsAreParameters:bool -> pattern:SynPat -> 'T []

Recursively get all identifiers from pattern using provided getIdents function and collect them into array. accessibility parameter is passed to getIdents, and can be narrowed down along the way (see checkAccessibility).

identFromSimplePat

Signature: _arg1:SynSimplePat -> Ident option
isNested

Signature: args:AstNodeRuleParams -> nodeIndex:int -> bool
getFunctionIdents

Signature: pattern:SynPat -> (Ident * string * 'b option) []