@gesslar/bedoc 1.4.1 → 1.4.2

package/dist/types/cli.d.ts

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
-export {};
-//# sourceMappingURL=cli.d.ts.map
+export {}
+//# sourceMappingURL=cli.d.ts.map

package/dist/types/core/ActionManager.d.ts

@@ -2,26 +2,26 @@ import Logger from './Logger';
 import HookManager from './HookManager';
 
 export interface ActionDefinition {
-    action: string;
-    contract: Record<string, unknown>;
-    meta: Record<string, unknown>;
+  action: string;
+  contract: Record<string, unknown>;
+  meta: Record<string, unknown>;
 }
 
 export default class ActionManager {
-    constructor(actionDefinition: ActionDefinition, logger: Logger);
-    get action(): ActionDefinition;
-    set hookManager(hookManager: HookManager);
-    get hookManager(): HookManager;
-    get contract(): Record<string, unknown>;
-    get meta(): Record<string, unknown>;
-    get log(): Logger;
-    setupAction(): Promise<void>;
-    runAction({ file, content }: {
-        file: string;
-        content: string;
-    }): Promise<string>;
-    cleanupAction(): Promise<void>;
-    toString(): string;
-    #private;
+  constructor(actionDefinition: ActionDefinition, logger: Logger);
+  get action(): ActionDefinition;
+  set hookManager(hookManager: HookManager);
+  get hookManager(): HookManager;
+  get contract(): Record<string, unknown>;
+  get meta(): Record<string, unknown>;
+  get log(): Logger;
+  setupAction(): Promise<void>;
+  runAction({ file, content }: {
+    file: string;
+    content: string;
+  }): Promise<string>;
+  cleanupAction(): Promise<void>;
+  toString(): string;
+  #private;
 }
 //# sourceMappingURL=ActionManager.d.ts.map

package/dist/types/core/Configuration.d.ts

@@ -1,27 +1,27 @@
 import { EnvironmentType } from './Core';
 
 interface ConfigurationOption {
-    value: unknown;
-    source: string;
+  value: unknown;
+  source: string;
 }
 
 interface ConfigurationOptions {
-    [key: string]: ConfigurationOption;
+  [key: string]: ConfigurationOption;
 }
 
 interface ValidateParams {
-    options: ConfigurationOptions;
-    source: EnvironmentType;
+  options: ConfigurationOptions;
+  source: EnvironmentType;
 }
 
 interface ValidationResult {
-    status: 'success';
-    validated: boolean;
-    [key: string]: unknown;
+  status: 'success';
+  validated: boolean;
+  [key: string]: unknown;
 }
 
 export default class Configuration {
-    validate({ options, source }: ValidateParams): Promise<ValidationResult>;
-    #private;
+  validate({ options, source }: ValidateParams): Promise<ValidationResult>;
+  #private;
 }
 //# sourceMappingURL=Configuration.d.ts.map

package/dist/types/core/ConfigurationParameters.d.ts

@@ -1,36 +1,36 @@
 import TypeSpec from './util/TypeSpec';
 
 interface PathConfig {
-    type: 'file' | 'directory';
-    mustExist: boolean;
+  type: 'file' | 'directory';
+  mustExist: boolean;
 }
 
 interface ConfigurationParameter {
-    short: string;
-    param?: string;
-    description: string;
-    type: TypeSpec;
-    required: boolean;
-    default?: boolean | number | string;
-    path?: PathConfig;
-    exclusiveOf?: string;
+  short: string;
+  param?: string;
+  description: string;
+  type: TypeSpec;
+  required: boolean;
+  default?: boolean | number | string;
+  path?: PathConfig;
+  exclusiveOf?: string;
 }
 
 interface ConfigurationParametersType {
-    input: ConfigurationParameter;
-    exclude: ConfigurationParameter;
-    language: ConfigurationParameter;
-    format: ConfigurationParameter;
-    maxConcurrent: ConfigurationParameter;
-    hooks: ConfigurationParameter;
-    output: ConfigurationParameter;
-    parser: ConfigurationParameter;
-    printer: ConfigurationParameter;
-    hookTimeout: ConfigurationParameter;
-    mock: ConfigurationParameter;
-    config: ConfigurationParameter;
-    debug: ConfigurationParameter;
-    debugLevel: ConfigurationParameter;
+  input: ConfigurationParameter;
+  exclude: ConfigurationParameter;
+  language: ConfigurationParameter;
+  format: ConfigurationParameter;
+  maxConcurrent: ConfigurationParameter;
+  hooks: ConfigurationParameter;
+  output: ConfigurationParameter;
+  parser: ConfigurationParameter;
+  printer: ConfigurationParameter;
+  hookTimeout: ConfigurationParameter;
+  mock: ConfigurationParameter;
+  config: ConfigurationParameter;
+  debug: ConfigurationParameter;
+  debugLevel: ConfigurationParameter;
 }
 
 export const ConfigurationParameters: Readonly<ConfigurationParametersType>;

package/dist/types/core/Conveyor.d.ts

@@ -3,45 +3,47 @@ import Logger from './Logger';
 import { FileMap } from './util/FDUtil';
 
 interface ProcessResult {
-    status: 'success' | 'error' | 'warning';
-    file?: FileMap;
-    error?: Error;
-    warning?: string;
-    result?: string;
-    destFile?: string;
-    content?: string;
+  status: 'success' | 'error' | 'warning';
+  file?: FileMap;
+  error?: Error;
+  warning?: string;
+  result?: string;
+  destFile?: string;
+  content?: string;
 }
 
