@teambit/formatter 1.0.108 → 1.0.109

package/dist/{preview-1703647408454.js → preview-1703698405864.js}

@@ -1,5 +1,5 @@
-import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.defender_formatter@1.0.108/dist/formatter.composition.js';
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.defender_formatter@1.0.108/dist/formatter.docs.mdx';
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.defender_formatter@1.0.109/dist/formatter.composition.js';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.defender_formatter@1.0.109/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.108",
+  "version": "1.0.109",
   "homepage": "https://bit.cloud/teambit/defender/formatter",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.defender",
     "name": "formatter",
-    "version": "1.0.108"
+    "version": "1.0.109"
   },
   "dependencies": {
     "chalk": "2.4.2",
@@ -15,12 +15,12 @@
     "cli-highlight": "2.1.9",
     "ink": "3.2.0",
     "@teambit/harmony": "0.4.6",
-    "@teambit/cli": "0.0.840",
-    "@teambit/component": "1.0.108",
-    "@teambit/envs": "1.0.108",
-    "@teambit/workspace": "1.0.108",
-    "@teambit/builder": "1.0.108",
-    "@teambit/logger": "0.0.933"
+    "@teambit/cli": "0.0.841",
+    "@teambit/component": "1.0.109",
+    "@teambit/envs": "1.0.109",
+    "@teambit/workspace": "1.0.109",
+    "@teambit/builder": "1.0.109",
+    "@teambit/logger": "0.0.934"
   },
   "devDependencies": {
     "@types/lodash": "4.14.165",
@@ -28,7 +28,7 @@
     "@types/jest": "^29.2.2",
     "@types/testing-library__jest-dom": "^5.9.5",
     "@teambit/defender.content.formatter-overview": "1.96.1",
-    "@teambit/harmony.envs.core-aspect-env": "0.0.13"
+    "@teambit/harmony.envs.core-aspect-env": "0.0.14"
   },
   "peerDependencies": {
     "react": "^17.0.0 || ^18.0.0",

package/format.cmd.ts

@@ -1,155 +0,0 @@
-import { TimerResponse, Timer } from '@teambit/legacy/dist/toolbox/timer';
-import { Command, CommandOptions } from '@teambit/cli';
-import { ComponentFactory, ComponentID } from '@teambit/component';
-import chalk from 'chalk';
-import { EnvsExecutionResult } from '@teambit/envs';
-import { Workspace } from '@teambit/workspace';
-import { compact, flatten } from 'lodash';
-import { FormatterMain } from './formatter.main.runtime';
-import { ComponentFormatResult, FormatResults, FileFormatResult } from './formatter';
-import { FormatterOptions } from './formatter-context';
-
-export type FormatCmdOptions = {
-  changed?: boolean;
-  json?: boolean;
-  check?: boolean;
-};
-
-type OutputContext = {
-  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 class FormatCmd implements Command {
-  name = 'format [component...]';
-  description = 'format components in the development workspace';
-  group = 'development';
-  helpUrl = 'reference/formatting/formatter-overview';
-  options = [
-    ['c', 'changed', 'format only new and modified components'],
-    ['', 'check', 'will output a human-friendly message and a list of unformatted files, if any'],
-    ['j', 'json', 'return the format results in json format'],
-  ] as CommandOptions;
-
-  constructor(
-    private formatter: FormatterMain,
-    private componentHost: ComponentFactory,
-    private workspace: Workspace
-  ) {}
-
-  async report([components = []]: [string[]], formatterOptions: FormatCmdOptions) {
-    const { duration, data, code, componentsIdsToFormat } = await this.json([components], formatterOptions);
-
-    const title = chalk.bold(
-      `formatting total of ${chalk.cyan(
-        componentsIdsToFormat.length.toString()
-      )} component(s) in workspace '${chalk.cyan(this.componentHost.name)}`
-    );
-
-    const componentsOutputs = this.getAllComponentsResultOutput(data.results, { check: formatterOptions.check });
-
-    const { seconds } = duration;
-    const summery = `formatted ${chalk.cyan(componentsIdsToFormat.length.toString())} components in ${chalk.cyan(
-      seconds.toString()
-    )}.`;
-
-    return {
-      data: `${title}\n\n${componentsOutputs}\n\n${summery}`,
-      code,
-    };
-  }
-
-  async json([components = []]: [string[]], formatterCmdOptions: FormatCmdOptions): Promise<JsonFormatResults> {
-    const timer = Timer.create();
-    timer.start();
-    const componentsIds = await this.getIdsToFormat(components, formatterCmdOptions.changed);
-    const componentsToFormat = await this.workspace.getMany(componentsIds);
-    const opts: FormatterOptions = {};
-    const formatterResults = formatterCmdOptions.check
-      ? await this.formatter.check(componentsToFormat, opts)
-      : await this.formatter.format(componentsToFormat, opts);
-    const jsonFormatterResults = toJsonFormatResults(formatterResults);
-    const timerResponse = timer.stop();
-    const statusCode = this.getStatusCode(jsonFormatterResults, formatterCmdOptions.check);
-
-    return {
-      duration: timerResponse,
-      data: jsonFormatterResults,
-      code: statusCode,
-      componentsIdsToFormat: componentsToFormat.map((comp) => comp.id.toString()),
-    };
-  }
-
-  private getStatusCode(results: JsonFormatDataResults, check = false): number {
-    if (!check) return 0;
-    const hasIssues = results.results.some((comp) => comp.results.some((file) => file.hasIssues));
-    if (hasIssues) return 1;
-    return 0;
-  }
-
-  private async getIdsToFormat(components: string[], changed = false): Promise<ComponentID[]> {
-    if (components.length) {
-      return this.workspace.resolveMultipleComponentIds(components);
-    }
-    if (changed) {
-      return this.workspace.getNewAndModifiedIds();
-    }
-    return this.componentHost.listIds();
-  }
-
-  private getAllComponentsResultOutput(componentsResult: JsonComponentFormatResult[], context: OutputContext) {
-    const allResults = componentsResult.map((comp) => this.getOneComponentResultOutput(comp, context));
-    return allResults.join('\n\n');
-  }
-
-  private getOneComponentResultOutput(componentResult: JsonComponentFormatResult, context: OutputContext) {
-    const title = chalk.bold.cyan(componentResult.componentId.toString({ ignoreVersion: true }));
-    const filesWithIssues = componentResult.results.filter((fileResult) => fileResult.hasIssues);
-    if (!filesWithIssues || !filesWithIssues.length) {
-      return `${title}\n${chalk.green('no issues found')}`;
-    }
-    let subTitle = chalk.green('the following files have been re-formatted:');
-    if (context.check) {
-      subTitle = chalk.red('issues found in the following files:');
-    }
-    const files = filesWithIssues.map(this.getOneComponentFileResultOutput);
-    return `${title}\n${subTitle}\n${files.join('\n')}`;
-  }
-
-  private getOneComponentFileResultOutput(fileResult: FileFormatResult) {
-    return fileResult.filePath;
-  }
-}
-
-function toJsonFormatResults(results: EnvsExecutionResult<FormatResults>): JsonFormatDataResults {
-  const newResults = results.results.map((res) => {
-    const resultsWithoutComponent = res.data?.results.map((result) => {
-      return {
-        componentId: result.component.id,
-        results: result.results,
-      };
-    });
-    return compact(resultsWithoutComponent);
-  });
-  return {
-    results: compact(flatten(newResults)),
-    errors: results?.errors,
-  };
-}

package/format.task.ts

@@ -1,25 +0,0 @@
-import { BuildTask, BuiltTaskResult, BuildContext, ComponentResult } from '@teambit/builder';
-import { Formatter } from './formatter';
-
-export class FormatTask implements BuildTask {
-  constructor(readonly aspectId: string, readonly name = 'format') {}
-
-  async execute(context: BuildContext): Promise<BuiltTaskResult> {
-    const formatter: Formatter = context.env.getFormatter();
-    // TODO: add option to select between check and format here
-    const results = await formatter.check(context);
-    const componentsResults = results.results.map((formatResult): ComponentResult => {
-      return {
-        component: formatResult.component,
-        metadata: {
-          results: formatResult.results,
-        },
-        errors: [],
-      };
-    });
-
-    return {
-      componentsResults,
-    };
-  }
-}

package/formatter-context.ts

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

package/formatter-env-type.ts

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

package/formatter.aspect.ts

@@ -1,5 +0,0 @@
-import { Aspect } from '@teambit/harmony';
-
-export const FormatterAspect = Aspect.create({
-  id: 'teambit.defender/formatter',
-});

package/formatter.graphql.ts

@@ -1,8 +0,0 @@
-import gql from 'graphql-tag';
-
-export function linterSchema() {
-  return {
-    typeDefs: gql``,
-    resolvers: {},
-  };
-}

package/formatter.main.runtime.ts

@@ -1,75 +0,0 @@
-import { CLIAspect, CLIMain, MainRuntime } from '@teambit/cli';
-import { Component, ComponentAspect, ComponentMain } from '@teambit/component';
-import { EnvsAspect, EnvsMain, ExecutionContext } from '@teambit/envs';
-import { LoggerAspect, LoggerMain } from '@teambit/logger';
-import { Workspace, WorkspaceAspect } from '@teambit/workspace';
-import { FormatterAspect } from './formatter.aspect';
-import { FormatterService } from './formatter.service';
-import { FormatTask } from './format.task';
-import { FormatCmd } from './format.cmd';
-import { FormatterOptions } from './formatter-context';
-import { Formatter } from './formatter';
-
-export type FormatterConfig = {};
-export class FormatterMain {
-  static runtime = MainRuntime;
-
-  constructor(private envs: EnvsMain, private formatterService: FormatterService) {}
-
-  /**
-   * format an array of components.
-   */
-  async format(components: Component[], opts: FormatterOptions) {
-    const envsRuntime = await this.envs.createEnvironment(components);
-    const formatResults = envsRuntime.run(this.formatterService, this.toFormatServiceOptions(opts, false));
-    return formatResults;
-  }
-
-  /**
-   * check format an array of components.
-   */
-  async check(components: Component[], opts: FormatterOptions) {
-    const envsRuntime = await this.envs.createEnvironment(components);
-    const formatResults = envsRuntime.run(this.formatterService, this.toFormatServiceOptions(opts, true));
-    return formatResults;
-  }
-
-  getFormatter(context: ExecutionContext, options: FormatterOptions): Formatter {
-    return this.formatterService.getFormatter(context, options);
-  }
-
-  private toFormatServiceOptions(opts: FormatterOptions, check = false): FormatterOptions {
-    return {
-      ...opts,
-      check,
-    };
-  }
-
-  /**
-   * create a format task for build pipelines.
-   * @param name name of the task.
-   */
-  createTask(name?: string): FormatTask {
-    return new FormatTask(FormatterAspect.id, name);
-  }
-
-  static dependencies = [EnvsAspect, CLIAspect, ComponentAspect, LoggerAspect, WorkspaceAspect];
-
-  static defaultConfig: FormatterConfig = {};
-
-  static async provider(
-    [envs, cli, component, loggerAspect, workspace]: [EnvsMain, CLIMain, ComponentMain, LoggerMain, Workspace],
-    config: FormatterConfig
-  ) {
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const logger = loggerAspect.createLogger(FormatterAspect.id);
-    const formatterService = new FormatterService(config);
-    const formatterAspect = new FormatterMain(envs, formatterService);
-    envs.registerService(formatterService);
-    cli.register(new FormatCmd(formatterAspect, component.getHost(), workspace));
-
-    return formatterAspect;
-  }
-}
-
-FormatterAspect.addRuntime(FormatterMain);

package/formatter.ts

@@ -1,43 +0,0 @@
-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/index.ts

@@ -1,9 +0,0 @@
-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;