@progress/kendo-typescript-tasks 10.0.21-ng12.37 → 10.0.22-dev.4

package/api.config.js

@@ -1,8 +1,22 @@
+const os = require('os');
 const path = require('path');
 
-const jsonPath = path.resolve('./api.json');
+const jsonPath = path.join(os.tmpdir(), `api-${process.pid}.json`);
 const typedoc = {
-    excludeExternals: true
+    // 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
 };
 
 module.exports = {

package/api.js

@@ -2,9 +2,8 @@
 
 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');
@@ -13,34 +12,13 @@ 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', 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-json', () => gulp.src([ "src/**/*.{ts,tsx}", ...DECLARATIONS, ...(config.externalApi || []) ], { "allowEmpty": true })
+        .pipe(typedoc(config.typedoc)));
 
     gulp.task('api-clean', (done) => {
-        execSync(`rm -rf docs/api`, {stdio:[0,1,2]});
+        execSync(`rm -rf docs/api`, { stdio: [ 0,1,2 ] });
         done();
     });
 
@@ -51,7 +29,7 @@ module.exports = (gulp, userConfig) => {
     }));
 
     gulp.task('api-check', series('api', (done) => {
-        execSync(`git diff --exit-code --color -- ${config.outPath}`,{stdio:[0,1,2]});
+        execSync(`git diff --exit-code --color -- ${config.outPath}`,{ stdio: [ 0,1,2 ] });
         done();
     }));
 };

package/gulp-tasks.js

@@ -3,10 +3,11 @@
 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');
@@ -26,25 +27,39 @@ module.exports = (gulp, libraryName, compilerPath, options, webpackConfigPath) =
 
         childProcess.exec(`${cmd} -p ${tsConfigPath}`, err => {
             del.sync([ 'src/**/*.ngfactory.*', 'src/**/*.ngsummary.*',
-                       'dist/**/*.ngfactory.*', 'dist/**/*.ngsummary.*' ]);
-            done(err)
+                'dist/**/*.ngfactory.*', 'dist/**/*.ngsummary.*' ]);
+            done(err);
         });
     };
 
     gulp.task('check-compilation', (done) => {
-        childProcess.execSync(`${tscPath} --noEmit`, {stdio:[0,1,2]});
-        done()
+        childProcess.execSync(`${tscPath} --noEmit`, { stdio: [ 0,1,2 ] });
+        done();
     });
 
