@progress/kendo-typescript-tasks 11.2.7-dev.1 → 11.2.7-dev.15

package/test/api.js

@@ -1,339 +0,0 @@
-'use strict';
-
-const generator = require('../src/api/generator');
-const fnPage = require('../src/api/fn-page');
-const classPage = require('../src/api/class-page');
-const componentPage = require('../src/api/component-page');
-const indexPage = require('../src/api/index-page');
-
-describe('API generation', () => {
-    const packageInfo = {
-        friendlyName: 'Foo'
-    };
-
-    describe('for functions', () => {
-        const fnSample = require('./fn.json');
-        const page = fnPage(fnSample);
-
-        it('includes root description', () => {
-            expect(page).toContain('ROOT_DESC');
-        });
-
-        it('includes root text', () => {
-            expect(page).toContain('ROOT_TEXT');
-        });
-
-        it('includes root example ', () => {
-            expect(page).toContain('ROOT_EXAMPLE');
-        });
-    });
-
-    describe('for function definitions', () => {
-        const fnDef = require('./fn-def.json');
-        const page = fnPage(fnDef);
-
-        it('includes signature description', () => {
-            expect(page).toContain('SIG_DESC');
-        });
-
-        it('includes signature text', () => {
-            expect(page).toContain('SIG_TEXT');
-        });
-
-        it('includes signature example', () => {
-            expect(page).toContain('SIG_EXAMPLE');
-        });
-
-        it('appends generic argument to class name', () => {
-            expect(page).toContain('fun<T>');
-        });
-    });
-
-    describe('for modules', () => {
-        const pkg = require('./package.json');
-        const members = generator.extractMembers(pkg.name, pkg.children, { modules: [ 'module1' ] });
-
-        it('adds module to slug', () => {
-            expect(members[0].slug).toEqual('api_package-name_module1_foo');
-        });
-
-        it('does not add default module to slug', () => {
-            expect(members[1].slug).toEqual('api_package-name_foo');
-        });
-
-        it('sets slugs for linking parameter types', () => {
-            const ctr = members[1].children[0];
-            const param = ctr.signatures[0].parameters[0];
-            expect(param.type.typeSlug).toEqual('api_package-name_module1_foo');
-        });
-    });
-
-    describe('for interfaces', () => {
-        const data = require('./interface-comments.json');
-        const members = generator.extractMembers(data.name, data.children, []);
-
-        it('copies signature description', () => {
-            const page = classPage(members[1]);
-            expect(page).toContain('SIG_DESC');
-        });
-
-        it('copies parameter descriptions', () => {
-            const page = classPage(members[1]);
-            expect(page).toContain('PARAM_DESC');
-        });
-
-        it('doesnt overwrite signature description', () => {
-            const page = classPage(members[2]);
-            expect(page).toContain('IMPL_SIG_DESC');
-        });
-
-        it('doesnt overwrite parameter descriptions', () => {
-            const page = classPage(members[2]);
-            expect(page).toContain('IMPL_PARAM_DESC');
-        });
-    });
-
-    describe('for classes', () => {
-        const classData = require('./class.json');
-        const page = classPage(classData);
-
-        it('appends generic argument to class name', () => {
-            expect(page).toContain('Shape<T>');
-        });
-
-        it('adds constructor docs', () => {
-            expect(page).toContain('## Constructors');
-            expect(page).toContain('### Shape&lt;T&gt;\n<code>\n\n\n(options?: any)\n\n\n</code>');
-        });
-
-        it('adds methods', () => {
-            const pageContent = `## Methods\n\n<table class="api-table api-table-methods">\n<thead class="api-table-methods-head">\n<tr>\n<th>\n\n\n#### get\n\n\n</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td>\n\n\nGets the value of the specified option.\n\n\n</td>\n</tr>\n\n<tr class="nested-table">\n<td>\n<table class="api-table api-table-returns">\n<thead class="api-table-returns-head">\n<tr>\n<th class="th-type">Returns</th>\n<th class="th-desc"></th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td type>\n\n\n<code>\n\n\nany\n\n\n</code>\n\n\n</td>\n<td>\n\n\nThe current option value.\n\n\n</td>\n</tr>\n</tbody>\n</table>\n</td>\n</tr>\n</tbody>\n</table>`;
-            expect(page).toContain(pageContent);
-        });
-
-        it('render default value', () => {
-            const meta = {
-                "name": "Component",
-                "children": [
-                    {
-                        "name": "foo",
-                        "flags": {
-                            "isPublic": true
-                        },
-                        "comment": {
-                            "tags": [
-                                {
-                                    "tag": "default",
-                                    "text": "42\n"
-                                }
-                            ]
-                        }
-                    }
-                ]
-            };
-
-            const page = classPage(meta);
-
-            expect(page).toContain('42');
-        });
-    });
-
-    describe('for type unions', () => {
-        const unionPage = require('../src/api/union-page');
-
-        it('formats anonymous interfaces', () => {
-            const unionData = require('./type-union.json');
-            const page = unionPage(unionData);
-            expect(page).toContain('{ allowUnsort?: boolean; mode?: "single" | "multiple"; }');
-        });
-
-        it('formats intersection interfaces', () => {
-            const intersectionData = require('./intersection.json');
-            const page = unionPage(intersectionData);
-            expect(page).toContain('ColumnSortSettings [intersected](https://www.typescriptlang.org/docs/handbook/advanced-types.html#intersection-types) with { mode?: "single" | "multiple"; }');
-        });
-
-        it('formats values conatining or equaling "null"', () => {
-            const unionData = require('./type-union-operators.json');
-            const page = unionPage(unionData);
-            expect(page).toContain('`type` FilterOperator = "gt" | "gte" | "isnull" | "isnotnull" | `null`');
-        });
-    });
-
-    describe('for components', () => {
-        const componentData = require('./components-def.json');
-
-        it('render component selector', () => {
-            const page = componentPage(componentData.component, packageInfo);
-
-            expect(page).toContain('my-component');
-        });
-
-        it('render directive selector', () => {
-            const page = componentPage(componentData.directive, packageInfo);
-
-            expect(page).toContain('[myDirective]');
-        });
-
-        it('render component exportAs', () => {
-            const page = componentPage(componentData.exportedComponent, packageInfo);
-
-            expect(page).toContain('Accessible in templates as `#kendoExportedInstance="exportedComponent"`');
-        });
-
-        it('render directive exportAs', () => {
-            const page = componentPage(componentData.exportedDirective, packageInfo);
-
-            expect(page).toContain('Accessible in templates as `#kendoExportedInstance="exportedDirective"`');
-        });
-
-        it('does not render exportAs', () => {
-            const page = componentPage(componentData.component, packageInfo);
-
-            expect(page).not.toContain('Accessible in templates as');
-        });
-
-        it('render default value', () => {
-            const component = {
-                "name": "Component",
-                "children": [
-                    {
-                        "name": "foo",
-                        "flags": {
-                            "isPublic": true
-                        },
-                        "comment": {
-                            "tags": [
-                                {
-                                    "tag": "default",
-                                    "text": "42\n"
-                                }
-                            ]
-                        }
-                    }
-                ]
-            };
-
-            const page = componentPage(component, packageInfo);
-
-            expect(page).toContain('42');
-        });
-    });
-
-    describe('for fields', () => {
-        const fieldsData = require('./fields-def.json');
-
-        it('does not render fields without comment', () => {
-
-            const page = componentPage(fieldsData.withoutComment, packageInfo);
-
-            expect(page).not.toContain('Fields');
-        });
-
-        it('render fields without decorators, but with comment', () => {
-
-            const page = componentPage(fieldsData.withComment, packageInfo);
-            const pageContent = `## Fields\n\n<table class="api-table api-table-fields">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-default">Default</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td class="table-cell-name">\n\n\n#### bar\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nQueryList&lt;string&gt;\n\n\n</code>\n\n\n</td>\n<td class="table-cell-default">\n\n\n\n\n</td>\n<td class="table-cell-comment">\n\n\nsome comment\n\nlong text\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
-            expect(page).toContain(pageContent);
-        });
-
-        it('render fields with decorators and comment', () => {
-
-            const page = componentPage(fieldsData.withCommentAndDecorator, packageInfo);
-            const pageContent = `## Fields\n\n<table class="api-table api-table-fields">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-default">Default</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td class="table-cell-name">\n\n\n#### bar\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nQueryList&lt;string&gt;\n\n\n</code>\n\n\n</td>\n<td class="table-cell-default">\n\n\n\n\n</td>\n<td class="table-cell-comment">\n\n\nsome comment\n\nlong text\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
-            expect(page).toContain(pageContent);
-        });
-    });
-
-    describe('for inputs', () => {
-        const inputsData = require('./inputs-def.json');
-
-        it('render inputs name and type', () => {
-
-            const page = componentPage(inputsData.withoutNameMapping, packageInfo);
-            const pageContent = `## Inputs\n\n<table class="api-table api-table-inputs">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-default">Default</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td class="table-cell-name">\n\n\n#### bar\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nboolean\n\n\n</code>\n\n\n</td>\n<td class="table-cell-default">\n\n\n\n\n</td>\n<td class="table-cell-comment">\n\n\n\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
-            expect(page).toContain(pageContent);
-        });
-
-        it('render fields with mapped name', () => {
-
-            const page = componentPage(inputsData.withNameMapping, packageInfo);
-            const pageContent = `## Inputs\n\n<table class="api-table api-table-inputs">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-default">Default</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td class="table-cell-name">\n\n\n#### foo\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nboolean\n\n\n</code>\n\n\n</td>\n<td class="table-cell-default">\n\n\n\n\n</td>\n<td class="table-cell-comment">\n\n\n\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
-            expect(page).toContain(pageContent);
-        });
-    });
-
-    describe('for events', () => {
-        const eventsData = require('./events-def.json');
-
-        it('render events names', () => {
-
-            const page = componentPage(eventsData.withoutNameMapping, packageInfo);
-
-            expect(page).toContain('Events');
-        });
-
-        it('render event with type', () => {
-            const page = componentPage(eventsData.withoutNameMapping, packageInfo);
-            const pageContent = `## Events\n\n<table class="api-table api-table-events">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td class="table-cell-name">\n\n\n#### valueChange\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nEventEmitter&lt;any&gt;\n\n\n</code>\n\n\n</td>\n<td class="table-cell-comment">\n\n\nFires each time the user selects a new value.\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
-            expect(page).toContain(pageContent);
-        });
-
-        it('render event binding name if available', () => {
-            const page = componentPage(eventsData.withNameMapping, packageInfo);
-            const pageContent = `## Events\n\n<table class="api-table api-table-events">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td class="table-cell-name">\n\n\n#### focus\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nEventEmitter&lt;any&gt;\n\n\n</code>\n\n\n</td>\n<td class="table-cell-comment">\n\n\nFires each time the user focuses the input element.\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
-            expect(page).toContain(pageContent);
-        });
-
-        it('should not throw when no decorators are available', () => {
-            expect(() => componentPage(eventsData.withoutDecorators, packageInfo)).not.toThrow();
-        });
-    });
-
-    describe('index', () => {
-        const page = indexPage('foo/bar', {
-            '': {
-                'Function': [ {
-                    'slug': 'root-f',
-                    'name': 'root-f'
-                } ]
-            },
-            'a': {
-                'Function': [ {
-                    'slug': 'a-f',
-                    'name': 'a-f'
-                } ]
-            },
-            'b': {
-                'Function': [ {
-                    'slug': 'b-f',
-                    'name': 'b-f'
-                } ]
-            }
-        }, {
-            friendlyName: 'Foo',
-            framework: 'Bar'
-        });
-
-        const assertModule = name => {
-            expect(new RegExp(`<h2 class="api-module-name">\\s*${name}\\s*<\\/h2>`).test(page)).toBeTruthy();
-        };
-
-        it('renders default group', () => {
-            assertModule('foo/bar');
-            expect(page).toContain('root-f');
-        });
-
-        it('renders module groups', () => {
-            assertModule('a');
-            expect(page).toContain('a-f');
-            assertModule('b');
-            expect(page).toContain('b-f');
-        });
-
-        it('renders "friendlyName" as page heading', () => {
-            expect(/#\s{1}Foo\s{1}API/.test(page)).toBe(true);
-        });
-    });
-});
-

package/test/class.json

@@ -1,73 +0,0 @@
-{
-    "name": "Shape",
-    "kindString": "Class",
-    "comment": {
-        "shortText": "Represents a drawing element that can be filled and stroked"
-    },
-    "typeParameter": [
-        {
-            "name": "T",
-            "kindString": "Type parameter"
-        }
-    ],
-    "children": [
-        {
-            "name": "constructor",
-            "kindString": "Constructor",
-            "flags": {
-                "isExported": true
-            },
-            "comment": {},
-            "signatures": [
-                {
-                    "name": "new Shape",
-                    "kindString": "Constructor signature",
-                    "flags": {},
-                    "comment": {},
-                    "parameters": [
-                        {
-                            "name": "options",
-                            "kindString": "Parameter",
-                            "flags": {
-                                "isOptional": true
-                            },
-                            "comment": {
-                                "shortText": "The initial values of all options.\n"
-                            },
-                            "type": {
-                                "type": "instrinct",
-                                "name": "any"
-                            }
-                        }
-                    ],
-                    "type": {
-                        "type": "reference",
-                        "name": "Shape"
-                    }
-                }
-            ]
-        },
-        {
-            "name": "get",
-            "kindString": "Method",
-            "flags": {
-                "isExported": true
-            },
-            "signatures": [
-                {
-                    "name": "get",
-                    "kindString": "Call signature",
-                    "flags": {},
-                    "comment": {
-                        "shortText": "Gets the value of the specified option.",
-                        "returns": "The current option value."
-                    },
-                    "type": {
-                        "type": "instrinct",
-                        "name": "any"
-                    }
-                }
-            ]
-        }
-    ]
-}

package/test/components-def.json

@@ -1,98 +0,0 @@
-{
-    "directive": {
-        "name": "MyDirective",
-        "comment": {
-            "shortText": "Represents the Kendo UI Grid component for Angular.",
-            "tags": [
-                {
-                    "tag": "example",
-                    "text": "\n```ts-preview\n@@Component({\n   selector: 'my-app',\n   template: `\n       <kendo-grid [data]=\"gridData\">\n       </kendo-grid>\n   `\n})\nclass AppComponent {\n   private gridData: any[] = products;\n}\n\nconst products = [{\n   \"ProductID\": 1,\n   \"ProductName\": \"Chai\",\n   \"UnitPrice\": 18.0000,\n   \"Discontinued\": true\n }, {\n   \"ProductID\": 2,\n   \"ProductName\": \"Chang\",\n   \"UnitPrice\": 19.0000,\n   \"Discontinued\": false\n }\n];\n```\n"
-                }
-            ]
-        },
-        "decorators": [
-            {
-                "name": "Directive",
-                "type": {
-                    "type": "reference",
-                    "name": "Directive"
-                },
-                "arguments": {
-                    "obj": "{\r\n    selector: '[myDirective]'\r\n}"
-                }
-            }
-        ]
-    },
-    "exportedDirective": {
-        "name": "ExportedDirective",
-        "comment": {
-            "shortText": "Represents the Kendo UI Grid component for Angular.",
-            "tags": [
-                {
-                    "tag": "example",
-                    "text": "\n```ts-preview\n@@Component({\n   selector: 'my-app',\n   template: `\n       <kendo-grid [data]=\"gridData\">\n       </kendo-grid>\n   `\n})\nclass AppComponent {\n   private gridData: any[] = products;\n}\n\nconst products = [{\n   \"ProductID\": 1,\n   \"ProductName\": \"Chai\",\n   \"UnitPrice\": 18.0000,\n   \"Discontinued\": true\n }, {\n   \"ProductID\": 2,\n   \"ProductName\": \"Chang\",\n   \"UnitPrice\": 19.0000,\n   \"Discontinued\": false\n }\n];\n```\n"
-                }
-            ]
-        },
-        "decorators": [
-            {
-                "name": "Directive",
-                "type": {
-                    "type": "reference",
-                    "name": "Directive"
-                },
-                "arguments": {
-                    "obj": "{\n    exportAs: 'exportedDirective',\r\n    selector: '[exportedDirective]'\r\n}"
-                }
-            }
-        ]
-    },
-    "component": {
-        "name": "MyComponent",
-        "comment": {
-            "shortText": "Represents the Kendo UI Grid component for Angular.",
-            "tags": [
-                {
-                    "tag": "example",
-                    "text": "\n```ts-preview\n@@Component({\n   selector: 'my-app',\n   template: `\n       <kendo-grid [data]=\"gridData\">\n       </kendo-grid>\n   `\n})\nclass AppComponent {\n   private gridData: any[] = products;\n}\n\nconst products = [{\n   \"ProductID\": 1,\n   \"ProductName\": \"Chai\",\n   \"UnitPrice\": 18.0000,\n   \"Discontinued\": true\n }, {\n   \"ProductID\": 2,\n   \"ProductName\": \"Chang\",\n   \"UnitPrice\": 19.0000,\n   \"Discontinued\": false\n }\n];\n```\n"
-                }
-            ]
-        },
-        "decorators": [
-            {
-                "name": "Component",
-                "type": {
-                    "type": "reference",
-                    "name": "Component"
-                },
-                "arguments": {
-                    "obj": "{\r\n    selector: 'my-component'\r\n}"
-                }
-            }
-        ]
-    },
-    "exportedComponent": {
-        "name": "ExportedComponent",
-        "comment": {
-            "shortText": "Represents the Kendo UI Grid component for Angular.",
-            "tags": [
-                {
-                    "tag": "example",
-                    "text": "\n```ts-preview\n@@Component({\n   selector: 'my-app',\n   template: `\n       <kendo-grid [data]=\"gridData\">\n       </kendo-grid>\n   `\n})\nclass AppComponent {\n   private gridData: any[] = products;\n}\n\nconst products = [{\n   \"ProductID\": 1,\n   \"ProductName\": \"Chai\",\n   \"UnitPrice\": 18.0000,\n   \"Discontinued\": true\n }, {\n   \"ProductID\": 2,\n   \"ProductName\": \"Chang\",\n   \"UnitPrice\": 19.0000,\n   \"Discontinued\": false\n }\n];\n```\n"
-                }
-            ]
-        },
-        "decorators": [
-            {
-                "name": "Component",
-                "type": {
-                    "type": "reference",
-                    "name": "Component"
-                },
-                "arguments": {
-                    "obj": "{\n    exportAs: 'exportedComponent',\r\n    selector: 'exported-component'\r\n}"
-                }
-            }
-        ]
-    }
-}

package/test/events-def.json

@@ -1,163 +0,0 @@
-{
-    "withoutNameMapping": {
-        "name": "FocusableComponent",
-        "flags": {
-            "isExported": true
-        },
-        "comment": {
-            "shortText": "Short text",
-            "text": "Long text"
-        },
-        "decorators": [
-            {
-                "name": "Component",
-                "type": {
-                    "type": "reference",
-                    "name": "Component"
-                },
-                "arguments": {
-                    "obj": "{\r\n    selector: 'kendo-focusable'\r\n}"
-                }
-            }
-        ],
-        "children": [
-            {
-                "name": "valueChange",
-                "kindString": "Property",
-                "flags": {
-                    "isExported": true,
-                    "isPublic": true
-                },
-                "comment": {
-                    "shortText": "Fires each time the user selects a new value."
-                },
-                "decorators": [
-                    {
-                        "name": "Output",
-                        "type": {
-                            "type": "reference",
-                            "name": "Output"
-                        },
-                        "arguments": {}
-                    }
-                ],
-                "type": {
-                    "type": "reference",
-                    "name": "EventEmitter",
-                    "typeArguments": [
-                        {
-                            "type": "instrinct",
-                            "name": "any"
-                        }
-                    ]
-                },
-                "defaultValue": " new EventEmitter()"
-            }
-        ]
-    },
-    "withNameMapping": {
-        "name": "FocusableComponent",
-        "flags": {
-            "isExported": true
-        },
-        "comment": {
-            "shortText": "Short text",
-            "text": "Long text"
-        },
-        "decorators": [
-            {
-                "name": "Component",
-                "type": {
-                    "type": "reference",
-                    "name": "Component"
-                },
-                "arguments": {
-                    "obj": "{\r\n    selector: 'kendo-focusable'\r\n}"
-                }
-            }
-        ],
-        "children": [
-            {
-                "name": "onfocus",
-                "kindString": "Property",
-                "flags": {
-                    "isExported": true,
-                    "isPublic": true
-                },
-                "comment": {
-                    "shortText": "Fires each time the user focuses the input element."
-                },
-                "decorators": [
-                    {
-                        "name": "Output",
-                        "type": {
-                            "type": "reference",
-                            "name": "Output"
-                        },
-                        "arguments": {
-                            "bindingPropertyName": "'focus'"
-                        }
-                    }
-                ],
-                "type": {
-                    "type": "reference",
-                    "name": "EventEmitter",
-                    "typeArguments": [
-                        {
-                            "type": "instrinct",
-                            "name": "any"
-                        }
-                    ]
-                },
-                "defaultValue": " new EventEmitter()"
-            }
-        ]
-
-    },
-    "withoutDecorators": {
-        "name": "FocusableComponent",
-        "flags": {
-            "isExported": true
-        },
-        "comment": {
-            "shortText": "Short text",
-            "text": "Long text"
-        },
-        "decorators": [
-            {
-                "name": "Component",
-                "type": {
-                    "type": "reference",
-                    "name": "Component"
-                },
-                "arguments": {
-                    "obj": "{\r\n    selector: 'kendo-focusable'\r\n}"
-                }
-            }
-        ],
-        "children": [
-            {
-                "name": "valueChange",
-                "kindString": "Property",
-                "flags": {
-                    "isExported": true,
-                    "isPublic": true
-                },
-                "comment": {
-                    "shortText": "Fires each time the user selects a new value."
-                },
-                "type": {
-                    "type": "reference",
-                    "name": "EventEmitter",
-                    "typeArguments": [
-                        {
-                            "type": "instrinct",
-                            "name": "any"
-                        }
-                    ]
-                },
-                "defaultValue": " new EventEmitter()"
-            }
-        ]
-    }
-}