@mnaoumov/typescript-dev-toolkit 3.13.1 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (74) hide show
  1. package/dist/lib/cjs/bundlers/esbuild-impl/preprocess-plugin.cjs +1 -1
  2. package/dist/lib/cjs/bundlers/esbuild-impl/preprocess-plugin.d.cts +1 -1
  3. package/dist/lib/cjs/docs-site/api-doc-link-rendering.cjs +1 -1
  4. package/dist/lib/cjs/docs-site/api-doc-settings.cjs +1 -1
  5. package/dist/lib/cjs/docs-site/api-doc-types.cjs +1 -1
  6. package/dist/lib/cjs/docs-site/api-doc-types.d.cts +57 -57
  7. package/dist/lib/cjs/docs-site/link-check.cjs +1 -1
  8. package/dist/lib/cjs/docs-site/link-check.d.cts +8 -8
  9. package/dist/lib/cjs/docs-site/og-images.cjs +1 -1
  10. package/dist/lib/cjs/docs-site/satteri-github-alerts.cjs +1 -1
  11. package/dist/lib/cjs/docs-site/unrendered-alerts.cjs +1 -1
  12. package/dist/lib/cjs/docs-site/unrendered-alerts.d.cts +2 -2
  13. package/dist/lib/cjs/linters/eslint-agnostic-core-boundary.cjs +1 -1
  14. package/dist/lib/cjs/linters/eslint-agnostic-core-boundary.d.cts +2 -2
  15. package/dist/lib/cjs/linters/eslint-config.cjs +2 -2
  16. package/dist/lib/cjs/linters/eslint-no-restricted-syntax.cjs +1 -1
  17. package/dist/lib/cjs/linters/eslint-no-restricted-syntax.d.cts +2 -2
  18. package/dist/lib/cjs/linters/eslint-rules/in-house-plugin.cjs +3 -3
  19. package/dist/lib/cjs/linters/eslint-rules/index.cjs +4 -4
  20. package/dist/lib/cjs/linters/eslint-rules/index.d.cts +1 -1
  21. package/dist/lib/cjs/linters/eslint-rules/no-unused-params-members.cjs +1 -1
  22. package/dist/lib/cjs/linters/eslint-rules/no-used-underscore-variables.cjs +1 -1
  23. package/dist/lib/cjs/linters/eslint-rules/readonly-interface-members.cjs +68 -0
  24. package/dist/lib/cjs/linters/eslint-rules/readonly-interface-members.d.cts +18 -0
  25. package/dist/lib/cjs/linters/eslint-rules/require-method-template.cjs +1 -1
  26. package/dist/lib/cjs/linters/eslint-rules/require-super-call.cjs +1 -1
  27. package/dist/lib/cjs/linters/eslint-types/@types/@eslint-community__eslint-plugin-eslint-comments__configs.d.cts +1 -1
  28. package/dist/lib/cjs/linters/markdownlint-types/@types/markdownlint-cli2-config-schema.d.cts +279 -279
  29. package/dist/lib/cjs/linters/over-exposure.cjs +1 -1
  30. package/dist/lib/cjs/linters/over-exposure.d.cts +6 -6
  31. package/dist/lib/cjs/npm.cjs +1 -1
  32. package/dist/lib/cjs/npm.d.cts +1 -1
  33. package/dist/lib/cjs/upstream-sync.cjs +1 -1
  34. package/dist/lib/cjs/upstream-sync.d.cts +31 -31
  35. package/dist/lib/esm/bundlers/esbuild-impl/preprocess-plugin.d.mts +1 -1
  36. package/dist/lib/esm/bundlers/esbuild-impl/preprocess-plugin.mjs +1 -1
  37. package/dist/lib/esm/docs-site/api-doc-link-rendering.mjs +1 -1
  38. package/dist/lib/esm/docs-site/api-doc-settings.mjs +1 -1
  39. package/dist/lib/esm/docs-site/api-doc-types.d.mts +57 -57
  40. package/dist/lib/esm/docs-site/link-check.d.mts +8 -8
  41. package/dist/lib/esm/docs-site/link-check.mjs +1 -1
  42. package/dist/lib/esm/docs-site/og-images.mjs +1 -1
  43. package/dist/lib/esm/docs-site/satteri-github-alerts.mjs +1 -1
  44. package/dist/lib/esm/docs-site/unrendered-alerts.d.mts +2 -2
  45. package/dist/lib/esm/docs-site/unrendered-alerts.mjs +1 -1
  46. package/dist/lib/esm/linters/eslint-agnostic-core-boundary.d.mts +2 -2
  47. package/dist/lib/esm/linters/eslint-agnostic-core-boundary.mjs +1 -1
  48. package/dist/lib/esm/linters/eslint-config.mjs +2 -2
  49. package/dist/lib/esm/linters/eslint-no-restricted-syntax.d.mts +2 -2
  50. package/dist/lib/esm/linters/eslint-no-restricted-syntax.mjs +1 -1
  51. package/dist/lib/esm/linters/eslint-rules/in-house-plugin.mjs +3 -3
  52. package/dist/lib/esm/linters/eslint-rules/index.d.mts +1 -1
  53. package/dist/lib/esm/linters/eslint-rules/index.mjs +3 -3
  54. package/dist/lib/esm/linters/eslint-rules/no-unused-params-members.mjs +1 -1
  55. package/dist/lib/esm/linters/eslint-rules/no-used-underscore-variables.mjs +1 -1
  56. package/dist/lib/esm/linters/eslint-rules/readonly-interface-members.d.mts +18 -0
  57. package/dist/lib/esm/linters/eslint-rules/readonly-interface-members.mjs +43 -0
  58. package/dist/lib/esm/linters/eslint-rules/require-method-template.mjs +1 -1
  59. package/dist/lib/esm/linters/eslint-rules/require-super-call.mjs +1 -1
  60. package/dist/lib/esm/linters/eslint-types/@types/@eslint-community__eslint-plugin-eslint-comments__configs.d.mts +1 -1
  61. package/dist/lib/esm/linters/markdownlint-types/@types/markdownlint-cli2-config-schema.d.mts +279 -279
  62. package/dist/lib/esm/linters/over-exposure.d.mts +6 -6
  63. package/dist/lib/esm/linters/over-exposure.mjs +1 -1
  64. package/dist/lib/esm/npm.d.mts +1 -1
  65. package/dist/lib/esm/npm.mjs +1 -1
  66. package/dist/lib/esm/upstream-sync.d.mts +31 -31
  67. package/dist/lib/esm/upstream-sync.mjs +1 -1
  68. package/linters/eslint-rules/readonly-interface-members/package.json +6 -0
  69. package/package.json +1 -1
  70. package/dist/lib/cjs/linters/eslint-rules/readonly-params-options-result-members.cjs +0 -103
  71. package/dist/lib/cjs/linters/eslint-rules/readonly-params-options-result-members.d.cts +0 -20
  72. package/dist/lib/esm/linters/eslint-rules/readonly-params-options-result-members.d.mts +0 -20
  73. package/dist/lib/esm/linters/eslint-rules/readonly-params-options-result-members.mjs +0 -78
  74. package/linters/eslint-rules/readonly-params-options-result-members/package.json +0 -6