-    gulp.task('lint', series(
-        'check-compilation',
-        linter([ 'src/**/*.{ts,tsx}', 'test/**/*.{ts,tsx}', 'e2e/**/*.{ts,tsx}' ])
-    ));
+    gulp.task('lint', series('check-compilation', () => {
+        const program = tslint.Linter.createProgram('./tsconfig.json', '.');
 
-    gulp.task('lint-docs', linter([ 'docs/examples/**/*.{ts,tsx}' ], {
-        overrideConfigFile: '.eslintrc.docs.json'
+        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', () => {
+        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;
@@ -53,10 +68,10 @@ module.exports = (gulp, libraryName, compilerPath, options, webpackConfigPath) =
 
         const config = Object.assign({}, webpackConfig.dev);
         config.resolve = Object.assign({}, config.resolve, {
-          alias: {
-            [packageInfo.name]: process.cwd() + '/src/main'
-          },
-          modules: [ path.join(process.cwd(), 'node_modules') ]
+            alias: {
+                [packageInfo.name]: process.cwd() + '/src/main'
+            },
+            modules: [ path.join(process.cwd(), 'node_modules') ]
         });
 
         const webpack = commonTasks.webpack(config);
@@ -71,7 +86,7 @@ module.exports = (gulp, libraryName, compilerPath, options, webpackConfigPath) =
         server.listen(webpackPort, host, err => {
             if (err) {
                 done();
-                throw new $.util.PluginError('webpack-dev-server', err);
+                throw new $.util.PluginError('webpack-dev-server', err); // eslint-disable-line no-undef
             }
         });
     });
@@ -80,5 +95,5 @@ module.exports = (gulp, libraryName, compilerPath, options, webpackConfigPath) =
     gulp.task('build-es-bundle', compile('tsconfig.es.json'));
     gulp.task('build-es2015-bundle', compile('tsconfig.es2015.json'));
     gulp.task('build-npm-bundle', compile('tsconfig.npm.json'));
-    gulp.task('build-package', series.apply(null, ['build-npm-bundle', 'build-es-bundle', 'build-cdn', 'build-systemjs-bundle']));
- };
+    gulp.task('build-package', series([ 'build-npm-bundle', 'build-es-bundle', 'build-cdn', 'build-systemjs-bundle' ]));
+};

package/gulpfile.js

@@ -3,13 +3,10 @@
 const gulp = require('gulp');
 const jasmine = require('gulp-jasmine');
 
-// kendo-common-task linter is ancient, skip it for now
-gulp.task('lint', (done) => done());
-
 gulp.task('test', () =>
     gulp.src('test/**/*.js')
-    .pipe(jasmine({
-        includeStackTrace: true
-    }))
+        .pipe(jasmine({
+            includeStackTrace: true
+        }))
 );
 

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.21-ng12.37+765c6e3",
+  "version": "10.0.22-dev.4+28182b5",
   "author": "Telerik",
   "license": "Apache-2.0",
   "scripts": {
@@ -15,31 +15,29 @@
     "API Generation"
   ],
   "peerDependencies": {
-    "typescript": "^4.3.4"
+    "typescript": "^3.4.5"
   },
   "dependencies": {
-    "@progress/kendo-common-tasks": "7.9.5-ng12.37+765c6e3",
-    "@typescript-eslint/eslint-plugin": "4.28.2",
-    "@typescript-eslint/parser": "4.28.2",
-    "core-js": "^3.18.0",
+    "@progress/kendo-common-tasks": "7.9.5-dev.8+28182b5",
+    "core-js": "^2.2.2",
     "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",
-    "typedoc": "~0.22.5"
+    "tslint": "^5.0.0",
+    "tslint-defocus": "^2.0.6",
+    "typedoc": "0.15.0"
   },
   "devDependencies": {
     "gulp-jasmine": "^2.4.2",
-    "typescript": "~4.3.4"
+    "typescript": "~3.4.5"
   },
   "repository": {
     "type": "git",
@@ -48,5 +46,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "765c6e3120a6d636c8ba1d927cfd3d1472f0122b"
+  "gitHead": "28182b56d4b5969becc7e346d5fc13ac995b0426"
 }

package/spec-bundle.js

@@ -31,5 +31,5 @@ function requireAll(requireContext) {
     return requireContext.keys().map(requireContext);
 }
 
-var modules = requireAll(testContext);
+let modules = requireAll(testContext); // eslint-disable-line no-unused-vars
 // requires and returns all modules that match

package/src/api/component-page.js

@@ -28,6 +28,8 @@ const decoratorProp = (prop) => (decorators) => {
 
         return match ? match[1] : undefined;
     }
+
+    return undefined;
 };
 
 const selector = decoratorProp('selector');

package/src/api/enum-page.js

@@ -9,7 +9,7 @@ function enumValues(member) {
             comment: comment(child),
             name: child.name
         };
-    })
+    });
 }
 
 const enumTemplate = template.compileFrom('enum-page.hbs');

package/src/api/generator.js

@@ -71,7 +71,7 @@ const associateTypes = (elements, knownTypes) => {
     traverseElements(elements, element => {
         addTypeSlug(element, knownTypes);
     });
-}
+};
 
 const normalizeUnionReferences = (element, members) => {
     if (element.kind === 'union') {
@@ -79,19 +79,17 @@ const normalizeUnionReferences = (element, members) => {
         for (let idx = types.length - 1; idx >= 0; idx--) {
             const type = types[idx];
             if (type.type === 'reference') {
-                const unionReference = members.find((child) => {
-                    return child.name === type.name;
-                });
+                const unionReference = members.find((child) => child.name === type.name);
 
                 if (unionReference && unionReference.kind === 'union') {
                     normalizeUnionReferences(unionReference, members);
                     const toReplace = unionReference.type.types;
-                    types.splice.apply(types, [idx, 1].concat(toReplace));
+                    types.splice.apply(types, [ idx, 1 ].concat(toReplace));
                 }
             }
         }
     }
-}
+};
 
 const normalizeMembers = (members) => {
     traverseElements(members, (element) => {
@@ -99,9 +97,7 @@ const normalizeMembers = (members) => {
 
         if (!element.comment && element.implementationOf) {
             const interfaceName = element.implementationOf.name.split('.')[0];
-            const interfaceOptions = members.find((child) => {
-                return child.name === interfaceName;
-            });
+            const interfaceOptions = members.find((child) => child.name === interfaceName);
 
             if (interfaceOptions) {
                 const baseOption = interfaceOptions.children.find(child => child.name === element.name);
@@ -110,13 +106,8 @@ const normalizeMembers = (members) => {
                 }
             }
         }
-
-        if (!element.comment && element.kindString === 'Accessor') {
-            const accessor = element.getSignature || element.setSignature || [];
-            element.comment = accessor[0].comment;
-        }
     });
-}
+};
 
 const mergeComments = (root, src) => {
     if (!root.comment && src.comment) {
@@ -128,23 +119,20 @@ const mergeComments = (root, src) => {
             mergeComments(root[key], src[key]);
         }
     });
