UNPKG

3.46 kBJavaScriptView Raw
1export type stylelint$configExtends = string | Array<string>;
2export type stylelint$configPlugins = string | Array<string>;
3export type stylelint$configProcessors =
4 | string
5 | Array<string | [string, Object]>;
6export type stylelint$configIgnoreFiles = string | Array<string>;
7
8export type stylelint$configRuleSettings = any | [any, Object];
9export type stylelint$configRules = {
10 [ruleName: string]: stylelint$configRuleSettings
11};
12
13export type stylelint$config = {
14 extends?: stylelint$configExtends,
15 plugins?: stylelint$configPlugins,
16 pluginFunctions?: {
17 [pluginName: string]: Function
18 },
19 processors?: stylelint$configProcessors,
20 processorFunctions?: Array<Function>,
21 ignoreFiles?: stylelint$configIgnoreFiles,
22 ignorePatterns?: string,
23 rules?: stylelint$configRules,
24 codeProcessors?: Array<Function>,
25 resultProcessors?: Array<Function>,
26 quiet?: boolean
27};
28
29export type stylelint$syntaxes = "scss" | "less" | "sugarss";
30
31export type stylelint$options = {
32 config?: stylelint$config,
33 configFile?: string,
34 configBasedir?: string,
35 configOverrides?: Object,
36 ignoreDisables?: boolean,
37 ignorePath?: string,
38 reportNeedlessDisables?: boolean,
39 syntax?: stylelint$syntaxes,
40 customSyntax?: string,
41 fix?: boolean
42};
43
44export type stylelint$internalApi = {
45 _options: stylelint$options,
46 _extendExplorer: { load: Function },
47 _fullExplorer: { load: Function },
48 _configCache: Map<string, Object>,
49 _specifiedConfigCache: Map<string, Object>,
50 _postcssResultCache: Map<string, Object>,
51
52 _augmentConfig: Function,
53 _getPostcssResult: Function,
54 _lintSource: Function,
55 _createStylelintResult: Function,
56 _createEmptyPostcssResult?: Function,
57
58 getConfigForFile: Function,
59 isPathIgnored: Function,
60 lintSource: Function
61};
62
63export type stylelint$warning = {
64 line: number,
65 column: number,
66 rule: string,
67 severity: string,
68 text: string
69};
70
71export type stylelint$result = {
72 source: string,
73 deprecations: Array<{
74 text: string,
75 reference: string
76 }>,
77 invalidOptionWarnings: Array<{
78 text: string
79 }>,
80 parseErrors: Array<stylelint$warning>,
81 errored?: boolean,
82 warnings: Array<stylelint$warning>,
83 ignored?: boolean,
84 _postcssResult?: Object
85};
86
87export type stylelint$cssSyntaxError = {
88 column: number,
89 file?: string,
90 input: {
91 column: number,
92 file?: string,
93 line: number,
94 source: string
95 },
96 line: number,
97 message: string,
98 name: string,
99 reason: string,
100 source: string
101};
102
103export type stylelint$needlessDisablesReport = Array<{
104 source: string,
105 ranges: Array<{
106 start: number,
107 end?: number
108 }>
109}>;
110
111export type stylelint$standaloneReturnValue = {
112 results: Array<stylelint$result>,
113 errored: boolean,
114 output: any,
115 maxWarningsExceeded?: {
116 maxWarnings: number,
117 foundWarnings: number
118 },
119 needlessDisables?: stylelint$needlessDisablesReport
120};
121
122export type stylelint$standaloneOptions = {
123 files?: string | Array<string>,
124 cache?: boolean,
125 cacheLocation?: string,
126 code?: string,
127 codeFilename?: string,
128 config?: stylelint$config,
129 configFile?: string,
130 configBasedir?: string,
131 configOverrides?: Object,
132 ignoreDisables?: boolean,
133 ignorePath?: string,
134 reportNeedlessDisables?: boolean,
135 maxWarnings?: number,
136 syntax?: stylelint$syntaxes,
137 customSyntax?: string,
138 formatter?: "json" | "string" | "verbose" | Function,
139 disableDefaultIgnores?: boolean,
140 allowEmptyInput?: boolean,
141 fix?: boolean
142};