forked from rDrama/rDrama
139 lines
2.7 KiB
TypeScript
139 lines
2.7 KiB
TypeScript
import { RangePosition } from './css-syntax-error.js'
|
||
import Node from './node.js'
|
||
|
||
export interface WarningOptions {
|
||
/**
|
||
* CSS node that caused the warning.
|
||
*/
|
||
node?: Node
|
||
|
||
/**
|
||
* Word in CSS source that caused the warning.
|
||
*/
|
||
word?: string
|
||
|
||
/**
|
||
* Start index, inclusive, in CSS node string that caused the warning.
|
||
*/
|
||
index?: number
|
||
|
||
/**
|
||
* End index, exclusive, in CSS node string that caused the warning.
|
||
*/
|
||
endIndex?: number
|
||
|
||
/**
|
||
* Start position, inclusive, in CSS node string that caused the warning.
|
||
*/
|
||
start?: RangePosition
|
||
|
||
/**
|
||
* End position, exclusive, in CSS node string that caused the warning.
|
||
*/
|
||
end?: RangePosition
|
||
|
||
/**
|
||
* Name of the plugin that created this warning. `Result#warn` fills
|
||
* this property automatically.
|
||
*/
|
||
plugin?: string
|
||
}
|
||
|
||
/**
|
||
* Represents a plugin’s warning. It can be created using `Node#warn`.
|
||
*
|
||
* ```js
|
||
* if (decl.important) {
|
||
* decl.warn(result, 'Avoid !important', { word: '!important' })
|
||
* }
|
||
* ```
|
||
*/
|
||
export default class Warning {
|
||
/**
|
||
* Type to filter warnings from `Result#messages`.
|
||
* Always equal to `"warning"`.
|
||
*/
|
||
type: 'warning'
|
||
|
||
/**
|
||
* The warning message.
|
||
*
|
||
* ```js
|
||
* warning.text //=> 'Try to avoid !important'
|
||
* ```
|
||
*/
|
||
text: string
|
||
|
||
/**
|
||
* The name of the plugin that created this warning.
|
||
* When you call `Node#warn` it will fill this property automatically.
|
||
*
|
||
* ```js
|
||
* warning.plugin //=> 'postcss-important'
|
||
* ```
|
||
*/
|
||
plugin: string
|
||
|
||
/**
|
||
* Contains the CSS node that caused the warning.
|
||
*
|
||
* ```js
|
||
* warning.node.toString() //=> 'color: white !important'
|
||
* ```
|
||
*/
|
||
node: Node
|
||
|
||
/**
|
||
* Line for inclusive start position in the input file with this warning’s source.
|
||
*
|
||
* ```js
|
||
* warning.line //=> 5
|
||
* ```
|
||
*/
|
||
line: number
|
||
|
||
/**
|
||
* Column for inclusive start position in the input file with this warning’s source.
|
||
*
|
||
* ```js
|
||
* warning.column //=> 6
|
||
* ```
|
||
*/
|
||
column: number
|
||
|
||
/**
|
||
* Line for exclusive end position in the input file with this warning’s source.
|
||
*
|
||
* ```js
|
||
* warning.endLine //=> 6
|
||
* ```
|
||
*/
|
||
endLine?: number
|
||
|
||
/**
|
||
* Column for exclusive end position in the input file with this warning’s source.
|
||
*
|
||
* ```js
|
||
* warning.endColumn //=> 4
|
||
* ```
|
||
*/
|
||
endColumn?: number
|
||
|
||
/**
|
||
* @param text Warning message.
|
||
* @param opts Warning options.
|
||
*/
|
||
constructor(text: string, opts?: WarningOptions)
|
||
|
||
/**
|
||
* Returns a warning position and message.
|
||
*
|
||
* ```js
|
||
* warning.toString() //=> 'postcss-lint:a.css:10:14: Avoid !important'
|
||
* ```
|
||
*
|
||
* @return Warning position and message.
|
||
*/
|
||
toString(): string
|
||
}
|