1 | 'use strict';
|
2 |
|
3 | var fs = require('fs');
|
4 | var parseComments = require('parse-comments');
|
5 | var _ = require('lodash');
|
6 | var eslintAngularIndex = require('../index');
|
7 | var ruleCategories = require('./ruleCategories.json');
|
8 | var RuleTester = require('eslint').RuleTester;
|
9 |
|
10 | var templates = require('./templates.js');
|
11 |
|
12 | var ruleNames = Object.keys(eslintAngularIndex.rules).filter(function(ruleName) {
|
13 |
|
14 | return !/^ng_/.test(ruleName);
|
15 | });
|
16 |
|
17 |
|
18 | var rules = ruleNames.map(_createRule);
|
19 |
|
20 | module.exports = {
|
21 | rules: rules,
|
22 | createDocFiles: createDocFiles,
|
23 | updateReadme: updateReadme,
|
24 | testDocs: testDocs
|
25 | };
|
26 |
|
27 |
|
28 |
|
29 |
|
30 |
|
31 |
|
32 | function createDocFiles(cb) {
|
33 | this.rules.forEach(function(rule) {
|
34 | fs.writeFileSync(rule.documentationPath, _trimTrailingSpacesAndMultilineBreaks(templates.ruleDocumentationContent(rule)));
|
35 | });
|
36 | (cb || _.noop)();
|
37 | }
|
38 |
|
39 |
|
40 |
|
41 |
|
42 |
|
43 |
|
44 | function updateReadme(readmePath, cb) {
|
45 | ruleCategories.rulesByCategory = _.groupBy(this.rules, 'category');
|
46 |
|
47 |
|
48 | ruleCategories.categoryOrder = ruleCategories.categoryOrder.filter(function(categoryName) {
|
49 | var rulesForCategory = ruleCategories.rulesByCategory[categoryName];
|
50 | return rulesForCategory && rulesForCategory.length > 0;
|
51 | });
|
52 |
|
53 | var readmeContent = fs.readFileSync(readmePath).toString();
|
54 | var newRuleSection = templates.readmeRuleSectionContent(ruleCategories);
|
55 |
|
56 |
|
57 | readmeContent = readmeContent.split(/## Rules[\S\s]*?----\n/).join(newRuleSection);
|
58 |
|
59 | fs.writeFileSync(readmePath, readmeContent);
|
60 | (cb || _.noop)();
|
61 | }
|
62 |
|
63 |
|
64 |
|
65 |
|
66 |
|
67 |
|
68 | function testDocs(cb) {
|
69 | this.rules.forEach(function(rule) {
|
70 | if (rule.examples !== undefined) {
|
71 | var eslintTester = new RuleTester();
|
72 | eslintTester.run(rule.ruleName, rule.module, rule.examples);
|
73 | }
|
74 | });
|
75 | (cb || _.noop)();
|
76 | }
|
77 |
|
78 | function _trimTrailingSpacesAndMultilineBreaks(content) {
|
79 | return content.replace(/( )+\n/g, '\n').replace(/\n\n+\n/g, '\n\n').replace(/\n+$/g, '\n');
|
80 | }
|
81 |
|
82 | function _parseConfigLine(configLine) {
|
83 |
|
84 | var preparedConfigLine = configLine.replace(/(\w+):/g, '"$1":').replace('\\:', ':');
|
85 | var example = JSON.parse('{' + preparedConfigLine + '}');
|
86 | return example;
|
87 | }
|
88 |
|
89 | function _wrapErrorMessage(errorMessage) {
|
90 | return {
|
91 | message: errorMessage
|
92 | };
|
93 | }
|
94 |
|
95 | function _parseExample(exampleSource) {
|
96 | var lines = exampleSource.split('\n');
|
97 |
|
98 |
|
99 | var example = _parseConfigLine(lines[0]);
|
100 |
|
101 |
|
102 | example.code = lines.slice(1).join('\n').trim();
|
103 |
|
104 |
|
105 | if (example.errorMessage) {
|
106 | if (_.isString(example.errorMessage)) {
|
107 | example.errors = [_wrapErrorMessage(example.errorMessage)];
|
108 | } else {
|
109 | throw new Error('Example "errorMessage" must be a string');
|
110 | }
|
111 | } else if (example.errorMessages) {
|
112 | if (_.isArray(example.errorMessages)) {
|
113 | example.errors = example.errorMessages.map(_wrapErrorMessage);
|
114 | } else {
|
115 | throw new Error('Example "errorMessages" must be an array');
|
116 | }
|
117 | }
|
118 |
|
119 |
|
120 | if (!example.valid && !(example.errorMessage || example.errorMessages)) {
|
121 | throw new Error('Example config requires "errorMessage(s)" when valid: false');
|
122 | }
|
123 |
|
124 |
|
125 | example.jsonOptions = example.options ? JSON.stringify(example.options) : '';
|
126 |
|
127 |
|
128 | if (example.options) {
|
129 | example.displayOptions = example.options;
|
130 | }
|
131 |
|
132 | return example;
|
133 | }
|
134 |
|
135 | function _loadExamples(rule) {
|
136 | var examplesSource = fs.readFileSync(rule.examplesPath).toString();
|
137 | var exampleRegex = /\s*\/\/\s*example\s*-/;
|
138 | if (!exampleRegex.test(examplesSource)) {
|
139 | return [];
|
140 | }
|
141 |
|
142 | return examplesSource.split(exampleRegex).slice(1).map(_parseExample.bind(rule));
|
143 | }
|
144 |
|
145 | function _filterByValidity(examples, validity) {
|
146 | return _.filter(examples, {valid: validity}) || [];
|
147 | }
|
148 |
|
149 | function _appendGroupedExamplesByValidity(groupedExamples, examples, config, validity) {
|
150 | var examplesByValidity = _filterByValidity(examples, validity);
|
151 | if (examplesByValidity.length > 0) {
|
152 | groupedExamples.push({
|
153 | config: config,
|
154 | valid: validity,
|
155 | examples: examplesByValidity
|
156 | });
|
157 | }
|
158 | }
|
159 |
|
160 | function _createRule(ruleName) {
|
161 |
|
162 | var rule = {
|
163 | ruleName: ruleName
|
164 | };
|
165 |
|
166 |
|
167 | rule.sourcePath = templates.ruleSourcePath(rule);
|
168 | rule.documentationPath = templates.ruleDocumentationPath(rule);
|
169 | rule.examplesPath = templates.ruleExamplesPath(rule);
|
170 |
|
171 |
|
172 | var mainRuleComment = parseComments(fs.readFileSync(rule.sourcePath).toString())[0];
|
173 |
|
174 |
|
175 | rule.lead = mainRuleComment.lead;
|
176 | rule.description = mainRuleComment.description.trim();
|
177 | rule.linkDescription = mainRuleComment.linkDescription ? mainRuleComment.linkDescription : rule.lead;
|
178 | rule.styleguideReferences = mainRuleComment.styleguideReferences || [];
|
179 | rule.version = mainRuleComment.version;
|
180 | rule.category = mainRuleComment.category || 'uncategorizedRule';
|
181 |
|
182 | rule.deprecated = !!mainRuleComment.deprecated;
|
183 | rule.sinceAngularVersion = mainRuleComment.sinceAngularVersion;
|
184 |
|
185 | if (rule.deprecated) {
|
186 | rule.deprecationReason = mainRuleComment.deprecated;
|
187 | rule.category = 'deprecatedRule';
|
188 | }
|
189 |
|
190 | if (!rule.version) {
|
191 | throw new Error('No @version found for ' + ruleName);
|
192 | }
|
193 |
|
194 |
|
195 | rule.module = require('../rules/' + rule.ruleName);
|
196 |
|
197 |
|
198 | rule.allExamples = _loadExamples(rule);
|
199 | rule.examples = {
|
200 | valid: _filterByValidity(rule.allExamples, true),
|
201 | invalid: _filterByValidity(rule.allExamples, false)
|
202 | };
|
203 |
|
204 | rule.groupedExamples = [];
|
205 | var examplesGroupedByConfig = _.groupBy(rule.allExamples, 'jsonOptions');
|
206 | _.each(examplesGroupedByConfig, function(examples, config) {
|
207 |
|
208 | _appendGroupedExamplesByValidity(rule.groupedExamples, examples, config, false);
|
209 |
|
210 |
|
211 | _appendGroupedExamplesByValidity(rule.groupedExamples, examples, config, true);
|
212 | });
|
213 | rule.hasOnlyOneConfig = Object.keys(examplesGroupedByConfig).length === 1;
|
214 |
|
215 | return rule;
|
216 | }
|