Merge pull request #77 from IgniteUI/dTsvetkov/update-typedoc-version

Update typedoc version and migrato to ESM type

components/convert-component.ts

@@ -3,14 +3,14 @@ import {
     Converter,
     ReflectionKind,
 } from 'typedoc';
-import { FileOperations } from '../utils/file-operations';
-import { ClassFactory } from '../utils/factories/class-factory';
-import { BaseFactory } from '../utils/factories/base-factory';
-import { EnumFactory } from '../utils/factories/enum-factory';
-import { Parser } from '../utils/parser';
-import { Constants } from '../utils/constants';
-import { InterfaceFactory } from '../utils/factories/interface-factory';
-import { FunctionFactory } from '../utils/factories/function-factory';
+import { FileOperations } from '../utils/file-operations.js';
+import { ClassFactory } from '../utils/factories/class-factory.js';
+import { BaseFactory } from '../utils/factories/base-factory.js';
+import { EnumFactory } from '../utils/factories/enum-factory.js';
+import { Parser } from '../utils/parser.js';
+import { Constants } from '../utils/constants.js';
+import { InterfaceFactory } from '../utils/factories/interface-factory.js';
+import { FunctionFactory } from '../utils/factories/function-factory.js';
 
 export class ConvertComponent {
     /**

components/render-component.ts

@@ -1,10 +1,9 @@
-import * as path from 'path';
-
+import path from 'path';
 import { ReflectionKind, RendererEvent, LogLevel, Application } from 'typedoc';
-import { FileOperations } from '../utils/file-operations';
-import { AttributeType } from '../utils/enums/json-keys';
-import { Constants } from '../utils/constants';
-import { Parser } from '../utils/parser';
+import { FileOperations } from '../utils/file-operations.js';
+import { AttributeType } from '../utils/enums/json-keys.js';
+import { Constants } from '../utils/constants.js';
+import { Parser } from '../utils/parser.js';
 
 export class RenderComponenet {
     private warns: boolean;

components/theme-component.ts

@@ -1,6 +1,6 @@
 import { RendererEvent, ReflectionKind, Application } from "typedoc";
-import { GlobalFuncs } from '../utils/global-funcs';
-import { HardcodedStrings } from '../utils/template-strings';
+import { GlobalFuncs } from '../utils/global-funcs.js';
+import { HardcodedStrings } from '../utils/template-strings.js';
 
 export class ThemeComponent {
     public app: Application;

index.ts

@@ -1,15 +1,14 @@
-import * as process from 'process';
-import * as fs from 'fs-extra';
-
+import process from 'process';
+import fs from 'fs-extra';
 import { Application, Converter, Renderer } from 'typedoc'
-import { ConvertComponent } from './components/convert-component';
-import { RenderComponenet } from './components/render-component';
-import { Constants } from './utils/constants';
-import { HardcodedStrings } from './utils/template-strings';
-import { ThemeComponent } from './components/theme-component';
-import { pluginOptions } from './utils/options';
+import { ConvertComponent } from './components/convert-component.js';
+import { RenderComponenet } from './components/render-component.js';
+import { Constants } from './utils/constants.js';
+import { HardcodedStrings } from './utils/template-strings.js';
+import { ThemeComponent } from './components/theme-component.js';
+import { pluginOptions } from './utils/options.js';
 
-export * from './utils/helpers/localize';
+export * from './utils/helpers/localize.js';
 
 export function load(PluginHost: Application) {
     const app = PluginHost.owner;

package.json

@@ -4,6 +4,7 @@
   "description": "Typedoc plugin which localize your documentation",
   "author": "Infragistics",
   "license": "MIT",
+  "type": "module",
   "main": "dist/index.js",
   "files": [
     "dist/"
@@ -19,14 +20,15 @@
     "typedoc",
     "localizaiton",
     "plugin",
-    "typedocplugin"
+    "typedocplugin",
+    "typedoc-plugin"
   ],
   "dependencies": {
     "fs-extra": "^11.2.0"
   },
   "devDependencies": {
-    "@types/node": "^18.11.0",
-    "typedoc": "^0.26.2",
-    "typescript": "^5.5.2"
+    "@types/node": "^20.17.6",
+    "typedoc": "^0.27.0",
+    "typescript": "^5.6.3"
   }
 }

tsconfig.json

@@ -1,30 +1,21 @@
 {
   "compilerOptions": {
-    /* Basic Options */
-    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
-    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    "target": "ES2022",
+    "module": "NodeNext",
     "lib": [
-        "es2017",
+        "ES2022",
         "dom"
-    ],                    /* Concatenate and emit output to single file. */
-    "outDir": "./dist",                        /* Redirect output structure to the directory. */
-
-    /* Strict Type-Checking Options */
-    "strict": false,                           /* Enable all strict type-checking options. */
-    "noImplicitAny": false,                 /* Raise error on expressions and declarations with an implied 'any' type. */
-
-    /* Module Resolution Options */
-    "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    ],       
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": false,
+    "noImplicitAny": false,
+    "moduleResolution": "NodeNext",
     "typeRoots": [
         "node_modules/@types"
-    ],                       /* List of folders to include type definitions from. */
+    ],
     "types": [
         "node"
-    ],                           /* Type declaration files to be included in compilation. */
-    "esModuleInterop": true,                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
-
-    /* Experimental Options */
-    "experimentalDecorators": true        /* Enables experimental support for ES7 decorators. */
+    ],
   }
 }