@@ -14,39 +14,39 @@ export interface MarkdownlintCli2ConfigurationSchema {
14
14
  /**
15
15
  * JSON Schema URI (expected by some editors)
16
16
  */
17
- $schema?: string;
17
+ readonly $schema?: string;
18
18
  /**
19
19
  * Markdownlint configuration schema : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/schema/.markdownlint.jsonc
20
20
  */
21
- config?: MarkdownlintConfigurationSchema;
21
+ readonly config?: MarkdownlintConfigurationSchema;
22
22
  /**
23
23
  * Module names or paths of custom rules to load and use when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.18.1/README.md#markdownlint-cli2jsonc
24
24
  */
25
- customRules?: (Rule | string)[];
25
+ readonly customRules?: (Rule | string)[];
26
26
  /**
27
27
  * Whether to enable fixing of linting errors reported by rules that emit fix information : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.18.1/README.md#markdownlint-cli2jsonc
28
28
  */
29
- fix?: boolean;
29
+ readonly fix?: boolean;
30
30
  /**
31
31
  * Regular expression used to match and ignore any front matter at the beginning of a document : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.18.1/README.md#markdownlint-cli2jsonc
32
32
  */
33
- frontMatter?: string;
33
+ readonly frontMatter?: string;
34
34
  /**
35
35
  * Whether to ignore files referenced by .gitignore (or glob expression) (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.18.1/README.md#markdownlint-cli2jsonc
36
36
  */
37
- gitignore?: boolean | string;
37
+ readonly gitignore?: boolean | string;
38
38
  /**
39
39
  * Glob expressions to include when linting (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.18.1/README.md#markdownlint-cli2jsonc
40
40
  */
41
- globs?: string[];
41
+ readonly globs?: string[];
42
42
  /**
43
43
  * Glob expressions to ignore when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.18.1/README.md#markdownlint-cli2jsonc
44
44
  */
45
- ignores?: string[];
45
+ readonly ignores?: string[];
46
46
  /**
47
47
  * Markdown-it plugins to load and use when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.18.1/README.md#markdownlint-cli2jsonc
48
48
  */
49
- markdownItPlugins?:
49
+ readonly markdownItPlugins?:
50
50
  | [
51
51
  string,
52
52
  Record<string, unknown>
@@ -55,23 +55,23 @@ export interface MarkdownlintCli2ConfigurationSchema {
55
55
  /**
56
56
  * Additional paths to resolve module locations from : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.18.1/README.md#markdownlint-cli2jsonc
57
57
  */
58
- modulePaths?: string[];
58
+ readonly modulePaths?: string[];
59
59
  /**
60
60
  * Whether to disable the display of the banner message and version numbers on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.18.1/README.md#markdownlint-cli2jsonc
61
61
  */
62
- noBanner?: boolean;
62
+ readonly noBanner?: boolean;
63
63
  /**
64
64
  * Whether to disable support of HTML comments within Markdown content : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.18.1/README.md#markdownlint-cli2jsonc
65
65
  */
66
- noInlineConfig?: boolean;
66
+ readonly noInlineConfig?: boolean;
67
67
  /**
68
68
  * Whether to disable the display of progress on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.18.1/README.md#markdownlint-cli2jsonc
69
69
  */
70
- noProgress?: boolean;
70
+ readonly noProgress?: boolean;
71
71
  /**
72
72
  * Output formatters to load and use to customize markdownlint-cli2 output (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.18.1/README.md#markdownlint-cli2jsonc
73
73
  */
74
- outputFormatters?:
74
+ readonly outputFormatters?:
75
75
  | [
76
76
  string,
77
77
  Record<string, unknown>
@@ -80,7 +80,7 @@ export interface MarkdownlintCli2ConfigurationSchema {
80
80
  /**
81
81
  * Whether to show the list of found files on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.18.1/README.md#markdownlint-cli2jsonc
82
82
  */
83
- showFound?: boolean;
83
+ readonly showFound?: boolean;
84
84
  }
85
85
  /**
86
86
  * Markdownlint configuration schema : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/schema/.markdownlint.jsonc
@@ -90,1255 +90,1255 @@ export interface MarkdownlintConfigurationSchema {
90
90
  /**
91
91
  * JSON Schema URI (expected by some editors)
92
92
  */
93
- '$schema'?: string;
93
+ readonly '$schema'?: string;
94
94
  /**
95
95
  * Accessibility : MD045, MD059
96
96
  */
97
- 'accessibility'?: boolean;
97
+ readonly 'accessibility'?: boolean;
98
98
  /**
99
99
  * Atx : MD018, MD019
100
100
  */
101
- 'atx'?: boolean;
101
+ readonly 'atx'?: boolean;
102
102
  /**
103
103
  * Atx_closed : MD020, MD021
104
104
  */
105
- 'atx_closed'?: boolean;
105
+ readonly 'atx_closed'?: boolean;
106
106
  /**
107
107
  * Blank_lines : MD012, MD022, MD031, MD032, MD047
108
108
  */
109
- 'blank_lines'?: boolean;
109
+ readonly 'blank_lines'?: boolean;
110
110
  /**
111
111
  * MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md031.md
112
112
  */
113
- 'blanks-around-fences'?:
113
+ readonly 'blanks-around-fences'?:
114
114
  | {
115
115
  /**
116
116
  * Include list items
117
117
  */
118
- list_items?: boolean;
118
+ readonly list_items?: boolean;
119
119
  }
120
120
  | boolean;
121
121
  /**
122
122
  * MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md022.md
123
123
  */
124
- 'blanks-around-headings'?:
124
+ readonly 'blanks-around-headings'?:
125
125
  | {
126
126
  /**
127
127
  * Blank lines above heading
128
128
  */
129
- lines_above?: number | number[];
129
+ readonly lines_above?: number | number[];
130
130
  /**
131
131
  * Blank lines below heading
132
132
  */
133
- lines_below?: number | number[];
133
+ readonly lines_below?: number | number[];
134
134
  }
135
135
  | boolean;
136
136
  /**
137
137
  * MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md032.md
138
138
  */
139
- 'blanks-around-lists'?: boolean;
139
+ readonly 'blanks-around-lists'?: boolean;
140
140
  /**
141
141
  * MD058/blanks-around-tables : Tables should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md058.md
142
142
  */
143
- 'blanks-around-tables'?: boolean;
143
+ readonly 'blanks-around-tables'?: boolean;
144
144
  /**
145
145
  * Blockquote : MD027, MD028
146
146
  */
147
- 'blockquote'?: boolean;
147
+ readonly 'blockquote'?: boolean;
148
148
  /**
149
149
  * Bullet : MD004, MD005, MD007, MD032
150
150
  */
151
- 'bullet'?: boolean;
151
+ readonly 'bullet'?: boolean;
152
152
  /**
153
153
  * Code : MD014, MD031, MD038, MD040, MD046, MD048
154
154
  */
155
- 'code'?: boolean;
155
+ readonly 'code'?: boolean;
156
156
  /**
157
157
  * MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md046.md
158
158
  */
159
- 'code-block-style'?:
159
+ readonly 'code-block-style'?:
160
160
  | {
161
161
  /**
162
162
  * Block style
163
163
  */
164
- style?: 'consistent' | 'fenced' | 'indented';
164
+ readonly style?: 'consistent' | 'fenced' | 'indented';
165
165
  }
166
166
  | boolean;
167
167
  /**
168
168
  * MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md048.md
169
169
  */
170
- 'code-fence-style'?:
170
+ readonly 'code-fence-style'?:
171
171
  | {
172
172
  /**
173
173
  * Code fence style
174
174
  */
175
- style?: 'backtick' | 'consistent' | 'tilde';
175
+ readonly style?: 'backtick' | 'consistent' | 'tilde';
176
176
  }
177
177
  | boolean;
178
178
  /**
179
179
  * MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md014.md
180
180
  */
181
- 'commands-show-output'?: boolean;
181
+ readonly 'commands-show-output'?: boolean;
182
182
  /**
183
183
  * Default state for all rules
184
184
  */
185
- 'default'?: boolean;
185
+ readonly 'default'?: boolean;
186
186
  /**
187
187
  * MD059/descriptive-link-text : Link text should be descriptive : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md
188
188
  */
189
- 'descriptive-link-text'?:
189
+ readonly 'descriptive-link-text'?:
190
190
  | {
191
191
  /**
192
192
  * Prohibited link texts
193
193
  */
194
- prohibited_texts?: string[];
194
+ readonly prohibited_texts?: string[];
195
195
  }
196
196
  | boolean;
197
197
  /**
198
198
  * Emphasis : MD036, MD037, MD049, MD050
199
199
  */
200
- 'emphasis'?: boolean;
200
+ readonly 'emphasis'?: boolean;
201
201
  /**
202
202
  * MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md049.md
203
203
  */
204
- 'emphasis-style'?:
204
+ readonly 'emphasis-style'?:
205
205
  | {
206
206
  /**
207
207
  * Emphasis style
208
208
  */
209
- style?: 'asterisk' | 'consistent' | 'underscore';
209
+ readonly style?: 'asterisk' | 'consistent' | 'underscore';
210
210
  }
211
211
  | boolean;
212
212
  /**
213
213
  * Path to configuration file to extend
214
214
  */
215
- 'extends'?: null | string;
215
+ readonly 'extends'?: null | string;
216
216
  /**
217
217
  * MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md040.md
218
218
  */
219
- 'fenced-code-language'?:
219
+ readonly 'fenced-code-language'?:
220
220
  | {
221
221
  /**
222
222
  * List of languages
223
223
  */
224
- allowed_languages?: string[];
224
+ readonly allowed_languages?: string[];
225
225
  /**
226
226
  * Require language only
227
227
  */
228
- language_only?: boolean;
228
+ readonly language_only?: boolean;
229
229
  }
230
230
  | boolean;
231
231
  /**
232
232
  * MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md041.md
233
233
  */
234
- 'first-line-h1'?:
234
+ readonly 'first-line-h1'?:
235
235
  | {
236
236
  /**
237
237
  * Allow content before first heading
238
238
  */
239
- allow_preamble?: boolean;
239
+ readonly allow_preamble?: boolean;
240
240
  /**
241
241
  * RegExp for matching title in front matter
242
242
  */
243
- front_matter_title?: string;
243
+ readonly front_matter_title?: string;
244
244
  /**
245
245
  * Heading level
246
246
  */
247
- level?: number;
247
+ readonly level?: number;
248
248
  }
249
249
  | boolean;
250
250
  /**
251
251
  * MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md041.md
252
252
  */
253
- 'first-line-heading'?:
253
+ readonly 'first-line-heading'?:
254
254
  | {
255
255
  /**
256
256
  * Allow content before first heading
257
257
  */
258
- allow_preamble?: boolean;
258
+ readonly allow_preamble?: boolean;
259
259
  /**
260
260
  * RegExp for matching title in front matter
261
261
  */
262
- front_matter_title?: string;
262
+ readonly front_matter_title?: string;
263
263
  /**
264
264
  * Heading level
265
265
  */
266
- level?: number;
266
+ readonly level?: number;
267
267
  }
268
268
  | boolean;
269
269
  /**
270
270
  * Hard_tab : MD010
271
271
  */
272
- 'hard_tab'?: boolean;
272
+ readonly 'hard_tab'?: boolean;
273
273
  /**
274
274
  * MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md001.md
275
275
  */
276
- 'heading-increment'?: boolean;
276
+ readonly 'heading-increment'?: boolean;
277
277
  /**
278
278
  * MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md023.md
279
279
  */
280
- 'heading-start-left'?: boolean;
280
+ readonly 'heading-start-left'?: boolean;
281
281
  /**
282
282
  * MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md003.md
283
283
  */
284
- 'heading-style'?:
284
+ readonly 'heading-style'?:
285
285
  | {
286
286
  /**
287
287
  * Heading style
288
288
  */
289
- style?: 'atx_closed' | 'atx' | 'consistent' | 'setext_with_atx_closed' | 'setext_with_atx' | 'setext';
289
+ readonly style?: 'atx_closed' | 'atx' | 'consistent' | 'setext_with_atx_closed' | 'setext_with_atx' | 'setext';
290
290
  }
291
291
  | boolean;
292
292
  /**
293
293
  * Headings : MD001, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043
294
294
  */
295
- 'headings'?: boolean;
295
+ readonly 'headings'?: boolean;
296
296
  /**
297
297
  * Hr : MD035
298
298
  */
299
- 'hr'?: boolean;
299
+ readonly 'hr'?: boolean;
300
300
  /**
301
301
  * MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md035.md
302
302
  */
303
- 'hr-style'?:
303
+ readonly 'hr-style'?:
304
304
  | {
305
305
  /**
306
306
  * Horizontal rule style
307
307
  */
308
- style?: string;
308
+ readonly style?: string;
309
309
  }
310
310
  | boolean;
311
311
  /**
312
312
  * Html : MD033
313
313
  */
314
- 'html'?: boolean;
314
+ readonly 'html'?: boolean;
315
315
  /**
316
316
  * Images : MD045, MD052, MD053, MD054
317
317
  */
318
- 'images'?: boolean;
318
+ readonly 'images'?: boolean;
319
319
  /**
320
320
  * Indentation : MD005, MD007, MD027
321
321
  */
322
- 'indentation'?: boolean;
322
+ readonly 'indentation'?: boolean;
323
323
  /**
324
324
  * Language : MD040
325
325
  */
326
- 'language'?: boolean;
326
+ readonly 'language'?: boolean;
327
327
  /**
328
328
  * Line_length : MD013
329
329
  */
330
- 'line_length'?: boolean;
330
+ readonly 'line_length'?: boolean;
331
331
  /**
332
332
  * MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md
333
333
  */
334
- 'line-length'?:
334
+ readonly 'line-length'?:
335
335
  | {
336
336
  /**
337
337
  * Number of characters for code blocks
338
338
  */
339
- code_block_line_length?: number;
339
+ readonly code_block_line_length?: number;
340
340
  /**
341
341
  * Include code blocks
342
342
  */
343
- code_blocks?: boolean;
343
+ readonly code_blocks?: boolean;
344
344
  /**
345
345
  * Number of characters for headings
346
346
  */
347
- heading_line_length?: number;
347
+ readonly heading_line_length?: number;
348
348
  /**
349
349
  * Include headings
350
350
  */
351
- headings?: boolean;
351
+ readonly headings?: boolean;
352
352
  /**
353
353
  * Number of characters
354
354
  */
355
- line_length?: number;
355
+ readonly line_length?: number;
356
356
  /**
357
357
  * Stern length checking
358
358
  */
359
- stern?: boolean;
359
+ readonly stern?: boolean;
360
360
  /**
361
361
  * Strict length checking
362
362
  */
363
- strict?: boolean;
363
+ readonly strict?: boolean;
364
364
  /**
365
365
  * Include tables
366
366
  */
367
- tables?: boolean;
367
+ readonly tables?: boolean;
368
368
  }
369
369
  | boolean;
370
370
  /**
371
371
  * MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md051.md
372
372
  */
373
- 'link-fragments'?:
373
+ readonly 'link-fragments'?:
374
374
  | {
375
375
  /**
376
376
  * Ignore case of fragments
377
377
  */
378
- ignore_case?: boolean;
378
+ readonly ignore_case?: boolean;
379
379
  /**
380
380
  * Pattern for ignoring additional fragments
381
381
  */
382
- ignored_pattern?: string;
382
+ readonly ignored_pattern?: string;
383
383
  }
384
384
  | boolean;
385
385
  /**
386
386
  * MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md053.md
387
387
  */
388
- 'link-image-reference-definitions'?:
388
+ readonly 'link-image-reference-definitions'?:
389
389
  | {
390
390
  /**
391
391
  * Ignored definitions
392
392
  */
393
- ignored_definitions?: string[];
393
+ readonly ignored_definitions?: string[];
394
394
  }
395
395
  | boolean;
396
396
  /**
397
397
  * MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md054.md
398
398
  */
399
- 'link-image-style'?:
399
+ readonly 'link-image-style'?:
400
400
  | {
401
401
  /**
402
402
  * Allow autolinks
403
403
  */
404
- autolink?: boolean;
404
+ readonly autolink?: boolean;
405
405
  /**
406
406
  * Allow collapsed reference links and images
407
407
  */
408
- collapsed?: boolean;
408
+ readonly collapsed?: boolean;
409
409
  /**
410
410
  * Allow full reference links and images
411
411
  */
412
- full?: boolean;
412
+ readonly full?: boolean;
413
413
  /**
414
414
  * Allow inline links and images
415
415
  */
416
- inline?: boolean;
416
+ readonly inline?: boolean;
417
417
  /**
418
418
  * Allow shortcut reference links and images
419
419
  */
420
- shortcut?: boolean;
420
+ readonly shortcut?: boolean;
421
421
  /**
422
422
  * Allow URLs as inline links
423
423
  */
424
- url_inline?: boolean;
424
+ readonly url_inline?: boolean;
425
425
  }
426
426
  | boolean;
427
427
  /**
428
428
  * Links : MD011, MD034, MD039, MD042, MD051, MD052, MD053, MD054, MD059
429
429
  */
430
- 'links'?: boolean;
430
+ readonly 'links'?: boolean;
431
431
  /**
432
432
  * MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md005.md
433
433
  */
434
- 'list-indent'?: boolean;
434
+ readonly 'list-indent'?: boolean;
435
435
  /**
436
436
  * MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md030.md
437
437
  */
438
- 'list-marker-space'?:
438
+ readonly 'list-marker-space'?:
439
439
  | {
440
440
  /**
441
441
  * Spaces for multi-line ordered list items
442
442
  */
443
- ol_multi?: number;
443
+ readonly ol_multi?: number;
444
444
  /**
445
445
  * Spaces for single-line ordered list items
446
446
  */
447
- ol_single?: number;
447
+ readonly ol_single?: number;
448
448
  /**
449
449
  * Spaces for multi-line unordered list items
450
450
  */
451
- ul_multi?: number;
451
+ readonly ul_multi?: number;
452
452
  /**
453
453
  * Spaces for single-line unordered list items
454
454
  */
455
- ul_single?: number;
455
+ readonly ul_single?: number;
456
456
  }
457
457
  | boolean;
458
458
  /**
459
459
  * MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md001.md
460
460
  */
461
- 'MD001'?: boolean;
461
+ readonly 'MD001'?: boolean;
462
462
  /**
463
463
  * MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md003.md
464
464
  */
465
- 'MD003'?:
465
+ readonly 'MD003'?:
466
466
  | {
467
467
  /**
468
468
  * Heading style
469
469
  */
470
- style?: 'atx_closed' | 'atx' | 'consistent' | 'setext_with_atx_closed' | 'setext_with_atx' | 'setext';
470
+ readonly style?: 'atx_closed' | 'atx' | 'consistent' | 'setext_with_atx_closed' | 'setext_with_atx' | 'setext';
471
471
  }
472
472
  | boolean;
473
473
  /**
474
474
  * MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md004.md
475
475
  */
476
- 'MD004'?:
476
+ readonly 'MD004'?:
477
477
  | {
478
478
  /**
479
479
  * List style
480
480
  */
481
- style?: 'asterisk' | 'consistent' | 'dash' | 'plus' | 'sublist';
481
+ readonly style?: 'asterisk' | 'consistent' | 'dash' | 'plus' | 'sublist';
482
482
  }
483
483
  | boolean;
484
484
  /**
485
485
  * MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md005.md
486
486
  */
487
- 'MD005'?: boolean;
487
+ readonly 'MD005'?: boolean;
488
488
  /**
489
489
  * MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md007.md
490
490
  */
491
- 'MD007'?:
491
+ readonly 'MD007'?:
492
492
  | {
493
493
  /**
494
494
  * Spaces for indent
495
495
  */
496
- indent?: number;
496
+ readonly indent?: number;
497
497
  /**
498
498
  * Spaces for first level indent (when start_indented is set)
499
499
  */
500
- start_indent?: number;
500
+ readonly start_indent?: number;
501
501
  /**
502
502
  * Whether to indent the first level of the list
503
503
  */
504
- start_indented?: boolean;
504
+ readonly start_indented?: boolean;
505
505
  }
506
506
  | boolean;
507
507
  /**
508
508
  * MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
509
509
  */
510
- 'MD009'?:
510
+ readonly 'MD009'?:
511
511
  | {
512
512
  /**
513
513
  * Spaces for line break
514
514
  */
515
- br_spaces?: number;
515
+ readonly br_spaces?: number;
516
516
  /**
517
517
  * Allow spaces for empty lines in list items
518
518
  */
519
- list_item_empty_lines?: boolean;
519
+ readonly list_item_empty_lines?: boolean;
520
520
  /**
521
521
  * Include unnecessary breaks
522
522
  */
523
- strict?: boolean;
523
+ readonly strict?: boolean;
524
524
  }
525
525
  | boolean;
526
526
  /**
527
527
  * MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md010.md
528
528
  */
529
- 'MD010'?:
529
+ readonly 'MD010'?:
530
530
  | {
531
531
  /**
532
532
  * Include code blocks
533
533
  */
534
- code_blocks?: boolean;
534
+ readonly code_blocks?: boolean;
535
535
  /**
536
536
  * Fenced code languages to ignore
537
537
  */
538
- ignore_code_languages?: string[];
538
+ readonly ignore_code_languages?: string[];
539
539
  /**
540
540
  * Number of spaces for each hard tab
541
541
  */
542
- spaces_per_tab?: number;
542
+ readonly spaces_per_tab?: number;
543
543
  }
544
544
  | boolean;
545
545
  /**
546
546
  * MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md011.md
547
547
  */
548
- 'MD011'?: boolean;
548
+ readonly 'MD011'?: boolean;
549
549
  /**
550
550
  * MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md012.md
551
551
  */
552
- 'MD012'?:
552
+ readonly 'MD012'?:
553
553
  | {
554
554
  /**
555
555
  * Consecutive blank lines
556
556
  */
557
- maximum?: number;
557
+ readonly maximum?: number;
558
558
  }
559
559
  | boolean;
560
560
  /**
561
561
  * MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md
562
562
  */
563
- 'MD013'?:
563
+ readonly 'MD013'?:
564
564
  | {
565
565
  /**
566
566
  * Number of characters for code blocks
567
567
  */
568
- code_block_line_length?: number;
568
+ readonly code_block_line_length?: number;
569
569
  /**
570
570
  * Include code blocks
571
571
  */
572
- code_blocks?: boolean;
572
+ readonly code_blocks?: boolean;
573
573
  /**
574
574
  * Number of characters for headings
575
575
  */
576
- heading_line_length?: number;
576
+ readonly heading_line_length?: number;
577
577
  /**
578
578
  * Include headings
579
579
  */
580
- headings?: boolean;
580
+ readonly headings?: boolean;
581
581
  /**
582
582
  * Number of characters
583
583
  */
584
- line_length?: number;
584
+ readonly line_length?: number;
585
585
  /**
586
586
  * Stern length checking
587
587
  */
588
- stern?: boolean;
588
+ readonly stern?: boolean;
589
589
  /**
590
590
  * Strict length checking
591
591
  */
592
- strict?: boolean;
592
+ readonly strict?: boolean;
593
593
  /**
594
594
  * Include tables
595
595
  */
596
- tables?: boolean;
596
+ readonly tables?: boolean;
597
597
  }
598
598
  | boolean;
599
599
  /**
600
600
  * MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md014.md
601
601
  */
602
- 'MD014'?: boolean;
602
+ readonly 'MD014'?: boolean;
603
603
  /**
604
604
  * MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md018.md
605
605
  */
606
- 'MD018'?: boolean;
606
+ readonly 'MD018'?: boolean;
607
607
  /**
608
608
  * MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md019.md
609
609
  */
610
- 'MD019'?: boolean;
610
+ readonly 'MD019'?: boolean;
611
611
  /**
612
612
  * MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md020.md
613
613
  */
614
- 'MD020'?: boolean;
614
+ readonly 'MD020'?: boolean;
615
615
  /**
616
616
  * MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md021.md
617
617
  */
618
- 'MD021'?: boolean;
618
+ readonly 'MD021'?: boolean;
619
619
  /**
620
620
  * MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md022.md
621
621
  */
622
- 'MD022'?:
622
+ readonly 'MD022'?:
623
623
  | {
624
624
  /**
625
625
  * Blank lines above heading
626
626
  */
627
- lines_above?: number | number[];
627
+ readonly lines_above?: number | number[];
628
628
  /**
629
629
  * Blank lines below heading
630
630
  */
631
- lines_below?: number | number[];
631
+ readonly lines_below?: number | number[];
632
632
  }
633
633
  | boolean;
634
634
  /**
635
635
  * MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md023.md
636
636
  */
637
- 'MD023'?: boolean;
637
+ readonly 'MD023'?: boolean;
638
638
  /**
639
639
  * MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md024.md
640
640
  */
641
- 'MD024'?:
641
+ readonly 'MD024'?:
642
642
  | {
643
643
  /**
644
644
  * Only check sibling headings
645
645
  */
646
- siblings_only?: boolean;
646
+ readonly siblings_only?: boolean;
647
647
  }
648
648
  | boolean;
649
649
  /**
650
650
  * MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md025.md
651
651
  */
652
- 'MD025'?:
652
+ readonly 'MD025'?:
653
653
  | {
654
654
  /**
655
655
  * RegExp for matching title in front matter
656
656
  */
657
- front_matter_title?: string;
657
+ readonly front_matter_title?: string;
658
658
  /**
659
659
  * Heading level
660
660
  */
661
- level?: number;
661
+ readonly level?: number;
662
662
  }
663
663
  | boolean;
664
664
  /**
665
665
  * MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md026.md
666
666
  */
667
- 'MD026'?:
667
+ readonly 'MD026'?:
668
668
  | {
669
669
  /**
670
670
  * Punctuation characters
671
671
  */
672
- punctuation?: string;
672
+ readonly punctuation?: string;
673
673
  }
674
674
  | boolean;
675
675
  /**
676
676
  * MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md027.md
677
677
  */
678
- 'MD027'?:
678
+ readonly 'MD027'?:
679
679
  | {
680
680
  /**
681
681
  * Include list items
682
682
  */
683
- list_items?: boolean;
683
+ readonly list_items?: boolean;
684
684
  }
685
685
  | boolean;
686
686
  /**
687
687
  * MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md028.md
688
688
  */
689
- 'MD028'?: boolean;
689
+ readonly 'MD028'?: boolean;
690
690
  /**
691
691
  * MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md029.md
692
692
  */
693
- 'MD029'?:
693
+ readonly 'MD029'?:
694
694
  | {
695
695
  /**
696
696
  * List style
697
697
  */
698
- style?: 'one_or_ordered' | 'one' | 'ordered' | 'zero';
698
+ readonly style?: 'one_or_ordered' | 'one' | 'ordered' | 'zero';
699
699
  }
700
700
  | boolean;
701
701
  /**
702
702
  * MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md030.md
703
703
  */
704
- 'MD030'?:
704
+ readonly 'MD030'?:
705
705
  | {
706
706
  /**
707
707
  * Spaces for multi-line ordered list items
708
708
  */
709
- ol_multi?: number;
709
+ readonly ol_multi?: number;
710
710
  /**
711
711
  * Spaces for single-line ordered list items
712
712
  */
713
- ol_single?: number;
713
+ readonly ol_single?: number;
714
714
  /**
715
715
  * Spaces for multi-line unordered list items
716
716
  */
717
- ul_multi?: number;
717
+ readonly ul_multi?: number;
718
718
  /**
719
719
  * Spaces for single-line unordered list items
720
720
  */
721
- ul_single?: number;
721
+ readonly ul_single?: number;
722
722
  }
723
723
  | boolean;
724
724
  /**
725
725
  * MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md031.md
726
726
  */
727
- 'MD031'?:
727
+ readonly 'MD031'?:
728
728
  | {
729
729
  /**
730
730
  * Include list items
731
731
  */
732
- list_items?: boolean;
732
+ readonly list_items?: boolean;
733
733
  }
734
734
  | boolean;
735
735
  /**
736
736
  * MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md032.md
737
737
  */
738
- 'MD032'?: boolean;
738
+ readonly 'MD032'?: boolean;
739
739
  /**
740
740
  * MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md033.md
741
741
  */
742
- 'MD033'?:
742
+ readonly 'MD033'?:
743
743
  | {
744
744
  /**
745
745
  * Allowed elements
746
746
  */
747
- allowed_elements?: string[];
747
+ readonly allowed_elements?: string[];
748
748
  }
749
749
  | boolean;
750
750
  /**
751
751
  * MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md034.md
752
752
  */
753
- 'MD034'?: boolean;
753
+ readonly 'MD034'?: boolean;
754
754
  /**
755
755
  * MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md035.md
756
756
  */
757
- 'MD035'?:
757
+ readonly 'MD035'?:
758
758
  | {
759
759
  /**
760
760
  * Horizontal rule style
761
761
  */
762
- style?: string;
762
+ readonly style?: string;
763
763
  }
764
764
  | boolean;
765
765
  /**
766
766
  * MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md036.md
767
767
  */
768
- 'MD036'?:
768
+ readonly 'MD036'?:
769
769
  | {
770
770
  /**
771
771
  * Punctuation characters
772
772
  */
773
- punctuation?: string;
773
+ readonly punctuation?: string;
774
774
  }
775
775
  | boolean;
776
776
  /**
777
777
  * MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md037.md
778
778
  */
779
- 'MD037'?: boolean;
779
+ readonly 'MD037'?: boolean;
780
780
  /**
781
781
  * MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md
782
782
  */
783
- 'MD038'?: boolean;
783
+ readonly 'MD038'?: boolean;
784
784
  /**
785
785
  * MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md039.md
786
786
  */
787
- 'MD039'?: boolean;
787
+ readonly 'MD039'?: boolean;
788
788
  /**
789
789
  * MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md040.md
790
790
  */
791
- 'MD040'?:
791
+ readonly 'MD040'?:
792
792
  | {
793
793
  /**
794
794
  * List of languages
795
795
  */
796
- allowed_languages?: string[];
796
+ readonly allowed_languages?: string[];
797
797
  /**
798
798
  * Require language only
799
799
  */
800
- language_only?: boolean;
800
+ readonly language_only?: boolean;
801
801
  }
802
802
  | boolean;
803
803
  /**
804
804
  * MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md041.md
805
805
  */
806
- 'MD041'?:
806
+ readonly 'MD041'?:
807
807
  | {
808
808
  /**
809
809
  * Allow content before first heading
810
810
  */
811
- allow_preamble?: boolean;
811
+ readonly allow_preamble?: boolean;
812
812
  /**
813
813
  * RegExp for matching title in front matter
814
814
  */
815
- front_matter_title?: string;
815
+ readonly front_matter_title?: string;
816
816
  /**
817
817
  * Heading level
818
818
  */
819
- level?: number;
819
+ readonly level?: number;
820
820
  }
821
821
  | boolean;
822
822
  /**
823
823
  * MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md042.md
824
824
  */
825
- 'MD042'?: boolean;
825
+ readonly 'MD042'?: boolean;
826
826
  /**
827
827
  * MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md043.md
828
828
  */
829
- 'MD043'?:
829
+ readonly 'MD043'?:
830
830
  | {
831
831
  /**
832
832
  * List of headings
833
833
  */
834
- headings?: string[];
834
+ readonly headings?: string[];
835
835
  /**
836
836
  * Match case of headings
837
837
  */
838
- match_case?: boolean;
838
+ readonly match_case?: boolean;
839
839
  }
840
840
  | boolean;
841
841
  /**
842
842
  * MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md044.md
843
843
  */
844
- 'MD044'?:
844
+ readonly 'MD044'?:
845
845
  | {
846
846
  /**
847
847
  * Include code blocks
848
848
  */
849
- code_blocks?: boolean;
849
+ readonly code_blocks?: boolean;
850
850
  /**
851
851
  * Include HTML elements
852
852
  */
853
- html_elements?: boolean;
853
+ readonly html_elements?: boolean;
854
854
  /**
855
855
  * List of proper names
856
856
  */
857
- names?: string[];
857
+ readonly names?: string[];
858
858
  }
859
859
  | boolean;
860
860
  /**
861
861
  * MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md045.md
862
862
  */
863
- 'MD045'?: boolean;
863
+ readonly 'MD045'?: boolean;
864
864
  /**
865
865
  * MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md046.md
866
866
  */
867
- 'MD046'?:
867
+ readonly 'MD046'?:
868
868
  | {
869
869
  /**
870
870
  * Block style
871
871
  */
872
- style?: 'consistent' | 'fenced' | 'indented';
872
+ readonly style?: 'consistent' | 'fenced' | 'indented';
873
873
  }
874
874
  | boolean;
875
875
  /**
876
876
  * MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md047.md
877
877
  */
878
- 'MD047'?: boolean;
878
+ readonly 'MD047'?: boolean;
879
879
  /**
880
880
  * MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md048.md
881
881
  */
882
- 'MD048'?:
882
+ readonly 'MD048'?:
883
883
  | {
884
884
  /**
885
885
  * Code fence style
886
886
  */
887
- style?: 'backtick' | 'consistent' | 'tilde';
887
+ readonly style?: 'backtick' | 'consistent' | 'tilde';
888
888
  }
889
889
  | boolean;
890
890
  /**
891
891
  * MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md049.md
892
892
  */
893
- 'MD049'?:
893
+ readonly 'MD049'?:
894
894
  | {
895
895
  /**
896
896
  * Emphasis style
897
897
  */
898
- style?: 'asterisk' | 'consistent' | 'underscore';
898
+ readonly style?: 'asterisk' | 'consistent' | 'underscore';
899
899
  }
900
900
  | boolean;
901
901
  /**
902
902
  * MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md050.md
903
903
  */
904
- 'MD050'?:
904
+ readonly 'MD050'?:
905
905
  | {
906
906
  /**
907
907
  * Strong style
908
908
  */
909
- style?: 'asterisk' | 'consistent' | 'underscore';
909
+ readonly style?: 'asterisk' | 'consistent' | 'underscore';
910
910
  }
911
911
  | boolean;
912
912
  /**
913
913
  * MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md051.md
914
914
  */
915
- 'MD051'?:
915
+ readonly 'MD051'?:
916
916
  | {
917
917
  /**
918
918
  * Ignore case of fragments
919
919
  */
920
- ignore_case?: boolean;
920
+ readonly ignore_case?: boolean;
921
921
  /**
922
922
  * Pattern for ignoring additional fragments
923
923
  */
924
- ignored_pattern?: string;
924
+ readonly ignored_pattern?: string;
925
925
  }
926
926
  | boolean;
927
927
  /**
928
928
  * MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md052.md
929
929
  */
930
- 'MD052'?:
930
+ readonly 'MD052'?:
931
931
  | {
932
932
  /**
933
933
  * Ignored link labels
934
934
  */
935
- ignored_labels?: string[];
935
+ readonly ignored_labels?: string[];
936
936
  /**
937
937
  * Include shortcut syntax
938
938
  */
939
- shortcut_syntax?: boolean;
939
+ readonly shortcut_syntax?: boolean;
940
940
  }
941
941
  | boolean;
942
942
  /**
943
943
  * MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md053.md
944
944
  */
945
- 'MD053'?:
945
+ readonly 'MD053'?:
946
946
  | {
947
947
  /**
948
948
  * Ignored definitions
949
949
  */
950
- ignored_definitions?: string[];
950
+ readonly ignored_definitions?: string[];
951
951
  }
952
952
  | boolean;
953
953
  /**
954
954
  * MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md054.md
955
955
  */
956
- 'MD054'?:
956
+ readonly 'MD054'?:
957
957
  | {
958
958
  /**
959
959
  * Allow autolinks
960
960
  */
961
- autolink?: boolean;
961
+ readonly autolink?: boolean;
962
962
  /**
963
963
  * Allow collapsed reference links and images
964
964
  */
965
- collapsed?: boolean;
965
+ readonly collapsed?: boolean;
966
966
  /**
967
967
  * Allow full reference links and images
968
968
  */
969
- full?: boolean;
969
+ readonly full?: boolean;
970
970
  /**
971
971
  * Allow inline links and images
972
972
  */
973
- inline?: boolean;
973
+ readonly inline?: boolean;
974
974
  /**
975
975
  * Allow shortcut reference links and images
976
976
  */
977
- shortcut?: boolean;
977
+ readonly shortcut?: boolean;
978
978
  /**
979
979
  * Allow URLs as inline links
980
980
  */
981
- url_inline?: boolean;
981
+ readonly url_inline?: boolean;
982
982
  }
983
983
  | boolean;
984
984
  /**
985
985
  * MD055/table-pipe-style : Table pipe style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md055.md
986
986
  */
987
- 'MD055'?:
987
+ readonly 'MD055'?:
988
988
  | {
989
989
  /**
990
990
  * Table pipe style
991
991
  */
992
- style?: 'consistent' | 'leading_and_trailing' | 'leading_only' | 'no_leading_or_trailing' | 'trailing_only';
992
+ readonly style?: 'consistent' | 'leading_and_trailing' | 'leading_only' | 'no_leading_or_trailing' | 'trailing_only';
993
993
  }
994
994
  | boolean;
995
995
  /**
996
996
  * MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md056.md
997
997
  */
998
- 'MD056'?: boolean;
998
+ readonly 'MD056'?: boolean;
999
999
  /**
1000
1000
  * MD058/blanks-around-tables : Tables should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md058.md
1001
1001
  */
1002
- 'MD058'?: boolean;
1002
+ readonly 'MD058'?: boolean;
1003
1003
  /**
1004
1004
  * MD059/descriptive-link-text : Link text should be descriptive : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md
1005
1005
  */
1006
- 'MD059'?:
1006
+ readonly 'MD059'?:
1007
1007
  | {
1008
1008
  /**
1009
1009
  * Prohibited link texts
1010
1010
  */
1011
- prohibited_texts?: string[];
1011
+ readonly prohibited_texts?: string[];
1012
1012
  }
1013
1013
  | boolean;
1014
1014
  /**
1015
1015
  * MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md045.md
1016
1016
  */
1017
- 'no-alt-text'?: boolean;
1017
+ readonly 'no-alt-text'?: boolean;
1018
1018
  /**
1019
1019
  * MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md034.md
1020
1020
  */
1021
- 'no-bare-urls'?: boolean;
1021
+ readonly 'no-bare-urls'?: boolean;
1022
1022
  /**
1023
1023
  * MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md028.md
1024
1024
  */
1025
- 'no-blanks-blockquote'?: boolean;
1025
+ readonly 'no-blanks-blockquote'?: boolean;
1026
1026
  /**
1027
1027
  * MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md024.md
1028
1028
  */
1029
- 'no-duplicate-heading'?:
1029
+ readonly 'no-duplicate-heading'?:
1030
1030
  | {
1031
1031
  /**
1032
1032
  * Only check sibling headings
1033
1033
  */
1034
- siblings_only?: boolean;
1034
+ readonly siblings_only?: boolean;
1035
1035
  }
1036
1036
  | boolean;
1037
1037
  /**
1038
1038
  * MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md036.md
1039
1039
  */
1040
- 'no-emphasis-as-heading'?:
1040
+ readonly 'no-emphasis-as-heading'?:
1041
1041
  | {
1042
1042
  /**
1043
1043
  * Punctuation characters
1044
1044
  */
1045
- punctuation?: string;
1045
+ readonly punctuation?: string;
1046
1046
  }
1047
1047
  | boolean;
1048
1048
  /**
1049
1049
  * MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md042.md
1050
1050
  */
1051
- 'no-empty-links'?: boolean;
1051
+ readonly 'no-empty-links'?: boolean;
1052
1052
  /**
1053
1053
  * MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md010.md
1054
1054
  */
1055
- 'no-hard-tabs'?:
1055
+ readonly 'no-hard-tabs'?:
1056
1056
  | {
1057
1057
  /**
1058
1058
  * Include code blocks
1059
1059
  */
1060
- code_blocks?: boolean;
1060
+ readonly code_blocks?: boolean;
1061
1061
  /**
1062
1062
  * Fenced code languages to ignore
1063
1063
  */
1064
- ignore_code_languages?: string[];
1064
+ readonly ignore_code_languages?: string[];
1065
1065
  /**
1066
1066
  * Number of spaces for each hard tab
1067
1067
  */
1068
- spaces_per_tab?: number;
1068
+ readonly spaces_per_tab?: number;
1069
1069
  }
1070
1070
  | boolean;
1071
1071
  /**
1072
1072
  * MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md033.md
1073
1073
  */
1074
- 'no-inline-html'?:
1074
+ readonly 'no-inline-html'?:
1075
1075
  | {
1076
1076
  /**
1077
1077
  * Allowed elements
1078
1078
  */
1079
- allowed_elements?: string[];
1079
+ readonly allowed_elements?: string[];
1080
1080
  }
1081
1081
  | boolean;
1082
1082
  /**
1083
1083
  * MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md018.md
1084
1084
  */
1085
- 'no-missing-space-atx'?: boolean;
1085
+ readonly 'no-missing-space-atx'?: boolean;
1086
1086
  /**
1087
1087
  * MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md020.md
1088
1088
  */
1089
- 'no-missing-space-closed-atx'?: boolean;
1089
+ readonly 'no-missing-space-closed-atx'?: boolean;
1090
1090
  /**
1091
1091
  * MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md012.md
1092
1092
  */
1093
- 'no-multiple-blanks'?:
1093
+ readonly 'no-multiple-blanks'?:
1094
1094
  | {
1095
1095
  /**
1096
1096
  * Consecutive blank lines
1097
1097
  */
1098
- maximum?: number;
1098
+ readonly maximum?: number;
1099
1099
  }
1100
1100
  | boolean;
1101
1101
  /**
1102
1102
  * MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md019.md
1103
1103
  */
1104
- 'no-multiple-space-atx'?: boolean;
1104
+ readonly 'no-multiple-space-atx'?: boolean;
1105
1105
  /**
1106
1106
  * MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md027.md
1107
1107
  */
1108
- 'no-multiple-space-blockquote'?:
1108
+ readonly 'no-multiple-space-blockquote'?:
1109
1109
  | {
1110
1110
  /**
1111
1111
  * Include list items
1112
1112
  */
1113
- list_items?: boolean;
1113
+ readonly list_items?: boolean;
1114
1114
  }
1115
1115
  | boolean;
1116
1116
  /**
1117
1117
  * MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md021.md
1118
1118
  */
1119
- 'no-multiple-space-closed-atx'?: boolean;
1119
+ readonly 'no-multiple-space-closed-atx'?: boolean;
1120
1120
  /**
1121
1121
  * MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md011.md
1122
1122
  */
1123
- 'no-reversed-links'?: boolean;
1123
+ readonly 'no-reversed-links'?: boolean;
1124
1124
  /**
1125
1125
  * MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md
1126
1126
  */
1127
- 'no-space-in-code'?: boolean;
1127
+ readonly 'no-space-in-code'?: boolean;
1128
1128
  /**
1129
1129
  * MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md037.md
1130
1130
  */
1131
- 'no-space-in-emphasis'?: boolean;
1131
+ readonly 'no-space-in-emphasis'?: boolean;
1132
1132
  /**
1133
1133
  * MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md039.md
1134
1134
  */
1135
- 'no-space-in-links'?: boolean;
1135
+ readonly 'no-space-in-links'?: boolean;
1136
1136
  /**
1137
1137
  * MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md026.md
1138
1138
  */
1139
- 'no-trailing-punctuation'?:
1139
+ readonly 'no-trailing-punctuation'?:
1140
1140
  | {
1141
1141
  /**
1142
1142
  * Punctuation characters
1143
1143
  */
1144
- punctuation?: string;
1144
+ readonly punctuation?: string;
1145
1145
  }
1146
1146
  | boolean;
1147
1147
  /**
1148
1148
  * MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
1149
1149
  */
1150
- 'no-trailing-spaces'?:
1150
+ readonly 'no-trailing-spaces'?:
1151
1151
  | {
1152
1152
  /**
1153
1153
  * Spaces for line break
1154
1154
  */
1155
- br_spaces?: number;
1155
+ readonly br_spaces?: number;
1156
1156
  /**
1157
1157
  * Allow spaces for empty lines in list items
1158
1158
  */
1159
- list_item_empty_lines?: boolean;
1159
+ readonly list_item_empty_lines?: boolean;
1160
1160
  /**
1161
1161
  * Include unnecessary breaks
1162
1162
  */
1163
- strict?: boolean;
1163
+ readonly strict?: boolean;
1164
1164
  }
1165
1165
  | boolean;
1166
1166
  /**
1167
1167
  * Ol : MD029, MD030, MD032
1168
1168
  */
1169
- 'ol'?: boolean;
1169
+ readonly 'ol'?: boolean;
1170
1170
  /**
1171
1171
  * MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md029.md
1172
1172
  */
1173
- 'ol-prefix'?:
1173
+ readonly 'ol-prefix'?:
1174
1174
  | {
1175
1175
  /**
1176
1176
  * List style
1177
1177
  */
1178
- style?: 'one_or_ordered' | 'one' | 'ordered' | 'zero';
1178
+ readonly style?: 'one_or_ordered' | 'one' | 'ordered' | 'zero';
1179
1179
  }
1180
1180
  | boolean;
1181
1181
  /**
1182
1182
  * MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md044.md
1183
1183
  */
1184
- 'proper-names'?:
1184
+ readonly 'proper-names'?:
1185
1185
  | {
1186
1186
  /**
1187
1187
  * Include code blocks
1188
1188
  */
1189
- code_blocks?: boolean;
1189
+ readonly code_blocks?: boolean;
1190
1190
  /**
1191
1191
  * Include HTML elements
1192
1192
  */
1193
- html_elements?: boolean;
1193
+ readonly html_elements?: boolean;
1194
1194
  /**
1195
1195
  * List of proper names
1196
1196
  */
1197
- names?: string[];
1197
+ readonly names?: string[];
1198
1198
  }
1199
1199
  | boolean;
1200
1200
  /**
1201
1201
  * MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md052.md
1202
1202
  */
1203
- 'reference-links-images'?:
1203
+ readonly 'reference-links-images'?:
1204
1204
  | {
1205
1205
  /**
1206
1206
  * Ignored link labels
1207
1207
  */
1208
- ignored_labels?: string[];
1208
+ readonly ignored_labels?: string[];
1209
1209
  /**
1210
1210
  * Include shortcut syntax
1211
1211
  */
1212
- shortcut_syntax?: boolean;
1212
+ readonly shortcut_syntax?: boolean;
1213
1213
  }
1214
1214
  | boolean;
1215
1215
  /**
1216
1216
  * MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md043.md
1217
1217
  */
1218
- 'required-headings'?:
1218
+ readonly 'required-headings'?:
1219
1219
  | {
1220
1220
  /**
1221
1221
  * List of headings
1222
1222
  */
1223
- headings?: string[];
1223
+ readonly headings?: string[];
1224
1224
  /**
1225
1225
  * Match case of headings
1226
1226
  */
1227
- match_case?: boolean;
1227
+ readonly match_case?: boolean;
1228
1228
  }
1229
1229
  | boolean;
1230
1230
  /**
1231
1231
  * MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md025.md
1232
1232
  */
1233
- 'single-h1'?:
1233
+ readonly 'single-h1'?:
1234
1234
  | {
1235
1235
  /**
1236
1236
  * RegExp for matching title in front matter
1237
1237
  */
1238
- front_matter_title?: string;
1238
+ readonly front_matter_title?: string;
1239
1239
  /**
1240
1240
  * Heading level
1241
1241
  */
1242
- level?: number;
1242
+ readonly level?: number;
1243
1243
  }
1244
1244
  | boolean;
1245
1245
  /**
1246
1246
  * MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md025.md
1247
1247
  */
1248
- 'single-title'?:
1248
+ readonly 'single-title'?:
1249
1249
  | {
1250
1250
  /**
1251
1251
  * RegExp for matching title in front matter
1252
1252
  */
1253
- front_matter_title?: string;
1253
+ readonly front_matter_title?: string;
1254
1254
  /**
1255
1255
  * Heading level
1256
1256
  */
1257
- level?: number;
1257
+ readonly level?: number;
1258
1258
  }
1259
1259
  | boolean;
1260
1260
  /**
1261
1261
  * MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md047.md
1262
1262
  */
1263
- 'single-trailing-newline'?: boolean;
1263
+ readonly 'single-trailing-newline'?: boolean;
1264
1264
  /**
1265
1265
  * Spaces : MD018, MD019, MD020, MD021, MD023
1266
1266
  */
1267
- 'spaces'?: boolean;
1267
+ readonly 'spaces'?: boolean;
1268
1268
  /**
1269
1269
  * Spelling : MD044
1270
1270
  */
1271
- 'spelling'?: boolean;
1271
+ readonly 'spelling'?: boolean;
1272
1272
  /**
1273
1273
  * MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md050.md
1274
1274
  */
1275
- 'strong-style'?:
1275
+ readonly 'strong-style'?:
1276
1276
  | {
1277
1277
  /**
1278
1278
  * Strong style
1279
1279
  */
1280
- style?: 'asterisk' | 'consistent' | 'underscore';
1280
+ readonly style?: 'asterisk' | 'consistent' | 'underscore';
1281
1281
  }
1282
1282
  | boolean;
1283
1283
  /**
1284
1284
  * Table : MD055, MD056, MD058
1285
1285
  */
1286
- 'table'?: boolean;
1286
+ readonly 'table'?: boolean;
1287
1287
  /**
1288
1288
  * MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md056.md
1289
1289
  */
1290
- 'table-column-count'?: boolean;
1290
+ readonly 'table-column-count'?: boolean;
1291
1291
  /**
1292
1292
  * MD055/table-pipe-style : Table pipe style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md055.md
1293
1293
  */
1294
- 'table-pipe-style'?:
1294
+ readonly 'table-pipe-style'?:
1295
1295
  | {
1296
1296
  /**
1297
1297
  * Table pipe style
1298
1298
  */
1299
- style?: 'consistent' | 'leading_and_trailing' | 'leading_only' | 'no_leading_or_trailing' | 'trailing_only';
1299
+ readonly style?: 'consistent' | 'leading_and_trailing' | 'leading_only' | 'no_leading_or_trailing' | 'trailing_only';
1300
1300
  }
1301
1301
  | boolean;
1302
1302
  /**
1303
1303
  * Ul : MD004, MD005, MD007, MD030, MD032
1304
1304
  */
1305
- 'ul'?: boolean;
1305
+ readonly 'ul'?: boolean;
1306
1306
  /**
1307
1307
  * MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md007.md
1308
1308
  */
1309
- 'ul-indent'?:
1309
+ readonly 'ul-indent'?:
1310
1310
  | {
1311
1311
  /**
1312
1312
  * Spaces for indent
1313
1313
  */
1314
- indent?: number;
1314
+ readonly indent?: number;
1315
1315
  /**
1316
1316
  * Spaces for first level indent (when start_indented is set)
1317
1317
  */
1318
- start_indent?: number;
1318
+ readonly start_indent?: number;
1319
1319
  /**
1320
1320
  * Whether to indent the first level of the list
1321
1321
  */
1322
- start_indented?: boolean;
1322
+ readonly start_indented?: boolean;
1323
1323
  }
1324
1324
  | boolean;
1325
1325
  /**
1326
1326
  * MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md004.md
1327
1327
  */
1328
- 'ul-style'?:
1328
+ readonly 'ul-style'?:
1329
1329
  | {
1330
1330
  /**
1331
1331
  * List style
1332
1332
  */
1333
- style?: 'asterisk' | 'consistent' | 'dash' | 'plus' | 'sublist';
1333
+ readonly style?: 'asterisk' | 'consistent' | 'dash' | 'plus' | 'sublist';
1334
1334
  }
1335
1335
  | boolean;
1336
1336
  /**
1337
1337
  * Url : MD034
1338
1338
  */
1339
- 'url'?: boolean;
1339
+ readonly 'url'?: boolean;
1340
1340
  /**
1341
1341
  * Whitespace : MD009, MD010, MD012, MD027, MD028, MD030, MD037, MD038, MD039
1342
1342
  */
1343
- 'whitespace'?: boolean;
1343
+ readonly 'whitespace'?: boolean;
1344
1344
  }