@teambit/formatter 1.0.228 → 1.0.230

package/artifacts/schema.json

@@ -95,7 +95,11 @@
                     "line": 17,
                     "character": 29
                   },
-                  "name": "EnvsMain"
+                  "name": "EnvsMain",
+                  "componentId": {
+                    "scope": "teambit.envs",
+                    "name": "envs"
+                  }
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -115,7 +119,8 @@
                     "line": 17,
                     "character": 65
                   },
-                  "name": "FormatterService"
+                  "name": "FormatterService",
+                  "internalFilePath": "formatter.service.ts"
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -174,7 +179,11 @@
                       "line": 22,
                       "character": 28
                     },
-                    "name": "Component"
+                    "name": "Component",
+                    "componentId": {
+                      "scope": "teambit.component",
+                      "name": "component"
+                    }
                   }
                 },
                 "isOptional": false,
@@ -256,7 +265,11 @@
                       "line": 31,
                       "character": 27
                     },
-                    "name": "Component"
+                    "name": "Component",
+                    "componentId": {
+                      "scope": "teambit.component",
+                      "name": "component"
+                    }
                   }
                 },
                 "isOptional": false,
@@ -321,7 +334,11 @@
                     "line": 37,
                     "character": 25
                   },
-                  "name": "ExecutionContext"
+                  "name": "ExecutionContext",
+                  "componentId": {
+                    "scope": "teambit.envs",
+                    "name": "envs"
+                  }
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -498,7 +515,11 @@
                         "line": 61,
                         "character": 55
                       },
-                      "name": "EnvsMain"
+                      "name": "EnvsMain",
+                      "componentId": {
+                        "scope": "teambit.envs",
+                        "name": "envs"
+                      }
                     },
                     {
                       "__schema": "TypeRefSchema",
@@ -507,7 +528,11 @@
                         "line": 61,
                         "character": 65
                       },
-                      "name": "CLIMain"
+                      "name": "CLIMain",
+                      "componentId": {
+                        "scope": "teambit.harmony",
+                        "name": "cli"
+                      }
                     },
                     {
                       "__schema": "TypeRefSchema",
@@ -516,7 +541,11 @@
                         "line": 61,
                         "character": 74
                       },
-                      "name": "ComponentMain"
+                      "name": "ComponentMain",
+                      "componentId": {
+                        "scope": "teambit.component",
+                        "name": "component"
+                      }
                     },
                     {
                       "__schema": "TypeRefSchema",
@@ -525,7 +554,11 @@
                         "line": 61,
                         "character": 89
                       },
-                      "name": "LoggerMain"
+                      "name": "LoggerMain",
+                      "componentId": {
+                        "scope": "teambit.harmony",
+                        "name": "logger"
+                      }
                     },
                     {
                       "__schema": "TypeRefSchema",
@@ -534,7 +567,11 @@
                         "line": 61,
                         "character": 101
                       },
-                      "name": "Workspace"
+                      "name": "Workspace",
+                      "componentId": {
+                        "scope": "teambit.workspace",
+                        "name": "workspace"
+                      }
                     }
                   ]
                 },
@@ -1187,7 +1224,11 @@
                     "line": 7,
                     "character": 26
                   },
-                  "name": "BuildContext"
+                  "name": "BuildContext",
+                  "componentId": {
+                    "scope": "teambit.pipelines",
+                    "name": "builder"
+                  }
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -1209,7 +1250,11 @@
                     "line": 7,
                     "character": 49
                   },
-                  "name": "BuiltTaskResult"
+                  "name": "BuiltTaskResult",
+                  "componentId": {
+                    "scope": "teambit.pipelines",
+                    "name": "builder"
+                  }
                 }
               ]
             },
@@ -1241,7 +1286,7 @@
                 "_legacy": {
                   "scope": "teambit.defender",
                   "name": "formatter",
-                  "version": "1.0.228"
+                  "version": "1.0.230"
                 },
                 "_scope": "teambit.defender"
               }
