Type aliases
ARIAAttribute
ARIAAttribute
: { defaultValue
?: undefined | string ; deprecated
?: undefined | true ; enum
: string [] ; isGlobal
?: undefined | true ; name
: string ; type
: "property" | "state" ; value
: ARIAAttributeValue }
Defined in packages/@markuplint/ml-spec/src/types.ts:206
Type declaration
Optional defaultValue?: undefined | string
Optional deprecated?: undefined | true
enum: string []
Optional isGlobal?: undefined | true
name: string
type: "property" | "state"
ARIAAttributeValue
ARIAAttributeValue: "true/false" | "tristate" | "true/false/undefined" | "ID reference" | "ID reference list" | "integer" | "number" | "string" | "token" | "token list" | "URI"
Defined in packages/@markuplint/ml-spec/src/types.ts:216
ARIRRoleAttribute
ARIRRoleAttribute: { description: string ; generalization: string [] ; isAbstract?: undefined | true ; name: string ; ownedAttribute: string [] }
Defined in packages/@markuplint/ml-spec/src/types.ts:198
Type declaration
description: string
generalization: string []
Optional isAbstract?: undefined | true
name: string
ownedAttribute: string []
AnonymousNode
Defined in packages/@markuplint/ml-core/src/ml-dom/types.ts:37
Type parameters
T: RuleConfigValue
O = null
Attribute
Attribute
: { condition
?: AttributeCondition ; deprecated
?: undefined | true ; description
: string ; enum
?: string [] ; experimental
?: undefined | true ; name
: string ; noUse
?: undefined | false | true ; nonStandard
?: undefined | true ; obsolete
?: undefined | true ; required
?: true | AttributeCondition ; requiredEither
?: string [] ; type
: AttributeType }
Defined in packages/@markuplint/ml-spec/src/types.ts:140
Type declaration
Optional deprecated?: undefined | true
description: string
Optional enum?: string []
Optional experimental?: undefined | true
name: string
Optional noUse?: undefined | false | true
Optional nonStandard?: undefined | true
Optional obsolete?: undefined | true
Optional requiredEither?: string []
AttributeCondition
AttributeCondition: { ancestor?: undefined | string ; self?: string | string [] }
Defined in packages/@markuplint/ml-spec/src/types.ts:155
Type declaration
Optional ancestor?: undefined | string
Optional self?: string | string []
AttributeType
AttributeType: "String" | "Boolean" | "Function" | "Date" | "Int" | "Uint" | "Float" | "NonZeroUint" | "AcceptList" | "AutoComplete" | "BCP47" | "Color" | "ColSpan" | "Coords" | "DateTime" | "Destination" | "DOMID" | "DOMIDList" | "ItemType" | "LinkSizes" | "LinkType" | "LinkTypeList" | "MediaQuery" | "MediaQueryList" | "MIMEType" | "ReferrerPolicy" | "RowSpan" | "SourceSizeList" | "SrcSet" | "TabIndex" | "Target" | "URL" | "URLHash" | "URLList"
Defined in packages/@markuplint/ml-spec/src/types.ts:162
Cites
Cites: string []
Defined in packages/@markuplint/ml-spec/src/types.ts:21
ContentModel
ContentModel: "#phrasing" | "#flow" | "#interactive" | "#heading" | "#sectioning" | "#metadata" | "#transparent" | "#embedded" | "#palpable" | "#script-supporting"
Defined in packages/@markuplint/ml-spec/src/permitted-structres.ts:17
CosmiConfig
CosmiConfig: ReturnType < LoaderSync >
Defined in packages/@markuplint/file-resolver/src/helper.ts:7
ElementCondition
ElementCondition: { __WIP__: "WORK_IN_PROGRESS" }
Defined in packages/@markuplint/ml-spec/src/types.ts:136
Type declaration
__WIP__: "WORK_IN_PROGRESS"
ElementSpec
Element
Spec: { attributes: ( Attribute | string ) [] ; categories: ContentModel [] ; cite: string ; deprecated?: undefined | true ; description?: undefined | string ; experimental?: undefined | true ; implicitRole: { conditions?: { condition: string ; role: ImplicitRole } [] ; role: ImplicitRole ; summary: string } ; name: string ; nonStandard?: undefined | true ; obsolete?: true | { alt: string } ; omittion: ElementSpecOmittion ; permittedRoles: { conditions?: { condition: string ; roles: PermittedRoles } [] ; roles: PermittedRoles ; summary: string } ; permittedStructures: PermittedStructuresSchema }
Defined in packages/@markuplint/ml-spec/src/types.ts:33
Type declaration
attributes: ( Attribute | string ) []
cite: string
Optional deprecated?: undefined | true
Optional description?: undefined | string
Optional experimental?: undefined | true
implicitRole: { conditions?: { condition: string ; role: ImplicitRole } [] ; role: ImplicitRole ; summary: string }
Optional conditions?: { condition: string ; role: ImplicitRole } []
summary: string
name: string
Optional nonStandard?: undefined | true
Optional obsolete?: true | { alt: string }
permittedRoles: { conditions?: { condition: string ; roles: PermittedRoles } [] ; roles: PermittedRoles ; summary: string }
Optional conditions?: { condition: string ; roles: PermittedRoles } []
summary: string
ElementSpecOmittion
Defined in packages/@markuplint/ml-spec/src/types.ts:129
ElementSpecOmittionTags
Defined in packages/@markuplint/ml-spec/src/types.ts:131
ExtendedSpec
Defined in packages/@markuplint/ml-spec/src/types.ts:12
ImplicitRole
ImplicitRole: string | false
Defined in packages/@markuplint/ml-spec/src/types.ts:121
Invalid
Invalid: { invalidType: "non-existent" | "invalid-value" ; message: string }
Defined in packages/@markuplint/rules/src/invalid-attr/type-check.ts:3
Type declaration
invalidType: "non-existent" | "invalid-value"
message: string
MLASTAttr
Defined in packages/@markuplint/ml-ast/src/types.ts:91
MLASTNode
Defined in packages/@markuplint/ml-ast/src/types.ts:22
MLASTParentNode
Defined in packages/@markuplint/ml-ast/src/types.ts:81
MLASTTag
Defined in packages/@markuplint/ml-ast/src/types.ts:79
MappedNode
MappedNode<N, T, O>: N extends MLASTElement ? MLDOMElement < T , O > : N extends MLASTElementCloseTag ? MLDOMElementCloseTag < T , O > : N extends MLASTOmittedElement ? MLDOMOmittedElement < T , O > : N extends MLASTParentNode ? MLDOMElement < T , O > | MLDOMOmittedElement < T , O > : N extends MLASTComment ? MLDOMComment < T , O > : N extends MLASTText ? MLDOMText < T , O > : N extends MLASTDoctype ? MLDOMDoctype < T , O > : N extends MLASTNode ? MLDOMNode < T , O , MLASTNode > : N extends MLASTPreprocessorSpecificBlock ? MLDOMPreprocessorSpecificBlock < T , O > : N extends MLASTAbstructNode ? MLDOMNode < T , O , MLASTAbstructNode > : N extends MLASTAttr ? MLDOMAttribute : N extends MLToken ? MLDOMToken < MLToken > : never
Defined in packages/@markuplint/ml-core/src/ml-dom/helper/mapped-nodes.ts:30
Type parameters
N
T: RuleConfigValue
O = null
Node
Defined in packages/@markuplint/ml-spec/src/permitted-structres.ts:16
NodeType
NodeType: "Doctype" | "Element" | "ElementCloseTag" | "OmittedElement" | "Comment" | "Text" | "Node" | "PSBlock"
Defined in packages/@markuplint/ml-core/src/ml-dom/types.ts:46
Optional
Optional<C>: {}
Defined in packages/markuplint/src/reporter/types.ts:11
Type parameters
Parse
Parse
: ( rawCode
: string , offsetOffset
?: undefined | number , offsetLine
?: undefined | number , offsetColumn
?: undefined | number ) => MLASTDocument
Defined in packages/@markuplint/ml-ast/src/types.ts:127
Type declaration
( rawCode: string , offsetOffset?: undefined | number , offsetLine?: undefined | number , offsetColumn?: undefined | number ) : MLASTDocument
Parameters
rawCode: string
Optional offsetOffset: undefined | number
Optional offsetLine: undefined | number
Optional offsetColumn: undefined | number
PermittedContent
Defined in packages/@markuplint/ml-spec/src/permitted-structres.ts:8
PermittedContentSpec
Defined in packages/@markuplint/ml-spec/src/permitted-structres.ts:28
PermittedRoles
PermittedRoles: string [] | boolean
Defined in packages/@markuplint/ml-spec/src/types.ts:127
ReportingData
Reporting
Data: MLResultInfo & { color: boolean ; format: string ; noStdOut: boolean ; problemOnly: boolean ; verbose: boolean }
Defined in packages/markuplint/src/reporter/types.ts:3
SpecDefs
Defined in packages/@markuplint/ml-spec/src/types.ts:23
SyncWalker
SyncWalker<T, O, N>: ( node: N ) => void
Defined in packages/@markuplint/ml-core/src/ml-dom/helper/walkers.ts:6
Type parameters
T: RuleConfigValue
O = null
N = AnonymousNode < T , O >
Target
Defined in packages/@markuplint/ml-spec/src/permitted-structres.ts:15
Walker
Walker<T, O, N>: ( node: N ) => Promise < void >
Defined in packages/@markuplint/ml-ast/src/types.ts:134
Defined in packages/@markuplint/ml-core/src/ml-dom/helper/walkers.ts:4
Type parameters
T: RuleConfigValue
O = null
N = AnonymousNode < T , O >
Type declaration
Parameters
Returns Promise < void >
Variables
Const ALL
ALL: "<[^>]+>" = "<[^>]+>"
Defined in packages/@markuplint/rules/src/permitted-contents/permitted-content.spec-to-regexp.ts:16
Const CUSTOM_ELEMENT
CUSTOM_ELEMENT: string = `(?:<[a-z](?:${rePCENChar})*\\-(?:${rePCENChar})*>)`
Defined in packages/@markuplint/rules/src/permitted-contents/permitted-content.spec-to-regexp.ts:19
Const ___InTRANSPARENT
___InTRANSPARENT: "___InTRANSPARENT" = "___InTRANSPARENT"
Defined in packages/@markuplint/rules/src/permitted-contents/permitted-content.spec-to-regexp.ts:18
Const ___TRANSPARENT___
___TRANSPARENT___: "___TRANSPARENT___" = "___TRANSPARENT___"
Defined in packages/@markuplint/rules/src/permitted-contents/permitted-content.spec-to-regexp.ts:17
Let cachedLocale
cachedLocale: string | null = null
Defined in packages/markuplint/src/i18n.ts:4
Const cli
cli: Result < { color: object ; configFile: object ; fix: object ; format: object ; problemOnly: object ; verbose: object } > = meow(help, {flags: {configFile: {type: 'string',alias: 'c',},fix: {type: 'boolean',},format: {type: 'string',alias: 'f',},color: {type: 'boolean',default: true,},problemOnly: {type: 'boolean',alias: 'p',},verbose: {type: 'boolean',},},})
Defined in packages/markuplint/src/cli-bootstrap.ts:24
Const eaw
eaw: { characterLength: ( char: string ) => number } = eastasianwidth
Defined in packages/markuplint/src/reporter/utils.ts:6
Type declaration
characterLength: ( char: string ) => number
Parameters
Returns number
Const explorer
explorer: { clearCaches: ( ) => void ; clearLoadCache: ( ) => void ; clearSearchCache: ( ) => void ; load: ( filepath: string ) => Promise < CosmiconfigResult > ; search: ( searchFrom?: undefined | string ) => Promise < CosmiconfigResult > } = cosmiconfig('markuplint')
Defined in packages/@markuplint/file-resolver/src/helper.ts:5
Type declaration
Readonly clearCaches: ( ) => void
Readonly clearLoadCache: ( ) => void
Readonly clearSearchCache: ( ) => void
Readonly load: ( filepath: string ) => Promise < CosmiconfigResult >
( filepath: string ) : Promise < CosmiconfigResult >
Parameters
Returns Promise < CosmiconfigResult >
Readonly search: ( searchFrom?: undefined | string ) => Promise < CosmiconfigResult >
( searchFrom?: undefined | string ) : Promise < CosmiconfigResult >
Parameters
Optional searchFrom: undefined | string
Returns Promise < CosmiconfigResult >
Const fileCaches
file
Caches: WeakMap < MLFile , string > = new WeakMap<MLFile, string>()
Defined in packages/@markuplint/file-resolver/src/ml-file.ts:7
Const help
help: "Usage$ markuplint <HTML file pathes (glob format)>$ <stdout> | markuplintOptions--config-file, -c FILE_PATH Ruleset file path.--fix, Fix HTML.--format, -f FORMAT Output format. Support "JSON", "Simple" and "Standard". Default: "Standard".--no-color, Output no color.--problem-only, -p Output only problems, without passeds.--verbose Output with detailed information.--help, -h Show help.--version, -v Show version.Examples$ markuplint verifyee.html --ruleset path/to/.markuplintrc$ cat verifyee.html | markuplint" = `Usage$ markuplint <HTML file pathes (glob format)>$ <stdout> | markuplintOptions--config-file, -c FILE_PATH Ruleset file path.--fix, Fix HTML.--format, -f FORMAT Output format. Support "JSON", "Simple" and "Standard". Default: "Standard".--no-color, Output no color.--problem-only, -p Output only problems, without passeds.--verbose Output with detailed information.--help, -h Show help.--version, -v Show version.Examples$ markuplint verifyee.html --ruleset path/to/.markuplintrc$ cat verifyee.html | markuplint`
Defined in packages/markuplint/src/cli-bootstrap.ts:3
Const loggerError
loggerError: Format = c.red
Defined in packages/markuplint/src/reporter/standard-reporter.ts:5
Defined in packages/markuplint/src/reporter/simple-reporter.ts:5
Const loggerWarning
loggerWarning: Format = c.xterm(208)
Defined in packages/markuplint/src/reporter/standard-reporter.ts:6
Defined in packages/markuplint/src/reporter/simple-reporter.ts:6
Const markuplint
markuplint: string = `markup${c.xterm(39)('lint')}`
Defined in packages/markuplint/src/reporter/utils.ts:5
Const rawTextElements
rawTextElements: string [] = ['script', 'style']
Defined in packages/@markuplint/ml-core/src/ml-dom/tokens/text.ts:14
Const reCostomElement
reCostomElement: RegExp = new RegExp(`^(?:[a-z](?:${rePCENChar})*\\-(?:${rePCENChar})*)$`, 'i')
Defined in packages/@markuplint/rules/src/helpers.ts:169
Const rePCENChar
rePCENChar: string = ['\\-','\\.','[0-9]','_','[a-z]','\u00B7','[\u00C0-\u00D6]','[\u00D8-\u00F6]','[\u00F8-\u037D]','[\u037F-\u1FFF]','[\u200C-\u200D]','[\u203F-\u2040]','[\u2070-\u218F]','[\u2C00-\u2FEF]','[\u3001-\uD7FF]','[\uF900-\uFDCF]','[\uFDF0-\uFFFD]','[\uD800-\uDBFF][\uDC00-\uDFFF]',].join('|')
Defined in packages/@markuplint/rules/src/helpers.ts:148
Const readFile
readFile: __promisify__ = util.promisify(fs.readFile)
Defined in packages/@markuplint/file-resolver/src/ml-file.ts:6
Const stat
stat: __promisify__ = util.promisify(fs.stat)
Defined in packages/@markuplint/file-resolver/src/ml-file.ts:5
Reference URLs