600402d440
All the docs related files (docs-app, doc-gen, content, etc)
are now to be found inside the `/aio` folder.
The related gulp tasks have been moved from the top level
gulp file to a new one inside the `/aio` folder.
The structure of the `/aio` folder now looks like:
```
/aio/
build/ # gulp tasks
content/ #MARKDOWN FILES for devguides, cheatsheet, etc
devguides/
cheatsheets/
transforms/ #dgeni packages, templates, etc
src/
app/
assets/
content/ #HTML + JSON build artifacts produced by dgeni from /aio/content.
#This dir is .gitignored-ed
e2e/ #protractor tests for the doc viewer app
node_modules/ #dependencies for both the doc viewer builds and the dgeni stuff
#This dir is .gitignored-ed
gulpfile.js #Tasks for generating docs and building & deploying the doc viewer
```
Closes #14361
33 lines
1.0 KiB
JavaScript
33 lines
1.0 KiB
JavaScript
var _ = require('lodash');
|
|
|
|
/**
|
|
* @dgProcessor checkUnbalancedBackTicks
|
|
* @description
|
|
* Searches the rendered content for an odd number of (```) backticks,
|
|
* which would indicate an unbalanced pair and potentially a typo in the
|
|
* source content.
|
|
*/
|
|
module.exports = function checkUnbalancedBackTicks(log, createDocMessage) {
|
|
|
|
var BACKTICK_REGEX = /^ *```/gm;
|
|
|
|
return {
|
|
// $runAfter: ['checkAnchorLinksProcessor'],
|
|
$runAfter: ['inlineTagProcessor'],
|
|
$runBefore: ['writeFilesProcessor'],
|
|
$process: function(docs) {
|
|
_.forEach(docs, function(doc) {
|
|
if (doc.renderedContent) {
|
|
var matches = doc.renderedContent.match(BACKTICK_REGEX);
|
|
if (matches && matches.length % 2 !== 0) {
|
|
doc.unbalancedBackTicks = true;
|
|
log.warn(createDocMessage(
|
|
'checkUnbalancedBackTicks processor: unbalanced backticks found in rendered content',
|
|
doc));
|
|
log.warn(doc.renderedContent);
|
|
}
|
|
}
|
|
});
|
|
}
|
|
};
|
|
}; |