@@ -1287,6 +1332,10 @@
                 "character": 16
               },
               "name": "EnvHandler",
+              "componentId": {
+                "scope": "teambit.envs",
+                "name": "envs"
+              },
               "typeArgs": [
                 {
                   "__schema": "TypeRefSchema",
@@ -1336,7 +1385,7 @@
                 "_legacy": {
                   "scope": "teambit.defender",
                   "name": "formatter",
-                  "version": "1.0.228"
+                  "version": "1.0.230"
                 },
                 "_scope": "teambit.defender"
               }
@@ -1568,7 +1617,11 @@
                       "line": 17,
                       "character": 29
                     },
-                    "name": "EnvsMain"
+                    "name": "EnvsMain",
+                    "componentId": {
+                      "scope": "teambit.envs",
+                      "name": "envs"
+                    }
                   },
                   "isOptional": false,
                   "isSpread": false
@@ -1588,7 +1641,8 @@
                       "line": 17,
                       "character": 65
                     },
-                    "name": "FormatterService"
+                    "name": "FormatterService",
+                    "internalFilePath": "formatter.service.ts"
                   },
                   "isOptional": false,
                   "isSpread": false
@@ -1647,7 +1701,11 @@
                         "line": 22,
                         "character": 28
                       },
-                      "name": "Component"
+                      "name": "Component",
+                      "componentId": {
+                        "scope": "teambit.component",
+                        "name": "component"
+                      }
                     }
                   },
                   "isOptional": false,
@@ -1729,7 +1787,11 @@
                         "line": 31,
                         "character": 27
                       },
-                      "name": "Component"
+                      "name": "Component",
+                      "componentId": {
+                        "scope": "teambit.component",
+                        "name": "component"
+                      }
                     }
                   },
                   "isOptional": false,
@@ -1794,7 +1856,11 @@
                       "line": 37,
                       "character": 25
                     },
-                    "name": "ExecutionContext"
+                    "name": "ExecutionContext",
+                    "componentId": {
+                      "scope": "teambit.envs",
+                      "name": "envs"
+                    }
                   },
                   "isOptional": false,
                   "isSpread": false
@@ -1971,7 +2037,11 @@
                           "line": 61,
                           "character": 55
                         },
-                        "name": "EnvsMain"
+                        "name": "EnvsMain",
+                        "componentId": {
+                          "scope": "teambit.envs",
+                          "name": "envs"
+                        }
                       },
                       {
                         "__schema": "TypeRefSchema",
@@ -1980,7 +2050,11 @@
                           "line": 61,
                           "character": 65
                         },
-                        "name": "CLIMain"
+                        "name": "CLIMain",
+                        "componentId": {
+                          "scope": "teambit.harmony",
+                          "name": "cli"
+                        }
                       },
                       {
                         "__schema": "TypeRefSchema",
@@ -1989,7 +2063,11 @@
                           "line": 61,
                           "character": 74
                         },
-                        "name": "ComponentMain"
+                        "name": "ComponentMain",
+                        "componentId": {
+                          "scope": "teambit.component",
+                          "name": "component"
+                        }
                       },
                       {
                         "__schema": "TypeRefSchema",
@@ -1998,7 +2076,11 @@
                           "line": 61,
                           "character": 89
                         },
-                        "name": "LoggerMain"
+                        "name": "LoggerMain",
+                        "componentId": {
+                          "scope": "teambit.harmony",
+                          "name": "logger"
+                        }
                       },
                       {
                         "__schema": "TypeRefSchema",
@@ -2007,7 +2089,11 @@
                           "line": 61,
                           "character": 101
                         },
-                        "name": "Workspace"
+                        "name": "Workspace",
+                        "componentId": {
+                          "scope": "teambit.workspace",
+                          "name": "workspace"
+                        }
                       }
                     ]
                   },
@@ -2674,7 +2760,11 @@
                       "line": 7,
                       "character": 26
                     },
-                    "name": "BuildContext"
+                    "name": "BuildContext",
+                    "componentId": {
+                      "scope": "teambit.pipelines",
+                      "name": "builder"
+                    }
                   },
                   "isOptional": false,
                   "isSpread": false
