@teambit/prettier 1.0.107 → 1.0.108

package/dist/prettier.composition.d.ts

@@ -1,2 +1,2 @@
-import React from 'react';
-export declare const Logo: () => React.JSX.Element;
+/// <reference types="react" />
+export declare const Logo: () => JSX.Element;

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

@@ -3,16 +3,16 @@ import { Formatter, FormatterMain, FormatterOptions } from '@teambit/formatter';
 import { Logger, LoggerMain } from '@teambit/logger';
 import { PrettierConfigMutator } from '@teambit/defender.prettier.config-mutator';
 import { WorkspaceConfigFilesMain } from '@teambit/workspace-config-files';
-export declare type PrettierOptions = {
+export type PrettierOptions = {
     /**
      * formatter config for prettier.
      */
     config: PrettierModuleOptions;
 };
-export declare type PrettierConfigTransformContext = {
+export type PrettierConfigTransformContext = {
     check: boolean;
 };
-export declare type PrettierConfigTransformer = (config: PrettierConfigMutator, context: PrettierConfigTransformContext) => PrettierConfigMutator;
+export type PrettierConfigTransformer = (config: PrettierConfigMutator, context: PrettierConfigTransformContext) => PrettierConfigMutator;
 export declare class PrettierMain {
     private logger;
     constructor(logger: Logger);
@@ -21,9 +21,9 @@ export declare class PrettierMain {
      * @param options prettier options.
      * @param PrettierModule reference to an `prettier` module.
      */
-    createFormatter(formatterOptions: FormatterOptions | undefined, options: PrettierOptions, transformers?: PrettierConfigTransformer[], PrettierModule?: any): Formatter;
+    createFormatter(formatterOptions: FormatterOptions, options: PrettierOptions, transformers?: PrettierConfigTransformer[], PrettierModule?: any): Formatter;
     static runtime: import("@teambit/harmony").RuntimeDefinition;
     static dependencies: import("@teambit/harmony").Aspect[];
     static provider([loggerExt]: [LoggerMain, FormatterMain, WorkspaceConfigFilesMain]): Promise<PrettierMain>;
 }
-export declare function runTransformersWithContext(config: PrettierConfigMutator, transformers: PrettierConfigTransformer[] | undefined, context: PrettierConfigTransformContext): PrettierConfigMutator;
+export declare function runTransformersWithContext(config: PrettierConfigMutator, transformers: PrettierConfigTransformer[], context: PrettierConfigTransformContext): PrettierConfigMutator;

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

@@ -1,4 +1,4 @@
-import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.defender_prettier@1.0.107/dist/prettier.composition.js';
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.defender_prettier@1.0.108/dist/prettier.composition.js';
 ;
 
 export const compositions = [compositions_0];

package/index.ts

@@ -0,0 +1,10 @@
+import { PrettierAspect } from './prettier.aspect';
+
+export { PrettierAspect };
+export type {
+  PrettierMain,
+  PrettierOptions,
+  PrettierConfigTransformer,
+  PrettierConfigTransformContext,
+} from './prettier.main.runtime';
+export default PrettierAspect;

package/package.json

@@ -1,39 +1,35 @@
 {
   "name": "@teambit/prettier",
-  "version": "1.0.107",
+  "version": "1.0.108",
   "homepage": "https://bit.cloud/teambit/defender/prettier",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.defender",
     "name": "prettier",
-    "version": "1.0.107"
+    "version": "1.0.108"
   },
   "dependencies": {
     "p-map-series": "2.1.0",
     "prettier": "2.3.2",
-    "core-js": "^3.0.0",
-    "@babel/runtime": "7.20.0",
     "@teambit/harmony": "0.4.6",
-    "@teambit/envs": "1.0.107",
-    "@teambit/formatter": "1.0.107",
-    "@teambit/logger": "0.0.932",
-    "@teambit/cli": "0.0.839",
+    "@teambit/envs": "1.0.108",
+    "@teambit/formatter": "1.0.108",
+    "@teambit/logger": "0.0.933",
+    "@teambit/cli": "0.0.840",
     "@teambit/defender.prettier.config-mutator": "0.0.94",
-    "@teambit/workspace-config-files": "1.0.107"
+    "@teambit/workspace-config-files": "1.0.108"
   },
   "devDependencies": {
-    "@types/react": "^17.0.8",
     "@types/prettier": "2.3.2",
     "@types/mocha": "9.1.0",
-    "@types/node": "12.20.4",
-    "@types/react-dom": "^17.0.5",
-    "@types/jest": "^26.0.0",
-    "@types/testing-library__jest-dom": "5.9.5"
+    "@types/jest": "^29.2.2",
+    "@types/testing-library__jest-dom": "^5.9.5",
+    "@teambit/harmony.envs.core-aspect-env": "0.0.13"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.624",
-    "react": "^16.8.0 || ^17.0.0",
-    "react-dom": "^16.8.0 || ^17.0.0"
+    "react": "^17.0.0 || ^18.0.0",
+    "@types/react": "^18.2.12",
+    "@teambit/legacy": "1.0.624"
   },
   "license": "Apache-2.0",
   "optionalDependencies": {},
@@ -47,7 +43,7 @@
   },
   "private": false,
   "engines": {
-    "node": ">=12.22.0"
+    "node": ">=16.0.0"
   },
   "repository": {
     "type": "git",
@@ -56,12 +52,9 @@
   "keywords": [
     "bit",
     "bit-aspect",
+    "bit-core-aspect",
     "components",
     "collaboration",
-    "web",
-    "react",
-    "react-components",
-    "angular",
-    "angular-components"
+    "web"
   ]
 }

package/prettier.aspect.ts

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

package/prettier.formatter.ts

@@ -0,0 +1,120 @@
+import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
+import {
+  Formatter,
+  FormatterContext,
+  FormatResults,
+  FileFormatResult,
+  ComponentFormatResult,
+} from '@teambit/formatter';
+import PrettierLib, { Options as PrettierModuleOptions } from 'prettier';
+import mapSeries from 'p-map-series';
+import { Logger } from '@teambit/logger';
+import { ExecutionContext } from '@teambit/envs';
+// import { PrettierOptions } from './prettier.main.runtime';
+
+export class PrettierFormatter implements Formatter {
+  constructor(
+    private logger: Logger,
+
+    private options: PrettierModuleOptions,
+
+    /**
+     * reference to the prettier module.
+     */
+    private prettierModule = PrettierLib
+  ) {}
+
+  id = 'prettier-formatter';
+  displayName = 'Prettier';
+
+  displayConfig() {
+    return JSON.stringify(this.options, null, 2);
+  }
+
+  async format(context: FormatterContext): Promise<FormatResults> {
+    return this.run(context);
+  }
+
+  async formatSnippet(snippet: string, filePath?: string): Promise<string> {
+    let parser;
+
+    if (filePath) {
+      const ext = filePath.split('.').pop();
+      const supportInfo = this.prettierModule.getSupportInfo();
+      const language = supportInfo.languages.find((lang) => lang.extensions && lang.extensions.includes(`.${ext}`));
+
+      if (language) {
+        parser = language.parsers[0];
+      }
+    }
+
+    parser = parser || 'babel';
+
+    const optsWithFilePath = Object.assign({}, this.options, { filepath: filePath, parser });
+
+    return this.prettierModule.format(snippet, optsWithFilePath);
+  }
+
+  async check(context: FormatterContext): Promise<FormatResults> {
+    return this.run(context);
+  }
+
+  private async run(context: FormatterContext & ExecutionContext): Promise<FormatResults> {
+    const check = !!context.check;
+    const longProcessLogger = this.logger.createLongProcessLogger('formatting components', context.components.length);
+    const resultsP = mapSeries(context.components, async (component): Promise<ComponentFormatResult> => {
+      longProcessLogger.logProgress(component.id.toString());
+      const mergedOpts = this.getOptions(this.options, context);
+      const filesP = component.filesystem.files.map(async (file): Promise<FileFormatResult> => {
+        const sourceCode = file.contents.toString('utf8');
+        const optsWithFilePath = this.addFilePathToOpts(mergedOpts, file);
+        const checkFormatResults = await this.prettierModule.check(sourceCode, optsWithFilePath);
+        const formatResults = await this.prettierModule.format(sourceCode, optsWithFilePath);
+
+        const hasIssues = !checkFormatResults;
+        const newContent = typeof formatResults === 'string' && hasIssues ? formatResults : undefined;
+
+        if (!check && newContent) {
+          file.contents = Buffer.from(newContent);
+          await file.write(undefined, true);
+        }
+
+        return {
+          filePath: file.relative,
+          hasIssues,
+          newContent,
+        };
+      });
+
+      const files = await Promise.all(filesP);
+
+      return {
+        component,
+        results: files,
+      };
+    });
+
+    const results = await resultsP;
+
+    return {
+      results,
+      errors: [],
+    };
+  }
+
+  /**
+   * get options for eslint.
+   */
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  private getOptions(options: PrettierModuleOptions, context: FormatterContext): PrettierModuleOptions {
+    return options;
+  }
+
+  private addFilePathToOpts(options: PrettierModuleOptions, file: AbstractVinyl): PrettierModuleOptions {
+    return Object.assign({}, options, { filepath: file.path });
+  }
+
+  version() {
+    return this.prettierModule.version;
+  }
+}

package/prettier.main.runtime.ts

@@ -0,0 +1,67 @@
+import { MainRuntime } from '@teambit/cli';
+import { Options as PrettierModuleOptions } from 'prettier';
+import { Formatter, FormatterMain, FormatterOptions } from '@teambit/formatter';
+import { Logger, LoggerAspect, LoggerMain } from '@teambit/logger';
+import { PrettierConfigMutator } from '@teambit/defender.prettier.config-mutator';
+import { WorkspaceConfigFilesMain } from '@teambit/workspace-config-files';
+import { PrettierAspect } from './prettier.aspect';
+import { PrettierFormatter } from './prettier.formatter';
+
+export type PrettierOptions = {
+  /**
+   * formatter config for prettier.
+   */
+  config: PrettierModuleOptions;
+};
+
+export type PrettierConfigTransformContext = {
+  check: boolean;
+};
+
+export type PrettierConfigTransformer = (
+  config: PrettierConfigMutator,
+  context: PrettierConfigTransformContext
+) => PrettierConfigMutator;
+
+export class PrettierMain {
+  constructor(private logger: Logger) {}
+  /**
+   * create a prettier formatter instance.
+   * @param options prettier options.
+   * @param PrettierModule reference to an `prettier` module.
+   */
+  createFormatter(
+    formatterOptions: FormatterOptions = {},
+    options: PrettierOptions,
+    transformers: PrettierConfigTransformer[] = [],
+    PrettierModule?: any
+  ): Formatter {
+    const configMutator = new PrettierConfigMutator(options.config);
+    const transformerContext: PrettierConfigTransformContext = { check: !!formatterOptions.check };
+    const afterMutation = runTransformersWithContext(configMutator.clone(), transformers, transformerContext);
+    return new PrettierFormatter(this.logger, afterMutation.raw, PrettierModule);
+  }
+
+  static runtime = MainRuntime;
+
+  static dependencies = [LoggerAspect];
+
+  static async provider([loggerExt]: [LoggerMain, FormatterMain, WorkspaceConfigFilesMain]): Promise<PrettierMain> {
+    const logger = loggerExt.createLogger(PrettierAspect.id);
+    return new PrettierMain(logger);
+  }
+}
+
+PrettierAspect.addRuntime(PrettierMain);
+
+export function runTransformersWithContext(
+  config: PrettierConfigMutator,
+  transformers: PrettierConfigTransformer[] = [],
+  context: PrettierConfigTransformContext
+): PrettierConfigMutator {
+  if (!Array.isArray(transformers)) return config;
+  const newConfig = transformers.reduce((acc, transformer) => {
+    return transformer(acc, context);
+  }, config);
+  return newConfig;
+}

package/tsconfig.json

@@ -1,38 +1,33 @@
 {
   "compilerOptions": {
     "lib": [
-      "es2019",
-      "DOM",
-      "ES6",
-      "DOM.Iterable",
-      "ScriptHost"
+      "esnext",
+      "dom",
+      "dom.Iterable"
     ],
-    "target": "es2015",
-    "module": "CommonJS",
-    "jsx": "react",
-    "allowJs": true,
-    "composite": true,
+    "target": "es2020",
+    "module": "es2020",
+    "jsx": "react-jsx",
     "declaration": true,
     "sourceMap": true,
-    "skipLibCheck": true,
     "experimentalDecorators": true,
-    "outDir": "dist",
+    "skipLibCheck": true,
     "moduleResolution": "node",
     "esModuleInterop": true,
-    "rootDir": ".",
     "resolveJsonModule": true,
-    "emitDeclarationOnly": true,
-    "emitDecoratorMetadata": true,
-    "allowSyntheticDefaultImports": true,
-    "strictPropertyInitialization": false,
-    "strict": true,
-    "noImplicitAny": false,
-    "preserveConstEnums": true
+    "allowJs": true,
+    "outDir": "dist",
+    "emitDeclarationOnly": true
   },
   "exclude": [
+    "artifacts",
+    "public",
     "dist",
+    "node_modules",
+    "package.json",
     "esm.mjs",
-    "package.json"
+    "**/*.cjs",
+    "./dist"
   ],
   "include": [
     "**/*",

package/types/asset.d.ts

@@ -5,12 +5,12 @@ declare module '*.png' {
 declare module '*.svg' {
   import type { FunctionComponent, SVGProps } from 'react';
 
-  export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
+  export const ReactComponent: FunctionComponent<
+    SVGProps<SVGSVGElement> & { title?: string }
+  >;
   const src: string;
   export default src;
 }
-
-// @TODO Gilad
 declare module '*.jpg' {
   const value: any;
   export = value;
@@ -27,3 +27,15 @@ declare module '*.bmp' {
   const value: any;
   export = value;
 }
+declare module '*.otf' {
+  const value: any;
+  export = value;
+}
+declare module '*.woff' {
+  const value: any;
+  export = value;
+}
+declare module '*.woff2' {
+  const value: any;
+  export = value;
+}