ilib-lint 2.2.0 → 2.3.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 (97) hide show
  1. package/docs/AnsiConsoleFormatter.html +2 -2
  2. package/docs/BuiltinPlugin.html +2 -2
  3. package/docs/ConfigBasedFormatter.html +2 -2
  4. package/docs/ConfigurationProvider.html +3 -3
  5. package/docs/ConfigurationProvider_loadConfiguration.html +3 -3
  6. package/docs/DeclarativeResourceRule.html +2 -2
  7. package/docs/DirItem.html +2 -2
  8. package/docs/DirItem.js.html +2 -2
  9. package/docs/FileConfigurationProvider.html +5 -5
  10. package/docs/FileConfigurationProvider_loadConfiguration.html +3 -3
  11. package/docs/FileType.html +181 -5
  12. package/docs/FileType.js.html +48 -5
  13. package/docs/FixerManager.html +2 -2
  14. package/docs/FixerManager.js.html +4 -4
  15. package/docs/FolderConfigurationProvider.html +4 -4
  16. package/docs/FolderConfigurationProvider_loadConfiguration.html +3 -3
  17. package/docs/FormatterManager.html +2 -2
  18. package/docs/FormatterManager.js.html +5 -5
  19. package/docs/LineParser.html +78 -4
  20. package/docs/LineRegexpChecker.html +2 -2
  21. package/docs/LintableFile.html +1099 -0
  22. package/docs/LintableFile.js.html +330 -0
  23. package/docs/ParserManager.html +167 -5
  24. package/docs/ParserManager.js.html +17 -5
  25. package/docs/PluginManager.html +10 -10
  26. package/docs/PluginManager.js.html +120 -92
  27. package/docs/Project.html +24 -24
  28. package/docs/Project.js.html +125 -88
  29. package/docs/ReleaseNotes.md +17 -0
  30. package/docs/ResourceCompleteness.html +2 -2
  31. package/docs/ResourceDNTTerms.html +10 -10
  32. package/docs/ResourceEdgeWhitespace.html +2 -2
  33. package/docs/ResourceICUPluralTranslation.html +2 -2
  34. package/docs/ResourceICUPlurals.html +2 -2
  35. package/docs/ResourceMatcher.html +2 -2
  36. package/docs/ResourceNoTranslation.html +2 -2
  37. package/docs/ResourceQuoteStyle.html +342 -6
  38. package/docs/ResourceRule.html +2 -2
  39. package/docs/ResourceSourceChecker.html +2 -2
  40. package/docs/ResourceSourceICUPluralCategories.html +2 -2
  41. package/docs/ResourceSourceICUPluralParams.html +2 -2
  42. package/docs/ResourceSourceICUPluralSyntax.html +2 -2
  43. package/docs/ResourceSourceICUUnexplainedParams.html +2 -2
  44. package/docs/ResourceStateChecker.html +2 -2
  45. package/docs/ResourceTargetChecker.html +2 -2
  46. package/docs/ResourceUniqueKeys.html +4 -4
  47. package/docs/ResultComparator.js.html +2 -2
  48. package/docs/RuleManager.html +2 -2
  49. package/docs/RuleManager.js.html +4 -4
  50. package/docs/RuleSet.html +142 -5
  51. package/docs/RuleSet.js.html +13 -2
  52. package/docs/SourceRegexpChecker.html +2 -2
  53. package/docs/StringFixCommand_StringFixCommand.html +2 -2
  54. package/docs/StringParser.html +4 -4
  55. package/docs/XliffParser.html +79 -5
  56. package/docs/config_Configuration.js.html +21 -3
  57. package/docs/config_ConfigurationProvider.js.html +21 -3
  58. package/docs/config_default.js.html +21 -3
  59. package/docs/formatters_AnsiConsoleFormatter.js.html +4 -4
  60. package/docs/formatters_ConfigBasedFormatter.js.html +4 -4
  61. package/docs/global.html +1090 -143
  62. package/docs/ilibLint.md +0 -0
  63. package/docs/index.html +2 -2
  64. package/docs/plugins_BuiltinPlugin.js.html +5 -5
  65. package/docs/plugins_LineParser.js.html +10 -10
  66. package/docs/plugins_XliffParser.js.html +18 -17
  67. package/docs/plugins_string_StringFix.js.html +4 -4
  68. package/docs/plugins_string_StringFixCommand.js.html +2 -2
  69. package/docs/plugins_string_StringFixer.js.html +4 -4
  70. package/docs/plugins_string_StringParser.js.html +8 -9
  71. package/docs/resource-xml.md +58 -0
  72. package/docs/rules_DeclarativeResourceRule.js.html +2 -2
  73. package/docs/rules_LineRegexpChecker.js.html +5 -5
  74. package/docs/rules_ResourceCompleteness.js.html +4 -4
  75. package/docs/rules_ResourceDNTTerms.js.html +4 -5
  76. package/docs/rules_ResourceEdgeWhitespace.js.html +4 -4
  77. package/docs/rules_ResourceICUPluralTranslation.js.html +4 -4
  78. package/docs/rules_ResourceICUPlurals.js.html +3 -3
  79. package/docs/rules_ResourceMatcher.js.html +3 -3
  80. package/docs/rules_ResourceNoTranslation.js.html +4 -4
  81. package/docs/rules_ResourceQuoteStyle.js.html +227 -122
  82. package/docs/rules_ResourceRule.js.html +4 -4
  83. package/docs/rules_ResourceSourceChecker.js.html +4 -4
  84. package/docs/rules_ResourceSourceICUPluralCategories.js.html +4 -4
  85. package/docs/rules_ResourceSourceICUPluralParams.js.html +4 -4
  86. package/docs/rules_ResourceSourceICUPluralSyntax.js.html +4 -4
  87. package/docs/rules_ResourceSourceICUUnexplainedParams.js.html +4 -4
  88. package/docs/rules_ResourceStateChecker.js.html +4 -4
  89. package/docs/rules_ResourceTargetChecker.js.html +4 -4
  90. package/docs/rules_ResourceUniqueKeys.js.html +4 -5
  91. package/docs/rules_SourceRegexpChecker.js.html +5 -5
  92. package/docs/rules_utils.js.html +2 -2
  93. package/package.json +13 -12
  94. package/src/LintableFile.js +7 -1
  95. package/src/formatters/AnsiConsoleFormatter.js +2 -1
  96. package/src/plugins/BuiltinPlugin.js +4 -1
  97. package/src/rules/ResourceXML.js +244 -0
