Skip to content

Commit f20d1d1

Browse files
simeonoffsimeonoff
authored
Merge pull request #77 from IgniteUI/dTsvetkov/update-typedoc-version
Update typedoc version and migrato to ESM type
2 parents 4e8487f + 29baaff commit f20d1d1

15 files changed

+140
-101
lines changed

‎components/convert-component.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ import {
33
Converter,
44
ReflectionKind,
55
} from 'typedoc';
6-
import { FileOperations } from '../utils/file-operations';
7-
import { ClassFactory } from '../utils/factories/class-factory';
8-
import { BaseFactory } from '../utils/factories/base-factory';
9-
import { EnumFactory } from '../utils/factories/enum-factory';
10-
import { Parser } from '../utils/parser';
11-
import { Constants } from '../utils/constants';
12-
import { InterfaceFactory } from '../utils/factories/interface-factory';
13-
import { FunctionFactory } from '../utils/factories/function-factory';
6+
import { FileOperations } from '../utils/file-operations.js';
7+
import { ClassFactory } from '../utils/factories/class-factory.js';
8+
import { BaseFactory } from '../utils/factories/base-factory.js';
9+
import { EnumFactory } from '../utils/factories/enum-factory.js';
10+
import { Parser } from '../utils/parser.js';
11+
import { Constants } from '../utils/constants.js';
12+
import { InterfaceFactory } from '../utils/factories/interface-factory.js';
13+
import { FunctionFactory } from '../utils/factories/function-factory.js';
1414

1515
export class ConvertComponent {
1616
/**

‎components/render-component.ts

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
import * as path from 'path';
2-
1+
import path from 'path';
32
import { ReflectionKind, RendererEvent, LogLevel, Application } from 'typedoc';
4-
import { FileOperations } from '../utils/file-operations';
5-
import { AttributeType } from '../utils/enums/json-keys';
6-
import { Constants } from '../utils/constants';
7-
import { Parser } from '../utils/parser';
3+
import { FileOperations } from '../utils/file-operations.js';
4+
import { AttributeType } from '../utils/enums/json-keys.js';
5+
import { Constants } from '../utils/constants.js';
6+
import { Parser } from '../utils/parser.js';
87

98
export class RenderComponenet {
109
private warns: boolean;

‎components/theme-component.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { RendererEvent, ReflectionKind, Application } from "typedoc";
2-
import { GlobalFuncs } from '../utils/global-funcs';
3-
import { HardcodedStrings } from '../utils/template-strings';
2+
import { GlobalFuncs } from '../utils/global-funcs.js';
3+
import { HardcodedStrings } from '../utils/template-strings.js';
44

55
export class ThemeComponent {
66
public app: Application;

‎index.ts

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
1-
import * as process from 'process';
2-
import * as fs from 'fs-extra';
3-
1+
import process from 'process';
2+
import fs from 'fs-extra';
43
import { Application, Converter, Renderer } from 'typedoc'
5-
import { ConvertComponent } from './components/convert-component';
6-
import { RenderComponenet } from './components/render-component';
7-
import { Constants } from './utils/constants';
8-
import { HardcodedStrings } from './utils/template-strings';
9-
import { ThemeComponent } from './components/theme-component';
10-
import { pluginOptions } from './utils/options';
4+
import { ConvertComponent } from './components/convert-component.js';
5+
import { RenderComponenet } from './components/render-component.js';
6+
import { Constants } from './utils/constants.js';
7+
import { HardcodedStrings } from './utils/template-strings.js';
8+
import { ThemeComponent } from './components/theme-component.js';
9+
import { pluginOptions } from './utils/options.js';
1110

12-
export * from './utils/helpers/localize';
11+
export * from './utils/helpers/localize.js';
1312

1413
export function load(PluginHost: Application) {
1514
const app = PluginHost.owner;

‎package-lock.json

Lines changed: 86 additions & 38 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
"description": "Typedoc plugin which localize your documentation",
55
"author": "Infragistics",
66
"license": "MIT",
7+
"type": "module",
78
"main": "dist/index.js",
89
"files": [
910
"dist/"
@@ -19,14 +20,15 @@
1920
"typedoc",
2021
"localizaiton",
2122
"plugin",
22-
"typedocplugin"
23+
"typedocplugin",
24+
"typedoc-plugin"
2325
],
2426
"dependencies": {
2527
"fs-extra": "^11.2.0"
2628
},
2729
"devDependencies": {
28-
"@types/node": "^18.11.0",
29-
"typedoc": "^0.26.2",
30-
"typescript": "^5.5.2"
30+
"@types/node": "^20.17.6",
31+
"typedoc": "^0.27.0",
32+
"typescript": "^5.6.3"
3133
}
3234
}

‎tsconfig.json

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,21 @@
11
{
22
"compilerOptions": {
3-
/* Basic Options */
4-
"target": "es6", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
5-
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
3+
"target": "ES2022",
4+
"module": "NodeNext",
65
"lib": [
7-
"es2017",
6+
"ES2022",
87
"dom"
9-
], /* Concatenate and emit output to single file. */
10-
"outDir": "./dist", /* Redirect output structure to the directory. */
11-
12-
/* Strict Type-Checking Options */
13-
"strict": false, /* Enable all strict type-checking options. */
14-
"noImplicitAny": false, /* Raise error on expressions and declarations with an implied 'any' type. */
15-
16-
/* Module Resolution Options */
17-
"moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
8+
],
9+
"declaration": true,
10+
"outDir": "./dist",
11+
"strict": false,
12+
"noImplicitAny": false,
13+
"moduleResolution": "NodeNext",
1814
"typeRoots": [
1915
"node_modules/@types"
20-
], /* List of folders to include type definitions from. */
16+
],
2117
"types": [
2218
"node"
23-
], /* Type declaration files to be included in compilation. */
24-
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
25-
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
26-
27-
/* Experimental Options */
28-
"experimentalDecorators": true /* Enables experimental support for ES7 decorators. */
19+
],
2920
}
3021
}

