honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

build(aio): implement rules to prevent headings in content (#22759) 

* No headings are allowed in `description` and `shortDescription`
* Only heading level 3 is allowed in `usageNotes`

PR Close #22759
This commit is contained in:
Pete Bacon Darwin 2018-03-13 11:24:05 +00:00 committed by Igor Minar
parent 7a8c58162c
commit 1619160c8a
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
aio/tools/transforms/angular-api-package/index.js vendored
View File

@ -119,6 +119,24 @@ module.exports = new Package('angular-api', [basePackage, typeScriptPackage])
addNotYetDocumentedProperty.docTypes = API_DOC_TYPES; addNotYetDocumentedProperty.docTypes = API_DOC_TYPES;
}) })
.config(function(checkContentRules, EXPORT_DOC_TYPES) {
const createNoMarkdownHeadings = require('./content-rules/noMarkdownHeadings');
const noMarkdownHeadings = createNoMarkdownHeadings();
const allowOnlyLevel3Headings = createNoMarkdownHeadings(1, 2, '4,');
const DOC_TYPES_TO_CHECK = EXPORT_DOC_TYPES.concat(['member', 'overload-info']);
const PROPS_TO_CHECK = ['description', 'shortDescription'];
DOC_TYPES_TO_CHECK.forEach(docType => {
const ruleSet = checkContentRules.docTypeRules[docType] = checkContentRules.docTypeRules[docType] || {};
PROPS_TO_CHECK.forEach(prop => {
const rules = ruleSet[prop] = ruleSet[prop] || [];
rules.push(noMarkdownHeadings);
});
const rules = ruleSet['usageNotes'] = ruleSet['usageNotes'] || [];
rules.push(allowOnlyLevel3Headings);
});
})
.config(function(computePathsProcessor, EXPORT_DOC_TYPES, generateApiListDoc) { .config(function(computePathsProcessor, EXPORT_DOC_TYPES, generateApiListDoc) {
const API_SEGMENT = 'api'; const API_SEGMENT = 'api';