@progress/kendo-typescript-tasks 10.0.17-dev.8 → 10.0.18-ng12.43

package/CHANGELOG.md

@@ -3,6 +3,21 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [10.0.17](https://github.com/telerik/kendo-build-tasks/compare/@progress/kendo-typescript-tasks@10.0.16...@progress/kendo-typescript-tasks@10.0.17) (2022-03-01)
+
+
+### Bug Fixes
+
+* **kendo-package-tasks:** do not include peer dependencies in CDN bundles ([fd36d5f](https://github.com/telerik/kendo-build-tasks/commit/fd36d5f5a15c0cf93ff07a3873384ce354f9a5b8))
+* **typescript-tasks:** API page title for common packages ([99791a4](https://github.com/telerik/kendo-build-tasks/commit/99791a4cf7ab9cfc166f6c1d1623ca494123414b))
+* **typescript-tasks:** stringLiteral api generation ([43bb598](https://github.com/telerik/kendo-build-tasks/commit/43bb598f7dc600fc0dde9a0aa6b3b94fe77a5e45))
+* **typescript-tasks:** union reference api generation ([0c44752](https://github.com/telerik/kendo-build-tasks/commit/0c4475220a9352cdc996c7962c2426bae6e85470))
+* **typescript-tasks:** use correct imports in CDN bundle ([74d06dd](https://github.com/telerik/kendo-build-tasks/commit/74d06dd78e641990791b30f537aa2871de6c71a7))
+
+
+
+
+
 ## [10.0.16](https://github.com/telerik/kendo-build-tasks/compare/@progress/kendo-typescript-tasks@10.0.15...@progress/kendo-typescript-tasks@10.0.16) (2021-12-03)
 
 **Note:** Version bump only for package @progress/kendo-typescript-tasks

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: true
 };
 
 module.exports = {

package/api.js

@@ -2,22 +2,41 @@
 
 const execSync = require('child_process').execSync;
 const path = require('path');
-const typedoc = require('gulp-typedoc');
-const deepAssign = require('lodash.merge');
+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');
 
 module.exports = (gulp, userConfig) => {
     const series = gulp.series;
-    const parallel = gulp.parallel;
 
-    const config = deepAssign({}, apiConfig, userConfig);
-    const DECLARATIONS = ["typings/index.d.ts", "node_modules/@types/core-js/index.d.ts"];
+    const config = merge({}, apiConfig, userConfig);
 
-    gulp.task('api-json', () => {
-        return 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) => {

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', (done) => {
-        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.17-dev.8+bd7ee38",
+  "version": "10.0.18-ng12.43+a7def87",
   "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.1-dev.8+bd7ee38",
-    "core-js": "^2.2.2",
+    "@progress/kendo-common-tasks": "ng12",
+    "@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.merge": "^4.6.0",
+    "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": "bd7ee38731bff7c723427f0c61b9d2b7fdb8f001"
+  "gitHead": "a7def87e4b0294e9b589f8a7c739630490b0cbc2"
 }

package/src/api/component-page.js

@@ -22,7 +22,7 @@ const findDecorator = (decorators) => ((decorators || []).find(d =>
 const decoratorProp = (prop) => (decorators) => {
     const compDecorator = findDecorator(decorators);
 
-if (compDecorator) {
+    if (compDecorator) {
         const regExp = new RegExp(`${prop}:\\s?['"](.+?)['"]`);
         const match = compDecorator.arguments.obj.match(regExp);
 

package/src/api/generator.js

@@ -83,13 +83,11 @@ const normalizeUnionReferences = (element, members) => {
                     return child.name === type.name;
                 });
 
-                let toReplace = [];
                 if (unionReference && unionReference.kind === 'union') {
                     normalizeUnionReferences(unionReference, members);
-                    toReplace = unionReference.type.types;
+                    const toReplace = unionReference.type.types;
+                    types.splice.apply(types, [idx, 1].concat(toReplace));
                 }
-
-                types.splice.apply(types, [idx, 1].concat(toReplace));
             }
         }
     }
@@ -112,6 +110,11 @@ const normalizeMembers = (members) => {
                 }
             }
         }
+
+        if (!element.comment && element.kindString === 'Accessor') {
+            const accessor = element.getSignature || element.setSignature || [];
+            element.comment = accessor[0].comment;
+        }
     });
 }
 
@@ -150,7 +153,7 @@ 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')
         .map(child => {
             const fullName = moduleFullName(module.name, packageName, rootModules);
@@ -197,7 +200,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/index-page.hbs

@@ -1,6 +1,6 @@
 ---
 title: {{friendlyName}} API
-page_title: {{platform}} {{friendlyName}} API | Kendo UI for {{platform}}
+page_title: {{platform}} {{friendlyName}} API | Kendo UI{{#if platform}} for {{platform}}{{/if}}
 description: "Learn how to build custom functionality of the {{platform}} {{friendlyName}} by Kendo UI with the help of the options available in the API."
 slug: {{slug}}
 api_reference: true

package/src/api/map-constructors.js

@@ -9,8 +9,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 name = ctr.name;
         const source = `${member.name}.constructor`;
 
@@ -21,6 +26,7 @@ const mapConstructors = (member) =>
             params: types.params(signature, source)
         }));
     }));
+};
 
 module.exports = mapConstructors;
 

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 });
@@ -135,6 +135,10 @@ const typeString = (prop) => {
         return unionTypes(prop).join(' | ');
     }
 
+    if (type.type === 'stringLiteral') {
+        return `'${type.value}'`;
+    }
+
     return singleTypeString(prop.type);
 };
 

package/src/api/union-page.hbs

@@ -3,7 +3,7 @@
 # {{name}}
 {{comment}}
 
-## Values
+## Members
 
 {{#each types}}
 * {{this}}

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/webpack.config.js

@@ -1,5 +1,6 @@
-const commonTasks = require('@progress/kendo-common-tasks');
 const path = require('path');
+const commonTasks = require('@progress/kendo-common-tasks');
+const { umdExternals } = require('@progress/kendo-common-tasks/umd-externals');
 
 const sourceExtensions = [ '.ts' ];
 const nodeModulesPath = path.join(__dirname, 'node_modules');
@@ -8,36 +9,9 @@ const resolve = commonTasks.resolveConfig(sourceExtensions, nodeModulesPath);
 
 const packageInfo = require(path.join(process.cwd(), 'package.json'));
 const packageKeys = (key) => Object.keys(packageInfo[key] || {});
-
+const peerDependencies = packageKeys('peerDependencies');
+const allDependencies = packageKeys('dependencies').concat(peerDependencies);
 const matchStartsWith = (key) => new RegExp(`^${key}`);
-const deps = packageKeys('dependencies').concat(packageKeys('peerDependencies'));
-const packageDependencies = deps.map(matchStartsWith);
-
-//list all Angular packages that should not appear in CDN bundles
-const angularPeers = [
-    '@angular/animations'
-];
-
-//list all packages that should not appear in CDN bundles
-const peers = [
-    '@progress/kendo-angular-intl',
-    '@progress/kendo-angular-l10n',
-    '@progress/kendo-drawing'
-];
-const internal = dep => dep.match(/@progress|@telerik/);
-const isPeer = dep => peers.find(pkg => pkg === dep);
-const isException = dep => dep.match(/tslib/);
-
-const prebuilt = [
-    /jszip[\/\\]dist[\/\\]jszip.js/,
-    /pako[\/\\]dist[\/\\]pako_deflate.js/
-];
-
-const cdnExternals = deps
-    .filter((dep) => ((!internal(dep) || isPeer(dep)) && !isException(dep)))
-    .concat(angularPeers)
-    .map(matchStartsWith);
-
 
 const tsLoader = (compilerOptions) => ({
     test: /\.ts?$/,
@@ -48,8 +22,21 @@ const tsLoader = (compilerOptions) => ({
     }
 });
 
+const cdn = commonTasks.webpackCommonConfig({
+    resolve,
+    stats: { assets: false },
+    output: { libraryTarget: 'umd' },
+    plugins: [],
+    optimization: {
+        minimize: true
+    },
+    module: {
+        rules: [ tsLoader({ declaration: false }) ]
+    }
+});
 
 module.exports = {
+    // dist/npm
     npmPackage: commonTasks.webpackCommonConfig({
         resolve,
 
@@ -58,7 +45,7 @@ module.exports = {
         externals: [
             /^\.\//,
             /^\.\.\//
-        ].concat(packageDependencies),
+        ].concat(allDependencies.map(matchStartsWith)),
 
         module: {
             rules: [ tsLoader({ sourceMap: true }) ]
@@ -67,33 +54,25 @@ module.exports = {
         devtool: 'source-map'
     }),
 
-    CDN: commonTasks.webpackCommonConfig({
-        resolve,
+    // dist/cdn/js/<package-name>.js
+    CDN: {
+        ...cdn,
+        externals: umdExternals(peerDependencies)
+    },
 
-        stats: { assets: false },
-
-        output: { libraryTarget: 'umd' },
-
-        plugins: [
-        ],
-        optimization: {
-            minimize: true
-        },
-        externals: cdnExternals,
-
-        module: {
-            rules: [ tsLoader({ declaration: false }) ],
-            noParse: prebuilt
-        }
-    }),
+    // dist/cdn/main.js
+    umdPackage: {
+        ...cdn,
+        externals: umdExternals(allDependencies)
+    },
 
     dev: commonTasks.webpackDevConfig({
         resolve,
         rules: [ tsLoader({ sourceMap: true }) ],
-        noParse: prebuilt,
         entries: 'examples/**/*.ts'
     }),
 
+    // dist/systemjs/<package-name>.js
     systemjs: commonTasks.webpackCommonConfig({
         resolve,
 
@@ -102,25 +81,5 @@ module.exports = {
         module: {
             rules: [ tsLoader({ declaration: false }) ]
         }
-    }),
-
-    umdPackage: commonTasks.webpackCommonConfig({
-        resolve,
-
-        stats: { assets: false },
-
-        output: { libraryTarget: 'umd' },
-
-        externals: packageDependencies,
-
-        plugins: [
-        ],
-        optimization: {
-            minimize: true
-        },
-        module: {
-            rules: [ tsLoader({ declaration: false }) ],
-            noParse: prebuilt
-        }
     })
 };