@progress/kendo-typescript-tasks 10.0.21-ng12.36 → 10.0.21

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [10.0.21](https://github.com/telerik/kendo-build-tasks/compare/@progress/kendo-typescript-tasks@10.0.20...@progress/kendo-typescript-tasks@10.0.21) (2022-03-14)
+
+
+### Bug Fixes
+
+* **typescript-tasks:** improve union page template ([a0371d5](https://github.com/telerik/kendo-build-tasks/commit/a0371d5ebd31d58d137b7011dff1f47171fb8347))
+
+
+
+
+
 ## [10.0.20](https://github.com/telerik/kendo-build-tasks/compare/@progress/kendo-typescript-tasks@10.0.19...@progress/kendo-typescript-tasks@10.0.20) (2022-03-10)
 
 **Note:** Version bump only for package @progress/kendo-typescript-tasks

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,30 +12,11 @@ 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', () => {
+        return gulp.src(["src/**/*.{ts,tsx}", ...DECLARATIONS, ...(config.externalApi || [])], { "allowEmpty": true })
+            .pipe(typedoc(config.typedoc));
     });
 
     gulp.task('api-clean', (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');
@@ -36,15 +37,29 @@ module.exports = (gulp, libraryName, compilerPath, options, webpackConfigPath) =
         done()
     });
 
-    gulp.task('lint', series(
-        'check-compilation',
-        linter([ 'src/**/*.{ts,tsx}', 'test/**/*.{ts,tsx}', 'e2e/**/*.{ts,tsx}' ])
-    ));
+    gulp.task('lint', series('check-compilation', (done) => {
+        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;

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.36+e5fce7e",
+  "version": "10.0.21",
   "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.36+e5fce7e",
-    "@typescript-eslint/eslint-plugin": "4.28.2",
-    "@typescript-eslint/parser": "4.28.2",
-    "core-js": "^3.18.0",
+    "@progress/kendo-common-tasks": "^7.9.4",
+    "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": "e5fce7ec4d83dcf06e1bd0b2c38fc0e5246d570d"
+  "gitHead": "312a5e97951ec3e69926d909e573bf5aafff222f"
 }

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

@@ -110,11 +110,6 @@ const normalizeMembers = (members) => {
                 }
             }
         }
-
-        if (!element.comment && element.kindString === 'Accessor') {
-            const accessor = element.getSignature || element.setSignature || [];
-            element.comment = accessor[0].comment;
-        }
     });
 }
 
@@ -153,7 +148,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);
@@ -200,6 +195,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) {

package/src/api/map-constructors.js

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

package/src/api/template-utils.js

@@ -7,6 +7,9 @@ const hbs = require('handlebars');
 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));
+
 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 });

package/src/api/union-page.hbs

@@ -3,9 +3,11 @@
 # {{name}}
 {{comment}}
 
-## Members
-
-{{#each types}}
-* {{this}}
-{{/each}}
-
+`type` {{name}} =
+  {{~#each types~}}
+    {{~#contains this 'slug'}} {{this}}
+      {{~else contains this '"'}} {{this}}
+      {{~else}} `{{this}}`
+    {{~/contains~}}
+    {{~#unless @last}} |{{/unless~}}
+  {{~/each}};

package/test/api.js

@@ -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"; }');
         });
     });
 

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;