‎utils/factories/base-factory.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { AttributeType } from "../enums/json-keys";
1+
import { AttributeType } from "../enums/json-keys.js";
22

33
export abstract class BaseFactory {
44
public name;

‎utils/factories/class-factory.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import { BaseFactory } from './base-factory';
2-
import { AttributeType } from '../enums/json-keys';
1+
import { BaseFactory } from './base-factory.js';
2+
import { AttributeType } from '../enums/json-keys.js';
33

44
const PROPERTIES_KEY = AttributeType[AttributeType.properties];
55
const METHODS_KEY = AttributeType[AttributeType.methods];

‎utils/factories/enum-factory.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import { AttributeType } from "../enums/json-keys";
2-
import { BaseFactory } from "./base-factory";
1+
import { AttributeType } from "../enums/json-keys.js";
2+
import { BaseFactory } from "./base-factory.js";
33

44
const ENUM_MEMBER_KEY = AttributeType[AttributeType.members];
55

‎utils/factories/function-factory.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { BaseFactory } from "./base-factory";
1+
import { BaseFactory } from "./base-factory.js";
22

33
export class FunctionFactory extends BaseFactory {
44

‎utils/factories/interface-factory.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import { AttributeType } from "../enums/json-keys";
2-
import { BaseFactory } from "./base-factory";
1+
import { AttributeType } from "../enums/json-keys.js";
2+
import { BaseFactory } from "./base-factory.js";
33

44
const PROPERTIES_KEY = AttributeType[AttributeType.properties];
55
const METHODS_KEY = AttributeType[AttributeType.methods];

‎utils/file-operations.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import * as fs from 'fs-extra';
2-
import * as path from 'path';
1+
import fs from 'fs-extra';
2+
import path from 'path';
33
import { Logger } from 'typedoc';
44

55
export class FileOperations {

‎utils/helpers/localize.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import { GlobalFuncs } from '../global-funcs';
2-
import { HardcodedStrings } from '../template-strings';
1+
import { GlobalFuncs } from '../global-funcs.js';
2+
import { HardcodedStrings } from '../template-strings.js';
33

44
/**
55
* Helper function which loclize the hardcoded template strings.

‎utils/options.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { Options, ParameterType } from 'typedoc'
2-
import { Constants } from './constants';
2+
import { Constants } from './constants.js';
33

44
export function pluginOptions(options: Pick<Options, "addDeclaration">) {
55

0 commit comments

Comments
 (0)