package/docs/LintableFile.html ADDED
@@ -0,0 +1,1099 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+
5
+ <meta charset="utf-8">
6
+ <title>LintableFile - Documentation</title>
7
+
8
+
9
+ <script src="scripts/prettify/prettify.js"></script>
10
+ <script src="scripts/prettify/lang-css.js"></script>
11
+ <!--[if lt IE 9]>
12
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13
+ <![endif]-->
14
+ <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16
+ <script src="scripts/nav.js" defer></script>
17
+
18
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
19
+ </head>
20
+ <body>
21
+
22
+ <input type="checkbox" id="nav-trigger" class="nav-trigger" />
23
+ <label for="nav-trigger" class="navicon-button x">
24
+ <div class="navicon"></div>
25
+ </label>
26
+
27
+ <label for="nav-trigger" class="overlay"></label>
28
+
29
+ <nav >
30
+
31
+
32
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AnsiConsoleFormatter.html">AnsiConsoleFormatter</a><ul class='methods'><li data-type='method'><a href="AnsiConsoleFormatter.html#format">format</a></li></ul></li><li><a href="BuiltinPlugin.html">BuiltinPlugin</a><ul class='methods'><li data-type='method'><a href="BuiltinPlugin.html#getFormatters">getFormatters</a></li><li data-type='method'><a href="BuiltinPlugin.html#getParsers">getParsers</a></li><li data-type='method'><a href="BuiltinPlugin.html#getRuleSets">getRuleSets</a></li><li data-type='method'><a href="BuiltinPlugin.html#getRules">getRules</a></li></ul></li><li><a href="ConfigBasedFormatter.html">ConfigBasedFormatter</a><ul class='methods'><li data-type='method'><a href="ConfigBasedFormatter.html#format">format</a></li></ul></li><li><a href="DeclarativeResourceRule.html">DeclarativeResourceRule</a><ul class='methods'><li data-type='method'><a href="DeclarativeResourceRule.html#checkString">checkString</a></li><li data-type='method'><a href="DeclarativeResourceRule.html#matchString">matchString</a></li></ul></li><li><a href="DirItem.html">DirItem</a><ul class='methods'><li data-type='method'><a href="DirItem.html#findIssues">findIssues</a></li><li data-type='method'><a href="DirItem.html#getFilePath">getFilePath</a></li><li data-type='method'><a href="DirItem.html#parse">parse</a></li></ul></li><li><a href="FileConfigurationProvider.html">FileConfigurationProvider</a><ul class='methods'><li data-type='method'><a href="FileConfigurationProvider.html#loadJsConfiguration">loadJsConfiguration</a></li><li data-type='method'><a href="FileConfigurationProvider.html#loadJsonConfiguration">loadJsonConfiguration</a></li></ul></li><li><a href="FileType.html">FileType</a><ul class='methods'><li data-type='method'><a href="FileType.html#getParserClasses">getParserClasses</a></li><li data-type='method'><a href="FileType.html#getRuleSetNames">getRuleSetNames</a></li><li data-type='method'><a href="FileType.html#getRules">getRules</a></li></ul></li><li><a href="FixerManager.html">FixerManager</a><ul class='methods'><li data-type='method'><a href="FixerManager.html#add">add</a></li><li data-type='method'><a href="FixerManager.html#get">get</a></li><li data-type='method'><a href="FixerManager.html#size">size</a></li></ul></li><li><a href="FolderConfigurationProvider.html">FolderConfigurationProvider</a><ul class='methods'><li data-type='method'><a href="FolderConfigurationProvider.html#hasConfigurationFile">hasConfigurationFile</a></li></ul></li><li><a href="FormatterManager.html">FormatterManager</a><ul class='methods'><li data-type='method'><a href="FormatterManager.html#add">add</a></li><li data-type='method'><a href="FormatterManager.html#get">get</a></li><li data-type='method'><a href="FormatterManager.html#getDescriptions">getDescriptions</a></li><li data-type='method'><a href="FormatterManager.html#size">size</a></li></ul></li><li><a href="LineParser.html">LineParser</a><ul class='methods'><li data-type='method'><a href="LineParser.html#parse">parse</a></li></ul></li><li><a href="LineRegexpChecker.html">LineRegexpChecker</a><ul class='methods'><li data-type='method'><a href="LineRegexpChecker.html#match">match</a></li></ul></li><li><a href="LintableFile.html">LintableFile</a><ul class='methods'><li data-type='method'><a href="LintableFile.html#findIssues">findIssues</a></li><li data-type='method'><a href="LintableFile.html#getIRs">getIRs</a></li><li data-type='method'><a href="LintableFile.html#getLocaleFromPath">getLocaleFromPath</a></li><li data-type='method'><a href="LintableFile.html#getStats">getStats</a></li><li data-type='method'><a href="LintableFile.html#parse">parse</a></li></ul></li><li><a href="ParserManager.html">ParserManager</a><ul class='methods'><li data-type='method'><a href="ParserManager.html#add">add</a></li><li data-type='method'><a href="ParserManager.html#get">get</a></li><li data-type='method'><a href="ParserManager.html#getByName">getByName</a></li><li data-type='method'><a href="ParserManager.html#getDescriptions">getDescriptions</a></li></ul></li><li><a href="PluginManager.html">PluginManager</a><ul class='methods'><li data-type='method'><a href="PluginManager.html#add">add</a></li><li data-type='method'><a href="PluginManager.html#getFixerManager">getFixerManager</a></li><li data-type='method'><a href="PluginManager.html#getFormatterManager">getFormatterManager</a></li><li data-type='method'><a href="PluginManager.html#getParserManager">getParserManager</a></li><li data-type='method'><a href="PluginManager.html#getRuleManager">getRuleManager</a></li><li data-type='method'><a href="PluginManager.html#getRuleSet">getRuleSet</a></li><li data-type='method'><a href="PluginManager.html#load">load</a></li></ul></li><li><a href="Project.html">Project</a><ul class='methods'><li data-type='method'><a href="Project.html#add">add</a></li><li data-type='method'><a href="Project.html#findIssues">findIssues</a></li><li data-type='method'><a href="Project.html#get">get</a></li><li data-type='method'><a href="Project.html#getExcludes">getExcludes</a></li><li data-type='method'><a href="Project.html#getFileType">getFileType</a></li><li data-type='method'><a href="Project.html#getFileTypeForPath">getFileTypeForPath</a></li><li data-type='method'><a href="Project.html#getFixerManager">getFixerManager</a></li><li data-type='method'><a href="Project.html#getIncludes">getIncludes</a></li><li data-type='method'><a href="Project.html#getLocales">getLocales</a></li><li data-type='method'><a href="Project.html#getName">getName</a></li><li data-type='method'><a href="Project.html#getOptions">getOptions</a></li><li data-type='method'><a href="Project.html#getParserManager">getParserManager</a></li><li data-type='method'><a href="Project.html#getPluginManager">getPluginManager</a></li><li data-type='method'><a href="Project.html#getRoot">getRoot</a></li><li data-type='method'><a href="Project.html#getRuleManager">getRuleManager</a></li><li data-type='method'><a href="Project.html#getScore">getScore</a></li><li data-type='method'><a href="Project.html#getSourceLocale">getSourceLocale</a></li><li data-type='method'><a href="Project.html#init">init</a></li><li data-type='method'><a href="Project.html#run">run</a></li><li data-type='method'><a href="Project.html#scan">scan</a></li></ul></li><li><a href="ResourceCompleteness.html">ResourceCompleteness</a><ul class='methods'><li data-type='method'><a href="ResourceCompleteness.html#matchString">matchString</a></li></ul></li><li><a href="ResourceDNTTerms.html">ResourceDNTTerms</a><ul class='methods'><li data-type='method'><a href="ResourceDNTTerms.html#matchString">matchString</a></li><li data-type='method'><a href="ResourceDNTTerms.html#.parseTermsFromJsonFile">parseTermsFromJsonFile</a></li><li data-type='method'><a href="ResourceDNTTerms.html#.parseTermsFromTxtFile">parseTermsFromTxtFile</a></li></ul></li><li><a href="ResourceEdgeWhitespace.html">ResourceEdgeWhitespace</a><ul class='methods'><li data-type='method'><a href="ResourceEdgeWhitespace.html#matchString">matchString</a></li></ul></li><li><a href="ResourceICUPluralTranslation.html">ResourceICUPluralTranslation</a><ul class='methods'><li data-type='method'><a href="ResourceICUPluralTranslation.html#matchString">matchString</a></li></ul></li><li><a href="ResourceICUPlurals.html">ResourceICUPlurals</a></li><li><a href="ResourceMatcher.html">ResourceMatcher</a><ul class='methods'><li data-type='method'><a href="ResourceMatcher.html#checkString">checkString</a></li></ul></li><li><a href="ResourceNoTranslation.html">ResourceNoTranslation</a><ul class='methods'><li data-type='method'><a href="ResourceNoTranslation.html#matchString">matchString</a></li></ul></li><li><a href="ResourceQuoteStyle.html">ResourceQuoteStyle</a><ul class='methods'><li data-type='method'><a href="ResourceQuoteStyle.html#matchString">matchString</a></li></ul></li><li><a href="ResourceRule.html">ResourceRule</a><ul class='methods'><li data-type='method'><a href="ResourceRule.html#getRuleType">getRuleType</a></li><li data-type='method'><a href="ResourceRule.html#match">match</a></li><li data-type='method'><a href="ResourceRule.html#matchString">matchString</a></li></ul></li><li><a href="ResourceSourceChecker.html">ResourceSourceChecker</a><ul class='methods'><li data-type='method'><a href="ResourceSourceChecker.html#checkString">checkString</a></li></ul></li><li><a href="ResourceSourceICUPluralCategories.html">ResourceSourceICUPluralCategories</a><ul class='methods'><li data-type='method'><a href="ResourceSourceICUPluralCategories.html#matchString">matchString</a></li></ul></li><li><a href="ResourceSourceICUPluralParams.html">ResourceSourceICUPluralParams</a><ul class='methods'><li data-type='method'><a href="ResourceSourceICUPluralParams.html#matchString">matchString</a></li></ul></li><li><a href="ResourceSourceICUPluralSyntax.html">ResourceSourceICUPluralSyntax</a><ul class='methods'><li data-type='method'><a href="ResourceSourceICUPluralSyntax.html#matchString">matchString</a></li></ul></li><li><a href="ResourceSourceICUUnexplainedParams.html">ResourceSourceICUUnexplainedParams</a><ul class='methods'><li data-type='method'><a href="ResourceSourceICUUnexplainedParams.html#matchString">matchString</a></li></ul></li><li><a href="ResourceStateChecker.html">ResourceStateChecker</a><ul class='methods'><li data-type='method'><a href="ResourceStateChecker.html#match">match</a></li></ul></li><li><a href="ResourceTargetChecker.html">ResourceTargetChecker</a><ul class='methods'><li data-type='method'><a href="ResourceTargetChecker.html#checkString">checkString</a></li></ul></li><li><a href="ResourceUniqueKeys.html">ResourceUniqueKeys</a><ul class='methods'><li data-type='method'><a href="ResourceUniqueKeys.html#match">match</a></li></ul></li><li><a href="RuleManager.html">RuleManager</a><ul class='methods'><li data-type='method'><a href="RuleManager.html#add">add</a></li><li data-type='method'><a href="RuleManager.html#addRuleSetDefinition">addRuleSetDefinition</a></li><li data-type='method'><a href="RuleManager.html#addRuleSetDefinitions">addRuleSetDefinitions</a></li><li data-type='method'><a href="RuleManager.html#get">get</a></li><li data-type='method'><a href="RuleManager.html#getDescriptions">getDescriptions</a></li><li data-type='method'><a href="RuleManager.html#getRuleSetDefinition">getRuleSetDefinition</a></li><li data-type='method'><a href="RuleManager.html#getRuleSetDefinitions">getRuleSetDefinitions</a></li><li data-type='method'><a href="RuleManager.html#getRules">getRules</a></li><li data-type='method'><a href="RuleManager.html#size">size</a></li><li data-type='method'><a href="RuleManager.html#sizeRuleSetDefinitions">sizeRuleSetDefinitions</a></li></ul></li><li><a href="RuleSet.html">RuleSet</a><ul class='methods'><li data-type='method'><a href="RuleSet.html#add">add</a></li><li data-type='method'><a href="RuleSet.html#addRule">addRule</a></li><li data-type='method'><a href="RuleSet.html#getRule">getRule</a></li><li data-type='method'><a href="RuleSet.html#getRules">getRules</a></li><li data-type='method'><a href="RuleSet.html#getSize">getSize</a></li><li data-type='method'><a href="RuleSet.html#removeRule">removeRule</a></li></ul></li><li><a href="SourceRegexpChecker.html">SourceRegexpChecker</a><ul class='methods'><li data-type='method'><a href="SourceRegexpChecker.html#match">match</a></li></ul></li><li><a href="StringFixCommand_StringFixCommand.html">StringFixCommand</a></li><li><a href="StringParser.html">StringParser</a><ul class='methods'><li data-type='method'><a href="StringParser.html#parse">parse</a></li><li data-type='method'><a href="StringParser.html#write">write</a></li></ul></li><li><a href="XliffParser.html">XliffParser</a><ul class='methods'><li data-type='method'><a href="XliffParser.html#parse">parse</a></li></ul></li></ul><h3>Interfaces</h3><ul><li><a href="ConfigurationProvider.html">ConfigurationProvider</a></li><li><a href="ConfigurationProvider_loadConfiguration.html">loadConfiguration</a></li><li><a href="FileConfigurationProvider_loadConfiguration.html">loadConfiguration</a></li><li><a href="FolderConfigurationProvider_loadConfiguration.html">loadConfiguration</a></li></ul><h3>Global</h3><ul><li><a href="global.html#DeclarativeRuleTypes">DeclarativeRuleTypes</a></li><li><a href="global.html#ResultComparator">ResultComparator</a></li><li><a href="global.html#concatIntlAstText">concatIntlAstText</a></li><li><a href="global.html#defaultConfiguration">defaultConfiguration</a></li><li><a href="global.html#severity">severity</a></li><li><a href="global.html#typeMap">typeMap</a></li></ul>
33
+
34
+ </nav>
35
+
36
+ <div id="main">
37
+
38
+ <h1 class="page-title">LintableFile</h1>
39
+
40
+
41
+
42
+
43
+
44
+
45
+
46
+ <section>
47
+
48
+ <header>
49
+
50
+ <h2>
51
+
52
+ LintableFile
53
+
54
+ </h2>
55
+
56
+ <div class="class-description usertext">Represent a source file</div>
57
+
58
+
59
+ </header>
60
+
61
+ <article>
62
+
63
+ <div class="container-overview">
64
+
65
+
66
+
67
+
68
+ <h2>Constructor</h2>
69
+
70
+
71
+ <h4 class="name" id="LintableFile"><span class="type-signature"></span>new LintableFile<span class="signature">(filePath, options, project)</span><span class="type-signature"></span></h4>
72
+
73
+
74
+
75
+
76
+
77
+
78
+ <dl class="details">
79
+
80
+ <dt class="tag-description">Description:</dt>
81
+ <dd class="tag-description"><ul class="dummy"><li>Construct a source file instance
82
+ The options parameter can contain any of the following properties:</li></ul></dd>
83
+
84
+
85
+
86
+ <dt class="tag-source">Source:</dt>
87
+ <dd class="tag-source"><ul class="dummy"><li>
88
+ <a href="LintableFile.js.html">LintableFile.js</a>, <a href="LintableFile.js.html#line33">line 33</a>
89
+ </li></ul></dd>
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+ </dl>
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+ <h5 class="h5-parameters">Parameters:</h5>
136
+
137
+
138
+ <table class="params">
139
+ <thead>
140
+ <tr>
141
+
142
+ <th>Name</th>
143
+
144
+
145
+ <th>Type</th>
146
+
147
+
148
+
149
+
150
+
151
+ <th class="last">Description</th>
152
+ </tr>
153
+ </thead>
154
+
155
+ <tbody>
156
+
157
+
158
+ <tr>
159
+
160
+ <td class="name"><code>filePath</code></td>
161
+
162
+
163
+ <td class="type">
164
+
165
+
166
+ <span class="param-type">String</span>
167
+
168
+
169
+
170
+
171
+ </td>
172
+
173
+
174
+
175
+
176
+
177
+ <td class="description last">path to the source file</td>
178
+ </tr>
179
+
180
+
181
+
182
+ <tr>
183
+
184
+ <td class="name"><code>options</code></td>
185
+
186
+
187
+ <td class="type">
188
+
189
+
190
+ <span class="param-type">Object</span>
191
+
192
+
193
+
194
+
195
+ </td>
196
+
197
+
198
+
199
+
200
+
201
+ <td class="description last">options for constructing this source file
202
+ <h6>Properties</h6>
203
+
204
+
205
+ <table class="params">
206
+ <thead>
207
+ <tr>
208
+
209
+ <th>Name</th>
210
+
211
+
212
+ <th>Type</th>
213
+
214
+
215
+ <th>Attributes</th>
216
+
217
+
218
+
219
+
220
+ <th class="last">Description</th>
221
+ </tr>
222
+ </thead>
223
+
224
+ <tbody>
225
+
226
+
227
+ <tr>
228
+
229
+ <td class="name"><code>filetype</code></td>
230
+
231
+
232
+ <td class="type">
233
+
234
+
235
+ <span class="param-type"><a href="FileType.html">FileType</a></span>
236
+
237
+
238
+
239
+
240
+ </td>
241
+
242
+
243
+ <td class="attributes">
244
+
245
+
246
+
247
+
248
+
249
+ </td>
250
+
251
+
252
+
253
+
254
+ <td class="description last">file type of this source file</td>
255
+ </tr>
256
+
257
+
258
+
259
+ <tr>
260
+
261
+ <td class="name"><code>filePath</code></td>
262
+
263
+
264
+ <td class="type">
265
+
266
+
267
+ <span class="param-type">String</span>
268
+
269
+
270
+
271
+
272
+ </td>
273
+
274
+
275
+ <td class="attributes">
276
+
277
+
278
+
279
+
280
+
281
+ </td>
282
+
283
+
284
+
285
+
286
+ <td class="description last">path to the file</td>
287
+ </tr>
288
+
289
+
290
+
291
+ <tr>
292
+
293
+ <td class="name"><code>settings</code></td>
294
+
295
+
296
+ <td class="type">
297
+
298
+
299
+ <span class="param-type">object</span>
300
+
301
+
302
+
303
+
304
+ </td>
305
+
306
+
307
+ <td class="attributes">
308
+
309
+ &lt;optional><br>
310
+
311
+
312
+
313
+
314
+
315
+ </td>
316
+
317
+
318
+
319
+
320
+ <td class="description last">additional settings from the ilib-lint config that apply to this file</td>
321
+ </tr>
322
+
323
+
324
+ </tbody>
325
+ </table>
326
+
327
+ </td>
328
+ </tr>
329
+
330
+
331
+
332
+ <tr>
333
+
334
+ <td class="name"><code>project</code></td>
335
+
336
+
337
+ <td class="type">
338
+
339
+
340
+ <span class="param-type"><a href="Project.html">Project</a></span>
341
+
342
+
343
+
344
+
345
+ </td>
346
+
347
+
348
+
349
+
350
+
351
+ <td class="description last">the project where this file is located</td>
352
+ </tr>
353
+
354
+
355
+ </tbody>
356
+ </table>
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+
373
+
374
+
375
+
376
+
377
+ </div>
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+ <h3 class="subsection-title">Members</h3>
394
+
395
+
396
+
397
+ <h4 class="name" id="irs"><span class="type-signature"></span>irs<span class="type-signature"> :Array.&lt;IntermediateRepresentation></span></h4>
398
+
399
+
400
+
401
+
402
+
403
+ <dl class="details">
404
+
405
+
406
+
407
+ <dt class="tag-source">Source:</dt>
408
+ <dd class="tag-source"><ul class="dummy"><li>
409
+ <a href="LintableFile.js.html">LintableFile.js</a>, <a href="LintableFile.js.html#line127">line 127</a>
410
+ </li></ul></dd>
411
+
412
+
413
+
414
+
415
+
416
+
417
+
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+
430
+
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+ </dl>
443
+
444
+
445
+
446
+
447
+
448
+
449
+
450
+ <h5 class="h5-types">Type:</h5>
451
+ <ul>
452
+ <li>
453
+
454
+ <span class="param-type">Array.&lt;IntermediateRepresentation></span>
455
+
456
+
457
+
458
+ </li>
459
+ </ul>
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+ <h3 class="subsection-title">Methods</h3>
471
+
472
+
473
+
474
+
475
+
476
+
477
+ <h4 class="name" id="findIssues"><span class="type-signature"></span>findIssues<span class="signature">(locales)</span><span class="type-signature"> &rarr; {Array.&lt;Result>}</span></h4>
478
+
479
+
480
+
481
+
482
+
483
+
484
+ <dl class="details">
485
+
486
+ <dt class="tag-description">Description:</dt>
487
+ <dd class="tag-description"><ul class="dummy"><li>Check the current file and return a list of issues found in this file.
488
+ This method parses the source file and applies each rule in turn
489
+ using the given locales. Optionally, it also applies the available auto-fixes
490
+ and overwrites the underlying file depending if it's enabled in the project config options.</li></ul></dd>
491
+
492
+
493
+
494
+ <dt class="tag-source">Source:</dt>
495
+ <dd class="tag-source"><ul class="dummy"><li>
496
+ <a href="LintableFile.js.html">LintableFile.js</a>, <a href="LintableFile.js.html#line115">line 115</a>
497
+ </li></ul></dd>
498
+
499
+
500
+
501
+
502
+
503
+
504
+
505
+
506
+
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+
526
+
527
+
528
+
529
+ </dl>
530
+
531
+
532
+
533
+
534
+
535
+
536
+
537
+
538
+
539
+
540
+
541
+
542
+
543
+ <h5 class="h5-parameters">Parameters:</h5>
544
+
545
+
546
+ <table class="params">
547
+ <thead>
548
+ <tr>
549
+
550
+ <th>Name</th>
551
+
552
+
553
+ <th>Type</th>
554
+
555
+
556
+
557
+
558
+
559
+ <th class="last">Description</th>
560
+ </tr>
561
+ </thead>
562
+
563
+ <tbody>
564
+
565
+
566
+ <tr>
567
+
568
+ <td class="name"><code>locales</code></td>
569
+
570
+
571
+ <td class="type">
572
+
573
+
574
+ <span class="param-type">Array.&lt;string></span>
575
+
576
+
577
+
578
+
579
+ </td>
580
+
581
+
582
+
583
+
584
+
585
+ <td class="description last">a set of locales to apply</td>
586
+ </tr>
587
+
588
+
589
+ </tbody>
590
+ </table>
591
+
592
+
593
+
594
+
595
+
596
+
597
+
598
+
599
+
600
+
601
+
602
+
603
+
604
+
605
+
606
+
607
+ <h5 class="h5-returns">Returns:</h5>
608
+
609
+
610
+ <div class="param-desc">
611
+ a list of natch results
612
+ </div>
613
+
614
+
615
+
616
+ <dl class="param-type">
617
+ <dt>
618
+ Type
619
+ </dt>
620
+ <dd>
621
+
622
+ <span class="param-type">Array.&lt;Result></span>
623
+
624
+
625
+
626
+ </dd>
627
+ </dl>
628
+
629
+
630
+
631
+
632
+
633
+
634
+
635
+
636
+
637
+
638
+ <h4 class="name" id="getIRs"><span class="type-signature"></span>getIRs<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;IntermediateRepresentation>}</span></h4>
639
+
640
+
641
+
642
+
643
+
644
+
645
+ <dl class="details">
646
+
647
+ <dt class="tag-description">Description:</dt>
648
+ <dd class="tag-description"><ul class="dummy"><li>Get the intermediate representations of this file.</li></ul></dd>
649
+
650
+
651
+
652
+ <dt class="tag-source">Source:</dt>
653
+ <dd class="tag-source"><ul class="dummy"><li>
654
+ <a href="LintableFile.js.html">LintableFile.js</a>, <a href="LintableFile.js.html#line237">line 237</a>
655
+ </li></ul></dd>
656
+
657
+
658
+
659
+
660
+
661
+
662
+
663
+
664
+
665
+
666
+
667
+
668
+
669
+
670
+
671
+
672
+
673
+
674
+
675
+
676
+
677
+
678
+
679
+
680
+
681
+
682
+
683
+
684
+
685
+
686
+
687
+ </dl>
688
+
689
+
690
+
691
+
692
+
693
+
694
+
695
+
696
+
697
+
698
+
699
+
700
+
701
+
702
+
703
+
704
+
705
+
706
+
707
+
708
+
709
+
710
+
711
+
712
+
713
+
714
+
715
+ <h5 class="h5-returns">Returns:</h5>
716
+
717
+
718
+ <div class="param-desc">
719
+ the intermediate representations
720
+ of this file
721
+ </div>
722
+
723
+
724
+
725
+ <dl class="param-type">
726
+ <dt>
727
+ Type
728
+ </dt>
729
+ <dd>
730
+
731
+ <span class="param-type">Array.&lt;IntermediateRepresentation></span>
732
+
733
+
734
+
735
+ </dd>
736
+ </dl>
737
+
738
+
739
+
740
+
741
+
742
+
743
+
744
+
745
+
746
+
747
+ <h4 class="name" id="getLocaleFromPath"><span class="type-signature"></span>getLocaleFromPath<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
748
+
749
+
750
+
751
+
752
+
753
+
754
+ <dl class="details">
755
+
756
+ <dt class="tag-description">Description:</dt>
757
+ <dd class="tag-description"><ul class="dummy"><li>Return the locale gleaned from the file path using the template in
758
+ the settings, or undefined if no locale could be found.</li></ul></dd>
759
+
760
+
761
+
762
+ <dt class="tag-source">Source:</dt>
763
+ <dd class="tag-source"><ul class="dummy"><li>
764
+ <a href="LintableFile.js.html">LintableFile.js</a>, <a href="LintableFile.js.html#line78">line 78</a>
765
+ </li></ul></dd>
766
+
767
+
768
+
769
+
770
+
771
+
772
+
773
+
774
+
775
+
776
+
777
+
778
+
779
+
780
+
781
+
782
+
783
+
784
+
785
+
786
+
787
+
788
+
789
+
790
+
791
+
792
+
793
+
794
+
795
+
796
+
797
+ </dl>
798
+
799
+
800
+
801
+
802
+
803
+
804
+
805
+
806
+
807
+
808
+
809
+
810
+
811
+
812
+
813
+
814
+
815
+
816
+
817
+
818
+
819
+
820
+
821
+
822
+
823
+
824
+
825
+ <h5 class="h5-returns">Returns:</h5>
826
+
827
+
828
+ <div class="param-desc">
829
+ the locale gleaned from the path, or the empty
830
+ string if no locale could be found.
831
+ </div>
832
+
833
+
834
+
835
+ <dl class="param-type">
836
+ <dt>
837
+ Type
838
+ </dt>
839
+ <dd>
840
+
841
+ <span class="param-type">String</span>
842
+
843
+
844
+
845
+ </dd>
846
+ </dl>
847
+
848
+
849
+
850
+
851
+
852
+
853
+
854
+
855
+
856
+
857
+ <h4 class="name" id="getStats"><span class="type-signature"></span>getStats<span class="signature">()</span><span class="type-signature"> &rarr; {FileStats}</span></h4>
858
+
859
+
860
+
861
+
862
+
863
+
864
+ <dl class="details">
865
+
866
+ <dt class="tag-description">Description:</dt>
867
+ <dd class="tag-description"><ul class="dummy"><li>Return the stats for the file after issues were found.</li></ul></dd>
868
+
869
+
870
+
871
+ <dt class="tag-source">Source:</dt>
872
+ <dd class="tag-source"><ul class="dummy"><li>
873
+ <a href="LintableFile.js.html">LintableFile.js</a>, <a href="LintableFile.js.html#line245">line 245</a>
874
+ </li></ul></dd>
875
+
876
+
877
+
878
+
879
+
880
+
881
+
882
+
883
+
884
+
885
+
886
+
887
+
888
+
889
+
890
+
891
+
892
+
893
+
894
+
895
+
896
+
897
+
898
+
899
+
900
+
901
+
902
+
903
+
904
+
905
+
906
+ </dl>
907
+
908
+
909
+
910
+
911
+
912
+
913
+
914
+
915
+
916
+
917
+
918
+
919
+
920
+
921
+
922
+
923
+
924
+
925
+
926
+
927
+
928
+
929
+
930
+
931
+
932
+
933
+
934
+ <h5 class="h5-returns">Returns:</h5>
935
+
936
+
937
+ <div class="param-desc">
938
+ the stats for the current file
939
+ </div>
940
+
941
+
942
+
943
+ <dl class="param-type">
944
+ <dt>
945
+ Type
946
+ </dt>
947
+ <dd>
948
+
949
+ <span class="param-type">FileStats</span>
950
+
951
+
952
+
953
+ </dd>
954
+ </dl>
955
+
956
+
957
+
958
+
959
+
960
+
961
+
962
+
963
+
964
+
965
+ <h4 class="name" id="parse"><span class="type-signature"></span>parse<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;IntermediateRepresentation>}</span></h4>
966
+
967
+
968
+
969
+
970
+
971
+
972
+ <dl class="details">
973
+
974
+ <dt class="tag-description">Description:</dt>
975
+ <dd class="tag-description"><ul class="dummy"><li>Parse the current source file into a list of Intermediate Representaitons</li></ul></dd>
976
+
977
+
978
+
979
+ <dt class="tag-source">Source:</dt>
980
+ <dd class="tag-source"><ul class="dummy"><li>
981
+ <a href="LintableFile.js.html">LintableFile.js</a>, <a href="LintableFile.js.html#line90">line 90</a>
982
+ </li></ul></dd>
983
+
984
+
985
+
986
+
987
+
988
+
989
+
990
+
991
+
992
+
993
+
994
+
995
+
996
+
997
+
998
+
999
+
1000
+
1001
+
1002
+
1003
+
1004
+
1005
+
1006
+
1007
+
1008
+
1009
+
1010
+
1011
+
1012
+
1013
+
1014
+ </dl>
1015
+
1016
+
1017
+
1018
+
1019
+
1020
+
1021
+
1022
+
1023
+
1024
+
1025
+
1026
+
1027
+
1028
+
1029
+
1030
+
1031
+
1032
+
1033
+
1034
+
1035
+
1036
+
1037
+
1038
+
1039
+
1040
+
1041
+
1042
+ <h5 class="h5-returns">Returns:</h5>
1043
+
1044
+
1045
+ <div class="param-desc">
1046
+ the parsed representations
1047
+ of this file
1048
+ </div>
1049
+
1050
+
1051
+
1052
+ <dl class="param-type">
1053
+ <dt>
1054
+ Type
1055
+ </dt>
1056
+ <dd>
1057
+
1058
+ <span class="param-type">Array.&lt;IntermediateRepresentation></span>
1059
+
1060
+
1061
+
1062
+ </dd>
1063
+ </dl>
1064
+
1065
+
1066
+
1067
+
1068
+
1069
+
1070
+
1071
+
1072
+
1073
+
1074
+
1075
+ </article>
1076
+
1077
+ </section>
1078
+
1079
+
1080
+
1081
+
1082
+
1083
+
1084
+ </div>
1085
+
1086
+ <br class="clear">
1087
+
1088
+ <footer>
1089
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Tue Jul 09 2024 11:26:16 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1090
+ </footer>
1091
+
1092
+ <script>prettyPrint();</script>
1093
+ <script src="scripts/polyfill.js"></script>
1094
+ <script src="scripts/linenumber.js"></script>
1095
+
1096
+
1097
+
1098
+ </body>
1099
+ </html>