@progress/kendo-typescript-tasks 10.0.22-dev.5 → 10.0.22-ng12.72

package/api.config.js

@@ -1,22 +1,8 @@
-const os = require('os');
 const path = require('path');
 
-const jsonPath = path.join(os.tmpdir(), `api-${process.pid}.json`);
+const jsonPath = path.resolve('./api.json');
 const typedoc = {
-    // TypeScript options
-    module: 'commonjs',
-    target: 'es6',
-    types: [],
-    experimentalDecorators: true,
-    jsx: 'react', // support for tsx files
-
-    // Output options
-    json: jsonPath,
-
-    // Typedoc options
-    excludeExternals: true,
-    ignoreCompilerErrors: false,
-    includeDeclarations: true
+    excludeExternals: false
 };
 
 module.exports = {

package/api.js

@@ -2,8 +2,9 @@
 
 const execSync = require('child_process').execSync;
 const path = require('path');
-const typedoc = require('gulp-typedoc');
 const { merge } = require('lodash');
+const typedoc = require('typedoc');
+const glob = require('glob');
 
 const api = require('./src/api/generator.js');
 const apiConfig = require('./api.config.js');
@@ -12,10 +13,31 @@ module.exports = (gulp, userConfig) => {
     const series = gulp.series;
 
     const config = merge({}, apiConfig, userConfig);
-    const DECLARATIONS = [ "typings/index.d.ts", "node_modules/@types/core-js/index.d.ts" ];
 
-    gulp.task('api-json', () => gulp.src([ "src/**/*.{ts,tsx}", ...DECLARATIONS, ...(config.externalApi || []) ], { "allowEmpty": true })
-        .pipe(typedoc(config.typedoc)));
+    gulp.task('api-json', async(done) => {
+        const entryPoints = [
+            ...glob.sync("src/**/*.{ts,tsx}"),
+            ...(config.externalApi || [])
+        ];
+
+        const app = new typedoc.Application();
+        app.options.addReader(new typedoc.TSConfigReader());
+        app.bootstrap({ ...config.typedoc, entryPoints });
+
+        const project = app.convert();
+        if (!project) {
+            done(new Error('Unable to initialize TypeDoc.'));
+            return;
+        }
+
+        await app.generateJson(project, apiConfig.jsonPath);
+        if (app.logger.hasErrors()) {
+            done(new Error('Unable to generate API reference, see messages above.'));
+            return;
+        }
+
+        done();
+    });
 
     gulp.task('api-clean', (done) => {
         execSync(`rm -rf docs/api`, { stdio: [ 0,1,2 ] });

package/gulp-tasks.js

@@ -3,11 +3,10 @@
 const del = require('del');
 const childProcess = require('child_process');
 const path = require('path');
-const gulpTsLint = require('gulp-tslint');
-const tslint = require('tslint');
 
 const apiTasks = require('./api.js');
 const commonTasks = require('@progress/kendo-common-tasks');
+const linter = require('./src/linter');
 
 const webpackConfig = require('./webpack.config.js');
 const tscPath = path.join(process.cwd(), 'node_modules', '.bin', 'tsc');
@@ -37,29 +36,15 @@ module.exports = (gulp, libraryName, compilerPath, options, webpackConfigPath) =
         done();
     });
 
-    gulp.task('lint', series('check-compilation', () => {
-        const program = tslint.Linter.createProgram('./tsconfig.json', '.');
+    gulp.task('lint', series(
+        'check-compilation',
+        linter([ 'src/**/*.{ts,tsx}', 'test/**/*.{ts,tsx}', 'e2e/**/*.{ts,tsx}' ])
+    ));
 
-        return gulp.src([ 'src/**/*.{ts,tsx}', 'test/**/*.{ts,tsx}', 'e2e/**/*.{ts,tsx}' ])
-            .pipe(gulpTsLint({
-                program: program,
-                formatter: 'verbose'
-            }))
-            .pipe(gulpTsLint.report());
+    gulp.task('lint-docs', linter([ 'docs/examples/**/*.{ts,tsx}' ], {
+        overrideConfigFile: '.eslintrc.docs.json'
     }));
 
-    gulp.task('lint-docs', () => {
-        const program = tslint.Linter.createProgram('./tsconfig.docs.json', '.');
-
-        return gulp.src([ 'docs/examples/**/*.{ts,tsx}' ])
-            .pipe(gulpTsLint({
-                formatter: 'prose',
-                program: program,
-                configuration: './tslint.docs.json'
-            }))
-            .pipe(gulpTsLint.report());
-    });
-
     gulp.task('start', (done) => {
         const webpackPort = 8888;
         const host = listenAddress;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@progress/kendo-typescript-tasks",
   "description": "Kendo UI TypeScript package gulp tasks",
   "main": "gulp-tasks.js",
-  "version": "10.0.22-dev.5+7464b2f",
+  "version": "10.0.22-ng12.72+c683c3c",
   "author": "Telerik",
   "license": "Apache-2.0",
   "scripts": {
@@ -15,29 +15,31 @@
     "API Generation"
   ],
   "peerDependencies": {
-    "typescript": "^3.4.5"
+    "typescript": "^4.3.4"
   },
   "dependencies": {
-    "@progress/kendo-common-tasks": "7.9.5-dev.9+7464b2f",
-    "core-js": "^2.2.2",
+    "@progress/kendo-common-tasks": "7.9.5-ng12.76+c683c3c",
+    "@typescript-eslint/eslint-plugin": "4.28.2",
+    "@typescript-eslint/parser": "4.28.2",
+    "core-js": "^3.18.0",
     "del": "2.2.2",
+    "eslint": "7.32.0",
+    "eslint-plugin-import": "2.25.2",
+    "eslint-plugin-rxjs": "3.3.7",
+    "glob": "^7.2.0",
     "gulp": "^4.0.0",
     "gulp-add-src": "^1.0.0",
-    "gulp-tslint": "^8.0.0",
-    "gulp-typedoc": "~2.2.2",
     "handlebars": "^4.0.5",
     "highlight.js": "9.14.2",
     "lodash": "^4.6.0",
     "mkdirp": "^0.5.0",
     "source-map-loader": "^0.1.5",
     "ts-loader": "4.1.0",
-    "tslint": "^5.0.0",
-    "tslint-defocus": "^2.0.6",
-    "typedoc": "0.15.0"
+    "typedoc": "~0.22.5"
   },
   "devDependencies": {
     "gulp-jasmine": "^2.4.2",
-    "typescript": "~3.4.5"
+    "typescript": "~4.3.4"
   },
   "repository": {
     "type": "git",
@@ -46,5 +48,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7464b2fd387ad36957188289d6df2156cb04be7f"
+  "gitHead": "c683c3cf53173e65898d3a40a13a2c6654e98238"
 }

package/src/api/comment.js

@@ -27,7 +27,9 @@ const commentTags = (comment, member) =>
     });
 
 const formatComment = (member, parentName, memberKind) => {
-    const comment = member.comment;
+    const signatures = member.type?.declaration?.signatures;
+    const comment = member.comment || signatures && signatures[0]?.comment;
+
     if (!comment) {
         warn(member, parentName, memberKind);
 

package/src/api/generator.js

@@ -106,6 +106,11 @@ const normalizeMembers = (members) => {
                 }
             }
         }
+
+        if (!element.comment && element.kindString === 'Accessor') {
+            const accessor = element.getSignature || element.setSignature || [];
+            element.comment = accessor[0].comment;
+        }
     });
 };
 
@@ -141,8 +146,9 @@ const extractMembers = (packageName, modules, config) => {
 
     const models = nonEmptyModules.map(module => module
         .children
-        .filter(child => child.flags.isExported)
+        .filter(child => child.kindString !== "Reference")
         .filter(child => child.name !== 'core')
+        .filter(child => !child.sources[0].fileName.includes('prosemirror'))
         .map(child => {
             const fullName = moduleFullName(module.name, packageName, rootModules);
 
@@ -188,7 +194,6 @@ const namespacesAsModules = data => {
     const modules = [];
     data.filter(moduleFilter).forEach(module => module
         .children
-        .filter(child => child.flags.isExported)
         .filter(child => child.name !== 'core')
         .forEach(child => {
             if (child.kindString === 'Module' && child.children) {

package/src/api/map-constructors.js

@@ -8,8 +8,13 @@ const utils = require('./utils');
 const isConstructor = (prop) =>
     prop.kindString && prop.kindString === 'Constructor' && isPublic(prop);
 
-const mapConstructors = (member) =>
-    utils.flatten(member.children.filter(isConstructor).map(ctr => {
+const mapConstructors = (member) => {
+    if (member.decorators && member.decorators.find(d => d.name === 'NgModule')) {
+        // Ignore NgModule constructors
+        return [];
+    }
+
+    return utils.flatten(member.children.filter(isConstructor).map(ctr => {
         const source = `${member.name}.constructor`;
 
         return ctr.signatures.map((signature) => ({
@@ -19,6 +24,7 @@ const mapConstructors = (member) =>
             params: types.params(signature, source)
         }));
     }));
+};
 
 module.exports = mapConstructors;
 

package/src/api/map-props.js

@@ -21,6 +21,7 @@ const isProp = (prop) => isPublic(prop) && !isConstructor(prop) && !isMethod(pro
 const mapProps = (children, parentName) =>
     children.filter(isProp).map(prop => {
         let type;
+        let commentProp = prop;
         if (prop.type) {
             type = types.typeString(prop);
         } else if (prop.kindString === 'Accessor') {
@@ -28,12 +29,13 @@ const mapProps = (children, parentName) =>
             const setter = prop.setSignature;
 
             // Fingers crossed
-            type = types.typeString(getter ?
-                accessor(getter) :
-                accessor(setter).parameters[0]
+            type = types.typeString(setter ?
+                accessor(setter).parameters[0] :
+                accessor(getter)
             );
         } else if (prop.kindString === 'Method') {
             type = types.callType(prop.signatures[0]);
+            commentProp = prop.signatures[0];
         }
 
         let name = prop.name;
@@ -53,7 +55,7 @@ const mapProps = (children, parentName) =>
             name: name,
             type: type,
             defaultValue: defaultValue(prop),
-            comment: comment(prop, parentName)
+            comment: comment(commentProp, parentName)
         };
     });
 

package/src/api/template-utils.js

@@ -10,6 +10,9 @@ hbs.registerHelper('capitalize',
 hbs.registerHelper('contains',
     (s, chars, options) => (s.includes(chars) ? options.fn(s) : options.inverse(s)));
 
+hbs.registerHelper('equals',
+    (s, comparer, options) => (s === comparer ? options.fn(s) : options.inverse(s)));
+
 const readLocal = (src) =>
     fs.readFileSync(path.join(__dirname, src), { encoding: 'utf-8' });
 

package/src/api/type-utils.js

@@ -5,7 +5,7 @@ const comment = require('./comment');
 const unionTypes = (member) =>
     member.type.types.map(type => {
         switch (type.type) {
-        case 'stringLiteral':
+        case 'literal':
             return `"${type.value}"`;
         default:
             return typeString({ type });
@@ -92,6 +92,10 @@ const INTERSECTION = ' [intersected](https://www.typescriptlang.org/docs/handboo
 const singleTypeString = (type) => {
     let suffix = '';
 
+    if (type.type === 'literal') {
+        return type.value;
+    }
+
     if (type.type === 'intersection') {
         return unionTypes({ type }).join(INTERSECTION);
     }
@@ -100,7 +104,7 @@ const singleTypeString = (type) => {
         const decl = type.declaration;
         if (decl.signatures) {
             const sig = decl.signatures[0];
-            if (decl.name === '__type' && sig.name === '__call') {
+            if (decl.name === '__type' && sig.kindString === 'Call signature') {
                 return callType(sig);
             }
         } else if (decl.indexSignature) {
@@ -115,12 +119,12 @@ const singleTypeString = (type) => {
         }
     }
 
-    if (type.typeArguments) {
-        suffix = `<${singleTypeString(type.typeArguments[0])}>`;
+    if (type.type === 'array') {
+        return `${singleTypeString(type.elementType)}[]`;
     }
 
-    if (type.type === 'array') {
-        suffix += '[]';
+    if (type.typeArguments) {
+        suffix = `<${singleTypeString(type.typeArguments[0])}>`;
     }
 
     const name = typeName(type);
@@ -135,8 +139,8 @@ const typeString = (prop) => {
         return unionTypes(prop).join(' | ');
     }
 
-    if (type.type === 'stringLiteral') {
-        return `'${type.value}'`;
+    if (type.type === 'literal') {
+        return `"${type.value}"`;
     }
 
     return singleTypeString(prop.type);

package/src/api/union-page.hbs

@@ -6,7 +6,7 @@
 `type` {{name}} =
   {{~#each types~}}
     {{~#contains this 'slug'}} {{this}}
-      {{~else contains this 'null'}} `null`
+      {{~else equals this '"null"'}} `null`
       {{~else contains this '"'}} {{this}}
       {{~else}} `{{this}}`
     {{~/contains~}}

package/src/linter.js

@@ -0,0 +1,18 @@
+const { ESLint } = require('eslint');
+
+const linter = (files, options = {}) => async function lint(done) {
+    const eslint = new ESLint(options);
+    const results = await eslint.lintFiles(files);
+    const formatter = await eslint.loadFormatter('stylish');
+    const errors = ESLint.getErrorResults(results);
+    const resultText = formatter.format(results);
+    console.log(resultText);
+
+    if (errors.length > 0) {
+        done(new Error('Lint failed.'));
+    } else {
+        done();
+    }
+};
+
+module.exports = linter;

package/test/api.js

@@ -170,6 +170,12 @@ describe('API generation', () => {
             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', () => {

package/test/intersection.json

@@ -46,11 +46,11 @@
                                         "type": "union",
                                         "types": [
                                             {
-                                                "type": "stringLiteral",
+                                                "type": "literal",
                                                 "value": "single"
                                             },
                                             {
-                                                "type": "stringLiteral",
+                                                "type": "literal",
                                                 "value": "multiple"
                                             }
                                         ]

package/test/type-union-operators.json

@@ -0,0 +1,42 @@
+{
+    "id": 416,
+    "name": "FilterOperator",
+    "kind": 4194304,
+    "kindString": "Type alias",
+    "flags": {},
+    "comment": {
+        "shortText": "Represents the FilterOperator type."
+    },
+    "sources": [
+        {
+            "fileName": "src/model/filter-expression.ts",
+            "line": 5,
+            "character": 12
+        }
+    ],
+    "type": {
+        "type": "union",
+        "types": [
+            {
+                "type": "literal",
+                "value": "gt"
+            },
+            {
+                "type": "literal",
+                "value": "gte"
+            },
+            {
+                "type": "literal",
+                "value": "isnull"
+            },
+            {
+                "type": "literal",
+                "value": "isnotnull"
+            },
+            {
+                "type": "literal",
+                "value": null
+            }
+        ]
+    }
+}

package/test/type-union.json

@@ -52,11 +52,11 @@
                                 "type": "union",
                                 "types": [
                                     {
-                                        "type": "stringLiteral",
+                                        "type": "literal",
                                         "value": "single"
                                     },
                                     {
-                                        "type": "stringLiteral",
+                                        "type": "literal",
                                         "value": "multiple"
                                     }
                                 ]