[rc] Fixed usage of markdown pipe within type definition components (#59

) * Bump acorn from 6.4.0 to 6.4.1 (#40) Bumps [acorn](https://github.com/acornjs/acorn) from 6.4.0 to 6.4.1. - [Release notes](https://github.com/acornjs/acorn/releases) - [Commits](acornjs/acorn@6.4.0...6.4.1) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Assorted fixes; unit tests (#42) * Updated changelog/package.json for 3.2.0 release (#43) * Adding license (#47) Added license to address blackbaud/skyux2-docs#894 * Fixed href generator for lowercase type names (#49) * Updated changelog/package.json for 3.2.1 release (#50) * Added theme picker control panel to demo (#52) * Added theme picker control panel to demo * Added tests * Added theme switcher to sample page. * Addressed PR feedback * Fixed import paths * Updated CHANGELOG and package.json for 3.3.0 release (#53) * Update README.md * [rc] Fix anchor links and markdown parsing * Fix unit tests Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Denise Pena <Denise.Pena@blackbaud.me> Co-authored-by: Paul Crowder <paul.crowder@blackbaud.com>
blackbaud · May 20, 2020 · cb676e4 · cb676e4
1 parent be2a1f8
commit cb676e4
Show file tree

Hide file tree

Showing 19 changed files with 82 additions and 14,573 deletions.
diff --git a/README.md b/README.md
@@ -35,7 +35,6 @@
   },
   "app": {
     "styles": [
-      "@skyux/theme/css/sky.css",
       "@skyux/docs-tools/css/docs-tools.css"
     ]
   }
@@ -117,4 +116,4 @@ export class AppExtrasModule { }
 - Code examples are automatically generated from source code added to `./src/app/public/plugin-resources/code-examples`.
 - Each code example should be self-contained (in its own folder) and have its own module. The module will dictate its own exports, imports, providers, or entry components.
 - Code examples are not instrumented for code coverage and are not included in any build results.
-- Any additional NPM packages that are needed for the code example to run should be added to the `packageDependencies` attribute on the `SkyDocsCodeExamples` component.
+- Any additional NPM packages that are needed for the code example to run should be added to the `packageDependencies` attribute on the `SkyDocsCodeExamples` component.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -5,9 +5,10 @@
   "scripts": {
     "build": "skyux build-public-library && node ./scripts/prepare-package.js",
     "build:ci": "npm run build",
+    "build:dev-bundle": "npm run build && node ./scripts/dev-bundle.js",
     "test": "skyux test --coverage library",
     "test:watch": "skyux watch --coverage library",
-    "start": "skyux serve",
+    "start": "npm run build:dev-bundle && skyux serve",
     "e2e": "skyux e2e",
     "lint": "skyux lint"
   },
@@ -58,7 +59,7 @@
     "@blackbaud/skyux-lib-media": "2.0.0-rc.0",
     "@blackbaud/skyux-lib-restricted-view": "2.0.0-rc.0",
     "@blackbaud/skyux-lib-stache": "4.0.0-rc.2",
-    "@skyux-sdk/builder": "4.0.0-rc.10",
+    "@skyux-sdk/builder": "4.0.0-rc.11",
     "@skyux-sdk/builder-plugin-skyux": "4.0.0-rc.0",
     "@skyux-sdk/e2e": "4.0.0-rc.1",
     "@skyux-sdk/testing": "4.0.0-rc.3",
@@ -67,6 +68,7 @@
     "@skyux/avatar": "4.0.0",
     "@skyux/config": "4.0.0",
     "@skyux/core": "4.1.0",
+    "@skyux/docs-tools": "4.0.0-rc.6",
     "@skyux/errors": "4.0.0",
     "@skyux/forms": "4.0.0",
     "@skyux/http": "4.0.0",