@@ -2696,7 +2786,11 @@
                       "line": 7,
                       "character": 49
                     },
-                    "name": "BuiltTaskResult"
+                    "name": "BuiltTaskResult",
+                    "componentId": {
+                      "scope": "teambit.pipelines",
+                      "name": "builder"
+                    }
                   }
                 ]
               },
@@ -2728,7 +2822,7 @@
                   "_legacy": {
                     "scope": "teambit.defender",
                     "name": "formatter",
-                    "version": "1.0.228"
+                    "version": "1.0.230"
                   },
                   "_scope": "teambit.defender"
                 }
@@ -2785,6 +2879,10 @@
                   "character": 16
                 },
                 "name": "EnvHandler",
+                "componentId": {
+                  "scope": "teambit.envs",
+                  "name": "envs"
+                },
                 "typeArgs": [
                   {
                     "__schema": "TypeRefSchema",
@@ -2809,7 +2907,7 @@
   "componentId": {
     "scope": "teambit.defender",
     "name": "formatter",
-    "version": "1.0.228"
+    "version": "1.0.230"
   },
   "taggedModuleExports": []
 }

package/dist/format.cmd.d.ts

@@ -0,0 +1,54 @@
+import { TimerResponse } from '@teambit/legacy/dist/toolbox/timer';
+import { Command, CommandOptions } from '@teambit/cli';
+import { ComponentFactory, ComponentID } from '@teambit/component';
+import { Workspace } from '@teambit/workspace';
+import { FormatterMain } from './formatter.main.runtime';
+import { ComponentFormatResult, FormatResults } from './formatter';
+export type FormatCmdOptions = {
+    changed?: boolean;
+    json?: boolean;
+    check?: boolean;
+};
+/**
+ * A type for result with componentId instead of the entire component, as when output to console, we don't want to print all the component
+ */
+export type JsonComponentFormatResult = Omit<ComponentFormatResult, 'component'> & {
+    componentId: ComponentID;
+};
+export type JsonFormatDataResults = Omit<FormatResults, 'results'> & {
+    results: JsonComponentFormatResult[];
+};
+/**
+ * A type for result with componentId instead of the entire component, as when output to console, we don't want to print all the component
+ */
+export type JsonFormatResults = {
+    duration: TimerResponse;
+    data: JsonFormatDataResults;
+    code: number;
+    componentsIdsToFormat: string[];
+};
+export declare class FormatCmd implements Command {
+    private formatter;
+    private componentHost;
+    private workspace;
+    name: string;
+    description: string;
+    arguments: {
+        name: string;
+        description: string;
+    }[];
+    group: string;
+    helpUrl: string;
+    options: CommandOptions;
+    constructor(formatter: FormatterMain, componentHost: ComponentFactory, workspace: Workspace);
+    report([pattern]: [string], formatterOptions: FormatCmdOptions): Promise<{
+        data: string;
+        code: number;
+    }>;
+    json([pattern]: [string], formatterCmdOptions: FormatCmdOptions): Promise<JsonFormatResults>;
+    private getStatusCode;
+    private getIdsToFormat;
+    private getAllComponentsResultOutput;
+    private getOneComponentResultOutput;
+    private getOneComponentFileResultOutput;
+}

package/dist/format.task.d.ts

@@ -0,0 +1,7 @@
+import { BuildTask, BuiltTaskResult, BuildContext } from '@teambit/builder';
+export declare class FormatTask implements BuildTask {
+    readonly aspectId: string;
+    readonly name: string;
+    constructor(aspectId: string, name?: string);
+    execute(context: BuildContext): Promise<BuiltTaskResult>;
+}

package/dist/formatter-context.d.ts

@@ -0,0 +1,6 @@
+import { ExecutionContext } from '@teambit/envs';
+export type FormatterOptions = {
+    check?: boolean;
+};
+export interface FormatterContext extends ExecutionContext, FormatterOptions {
+}

package/dist/formatter-env-type.d.ts

@@ -0,0 +1,8 @@
+import { EnvHandler } from '@teambit/envs';
+import { Formatter } from './formatter';
+export interface FormatterEnv {
+    /**
+     * return a Formatter instance.
+     */
+    formatter(): EnvHandler<Formatter>;
+}

package/dist/formatter.aspect.d.ts

@@ -0,0 +1,2 @@
+import { Aspect } from '@teambit/harmony';
+export declare const FormatterAspect: Aspect;

package/dist/formatter.composition.d.ts

@@ -0,0 +1 @@
+export declare const Logo: () => import("react/jsx-runtime").JSX.Element;

package/dist/formatter.d.ts

@@ -0,0 +1,36 @@
+import { Component } from '@teambit/component';
+import { FormatterContext } from './formatter-context';
+export type ComponentFormatResult = {
+    /**
+     * the formatted component.
+     */
+    component: Component;
+    /**
+     * format results for each file of the component.
+     */
+    results: FileFormatResult[];
+};
+export type FileFormatResult = {
+    /**
+     * path of the formatted file.
+     */
+    filePath: string;
+    /**
+     * Does the file has formatting issues (needs format)
+     */
+    hasIssues: boolean;
+    /**
+     * The new file content after the formatting
+     */
+    newContent?: string;
+};
+export type FormatResults = {
+    results: ComponentFormatResult[];
+    errors: Error[];
+};
+export interface Formatter {
+    id: string;
+    format(context: FormatterContext): Promise<FormatResults>;
+    formatSnippet(snippet: string, filepath?: string): Promise<string>;
+    check(context: FormatterContext): Promise<FormatResults>;
+}

package/dist/formatter.graphql.d.ts

@@ -0,0 +1,4 @@
+export declare function linterSchema(): {
+    typeDefs: import("graphql").DocumentNode;
+    resolvers: {};
+};

package/dist/formatter.main.runtime.d.ts

@@ -0,0 +1,34 @@
+import { CLIMain } from '@teambit/cli';
+import { Component, ComponentMain } from '@teambit/component';
+import { EnvsMain, ExecutionContext } from '@teambit/envs';
+import { LoggerMain } from '@teambit/logger';
+import { Workspace } from '@teambit/workspace';
+import { FormatterService } from './formatter.service';
+import { FormatTask } from './format.task';
+import { FormatterOptions } from './formatter-context';
+import { Formatter } from './formatter';
+export type FormatterConfig = {};
+export declare class FormatterMain {
+    private envs;
+    private formatterService;
+    static runtime: import("@teambit/harmony").RuntimeDefinition;
+    constructor(envs: EnvsMain, formatterService: FormatterService);
+    /**
+     * format an array of components.
+     */
+    format(components: Component[], opts: FormatterOptions): Promise<import("@teambit/envs").EnvsExecutionResult<import("./formatter").FormatResults>>;
+    /**
+     * check format an array of components.
+     */
+    check(components: Component[], opts: FormatterOptions): Promise<import("@teambit/envs").EnvsExecutionResult<import("./formatter").FormatResults>>;
+    getFormatter(context: ExecutionContext, options: FormatterOptions): Formatter;
+    private toFormatServiceOptions;
+    /**
+     * create a format task for build pipelines.
+     * @param name name of the task.
+     */
+    createTask(name?: string): FormatTask;
+    static dependencies: import("@teambit/harmony").Aspect[];
+    static defaultConfig: FormatterConfig;
+    static provider([envs, cli, component, loggerAspect, workspace]: [EnvsMain, CLIMain, ComponentMain, LoggerMain, Workspace], config: FormatterConfig): Promise<FormatterMain>;
+}

package/dist/formatter.service.d.ts

@@ -0,0 +1,26 @@
+import { EnvService, ExecutionContext, EnvDefinition, Env, EnvContext, ServiceTransformationMap } from '@teambit/envs';
+import { Formatter, FormatResults } from './formatter';
+import { FormatterOptions } from './formatter-context';
+import { FormatterConfig } from './formatter.main.runtime';
+type FormatterTransformationMap = ServiceTransformationMap & {
+    getFormatter: () => Formatter;
+};
+export declare class FormatterService implements EnvService<FormatResults> {
+    private formatterConfig;
+    name: string;
+    constructor(formatterConfig: FormatterConfig);
+    run(context: ExecutionContext, options: FormatterOptions): Promise<FormatResults>;
+    getFormatter(context: ExecutionContext, options: FormatterOptions): Formatter;
+    private optionsWithDefaults;
+    private mergeContext;
+    render(env: EnvDefinition): string;
+    transform(env: Env, context: EnvContext): FormatterTransformationMap | undefined;
+    getDescriptor(env: EnvDefinition): {
+        id: any;
+        icon: any;
+        config: any;
+        version: any;
+        displayName: any;
+    } | undefined;
+}
+export {};

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import { FormatterAspect } from './formatter.aspect';
+export { FormatterAspect };
+export type { FormatterMain, FormatterConfig } from './formatter.main.runtime';
+export type { FormatResults, Formatter, FileFormatResult, ComponentFormatResult } from './formatter';
+export type { FormatTask } from './format.task';
+export type { FormatterEnv } from './formatter-env-type';
+export type { FormatterContext, FormatterOptions } from './formatter-context';
+export default FormatterAspect;

package/dist/{preview-1712805335812.js → preview-1712891953391.js}

@@ -1,5 +1,5 @@
-import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.defender_formatter@1.0.228/dist/formatter.composition.js';
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.defender_formatter@1.0.228/dist/formatter.docs.mdx';
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.defender_formatter@1.0.230/dist/formatter.composition.js';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.defender_formatter@1.0.230/dist/formatter.docs.mdx';
 
 export const compositions = [compositions_0];
 export const overview = [overview_0];

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/formatter",
-  "version": "1.0.228",
+  "version": "1.0.230",
   "homepage": "https://bit.cloud/teambit/defender/formatter",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.defender",
     "name": "formatter",
-    "version": "1.0.228"
+    "version": "1.0.230"
   },
   "dependencies": {
     "chalk": "2.4.2",
@@ -14,19 +14,19 @@
     "graphql-tag": "2.12.1",
     "cli-highlight": "2.1.9",
     "@teambit/harmony": "0.4.6",
-    "@teambit/cli": "0.0.861",
-    "@teambit/component": "1.0.228",
-    "@teambit/envs": "1.0.228",
-    "@teambit/workspace": "1.0.228",
-    "@teambit/builder": "1.0.228",
-    "@teambit/logger": "0.0.954"
+    "@teambit/cli": "0.0.862",
+    "@teambit/component": "1.0.230",
+    "@teambit/envs": "1.0.230",
+    "@teambit/workspace": "1.0.230",
+    "@teambit/builder": "1.0.230",
+    "@teambit/logger": "0.0.955"
   },
   "devDependencies": {
     "@types/lodash": "4.14.165",
     "@types/mocha": "9.1.0",
     "chai": "4.3.0",
     "@teambit/defender.content.formatter-overview": "1.96.1",
-    "@teambit/harmony.envs.core-aspect-env": "0.0.30"
+    "@teambit/harmony.envs.core-aspect-env": "0.0.33"
   },
   "peerDependencies": {
     "react": "^17.0.0 || ^18.0.0",

package/tsconfig.json

@@ -20,8 +20,7 @@
     "emitDeclarationOnly": true,
     "strict": true,
     "strictPropertyInitialization": false,
-    "noImplicitAny": false,
-    "composite": true
+    "noImplicitAny": false
   },
   "exclude": [
     "artifacts",
@@ -36,25 +35,5 @@
   "include": [
     "**/*",
     "**/*.json"
-  ],
-  "references": [
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cli@0.0.861"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_component@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.envs_envs@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.workspace_workspace@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.pipelines_builder@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_logger@0.0.954"
-    }
   ]
 }