Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit 9fb7716

Browse files
petebacondarwinNarretz
authored andcommitted
chore(doc-gen): filter out componentGroup doc types from search results
These doc types do not contain useful information from the point of view of search results and are making the results less clear
1 parent b78b129 commit 9fb7716

File tree

2 files changed

+31
-20
lines changed

2 files changed

+31
-20
lines changed

docs/config/index.js

+4
Original file line numberDiff line numberDiff line change
@@ -170,4 +170,8 @@ module.exports = new Package('angularjs', [
170170
jqueryDeployment,
171171
productionDeployment
172172
];
173+
})
174+
175+
.config(function(generateKeywordsProcessor) {
176+
generateKeywordsProcessor.docTypesToIgnore = ['componentGroup'];
173177
});

docs/config/processors/keywords.js

+27-20
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ module.exports = function generateKeywordsProcessor(log, readFilesProcessor) {
1616
ignoreWordsFile: undefined,
1717
areasToSearch: ['api', 'guide', 'misc', 'error', 'tutorial'],
1818
propertiesToIgnore: [],
19+
docTypesToIgnore: [],
1920
$validate: {
2021
ignoreWordsFile: { },
2122
areasToSearch: { presence: true },
23+
docTypesToIgnore: { },
2224
propertiesToIgnore: { }
2325
},
2426
$runAfter: ['memberDocsProcessor'],
@@ -28,6 +30,7 @@ module.exports = function generateKeywordsProcessor(log, readFilesProcessor) {
2830
// Keywords to ignore
2931
var wordsToIgnore = [];
3032
var propertiesToIgnore;
33+
var docTypesToIgnore;
3134
var areasToSearch;
3235

3336
// Keywords start with "ng:" or one of $, _ or a letter
@@ -47,6 +50,8 @@ module.exports = function generateKeywordsProcessor(log, readFilesProcessor) {
4750
areasToSearch = _.indexBy(this.areasToSearch);
4851
propertiesToIgnore = _.indexBy(this.propertiesToIgnore);
4952
log.debug('Properties to ignore', propertiesToIgnore);
53+
docTypesToIgnore = _.indexBy(this.docTypesToIgnore);
54+
log.debug('Doc types to ignore', docTypesToIgnore);
5055

5156
var ignoreWordsMap = _.indexBy(wordsToIgnore);
5257

@@ -78,34 +83,36 @@ module.exports = function generateKeywordsProcessor(log, readFilesProcessor) {
7883

7984
// We are only interested in docs that live in the right area
8085
docs = _.filter(docs, function(doc) { return areasToSearch[doc.area]; });
86+
docs = _.filter(docs, function(doc) { return !docTypesToIgnore[doc.docType]; });
8187

8288
_.forEach(docs, function(doc) {
8389

84-
var words = [];
85-
var keywordMap = _.clone(ignoreWordsMap);
86-
var members = [];
87-
var membersMap = {};
8890

89-
// Search each top level property of the document for search terms
90-
_.forEach(doc, function(value, key) {
91+
var words = [];
92+
var keywordMap = _.clone(ignoreWordsMap);
93+
var members = [];
94+
var membersMap = {};
9195

92-
if ( _.isString(value) && !propertiesToIgnore[key] ) {
93-
extractWords(value, words, keywordMap);
94-
}
96+
// Search each top level property of the document for search terms
97+
_.forEach(doc, function(value, key) {
9598

96-
if ( key === 'methods' || key === 'properties' || key === 'events' ) {
97-
_.forEach(value, function(member) {
98-
extractWords(member.name, members, membersMap);
99-
});
100-
}
101-
});
99+
if ( _.isString(value) && !propertiesToIgnore[key] ) {
100+
extractWords(value, words, keywordMap);
101+
}
102+
103+
if ( key === 'methods' || key === 'properties' || key === 'events' ) {
104+
_.forEach(value, function(member) {
105+
extractWords(member.name, members, membersMap);
106+
});
107+
}
108+
});
102109

103110

104-
doc.searchTerms = {
105-
titleWords: extractTitleWords(doc.name),
106-
keywords: _.sortBy(words).join(' '),
107-
members: _.sortBy(members).join(' ')
108-
};
111+
doc.searchTerms = {
112+
titleWords: extractTitleWords(doc.name),
113+
keywords: _.sortBy(words).join(' '),
114+
members: _.sortBy(members).join(' ')
115+
};
109116

110117
});
111118

0 commit comments

Comments
 (0)