diff --git a/scripts/dev-bundle.js b/scripts/dev-bundle.js
@@ -0,0 +1,10 @@
+const fs = require('fs-extra');
+const rimraf = require('rimraf');
+
+const json = fs.readJsonSync('./package.json');
+const dest = `./node_modules/${json.name}`;
+
+rimraf.sync(dest);
+
+fs.ensureDirSync(dest);
+fs.copySync('./dist', dest);
diff --git a/src/app/app-extras.module.ts b/src/app/app-extras.module.ts
@@ -7,6 +7,13 @@ import {
   SkyCodeModule
 } from '@blackbaud/skyux-lib-code-block';
 
+// Do not import from public_api since the SKY UX plugin needs to assign providers from the same place.
+// (The SKY UX plugin pulls types from node_modules.)
+import {
+  SkyDocsToolsModule,
+  SkyDocsToolsOptions
+} from '@skyux/docs-tools'; // <-- Important!
+
 import {
   SkyAlertModule
 } from '@skyux/indicators';
@@ -19,11 +26,6 @@ import {
   SkyAppLinkModule
 } from '@skyux/router';
 
-import {
-  SkyDocsToolsModule,
-  SkyDocsToolsOptions
-} from './public/public_api';
-
 @NgModule({
   exports: [
     SkyAlertModule,

diff --git a/src/app/public/modules/_documentation-test/foo.component.ts b/src/app/public/modules/_documentation-test/foo.component.ts
@@ -53,7 +53,7 @@ export class FooComponent<U extends FooUser> implements OnInit {
   public baz: boolean = false;
 
   /**
-   * This is the description for bar input. You must provide FooEnum values.
+   * This is the description for bar input. You must provide `FooEnum` values.
    * @defaultvalue FooEnum.Foo
    */
   @Input()

diff --git a/src/app/public/modules/demo/fixtures/demo.component.fixture.ts b/src/app/public/modules/demo/fixtures/demo.component.fixture.ts
@@ -15,6 +15,10 @@ import {
   SkyDocsDemoControlPanelComponent
 } from '../demo-control-panel.component';
 
+import {
+  SkyDocsDemoControlPanelChange
+} from '../demo-control-panel-change';
+
 import {
   SkyDocsDemoComponent
 } from '../demo.component';
@@ -57,7 +61,7 @@ export class DemoFixtureComponent {
 
   public onDemoReset(): void { }
 
-  public onDemoSelectionChange(): void { }
+  public onDemoSelectionChange(change: SkyDocsDemoControlPanelChange): void { }
 
   public changeFormControls(): void {
     this.showRadios = false;

diff --git a/src/app/public/modules/safe-html/safe-html.component.html b/src/app/public/modules/safe-html/safe-html.component.html
@@ -1,4 +1,4 @@
 <div
   class="sky-docs-safe-html"
-  [innerHtml]="getTrustedHtml(innerHtml | skyDocsMarkdown)"
+  [innerHtml]="getTrustedHtml(innerHtml)"
 ></div>
diff --git a/src/app/public/modules/safe-html/safe-html.module.ts b/src/app/public/modules/safe-html/safe-html.module.ts
@@ -1,10 +1,10 @@
 import {
-  NgModule
-} from '@angular/core';
+  CommonModule
+} from '@angular/common';
 
 import {
-  SkyDocsMarkdownModule
-} from '../markdown/markdown.module';
+  NgModule
+} from '@angular/core';
 
 import {
   SkyDocsSafeHtmlComponent
@@ -15,7 +15,7 @@ import {
     SkyDocsSafeHtmlComponent
   ],
   imports: [
-    SkyDocsMarkdownModule
+    CommonModule
   ],
   exports: [
     SkyDocsSafeHtmlComponent

diff --git a/src/app/public/modules/type-definitions/anchor-link.service.spec.ts b/src/app/public/modules/type-definitions/anchor-link.service.spec.ts
@@ -43,7 +43,7 @@ describe('Anchor link service', function () {
 
   it('should add anchor links to known types', () => {
     const service = new SkyDocsAnchorLinkService(mockTypeDefinitionsProvider);
-    const content = 'Foo FooComponent FooUser Foo2 [[Foo]] [[FooUser]] FooComponent [[Foo]] (FooUser) >Foo< FooUnknown UnknownFoo FooEnum.Foo';
+    const content = 'Foo FooComponent FooUser Foo2 [[Foo]] [[FooUser]] FooComponent [[Foo]] (FooUser) >Foo< FooUnknown UnknownFoo FooEnum.Foo `FooUser` <a href="#">FooUser</a>';
     const result = service.applyTypeAnchorLinks(content);
 
     expect(result).toEqual([
@@ -59,7 +59,9 @@ describe('Anchor link service', function () {
       '>Foo<',
       'FooUnknown',
       'UnknownFoo',
-      '<a class="sky-docs-anchor-link" href="#foo-enum">FooEnum</a>.Foo'
+      '<a class="sky-docs-anchor-link" href="#foo-enum">FooEnum</a>.Foo',
+      '<a class="sky-docs-anchor-link" href="#foo-user">FooUser</a>',
+      '<a href="#">FooUser</a>'
     ].join(' '));
   });
 

diff --git a/src/app/public/modules/type-definitions/anchor-link.service.ts b/src/app/public/modules/type-definitions/anchor-link.service.ts
@@ -36,6 +36,7 @@ export class SkyDocsAnchorLinkService {
     content = this.removeDoubleSquareBrackets(content);
 
     Object.keys(this.anchorIds).forEach((typeName) => {
+      content = this.removeBackticks(typeName, content);
       const anchorId = this.anchorIds[typeName];
       const anchorHtml = `<a class="sky-docs-anchor-link" href="#${anchorId}">${typeName}</a>`;
       const regex = createRegex(typeName);
@@ -74,4 +75,13 @@ export class SkyDocsAnchorLinkService {
     return content;
   }
 
+  /**
+   * Removes backtick characters around known types to prevent
+   * the markdown pipe from wrapping them with code elements.
+   */
+  private removeBackticks(typeName: string, content: string): string {
+    const regexp = new RegExp(`\`(${typeName})\``, 'g');
+    return content.replace(regexp, typeName);
+  }
+
 }
diff --git a/src/app/public/modules/type-definitions/class-definition.component.html b/src/app/public/modules/type-definitions/class-definition.component.html
@@ -10,7 +10,7 @@
 
   <sky-docs-safe-html
     class="sky-docs-class-definition-description"
-    [innerHtml]="config.description | skyDocsTypeAnchorLinks"
+    [innerHtml]="config.description | skyDocsTypeAnchorLinks | skyDocsMarkdown"
   ></sky-docs-safe-html>
 
   <ng-container *ngIf="config.properties && config.properties.length">
@@ -20,7 +20,7 @@
         [propertyType]="property.type"
       >
         <sky-docs-safe-html
-          [innerHtml]="property.description | skyDocsTypeAnchorLinks"
+          [innerHtml]="property.description | skyDocsTypeAnchorLinks | skyDocsMarkdown"
         ></sky-docs-safe-html>
       </sky-docs-property-definition>
     </sky-docs-property-definitions>
@@ -36,7 +36,7 @@
       >
         <sky-docs-safe-html
           class="sky-docs-class-definition-method-description"
-          [innerHtml]="method.description | skyDocsTypeAnchorLinks"
+          [innerHtml]="method.description | skyDocsTypeAnchorLinks | skyDocsMarkdown"
         ></sky-docs-safe-html>
 
         <sky-code-block
@@ -58,7 +58,7 @@ <h4 class="sky-docs-class-definition-heading">
               [parameterType]="parameter.type"
             >
               <sky-docs-safe-html
-                [innerHtml]="parameter.description | skyDocsTypeAnchorLinks"
+                [innerHtml]="parameter.description | skyDocsTypeAnchorLinks | skyDocsMarkdown"
               ></sky-docs-safe-html>
             </sky-docs-parameter-definition>
           </sky-docs-parameter-definitions>

diff --git a/src/app/public/modules/type-definitions/directive-definition.component.html b/src/app/public/modules/type-definitions/directive-definition.component.html
@@ -10,7 +10,7 @@
 
   <sky-docs-safe-html
     class="sky-docs-directive-definition-description"
-    [innerHtml]="config.description | skyDocsTypeAnchorLinks"
+    [innerHtml]="config.description | skyDocsTypeAnchorLinks | skyDocsMarkdown"
   ></sky-docs-safe-html>
 
   <h4 class="sky-docs-directive-definition-h4">
@@ -44,7 +44,7 @@ <h4 class="sky-docs-directive-definition-h4">
       [propertyType]="property.type"
     >
       <sky-docs-safe-html
-        [innerHtml]="property.description | skyDocsTypeAnchorLinks"
+        [innerHtml]="property.description | skyDocsTypeAnchorLinks | skyDocsMarkdown"
       ></sky-docs-safe-html>
     </sky-docs-property-definition>
     <sky-docs-property-definition *ngFor="let property of eventProperties"
@@ -56,7 +56,7 @@ <h4 class="sky-docs-directive-definition-h4">
       [propertyType]="property.type"
     >
       <sky-docs-safe-html
-        [innerHtml]="property.description | skyDocsTypeAnchorLinks"
+        [innerHtml]="property.description | skyDocsTypeAnchorLinks | skyDocsMarkdown"
       ></sky-docs-safe-html>
     </sky-docs-property-definition>
   </sky-docs-property-definitions>

diff --git a/src/app/public/modules/type-definitions/enumeration-definition.component.html b/src/app/public/modules/type-definitions/enumeration-definition.component.html
@@ -17,7 +17,7 @@
       [propertyName]="member.name"
     >
       <sky-docs-safe-html
-        [innerHtml]="member.description | skyDocsTypeAnchorLinks"
+        [innerHtml]="member.description | skyDocsTypeAnchorLinks | skyDocsMarkdown"
       ></sky-docs-safe-html>
     </sky-docs-property-definition>
   </sky-docs-property-definitions>

diff --git a/src/app/public/modules/type-definitions/interface-definition.component.html b/src/app/public/modules/type-definitions/interface-definition.component.html
@@ -10,7 +10,7 @@
 
   <sky-docs-safe-html
     class="sky-docs-interface-definition-description"
-    [innerHtml]="config.description | skyDocsTypeAnchorLinks"
+    [innerHtml]="config.description | skyDocsTypeAnchorLinks | skyDocsMarkdown"
   ></sky-docs-safe-html>
 
   <sky-code-block
@@ -29,7 +29,7 @@
         [propertyType]="property.type"
       >
         <sky-docs-safe-html
-          [innerHtml]="property.description | skyDocsTypeAnchorLinks"
+          [innerHtml]="property.description | skyDocsTypeAnchorLinks | skyDocsMarkdown"
         ></sky-docs-safe-html>
       </sky-docs-property-definition>
     </sky-docs-property-definitions>

diff --git a/src/app/public/modules/type-definitions/pipe-definition.component.html b/src/app/public/modules/type-definitions/pipe-definition.component.html
@@ -7,7 +7,7 @@
   </sky-docs-heading-anchor>
 
   <sky-docs-safe-html
-    [innerHtml]="config.description | skyDocsTypeAnchorLinks"
+    [innerHtml]="config.description | skyDocsTypeAnchorLinks | skyDocsMarkdown"
   ></sky-docs-safe-html>
 
   <ng-container *ngIf="config.codeExample">
@@ -32,7 +32,7 @@ <h4 class="sky-docs-pipe-definition-heading">
       [parameterType]="config.inputValue.type"
     >
       <sky-docs-safe-html
-        [innerHtml]="config.inputValue.description | skyDocsTypeAnchorLinks"
+        [innerHtml]="config.inputValue.description | skyDocsTypeAnchorLinks | skyDocsMarkdown"
       ></sky-docs-safe-html>
     </sky-docs-parameter-definition>
   </sky-docs-parameter-definitions>
@@ -49,7 +49,7 @@ <h4 class="sky-docs-pipe-definition-heading">
         [parameterType]="parameter.type"
       >
         <sky-docs-safe-html
-          [innerHtml]="parameter.description | skyDocsTypeAnchorLinks"
+          [innerHtml]="parameter.description | skyDocsTypeAnchorLinks | skyDocsMarkdown"
         ></sky-docs-safe-html>
       </sky-docs-parameter-definition>
     </sky-docs-parameter-definitions>

diff --git a/src/app/public/modules/type-definitions/type-alias-definition.component.html b/src/app/public/modules/type-definitions/type-alias-definition.component.html
@@ -10,7 +10,7 @@
 
   <sky-docs-safe-html
     class="sky-docs-type-alias-definition-description"
-    [innerHtml]="config.description | skyDocsTypeAnchorLinks"
+    [innerHtml]="config.description | skyDocsTypeAnchorLinks | skyDocsMarkdown"
   ></sky-docs-safe-html>
 
   <sky-code-block
@@ -44,7 +44,7 @@ <h4 class="sky-docs-type-alias-definition-heading">
         [parameterType]="parameter.type"
       >
         <sky-docs-safe-html
-          [innerHtml]="parameter.description | skyDocsTypeAnchorLinks"
+          [innerHtml]="parameter.description | skyDocsTypeAnchorLinks | skyDocsMarkdown"
         ></sky-docs-safe-html>
       </sky-docs-parameter-definition>
     </sky-docs-parameter-definitions>

diff --git a/src/app/public/modules/type-definitions/type-definitions.service.spec.ts b/src/app/public/modules/type-definitions/type-definitions.service.spec.ts
@@ -2,6 +2,8 @@ import {
   expect
 } from '@skyux-sdk/testing';
 
+import * as mockTypeDocJson from './fixtures/mock-documentation.json';
+
 import {
   SkyDocsTypeDefinitionsProvider
 } from './type-definitions-provider';
@@ -10,7 +12,11 @@ import {
   SkyDocsTypeDefinitionsService
 } from './type-definitions.service';
 
-import * as mockTypeDocJson from './fixtures/mock-documentation.json';
+import {
+  SkyDocsTypeAliasFunctionDefinition,
+  SkyDocsTypeAliasIndexSignatureDefinition,
+  SkyDocsTypeAliasUnionDefinition
+} from './type-alias-definition';
 
 describe('Type definitions service', function () {
 
@@ -425,20 +431,20 @@ describe('Type definitions service', function () {
             }
           ],
           returnType: 'FooUser'
-        },
+        } as SkyDocsTypeAliasFunctionDefinition,
         {
           anchorId: 'type-alias-footypeindexsignature',
           description: '',
           name: 'FooTypeIndexSignature',
           keyName: '_',
           valueType: 'FooUser'
-        },
+        } as SkyDocsTypeAliasIndexSignatureDefinition,
         {
           anchorId: 'type-alias-footypeunioncomplex',
           description: 'This is the description for FooTypeUnionComplex. It can be of type [[FooDate]].',
           name: 'FooTypeUnionComplex',
           types: [ 'string', 'FooDate', 'number', 'false', '1' ]
-        },
+        } as SkyDocsTypeAliasUnionDefinition,
         {
           anchorId: 'type-alias-footypeunionstring',
           description: 'This is the description for FooTypeUnionString.',
@@ -465,6 +471,15 @@ describe('Type definitions service', function () {
     });
   });
 
+  it('should warn if the provider does not include types', () => {
+    (definitionsProvider as any).typeDefinitions = [];
+
+    const spy = spyOn(console, 'warn');
+    const service = new SkyDocsTypeDefinitionsService(definitionsProvider);
+    service.getTypeDefinitions('/src/app/public/modules/empty/');
+    expect(spy).toHaveBeenCalledWith('Type definitions were not found for location: modules/empty/');
+  });
+
   it('should throw an error if the source code path does not end in a slash', () => {
     const service = new SkyDocsTypeDefinitionsService(definitionsProvider);
     expect(function () {

diff --git a/src/app/public/public_api.ts b/src/app/public/public_api.ts
@@ -18,8 +18,6 @@ export * from './modules/markdown/markdown.pipe';
 
 export * from './modules/module-info/module-info.module';
 
-export * from './modules/safe-html/safe-html.module';
-
 export * from './modules/shared/docs-tools-component-info';
 export * from './modules/shared/docs-tools-options';
 export * from './modules/shared/docs-tools-supportal.service';