utils/factories/base-factory.ts

@@ -1,4 +1,4 @@
-import { AttributeType } from "../enums/json-keys";
+import { AttributeType } from "../enums/json-keys.js";
 
 export abstract class BaseFactory {
     public name;

utils/factories/class-factory.ts

@@ -1,5 +1,5 @@
-import { BaseFactory } from './base-factory';
-import { AttributeType } from '../enums/json-keys';
+import { BaseFactory } from './base-factory.js';
+import { AttributeType } from '../enums/json-keys.js';
 
 const PROPERTIES_KEY = AttributeType[AttributeType.properties];
 const METHODS_KEY = AttributeType[AttributeType.methods];

utils/factories/enum-factory.ts

@@ -1,5 +1,5 @@
-import { AttributeType } from "../enums/json-keys";
-import { BaseFactory } from "./base-factory";
+import { AttributeType } from "../enums/json-keys.js";
+import { BaseFactory } from "./base-factory.js";
 
 const ENUM_MEMBER_KEY = AttributeType[AttributeType.members];
 

utils/factories/function-factory.ts

@@ -1,4 +1,4 @@
-import { BaseFactory } from "./base-factory";
+import { BaseFactory } from "./base-factory.js";
 
 export class FunctionFactory extends BaseFactory {
 

utils/factories/interface-factory.ts

@@ -1,5 +1,5 @@
-import { AttributeType } from "../enums/json-keys";
-import { BaseFactory } from "./base-factory";
+import { AttributeType } from "../enums/json-keys.js";
+import { BaseFactory } from "./base-factory.js";
 
 const PROPERTIES_KEY = AttributeType[AttributeType.properties];
 const METHODS_KEY = AttributeType[AttributeType.methods];

utils/file-operations.ts

@@ -1,5 +1,5 @@
-import * as fs from 'fs-extra';
-import * as path from 'path';
+import fs from 'fs-extra';
+import path from 'path';
 import { Logger } from 'typedoc';
 
 export class FileOperations {

utils/helpers/localize.ts

@@ -1,5 +1,5 @@
-import { GlobalFuncs } from '../global-funcs';
-import { HardcodedStrings } from '../template-strings';
+import { GlobalFuncs } from '../global-funcs.js';
+import { HardcodedStrings } from '../template-strings.js';
 
 /**
  * Helper function which loclize the hardcoded template strings.

utils/options.ts

@@ -1,5 +1,5 @@
 import { Options, ParameterType } from 'typedoc'
-import { Constants } from './constants';
+import { Constants } from './constants.js';
 
 export function pluginOptions(options: Pick<Options, "addDeclaration">) {