@rsdoctor/types 0.0.2-beta.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Bytedance, Inc. and its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,15 @@
+# Rsdoctor
+
+Rsdoctor is a tool for diagnosing and analyzing the build process and build artifacts to help developers quickly identify and solve problems.
+
+It also supports Webpack and Rspack builders, as well as various build frameworks, such as Rsbuild.
+
+## Documentation
+
+## Contributing
+
+Please read the [Contributing Guide](https://github.com/web-infra-dev/rsdoctor/blob/main/CONTRIBUTING.md).
+
+## License
+
+Rsdoctor is [MIT licensed](https://github.com/web-infra-dev/rsdoctor/blob/main/LICENSE).

package/dist/babel.d.ts

@@ -0,0 +1,13 @@
+/** Babel Error */
+export interface Error {
+    code: string;
+    reasonCode: string;
+    message: string;
+    name: string;
+    stack: string;
+    pos?: number;
+    loc?: {
+        line: number;
+        column: number;
+    };
+}

package/dist/babel.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/client.d.ts

@@ -0,0 +1,108 @@
+export declare enum DoctorClientUrlQuery {
+    BundleDiffFiles = "__bundle_files__",
+    ManifestFile = "manifest"
+}
+export declare enum DoctorClientRoutes {
+    Overall = "/overall",
+    WebpackLoaderOverall = "/webpack/loaders/overall",
+    WebpackLoaderAnalysis = "/webpack/loaders/analysis",
+    ModuleResolve = "/module/resolve",
+    WebpackPlugins = "/webpack/plugins",
+    BundleSize = "/bundle/size",
+    ModuleAnalyze = "/module/analyze",
+    TreeShaking = "/treeshaking",
+    BundleDiff = "/resources/bundle/diff",
+    RuleIndex = "/resources/rules",
+    Uploader = "/resources/uploader",
+    EmoCheck = "/emo/check"
+}
+export declare enum DoctorClientDiffState {
+    Equal = "-",
+    Up = "UP",
+    Down = "DOWN"
+}
+export interface DoctorClientAssetsDiffItem {
+    size: {
+        baseline: number;
+        current: number;
+    };
+    count: {
+        baseline: number;
+        current: number;
+    };
+    percent: number;
+    state: DoctorClientDiffState;
+}
+export interface DoctorClientAssetsDiffResult {
+    all: {
+        total: DoctorClientAssetsDiffItem;
+    };
+    js: {
+        total: DoctorClientAssetsDiffItem;
+        initial: DoctorClientAssetsDiffItem;
+    };
+    css: {
+        total: DoctorClientAssetsDiffItem;
+        initial: DoctorClientAssetsDiffItem;
+    };
+    imgs: {
+        total: DoctorClientAssetsDiffItem;
+    };
+    html: {
+        total: DoctorClientAssetsDiffItem;
+    };
+    media: {
+        total: DoctorClientAssetsDiffItem;
+    };
+    fonts: {
+        total: DoctorClientAssetsDiffItem;
+    };
+    /**
+     * files exclude these extensions above
+     */
+    others: {
+        total: DoctorClientAssetsDiffItem;
+    };
+}
+interface AssetInfo {
+    size: number;
+    count: number;
+    files: {
+        path: string;
+        size: number;
+        initial: boolean;
+        content: string | void;
+    }[];
+}
+export interface DoctorClientAssetsSummary {
+    all: {
+        total: AssetInfo;
+    };
+    js: {
+        total: AssetInfo;
+        initial: AssetInfo;
+    };
+    css: {
+        total: AssetInfo;
+        initial: AssetInfo;
+    };
+    imgs: {
+        total: AssetInfo;
+    };
+    html: {
+        total: AssetInfo;
+    };
+    media: {
+        total: AssetInfo;
+    };
+    fonts: {
+        total: AssetInfo;
+    };
+    /**
+     * files exclude these extensions above
+     */
+    others: {
+        total: AssetInfo;
+    };
+}
+export {};

package/dist/client.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DoctorClientDiffState = exports.DoctorClientRoutes = exports.DoctorClientUrlQuery = void 0;
+var DoctorClientUrlQuery;
+(function (DoctorClientUrlQuery) {
+    DoctorClientUrlQuery["BundleDiffFiles"] = "__bundle_files__";
+    DoctorClientUrlQuery["ManifestFile"] = "manifest";
+})(DoctorClientUrlQuery || (exports.DoctorClientUrlQuery = DoctorClientUrlQuery = {}));
+var DoctorClientRoutes;
+(function (DoctorClientRoutes) {
+    DoctorClientRoutes["Overall"] = "/overall";
+    DoctorClientRoutes["WebpackLoaderOverall"] = "/webpack/loaders/overall";
+    DoctorClientRoutes["WebpackLoaderAnalysis"] = "/webpack/loaders/analysis";
+    DoctorClientRoutes["ModuleResolve"] = "/module/resolve";
+    DoctorClientRoutes["WebpackPlugins"] = "/webpack/plugins";
+    DoctorClientRoutes["BundleSize"] = "/bundle/size";
+    DoctorClientRoutes["ModuleAnalyze"] = "/module/analyze";
+    DoctorClientRoutes["TreeShaking"] = "/treeshaking";
+    DoctorClientRoutes["BundleDiff"] = "/resources/bundle/diff";
+    DoctorClientRoutes["RuleIndex"] = "/resources/rules";
+    DoctorClientRoutes["Uploader"] = "/resources/uploader";
+    DoctorClientRoutes["EmoCheck"] = "/emo/check";
+})(DoctorClientRoutes || (exports.DoctorClientRoutes = DoctorClientRoutes = {}));
+var DoctorClientDiffState;
+(function (DoctorClientDiffState) {
+    DoctorClientDiffState["Equal"] = "-";
+    DoctorClientDiffState["Up"] = "UP";
+    DoctorClientDiffState["Down"] = "DOWN";
+})(DoctorClientDiffState || (exports.DoctorClientDiffState = DoctorClientDiffState = {}));

package/dist/common.d.ts

@@ -0,0 +1,26 @@
+export type NonFunctionPropertyNames<T> = {
+    [K in keyof T]: T[K] extends Function ? never : K;
+}[keyof T];
+export type NonFunctionProperties<T> = Pick<T, NonFunctionPropertyNames<T>>;
+export type PlainObject<T = any> = {
+    [key: string]: T;
+};
+export type PromiseReturnType<T> = T extends (...args: any[]) => Promise<infer P> ? P : T;
+export type DeepRequired<T> = T extends PlainObject ? {
+    [K in keyof T]-?: DeepRequired<T[K]>;
+} : T;
+export type OrPromise<T> = T | Promise<T>;
+export type Constructor<T> = T extends abstract new (...args: infer P1) => infer R1 ? new (...args: P1) => R1 : T extends new (...args: infer P2) => infer R2 ? new (...args: P2) => R2 : never;
+export type Function<P extends any[] = any[], R = any> = (...args: P) => R;
+export type FunctionPropertyNames<T> = {
+    [K in keyof T]: T[K] extends Function ? K : never;
+}[keyof T];
+export type Get<T, K, F = never> = K extends keyof T ? T[K] : F;
+export type ObjectPropertyNames<T> = {
+    [K in keyof T]: T[K] extends PlainObject ? K : never;
+}[keyof T];
+export type ArrayToUnion<T extends any[]> = T[number];
+export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+export type LastOf<T> = UnionToIntersection<T extends any ? () => T : never> extends () => infer R ? R : never;
+export type Push<T extends any[], V> = [...T, V];
+export type UnionToTuple<T, L = LastOf<T>, N = [T] extends [never] ? true : false> = true extends N ? [] : Push<UnionToTuple<Exclude<T, L>>, L>;

package/dist/common.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/constants.d.ts

@@ -0,0 +1,16 @@
+export declare const JSExtension = ".js";
+export declare const CSSExtension = ".css";
+export declare const HtmlExtension = ".html";
+export declare const ImgExtensions: string[];
+export declare const MediaExtensions: string[];
+export declare const FontExtensions: string[];
+export declare const MapExtensions: string[];
+export declare const DoctorOutputFolder = ".rsdoctor";
+export declare const DoctorOutputManifest = "manifest.json";
+export declare const DoctorOutputManifestPath: ".rsdoctor/manifest.json";
+export declare const StatsFilePath = "dist/stats.json";
+export declare const DoctorMonitorNodeBId = "Rsdoctor";
+export declare const DoctorMonitorWebBId = "Rsdoctor-Client";
+export declare const DoctorMonitorDocBId = "Rsdoctor-Doc";
+export declare const DoctorProcessEnvDebugKey = "RSDOCTOR_DEBUG";
+export declare const RsdoctorClientUrl = "";

package/dist/constants.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RsdoctorClientUrl = exports.DoctorProcessEnvDebugKey = exports.DoctorMonitorDocBId = exports.DoctorMonitorWebBId = exports.DoctorMonitorNodeBId = exports.StatsFilePath = exports.DoctorOutputManifestPath = exports.DoctorOutputManifest = exports.DoctorOutputFolder = exports.MapExtensions = exports.FontExtensions = exports.MediaExtensions = exports.ImgExtensions = exports.HtmlExtension = exports.CSSExtension = exports.JSExtension = void 0;
+exports.JSExtension = '.js';
+exports.CSSExtension = '.css';
+exports.HtmlExtension = '.html';
+exports.ImgExtensions = [
+    '.png',
+    '.jpg',
+    '.svg',
+    '.webp',
+    '.jpeg',
+    '.gif',
+    '.bmp',
+];
+exports.MediaExtensions = [
+    '.mp3',
+    '.mp4',
+    '.avi',
+    '.wav',
+    '.flv',
+    '.mov',
+    '.mpg',
+    '.mpeg',
+];
+exports.FontExtensions = ['.ttf', '.fnt', '.fon', '.otf'];
+exports.MapExtensions = ['.js.map', '.ts.map', '.LICENSE.txt'];
+exports.DoctorOutputFolder = '.rsdoctor';
+exports.DoctorOutputManifest = 'manifest.json';
+exports.DoctorOutputManifestPath = `${exports.DoctorOutputFolder}/${exports.DoctorOutputManifest}`;
+exports.StatsFilePath = 'dist/stats.json';
+exports.DoctorMonitorNodeBId = 'Rsdoctor';
+exports.DoctorMonitorWebBId = 'Rsdoctor-Client';
+exports.DoctorMonitorDocBId = 'Rsdoctor-Doc';
+exports.DoctorProcessEnvDebugKey = 'RSDOCTOR_DEBUG';
+exports.RsdoctorClientUrl = ''; // TODO: rsdoctor client url

package/dist/emo.d.ts

@@ -0,0 +1,28 @@
+export type WorkspaceCheckDataType = {
+    message: string;
+    type: 'issues' | 'message' | 'code';
+    title: string;
+    severity?: EmoCheckSeverity;
+    result?: {
+        package: string;
+        data: Record<string, string | string[]>[];
+        tag?: string;
+    } | {
+        path: string;
+        line?: number;
+        column?: number;
+    }[] | Record<string, {
+        version: string;
+        pkgname: string;
+    }>;
+    issues?: string[];
+};
+export type EmoCheckData = {
+    projectInfo: Record<string, string | Object>;
+    workspaceRes: Record<string, WorkspaceCheckDataType[]>;
+};
+export declare enum EmoCheckSeverity {
+    Error = 0,
+    Warn = 1,
+    Info = 2
+}

package/dist/emo.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmoCheckSeverity = void 0;
+var EmoCheckSeverity;
+(function (EmoCheckSeverity) {
+    EmoCheckSeverity[EmoCheckSeverity["Error"] = 0] = "Error";
+    EmoCheckSeverity[EmoCheckSeverity["Warn"] = 1] = "Warn";
+    EmoCheckSeverity[EmoCheckSeverity["Info"] = 2] = "Info";
+})(EmoCheckSeverity || (exports.EmoCheckSeverity = EmoCheckSeverity = {}));

package/dist/error.d.ts

@@ -0,0 +1,137 @@
+import type { NonFunctionProperties } from './common';
+import type { BaseRuleStoreData } from './rule';
+/**
+ * Position
+ *   - `line` start with `1`
+ *   - `column` start with `0`
+ */
+export interface Position {
+    line: number;
+    column: number;
+}
+/** Range of Position */
+export interface Range {
+    start: Position;
+    end: Position;
+}
+/** Offset range  */
+export interface OffsetRange {
+    start: number;
+    end: number;
+}
+/** Error Level */
+export declare enum ErrorLevel {
+    Ignore = 0,
+    Warn = 1,
+    Error = 2
+}
+/** Code prompt location */
+export interface CodeFramePosition {
+    line: number;
+    column?: number;
+}
+/** File options where the code is located */
+export interface CodeFrameFileOption {
+    filePath: string;
+}
+/** Code indication options */
+export interface CodeFrameNormalOption {
+    filePath: string;
+    fileContent: string;
+    start?: CodeFramePosition;
+    end?: CodeFramePosition;
+}
+/**
+ * Code indication options
+ *   - This type is mainly for compatibility with esbuild.
+ */
+export interface CodeFrameLineOption {
+    /** File path */
+    filePath: string;
+    /** Error line text */
+    lineText: string;
+    /** Starting point */
+    start?: CodeFramePosition;
+    /** Error character length */
+    length?: number;
+}
+export type CodeFrameOption = CodeFrameFileOption | CodeFrameNormalOption | CodeFrameLineOption;
+/** Control item */
+export interface ControllerOption {
+    /**
+     * Hide stack information
+     *   - default is `true`
+     */
+    noStack?: boolean;
+    /**
+     * Do not display colors
+     *   - default is `false`
+     */
+    noColor?: boolean;
+}
+/** repair data */
+export interface FixData {
+    /** Modify the starting position of string in the original text. */
+    start: number;
+    /** Modify string in the key position of the original text */
+    end: number;
+    /**
+     * Replaced new text
+     *   - If empty, delete the original text.
+     */
+    newText?: string;
+    /** Has it been fixed */
+    isFixed?: boolean;
+}
+/** Error Data */
+export interface DevToolErrorData {
+    /** Error number */
+    id: number;
+    /** Wrong code */
+    code?: string;
+    /** Error category */
+    category?: string;
+    title: string;
+    message: string;
+    stack?: string;
+    fixData?: FixData;
+    detail?: any;
+    /** Absolute path where the error is located. */
+    path?: string;
+    /**
+     * Error level
+     *   - default is `'Error'`
+     */
+    level?: keyof typeof ErrorLevel;
+    /** Error prompt */
+    hint?: string;
+    /** Description link */
+    referenceUrl?: string;
+    codeFrame?: CodeFrameOption;
+}
+/**  Error data */
+export interface DevToolErrorInstance extends DevToolErrorData {
+    /** Output stored data */
+    toData(): BaseRuleStoreData;
+    toString(): string;
+    toJSON(): {
+        message: string;
+        name: string;
+        stack?: string;
+    };
+    /** Set control items */
+    setControllerOption(opt: ControllerOption): void;
+    /** Set code instructions */
+    setCodeFrame(opt: CodeFrameOption): void;
+    /** Is the error the same */
+    isSame<T extends DevToolErrorInstance>(error: T): boolean;
+}
+export interface DevToolErrorsData {
+    errors: DevToolErrorInstance[];
+    warnings: DevToolErrorInstance[];
+}
+/** Incorrect data input */
+export type DevToolErrorParams = Omit<NonFunctionProperties<DevToolErrorInstance>, 'message' | 'title' | 'path' | 'id'> & {
+    controller?: ControllerOption;
+    codeFrame?: CodeFrameOption;
+};

package/dist/error.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrorLevel = void 0;
+/** Error Level */
+var ErrorLevel;
+(function (ErrorLevel) {
+    ErrorLevel[ErrorLevel["Ignore"] = 0] = "Ignore";
+    ErrorLevel[ErrorLevel["Warn"] = 1] = "Warn";
+    ErrorLevel[ErrorLevel["Error"] = 2] = "Error";
+})(ErrorLevel || (exports.ErrorLevel = ErrorLevel = {}));

package/dist/esbuild.d.ts

@@ -0,0 +1,30 @@
+/** Esbuild Error */
+export interface Error {
+    id: string;
+    pluginName: string;
+    text: string;
+    location: Location | null;
+    notes: Note[];
+    /**
+     * Optional user-specified data that is passed through unmodified. You can
+     * use this to stash the original error, for example.
+     */
+    detail: any;
+}
+interface Note {
+    text: string;
+    location: Location | null;
+}
+interface Location {
+    file: string;
+    namespace: string;
+    /** 1-based */
+    line: number;
+    /** 0-based, in bytes */
+    column: number;
+    /** in bytes */
+    length: number;
+    lineText: string;
+    suggestion: string;
+}
+export {};

package/dist/esbuild.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+export * as Manifest from './manifest';
+export * as Esbuild from './esbuild';
+export * as Babel from './babel';
+export * as Common from './common';
+export * as Err from './error';
+export * as Logger from './logger';
+export * as SDK from './sdk';
+export * as Modules from './modules';
+export * as Linter from './linter';
+export * as Rule from './rule';
+export * as Thirdparty from './thirdparty';
+export * as Client from './client';
+export * as Constants from './constants';
+export * as Plugin from './plugin';

package/dist/index.js

@@ -0,0 +1,40 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Plugin = exports.Constants = exports.Client = exports.Thirdparty = exports.Rule = exports.Linter = exports.Modules = exports.SDK = exports.Logger = exports.Err = exports.Common = exports.Babel = exports.Esbuild = exports.Manifest = void 0;
+exports.Manifest = __importStar(require("./manifest"));
+exports.Esbuild = __importStar(require("./esbuild"));
+exports.Babel = __importStar(require("./babel"));
+exports.Common = __importStar(require("./common"));
+exports.Err = __importStar(require("./error"));
+exports.Logger = __importStar(require("./logger"));
+exports.SDK = __importStar(require("./sdk"));
+exports.Modules = __importStar(require("./modules"));
+exports.Linter = __importStar(require("./linter"));
+exports.Rule = __importStar(require("./rule"));
+exports.Thirdparty = __importStar(require("./thirdparty"));
+exports.Client = __importStar(require("./client"));
+exports.Constants = __importStar(require("./constants"));
+exports.Plugin = __importStar(require("./plugin"));

package/dist/linter/diagnostic.d.ts

@@ -0,0 +1,45 @@
+import { RuleMessage, BaseRuleStoreData, RuleStoreDataItem } from '../rule';
+import { ErrorLevel as Severity, Range, FixData } from '../error';
+export { ErrorLevel as Severity } from '../error';
+export type { Range, OffsetRange, Position, FixData } from '../error';
+/** Diagnostic recommendations */
+export interface Suggestion {
+    description: string;
+    fixData?: FixData;
+}
+/** Error file information */
+export interface ReportDocument {
+    /** file path */
+    path: string;
+    /**  Is it a transformed code */
+    isTransformed?: boolean;
+    /** code content */
+    content: string;
+    range: Range;
+}
+/** Report erroneous data */
+export interface ReportData {
+    /** Error message */
+    message: string;
+    /** Error file information  */
+    document?: ReportDocument;
+    /** Diagnostic suggestiions */
+    suggestions?: Suggestion;
+    /**
+     * Detailed information
+     *   - Mainly additional data provided to the platform.
+     */
+    detail?: any;
+}
+export type ReportDetailData<T extends BaseRuleStoreData> = Omit<T, keyof BaseRuleStoreData> & {
+    /**
+     * Error text
+     * - When this is present, Diagnostic ['message'] will be overwritten
+     */
+    description?: string;
+};
+export interface Diagnostic extends ReportData, Pick<RuleMessage, 'category' | 'code'> {
+    severity: Severity;
+    title: string;
+    detail?: RuleStoreDataItem;
+}

package/dist/linter/diagnostic.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Severity = void 0;
+var error_1 = require("../error");
+Object.defineProperty(exports, "Severity", { enumerable: true, get: function () { return error_1.ErrorLevel; } });

package/dist/linter/index.d.ts

@@ -0,0 +1,2 @@
+export * from './diagnostic';
+export * from './rule';

package/dist/linter/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./diagnostic"), exports);
+__exportStar(require("./rule"), exports);