-}
-
-const moduleRoot = (moduleName, rootModules) => {
-    return rootModules.includes(moduleName) ? moduleName :
-        rootModules.find(rootModule => moduleName.indexOf(rootModule) > -1);
 };
 
+const moduleRoot = (moduleName, rootModules) => (rootModules.includes(moduleName) ? moduleName :
+    rootModules.find(rootModule => moduleName.indexOf(rootModule) > -1));
+
 const moduleFullName = (moduleName, packageName, rootModules) => {
     const rootModule = moduleRoot(moduleName, rootModules);
     let fullName = packageName;
-    if (rootModule)
-    {
+    if (rootModule) {
         fullName += '_' + rootModule;
     }
 
     return fullName;
-}
+};
 
 const extractMembers = (packageName, modules, config) => {
     const knownTypes = {};
@@ -153,7 +141,7 @@ const extractMembers = (packageName, modules, config) => {
 
     const models = nonEmptyModules.map(module => module
         .children
-        .filter(child => child.kindString !== "Reference")
+        .filter(child => child.flags.isExported)
         .filter(child => child.name !== 'core')
         .map(child => {
             const fullName = moduleFullName(module.name, packageName, rootModules);
@@ -187,7 +175,7 @@ const extractMembers = (packageName, modules, config) => {
     const members = utils.flatten(models)
         .sort(utils.nameComparer)
         .map(model => {
-            associateTypes([model], knownTypes);
+            associateTypes([ model ], knownTypes);
             return model;
         });
 
@@ -200,6 +188,7 @@ 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) {
@@ -231,6 +220,18 @@ const groupMembers = (members) => {
     return membersByModule;
 };
 
+const packagePlatform = (packageInfo) => {
+    let platform = '';
+
+    if (/-angular-/.test(packageInfo.name)) {
+        platform = 'Angular';
+    } else if (/-react-/.test(packageInfo.name)) {
+        platform = 'React';
+    }
+
+    return platform;
+};
+
 const generate = (done, config, packageInfo) => {
     const meta = require(config.jsonPath);
     const namespaces = namespacesAsModules(meta.children);
@@ -238,8 +239,7 @@ const generate = (done, config, packageInfo) => {
     const membersByModule = config.reorderModules ?
         config.reorderModules(groupMembers(members)) : groupMembers(members);
     const outPath = config.outPath;
-    const platform = /-angular-/.test(packageInfo.name) ? 'Angular' :
-                       /-react-/.test(packageInfo.name) ? 'React'   : '';
+    const platform = packagePlatform(packageInfo);
     const info = Object.assign({ platform }, packageInfo['@progress']);
 
     writeFile(`${outPath}/index.md`, indexPage(packageInfo.name, membersByModule, info));

package/src/api/map-constructors.js

@@ -2,21 +2,14 @@
 
 const comment = require('./comment');
 const isPublic = require('./is-public');
-const isInput = require('./is-input');
 const types = require('./type-utils');
 const utils = require('./utils');
 
 const isConstructor = (prop) =>
     prop.kindString && prop.kindString === 'Constructor' && isPublic(prop);
 
-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 name = ctr.name;
+const mapConstructors = (member) =>
+    utils.flatten(member.children.filter(isConstructor).map(ctr => {
         const source = `${member.name}.constructor`;
 
         return ctr.signatures.map((signature) => ({
@@ -26,7 +19,6 @@ const mapConstructors = (member) => {
             params: types.params(signature, source)
         }));
     }));
-};
 
 module.exports = mapConstructors;
 

package/src/api/map-props.js

@@ -15,7 +15,7 @@ const defaultValue = prop => {
     return text && ` (default: ${text.trim()})`;
 };
 
-const accessor = signature => Array.isArray(signature) ? signature[0] : signature;
+const accessor = signature => (Array.isArray(signature) ? signature[0] : signature);
 
 const isProp = (prop) => isPublic(prop) && !isConstructor(prop) && !isMethod(prop);
 const mapProps = (children, parentName) =>

package/src/api/member-page.js

@@ -1,7 +1,6 @@
 "use strict";
 
 const path = require('path');
-const template = require('./template-utils');
 const componentPage = require('./component-page');
 const constantPage = require('./constant-page');
 const classPage = require('./class-page');

package/src/api/return-type.js

@@ -16,7 +16,7 @@ const returnType = (definition, parentName) => {
     if (!comment && definition.type.name !== 'void') {
         let source = `${definition.name}`;
         if (parentName) {
-          source = `${parentName } - ${source}`;
+            source = `${parentName } - ${source}`;
         }
         utils.warn('Undocumented return type', source);
     }

package/src/api/template-utils.js

@@ -8,7 +8,7 @@ hbs.registerHelper('capitalize',
     s => s.slice(0,1).toUpperCase() + s.slice(1));
 
 hbs.registerHelper('contains',
-    (s, chars, options) => s.includes(chars) ? options.fn(s) : options.inverse(s));
+    (s, chars, options) => (s.includes(chars) ? 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 'literal':
+        case 'stringLiteral':
             return `"${type.value}"`;
         default:
             return typeString({ type });
@@ -118,7 +118,7 @@ const singleTypeString = (type) => {
     if (type.typeArguments) {
         suffix = `<${singleTypeString(type.typeArguments[0])}>`;
     }
-    
+
     if (type.type === 'array') {
         suffix += '[]';
     }
@@ -153,7 +153,7 @@ const fullName = (member) => {
     }
 
     return member.name + suffix;
-}
+};
 
 module.exports = {
     callSignature: callSignature,

package/src/api/utils.js

@@ -9,15 +9,15 @@ const not = predicate => member => !predicate(member);
 
 const ignore = predicate => props => (props || []).filter(predicate);
 
-const hasProp = prop => obj => !!obj[prop];
+const hasProp = prop => obj => Boolean(obj[prop]);
 
 const groupBy = (predicate, list) =>
     list.reduce((acc, item) => {
-      const field = predicate(item);
-      acc[field] = acc[field] || [];
-      acc[field].push(item);
-      return acc;
-    }, {})
+        const field = predicate(item);
+        acc[field] = acc[field] || [];
+        acc[field].push(item);
+        return acc;
+    }, {});
 
 const WARNINGS = [];
 const warn = (type, text) => {

package/stub-loader.js

@@ -1,4 +1,4 @@
 
 module.exports = function() {
-  return '{}';
+    return '{}';
 };

package/test/api.js

@@ -51,7 +51,7 @@ describe('API generation', () => {
 
     describe('for modules', () => {
         const pkg = require('./package.json');
-        const members = generator.extractMembers(pkg.name, pkg.children, { modules: ['module1'] });
+        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');
@@ -162,13 +162,13 @@ describe('API generation', () => {
         it('formats anonymous interfaces', () => {
             const unionData = require('./type-union.json');
             const page = unionPage(unionData);
-            expect(page).toContain("{ allowUnsort?: boolean; mode?: 'single' | 'multiple'; }");
+            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'; }");
+            expect(page).toContain('ColumnSortSettings [intersected](https://www.typescriptlang.org/docs/handbook/advanced-types.html#intersection-types) with { mode?: "single" | "multiple"; }');
         });
     });
 
@@ -325,22 +325,22 @@ describe('API generation', () => {
     describe('index', () => {
         const page = indexPage('foo/bar', {
             '': {
-                'Function': [{
+                'Function': [ {
                     'slug': 'root-f',
                     'name': 'root-f'
-                }]
+                } ]
             },
             'a': {
-                'Function': [{
+                'Function': [ {
                     'slug': 'a-f',
                     'name': 'a-f'
-                }]
+                } ]
             },
             'b': {
-                'Function': [{
+                'Function': [ {
                     'slug': 'b-f',
                     'name': 'b-f'
-                }]
+                } ]
             }
         }, {
             friendlyName: 'Foo',
@@ -348,7 +348,7 @@ describe('API generation', () => {
         });
 
         const assertModule = name => {
-            expect(new RegExp(`<h2 class=\"module-name\">\\s*${name}\\s*<\\/h2>`).test(page)).toBeTruthy();
+            expect(new RegExp(`<h2 class="module-name">\\s*${name}\\s*<\\/h2>`).test(page)).toBeTruthy();
         };
 
         it('renders default group', () => {

package/src/linter.js

@@ -1,18 +0,0 @@
-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;