docs: remove examples-package (#7190)

This project does not have complex examples like Angular, thus we don't have to have infrastructure for this. Since we're just library, our examples are always written in a single file. The plan is to remove as much Angular specific stuff from the docs app as possible.

docs_app/package.json

@@ -85,7 +85,6 @@
     "css-selector-parser": "^1.3.0",
     "dgeni": "^0.4.14",
     "dgeni-packages": "^0.30.0",
-    "entities": "^1.1.1",
     "eslint": "^5.16.0",
     "eslint-plugin-jasmine": "^2.2.0",
     "firebase-tools": "^9.3.0",

docs_app/tools/transforms/README.md

@@ -38,7 +38,6 @@ you are working on.
 * angular-api-package
 * angular-content-package
 * content-package
-* examples-package
 * links-package
 * post-process-package
 * remark-package

docs_app/tools/transforms/angular-api-package/index.js

@@ -12,6 +12,7 @@ const typeScriptPackage = require('dgeni-packages/typescript');
 const { API_SOURCE_PATH, API_TEMPLATES_PATH, MARBLE_IMAGES_PATH, MARBLE_IMAGES_WEB_PATH,
   requireFolder } = require('../config');
 
+// prettier-ignore
 module.exports = new Package('angular-api', [basePackage, typeScriptPackage])
 
   // Register the processors
@@ -55,7 +56,7 @@ module.exports = new Package('angular-api', [basePackage, typeScriptPackage])
   })
 
   // Where do we get the source files?
-  .config(function(readTypeScriptModules, readFilesProcessor, collectExamples, tsParser) {
+  .config(function(readTypeScriptModules, readFilesProcessor, tsParser) {
 
     // Tell TypeScript how to load modules that start with `@angular`
     tsParser.options.paths = { '@angular/*': [API_SOURCE_PATH + '/*'] };
@@ -84,7 +85,6 @@ module.exports = new Package('angular-api', [basePackage, typeScriptPackage])
         fileReader: 'exampleFileReader'
       }
     ];
-    collectExamples.exampleFolders.push('examples');
   })
 
   // Configure jsdoc-style tag parsing
@@ -96,7 +96,6 @@ module.exports = new Package('angular-api', [basePackage, typeScriptPackage])
 
   // Additional jsdoc config (for RxJS source)
   .config(function(parseTagsProcessor) {
-    parseTagsProcessor.tagDefinitions.push({ name: 'example', aliases: ['examples'], multi: true, docProperty: 'examples' });
     parseTagsProcessor.tagDefinitions.push({ name: 'owner' });
     parseTagsProcessor.tagDefinitions.push({ name: 'static' });
     parseTagsProcessor.tagDefinitions.push({ name: 'nocollapse' });

docs_app/tools/transforms/angular-base-package/index.js

@@ -11,18 +11,17 @@ const Package = require('dgeni').Package;
 const jsdocPackage = require('dgeni-packages/jsdoc');
 const nunjucksPackage = require('dgeni-packages/nunjucks');
 const linksPackage = require('../links-package');
-const examplesPackage = require('../examples-package');
 const targetPackage = require('../target-package');
 const remarkPackage = require('../remark-package');
 const postProcessPackage = require('dgeni-packages/post-process-html');
 
 const { PROJECT_ROOT, CONTENTS_PATH, OUTPUT_PATH, DOCS_OUTPUT_PATH, TEMPLATES_PATH, AIO_PATH, requireFolder } = require('../config');
 
+// prettier-ignore
 module.exports = new Package('angular-base', [
   jsdocPackage,
   nunjucksPackage,
   linksPackage,
-  examplesPackage,
   targetPackage,
   remarkPackage,
   postProcessPackage,
@@ -60,14 +59,12 @@ module.exports = new Package('angular-base', [
   })
 
   // Where do we get the source files?
-  .config(function (readFilesProcessor, collectExamples, generateKeywordsProcessor, jsonFileReader) {
+  .config(function (readFilesProcessor, generateKeywordsProcessor, jsonFileReader) {
     readFilesProcessor.fileReaders.push(jsonFileReader);
     readFilesProcessor.basePath = PROJECT_ROOT;
     readFilesProcessor.sourceFiles = [];
-    collectExamples.exampleFolders = [];
 
     generateKeywordsProcessor.ignoreWordsFile = path.resolve(__dirname, 'ignore.words');
-    generateKeywordsProcessor.docTypesToIgnore = ['example-region'];
     generateKeywordsProcessor.propertiesToIgnore = ['renderedContent'];
   })
 
@@ -125,12 +122,8 @@ module.exports = new Package('angular-base', [
     getLinkInfo.useFirstAmbiguousLink = false;
   })
 
-  .config(function (computePathsProcessor, generateKeywordsProcessor) {
+  .config(function (generateKeywordsProcessor) {
     generateKeywordsProcessor.outputFolder = 'app';
-
-    // Replace any path templates inherited from other packages
-    // (we want full and transparent control)
-    computePathsProcessor.pathTemplates = [{ docTypes: ['example-region'], getOutputPath: function () {} }];
   })
 
   .config(function (postProcessHtml, addImageDimensions, autoLinkCode, filterPipes, filterAmbiguousDirectiveAliases, filterFromInImports, filterNeverAsGeneric) {

docs_app/tools/transforms/angular.io-package/index.js

@@ -13,6 +13,7 @@ const { extname, resolve } = require('canonical-path');
 const { existsSync } = require('fs');
 const { SRC_PATH } = require('../config');
 
+// prettier-ignore
 module.exports = new Package('angular.io', [gitPackage, apiPackage, contentPackage])
 
   // This processor relies upon the versionInfo. See below...
@@ -27,7 +28,7 @@ module.exports = new Package('angular.io', [gitPackage, apiPackage, contentPacka
     renderDocsProcessor.extraData.versionInfo = versionInfo;
   })
 
-  .config(function(checkAnchorLinksProcessor, linkInlineTagDef, renderExamples) {
+  .config(function(checkAnchorLinksProcessor, linkInlineTagDef) {
 
     // Fail the processing if there is an invalid link
     linkInlineTagDef.failOnBadLink = false;
@@ -50,10 +51,6 @@ module.exports = new Package('angular.io', [gitPackage, apiPackage, contentPacka
     });
     checkAnchorLinksProcessor.pathVariants = ['', '/', '.html', '/index.html', '#top-of-page'];
     checkAnchorLinksProcessor.errorOnUnmatchedLinks = false;
-
-    // Make sure we fail if the examples are not right
-    renderExamples.ignoreBrokenExamples = false;
-
   })
 
   .config(function(renderLinkInfo, postProcessHtml) {