@progress/kendo-typescript-api-tasks 1.1.2-dev.27 → 1.1.2-dev.32

package/lib/class-page.js

@@ -17,8 +17,8 @@ const classPage = (member, meta) => {
     let constructors = null;
     if (member.children) {
         constructors = mapConstructors(member);
-        methods = mapMethods(member.children, member.name);
-        props = mapProps(member.children, member.name);
+        methods = mapMethods(member.children, member);
+        props = mapProps(member.children, member);
     }
 
     return classTemplate(Object.assign({}, meta, {

package/lib/comment.js

@@ -34,7 +34,7 @@ const commentSummary = (comment) => {
     return comment.summary.map(c => c.text).join('').trim();
 };
 
-const formatComment = (member, parentName, memberKind) => {
+const formatComment = (member, parent) => {
     let signatures;
     if (member.type && member.type.declaration) {
         signatures = member.type.declaration.signatures;
@@ -43,7 +43,7 @@ const formatComment = (member, parentName, memberKind) => {
     const comment = member.comment || signatures && signatures[0] && signatures[0].comment;
 
     if (!comment) {
-        warn(member, parentName, memberKind);
+        warn(member, parent);
 
         return '';
     }

package/lib/component-page.js

@@ -44,10 +44,10 @@ const componentPage = (component, meta) => {
     let events;
     let methods;
     if (component.children) {
-        fields = ignoreWithoutComment(mapProps(component.children.filter(isField), component.name));
-        inputs = ignoreWithoutComment(mapProps(component.children.filter(isInput), component.name));
-        events = mapProps(component.children.filter(isEvent), component.name);
-        methods = mapMethods(component.children, component.name);
+        fields = ignoreWithoutComment(mapProps(component.children.filter(isField), component));
+        inputs = ignoreWithoutComment(mapProps(component.children.filter(isInput), component));
+        events = mapProps(component.children.filter(isEvent), component);
+        methods = mapMethods(component.children, component);
     }
 
     return componentTemplate(Object.assign({}, meta, {

package/lib/generator.js

@@ -161,6 +161,7 @@ const extractMembers = (packageName, modules, config) => {
                 packageName: fullName,
                 url: `${child.name}`,
                 signatures: child.signatures,
+                sources: child.sources,
                 slug: slug(fullName, child.name),
                 typeParameter: child.typeParameter
             };

package/lib/map-constructors.js

@@ -15,16 +15,14 @@ const mapConstructors = (member) => {
         return [];
     }
 
-    return utils.flatten(member.children.filter(isConstructor).map(ctr => {
-        const source = `${member.name}.constructor`;
-
-        return ctr.signatures.map((signature) => ({
+    return utils.flatten(member.children.filter(isConstructor).map(ctr =>
+        ctr.signatures.map((signature) => ({
             signature: types.callSignature(signature),
-            comment: comment(signature, source),
+            comment: comment(signature),
             name: types.fullName(member),
-            params: types.params(signature, source)
-        }));
-    }));
+            params: types.params(signature)
+        }))
+    ));
 };
 
 module.exports = mapConstructors;

package/lib/map-methods.js

@@ -6,16 +6,14 @@ const isMethod = require('./is-method.js');
 const returnType = require('./return-type');
 const utils = require('./utils');
 
-const mapMethods = (children, parentName) =>
+const mapMethods = (children, parent) =>
     utils.flatten(children.filter(isMethod).map(method => {
         const name = method.name;
-        const source = `${parentName}.${name}`;
-
         return method.signatures.map((signature) => ({
-            comment: comment(signature, source),
+            comment: comment(signature, parent),
             name: name,
-            returns: returnType(signature, source),
-            params: types.params(signature, source)
+            returns: returnType(signature, parent),
+            params: types.params(signature, parent)
         }));
     }));
 

package/lib/map-props.js

@@ -19,7 +19,7 @@ const defaultValue = prop => {
 const accessor = signature => (Array.isArray(signature) ? signature[0] : signature);
 
 const isProp = (prop) => isPublic(prop) && !isConstructor(prop) && !isMethod(prop);
-const mapProps = (children, parentName) =>
+const mapProps = (children, parent) =>
     children.filter(isProp).map(prop => {
         let type;
         let commentProp = prop;
@@ -56,7 +56,7 @@ const mapProps = (children, parentName) =>
             name: name,
             type: type,
             defaultValue: defaultValue(prop),
-            comment: comment(commentProp, parentName)
+            comment: comment(commentProp, parent)
         };
     });
 

package/lib/react/component-page.js

@@ -14,8 +14,8 @@ const componentPage = (component, meta) => {
     let properties;
     let methods;
     if (component.children) {
-        properties = mapProps(component.children.filter(isField), component.name);
-        methods = mapMethods(component.children, component.name);
+        properties = mapProps(component.children.filter(isField), component);
+        methods = mapMethods(component.children, component);
     }
 
     return componentTemplate(Object.assign({}, meta, {

package/lib/return-type.js

@@ -2,8 +2,9 @@
 
 const types = require('./type-utils.js');
 const utils = require('./utils.js');
+const source = require('./source');
 
-const returnType = (definition, parentName) => {
+const returnType = (definition, parent) => {
     if (definition.type.name === 'void') {
         return undefined;
     }
@@ -15,11 +16,7 @@ const returnType = (definition, parentName) => {
 
     let comment = '';
     if ((!tag && definition.type.name !== 'void') || (tag && tag.content.length === 0)) {
-        let source = `${definition.name}`;
-        if (parentName) {
-            source = `${parentName } - ${source}`;
-        }
-        utils.warn('Undocumented return type', source);
+        utils.warn('Undocumented return type', source(definition, parent));
     } else {
         comment = tag.content.map(c => c.text).join('').trim();
     }

package/lib/source.js

@@ -0,0 +1,7 @@
+const source = (member, parent) => {
+    const source = parent ? parent.sources[0] : member.sources[0];
+    const sourceFile = `${source.fileName}:${source.line}`;
+    return `'${member.name}' ${sourceFile}`;
+};
+
+module.exports = source;

package/lib/type-utils.js

@@ -35,9 +35,9 @@ const anonParams = (definition) => {
     return params;
 };
 
-const params = (definition, parentName) => {
+const params = (definition, parent) => {
     const paramComment = (param) =>
-        comment(param, parentName, 'parameter').trim();
+        comment(param, parent, 'parameter').trim();
 
     const params = anonParams(definition);
     params.forEach((param) => {

package/lib/warn.js

@@ -2,20 +2,15 @@
 
 const utils = require('./utils.js');
 const rules = require('./warning-rules.js');
+const source = require('./source');
 
 const runner = rules => member =>
     rules.reduce((result, rule) => result && rule(member), true);
 
-const warn = (member, parentName, kind = 'member') => {
+const warn = (member, parent, kind = 'member') => {
     const shouldWarn = runner(rules);
-    let source = member.name;
-
-    if (parentName) {
-        source = `${parentName}.${source}`;
-    }
-
     if (shouldWarn(member)) {
-        utils.warn(`Undocumented ${kind}`, source);
+        utils.warn(`Undocumented ${kind}`, source(member, parent));
     }
 };
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@progress/kendo-typescript-api-tasks",
   "description": "Kendo UI API docs package gulp tasks",
-  "version": "1.1.2-dev.27+1996482",
+  "version": "1.1.2-dev.32+864edf2",
   "author": "Progress",
   "license": "Apache-2.0",
   "main": "index.js",
@@ -40,5 +40,5 @@
     "jest-cli": "^29.2.2",
     "typescript": "5.2.2"
   },
-  "gitHead": "1996482d0a54f58b78d9755e4750afce5a61d821"
+  "gitHead": "864edf23cc968b7eb30826398c8f926f2175e2b8"
 }

package/test/warning.js

@@ -15,12 +15,18 @@ describe('comment warnings', () => {
                 {
                     name: "Input"
                 }
+            ],
+            sources: [
+                {
+                    "fileName": "libs/foo.ts",
+                    "line": 42
+                }
             ]
         };
 
-        warn(member, '');
+        warn(member);
 
-        expect(utils.warnings()[0]).toContain('Undocumented member foo');
+        expect(utils.warnings()[0]).toContain('Undocumented member \'foo\' libs/foo.ts:42');
     });
 
     it('should warn for Output property', () => {
@@ -30,12 +36,18 @@ describe('comment warnings', () => {
                 {
                     name: "Output"
                 }
+            ],
+            sources: [
+                {
+                    "fileName": "libs/foo.ts",
+                    "line": 42
+                }
             ]
         };
 
-        warn(member, '');
+        warn(member);
 
-        expect(utils.warnings()[0]).toContain('Undocumented member foo');
+        expect(utils.warnings()[0]).toContain('Undocumented member \'foo\' libs/foo.ts:42');
     });
 
     it('should warn for Output property', () => {
@@ -45,12 +57,18 @@ describe('comment warnings', () => {
                 {
                     name: "Output"
                 }
+            ],
+            sources: [
+                {
+                    "fileName": "libs/foo.ts",
+                    "line": 42
+                }
             ]
         };
 
-        warn(member, '');
+        warn(member);
 
-        expect(utils.warnings()[0]).toContain('Undocumented member foo');
+        expect(utils.warnings()[0]).toContain('Undocumented member \'foo\' libs/foo.ts:42');
     });
 
     it('should not warn for fields without decorators', () => {
@@ -58,7 +76,7 @@ describe('comment warnings', () => {
             name: "foo"
         };
 
-        warn(member, '');
+        warn(member);
 
         expect(utils.warnings().length).toEqual(0);
     });
@@ -73,7 +91,7 @@ describe('comment warnings', () => {
             ]
         };
 
-        warn(member, '');
+        warn(member);
 
         expect(utils.warnings().length).toEqual(0);
     });
@@ -83,7 +101,7 @@ describe('comment warnings', () => {
             name: "__namedParameters"
         };
 
-        warn(member, '');
+        warn(member);
 
         expect(utils.warnings().length).toEqual(0);
     });