-interface ConveyResult {
-    succeeded: Array<{ input: FileMap; output: FileMap }>;
-    errored: Array<{ input: FileMap; error: Error }>;
+export interface ConveyResult {
+  succeeded: Array<{ input: FileMap; output: FileMap }>;
+  errored: Array<{ input: FileMap; error: Error }>;
+  warned: Array<{ input: FileMap; warning: string }>;
 }
 
 export default class Conveyor {
-    constructor(
-        parse: ActionManager,
-        print: ActionManager,
-        logger: Logger,
-        output: FileMap
-    );
+  constructor(
+    parse: ActionManager,
+    print: ActionManager,
+    logger: Logger,
+    output: FileMap
+  );
 
-    readonly parse: ActionManager;
-    readonly print: ActionManager;
-    readonly logger: Logger;
-    readonly output: FileMap;
+  readonly parse: ActionManager;
+  readonly print: ActionManager;
+  readonly logger: Logger;
+  readonly output: FileMap;
 
-    /**
-     * Processes files with a concurrency limit.
-     *
-     * @param files - List of files to process.
-     * @param maxConcurrent - Maximum number of concurrent tasks.
-     * @returns Resolves when all files are processed.
-     */
-    convey(files: FileMap[], maxConcurrent?: number): Promise<ConveyResult>;
+  /**
+   * Processes files with a concurrency limit.
+   *
+   * @param files - List of files to process.
+   * @param maxConcurrent - Maximum number of concurrent tasks.
+   * @returns Resolves when all files are processed.
+   */
+  convey(files: FileMap[], maxConcurrent?: number): Promise<ConveyResult>;
 
-    #succeeded: Array<{ input: FileMap; output: FileMap }>;
-    #errored: Array<{ input: FileMap; error: Error }>;
-    #processFile(file: FileMap): Promise<ProcessResult>;
-    #writeOutput(destFile: string, content: string): Promise<ProcessResult>;
+  #succeeded: Array<{ input: FileMap; output: FileMap }>;
+  #errored: Array<{ input: FileMap; error: Error }>;
+  #warned: Array<{ input: FileMap; warning: string }>;
+  #processFile(file: FileMap): Promise<ProcessResult>;
+  #writeOutput(destFile: string, content: string): Promise<ProcessResult>;
 }
 //# sourceMappingURL=Conveyor.d.ts.map

package/dist/types/core/Core.d.ts

@@ -1,53 +1,48 @@
 import Logger from './Logger';
 import ActionManager from './ActionManager';
-import { FileMap } from './util/FDUtil';
+import { ConveyResult} from './Conveyor';
 
 export const Environment: Readonly<{
-    EXTENSION: 'extension';
-    NPM: 'npm';
-    ACTION: 'action';
-    CLI: 'cli';
+  EXTENSION: 'extension';
+  NPM: 'npm';
+  ACTION: 'action';
+  CLI: 'cli';
 }>;
 
 export type EnvironmentType = typeof Environment[keyof typeof Environment];
 
 interface CoreOptions {
-    debug?: boolean;
-    debugLevel?: number;
-    name?: string;
-    [key: string]: unknown;
+  debug?: boolean;
+  debugLevel?: number;
+  name?: string;
+  [key: string]: unknown;
 }
 
 interface CoreConstructorOptions extends CoreOptions {
-    hooks?: string;
-    hooksTimeout?: number;
-    output?: string;
-    maxConcurrent?: number;
+  hooks?: string;
+  hooksTimeout?: number;
+  output?: string;
+  maxConcurrent?: number;
 }
 
 interface NewParams {
-    options: CoreOptions;
-    source: EnvironmentType;
-}
-
-interface ProcessResult {
-    succeeded: Array<{ input: FileMap; output: FileMap }>;
-    errored: Array<{ input: FileMap; error: Error }>;
+  options: CoreOptions;
+  source: EnvironmentType;
 }
 
 export default class Core {
-    static new({ options, source }: NewParams): Promise<Core>;
+  static new({ options, source }: NewParams): Promise<Core>;
 
-    constructor(options: CoreConstructorOptions);
+  constructor(options: CoreConstructorOptions);
 
-    readonly options: CoreConstructorOptions;
-    readonly logger: Logger;
-    readonly packageJson: Record<string, unknown>;
-    readonly debugOptions: {
-        name: string | null;
-        debugLevel: number;
-    };
-    readonly actions: Record<string, ActionManager>;
+  readonly options: CoreConstructorOptions;
+  readonly logger: Logger;
+  readonly packageJson: Record<string, unknown>;
+  readonly debugOptions: {
+    name: string | null;
+    debugLevel: number;
+  };
+  readonly actions: Record<string, ActionManager>;
 
-    processFiles(glob: string | string[], startTime?: [number, number]): Promise<ProcessResult>;
+  processFiles(glob: string | string[], startTime?: [number, number]): Promise<ConveyResult>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gesslar/bedoc",
-  "version": "1.4.1",
+  "version": "1.4.2",
   "description": "Pluggable documentation engine for any language and format",
   "publisher": "gesslar",
   "main": "./src/core/Core.js",
@@ -18,6 +18,13 @@
     ".": {
       "import": "./src/core/Core.js",
       "types": "./dist/types/core/Core.d.ts"
+    },
+    "./BeDoc": {
+      "import": "./src/core/Core.js",
+      "types": "./dist/types/core/Core.d.ts"
+    },
+    "./*": {
+      "types": "./dist/types/*"
     }
   },
   "type": "module",
@@ -38,6 +45,8 @@
   },
   "devDependencies": {
     "@stylistic/eslint-plugin-js": "^3.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.22.0",
+    "@typescript-eslint/parser": "^8.22.0",
     "axios": "^1.7.9",
     "chokidar": "^4.0.3",
     "eslint": "^9.18.0",