@teambit/linter 0.0.555 → 0.0.559

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/linter",
-  "version": "0.0.555",
+  "version": "0.0.559",
   "homepage": "https://bit.dev/teambit/defender/linter",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.defender",
     "name": "linter",
-    "version": "0.0.555"
+    "version": "0.0.559"
   },
   "dependencies": {
     "chalk": "2.4.2",
@@ -17,12 +17,12 @@
     "ink": "3.0.8",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/cli": "0.0.386",
-    "@teambit/component": "0.0.555",
-    "@teambit/envs": "0.0.555",
-    "@teambit/workspace": "0.0.555",
-    "@teambit/builder": "0.0.555",
-    "@teambit/logger": "0.0.471"
+    "@teambit/cli": "0.0.389",
+    "@teambit/component": "0.0.559",
+    "@teambit/envs": "0.0.559",
+    "@teambit/workspace": "0.0.559",
+    "@teambit/builder": "0.0.559",
+    "@teambit/logger": "0.0.474"
   },
   "devDependencies": {
     "@types/lodash": "4.14.165",
@@ -34,7 +34,7 @@
     "@types/node": "12.20.4"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.172",
+    "@teambit/legacy": "1.0.175",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -62,12 +62,27 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.172",
+        "@teambit/legacy": "1.0.175",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }
     }
   },
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo",
+    "**/*.md",
+    "**/*.mdx",
+    "**/*.js",
+    "**/*.json",
+    "**/*.sass",
+    "**/*.scss",
+    "**/*.less",
+    "**/*.css",
+    "**/*.css",
+    "**/*.jpeg",
+    "**/*.gif"
+  ],
   "private": false,
   "engines": {
     "node": ">=12.22.0"

package/tsconfig.json

@@ -15,9 +15,9 @@
     "skipLibCheck": true,
     "moduleResolution": "node",
     "esModuleInterop": true,
-    "outDir": "dist",
     "composite": true,
     "emitDeclarationOnly": true,
+    "outDir": "dist",
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
     "allowSyntheticDefaultImports": true,

package/index.ts

@@ -1,8 +0,0 @@
-import { LinterAspect } from './linter.aspect';
-
-export { LinterAspect };
-export type { LinterMain, LinterConfig } from './linter.main.runtime';
-export { LintResults, Linter, LintResult, ComponentLintResult } from './linter';
-export type { LintTask } from './lint.task';
-export type { LinterContext, LinterOptions } from './linter-context';
-export default LinterAspect;

package/lint.cmd.ts

@@ -1,144 +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, omit } from 'lodash';
-import { LinterMain } from './linter.main.runtime';
-import { ComponentLintResult, LintResults } from './linter';
-import { FixTypes, LinterOptions } from './linter-context';
-
-export type LintCmdOptions = {
-  changed?: boolean;
-  fix?: boolean;
-  fixType?: string;
-  json?: 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 JsonComponentLintResult = Omit<ComponentLintResult, 'component'> & {
-  componentId: ComponentID;
-};
-
-export type JsonLintDataResults = Omit<LintResults, 'results'> & { results: JsonComponentLintResult[] };
-/**
- * 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 JsonLintResults = {
-  code: number;
-  data: {
-    duration: TimerResponse;
-    lintResults: JsonLintDataResults;
-    componentsIdsToLint: string[];
-  };
-};
-
-export class LintCmd implements Command {
-  name = 'lint [component...]';
-  description = 'lint components in the development workspace';
-  group = 'development';
-  options = [
-    ['c', 'changed', 'lint only new and modified components'],
-    ['f', 'fix', 'automatically fix problems'],
-    ['', 'fix-type <fixType>', 'specify the types of fixes to apply (problem, suggestion, layout)'],
-    ['j', 'json', 'return the lint results in json format'],
-  ] as CommandOptions;
-
-  constructor(private linter: LinterMain, private componentHost: ComponentFactory, private workspace: Workspace) {}
-
-  async report([components = []]: [string[]], linterOptions: LintCmdOptions) {
-    const { code, data } = await this.json([components], linterOptions);
-    const { duration, lintResults, componentsIdsToLint } = data;
-    const title = chalk.bold(
-      `linting total of ${chalk.cyan(componentsIdsToLint.length.toString())} component(s) in workspace '${chalk.cyan(
-        this.componentHost.name
-      )}'`
-    );
-
-    const componentsOutputs = lintResults.results
-      .map((lintRes) => {
-        const compTitle = chalk.bold.cyan(lintRes.componentId.toString({ ignoreVersion: true }));
-        const compOutput = lintRes.output;
-        return `${compTitle}\n${compOutput}`;
-      })
-      .join('\n');
-
-    const { seconds } = duration;
-    const summery = `linted ${chalk.cyan(componentsIdsToLint.length.toString())} components in ${chalk.cyan(
-      seconds.toString()
-    )}.`;
-    return { code, data: `${title}\n\n${componentsOutputs}\n\n${summery}` };
-  }
-
-  async json([components = []]: [string[]], linterOptions: LintCmdOptions): Promise<JsonLintResults> {
-    const timer = Timer.create();
-    timer.start();
-    const componentsIds = await this.getIdsToLint(components, linterOptions.changed);
-    const componentsToLint = await this.workspace.getMany(componentsIds);
-    const opts: LinterOptions = {
-      fix: linterOptions.fix,
-      fixTypes: linterOptions.fixType ? (linterOptions.fixType.split(',') as FixTypes) : undefined,
-    };
-    const linterResults = await this.linter.lint(componentsToLint, opts);
-    const jsonLinterResults = toJsonLintResults(linterResults);
-    // console.log('jsonLinterResults', JSON.stringify(jsonLinterResults, null, 2));
-    const timerResponse = timer.stop();
-    let code = 0;
-    if (jsonLinterResults.totalErrorCount || jsonLinterResults.totalFatalErrorCount) {
-      code = 1;
-    }
-    return {
-      code,
-      data: {
-        duration: timerResponse,
-        lintResults: jsonLinterResults,
-        componentsIdsToLint: componentsToLint.map((comp) => comp.id.toString()),
-      },
-    };
-  }
-
-  private async getIdsToLint(components: string[], changed = false): Promise<ComponentID[]> {
-    if (components.length) {
-      return this.workspace.resolveMultipleComponentIds(components);
-    }
-    if (changed) {
-      return this.workspace.getNewAndModifiedIds();
-    }
-    return this.componentHost.listIds();
-  }
-}
-
-function toJsonLintResults(results: EnvsExecutionResult<LintResults>): JsonLintDataResults {
-  let totalErrorCount = 0;
-  let totalFatalErrorCount = 0;
-  let totalFixableErrorCount = 0;
-  let totalFixableWarningCount = 0;
-  let totalWarningCount = 0;
-  const newResults = results.results.map((res) => {
-    const resultsWithoutComponent = res.data?.results.map((result) => {
-      return Object.assign({}, { componentId: result.component.id }, omit(result, ['component']));
-    });
-
-    if (res.data) {
-      totalErrorCount += res.data.totalErrorCount ?? 0;
-      totalFatalErrorCount += res.data.totalFatalErrorCount ?? 0;
-      totalFixableErrorCount += res.data.totalFixableErrorCount ?? 0;
-      totalFixableWarningCount += res.data.totalFixableWarningCount ?? 0;
-      totalWarningCount += res.data.totalWarningCount ?? 0;
-    }
-
-    return compact(resultsWithoutComponent);
-  });
-  return {
-    results: compact(flatten(newResults)),
-    totalErrorCount,
-    totalFatalErrorCount,
-    totalFixableErrorCount,
-    totalFixableWarningCount,
-    totalWarningCount,
-    errors: results?.errors,
-  };
-}

package/lint.task.ts

@@ -1,27 +0,0 @@
-import { BuildTask, BuiltTaskResult, BuildContext, ComponentResult } from '@teambit/builder';
-import { Linter } from './linter';
-
-export class LintTask implements BuildTask {
-  constructor(readonly aspectId: string, readonly name = 'lint') {}
-
-  async execute(context: BuildContext): Promise<BuiltTaskResult> {
-    const linter: Linter = context.env.getLinter();
-    const results = await linter.lint(context);
-    const componentsResults = results.results.map(
-      (lintResult): ComponentResult => {
-        return {
-          component: lintResult.component,
-          metadata: {
-            output: lintResult.output,
-            results: lintResult.results,
-          },
-          errors: [],
-        };
-      }
-    );
-
-    return {
-      componentsResults,
-    };
-  }
-}

package/linter-context.ts

@@ -1,24 +0,0 @@
-import { ExecutionContext } from '@teambit/envs';
-
-export type FixType = 'problem' | 'suggestion' | 'layout';
-export type FixTypes = Array<FixType>;
-
-export interface LinterOptions {
-  /**
-   * extensions formats to lint. (e.g. .ts, .tsx, etc.)
-   */
-  extensionFormats?: string[];
-
-  /**
-   * automatically fix problems
-   */
-  fix?: boolean;
-
-  /**
-   * specify the types of fixes to apply (problem, suggestion, layout)
-   */
-  fixTypes?: FixTypes;
-}
-export interface LinterContext extends ExecutionContext, LinterOptions {
-  quiet?: boolean;
-}

package/linter.aspect.ts

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

package/linter.graphql.ts

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

package/linter.main.runtime.ts

@@ -1,64 +0,0 @@
-import { CLIAspect, CLIMain, MainRuntime } from '@teambit/cli';
-import { Component, ComponentAspect, ComponentMain } from '@teambit/component';
-import { EnvsAspect, EnvsMain } from '@teambit/envs';
-import { LoggerAspect, LoggerMain } from '@teambit/logger';
-import { Workspace, WorkspaceAspect } from '@teambit/workspace';
-import { LinterAspect } from './linter.aspect';
-import { LinterService } from './linter.service';
-import { LintTask } from './lint.task';
-import { LintCmd } from './lint.cmd';
-import { FixTypes, LinterOptions } from './linter-context';
-
-export type LinterConfig = {
-  /**
-   * extension formats to lint.
-   */
-  extensionFormats: string[];
-  fixTypes?: FixTypes;
-};
-
-export class LinterMain {
-  static runtime = MainRuntime;
-
-  constructor(private envs: EnvsMain, private linterService: LinterService) {}
-
-  /**
-   * lint an array of components.
-   */
-  async lint(components: Component[], opts: LinterOptions) {
-    const envsRuntime = await this.envs.createEnvironment(components);
-    const lintResults = envsRuntime.run(this.linterService, opts);
-    return lintResults;
-  }
-
-  /**
-   * create a lint task for build pipelines.
-   * @param name name of the task.
-   */
-  createTask(name?: string): LintTask {
-    return new LintTask(LinterAspect.id, name);
-  }
-
-  static dependencies = [EnvsAspect, CLIAspect, ComponentAspect, LoggerAspect, WorkspaceAspect];
-
-  static defaultConfig: LinterConfig = {
-    extensionFormats: ['.ts', '.tsx', '.js', '.jsx', '.mjs'],
-    fixTypes: ['layout', 'problem', 'suggestion'],
-  };
-
-  static async provider(
-    [envs, cli, component, loggerAspect, workspace]: [EnvsMain, CLIMain, ComponentMain, LoggerMain, Workspace],
-    config: LinterConfig
-  ) {
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const logger = loggerAspect.createLogger(LinterAspect.id);
-    const linterService = new LinterService(config);
-    const linterAspect = new LinterMain(envs, linterService);
-    envs.registerService(linterService);
-    cli.register(new LintCmd(linterAspect, component.getHost(), workspace));
-
-    return linterAspect;
-  }
-}
-
-LinterAspect.addRuntime(LinterMain);

package/linter.service.tsx

@@ -1,76 +0,0 @@
-import React from 'react';
-import { defaults } from 'lodash';
-import { EnvService, ExecutionContext, EnvDefinition } from '@teambit/envs';
-import { Text, Newline } from 'ink';
-import highlight from 'cli-highlight';
-import { Linter, LintResults } from './linter';
-import { LinterContext, LinterOptions } from './linter-context';
-import { LinterConfig } from './linter.main.runtime';
-
-export class LinterService implements EnvService<LintResults> {
-  name = 'linter';
-
-  constructor(private linterConfig: LinterConfig) {}
-
-  async run(context: ExecutionContext, options: LinterOptions): Promise<LintResults> {
-    const mergedOpts = this.optionsWithDefaults(options);
-    const linterContext = this.mergeContext(mergedOpts, context);
-    const linter: Linter = context.env.getLinter(linterContext);
-
-    const results = await linter.lint(linterContext);
-    return results;
-  }
-
-  private optionsWithDefaults(options: LinterOptions): LinterOptions {
-    return defaults(options, this.linterConfig);
-  }
-
-  private mergeContext(options: LinterOptions, context?: ExecutionContext): LinterContext {
-    const linterContext: LinterContext = Object.assign(
-      {},
-      {
-        quiet: false,
-        extensionFormats: options.extensionFormats,
-        fixTypes: options.fixTypes,
-        fix: options.fix,
-      },
-      context
-    );
-    return linterContext;
-  }
-
-  render(env: EnvDefinition) {
-    const descriptor = this.getDescriptor(env);
-
-    return (
-      <Text key={descriptor?.id}>
-        <Text color="cyan">configured linter: </Text>
-        <Text>
-          {descriptor?.id} ({descriptor?.displayName} @ {descriptor?.version})
-        </Text>
-        <Newline />
-        <Text color="cyan">linter config:</Text>
-        <Newline />
-        <Text>
-          {descriptor?.config && highlight(descriptor?.config, { language: 'javascript', ignoreIllegals: true })}
-        </Text>
-        <Newline />
-      </Text>
-    );
-  }
-
-  getDescriptor(env: EnvDefinition) {
-    if (!env.env.getLinter) return undefined;
-    const mergedOpts = this.optionsWithDefaults({});
-    const linterContext = this.mergeContext(mergedOpts);
-    const linter = env.env.getLinter(linterContext);
-
-    return {
-      id: linter.id,
-      icon: linter.icon,
-      config: linter.displayConfig ? linter.displayConfig() : undefined,
-      version: linter.version ? linter.version() : '?',
-      displayName: linter.displayName ? linter.displayName : '?',
-    };
-  }
-}

package/linter.ts

@@ -1,147 +0,0 @@
-import { Component } from '@teambit/component';
-import { LinterContext } from './linter-context';
-
-export type ComponentLintResult = {
-  /**
-   * the linted component.
-   */
-  component: Component;
-
-  /**
-   * CLI output of the linter.
-   */
-  output: string;
-
-  /**
-   * total errors count of the component (from all of the files).
-   */
-  totalErrorCount: number;
-  /**
-   * total fatal errors count of the component (from all of the files).
-   */
-  totalFatalErrorCount?: number;
-  /**
-   * total fixable errors count of the component (from all of the files).
-   */
-  totalFixableErrorCount?: number;
-  /**
-   * total fatal warning count of the component (from all of the files).
-   */
-  totalFixableWarningCount?: number;
-  /**
-   * total warning count of the component (from all of the files).
-   */
-  totalWarningCount: number;
-
-  /**
-   * lint results for each one of the component files
-   */
-  results: LintResult[];
-};
-
-export type LintResult = {
-  /**
-   * path of the linted file.
-   */
-  filePath: string;
-
-  /**
-   * numbers of errors found.
-   */
-  errorCount: number;
-
-  /**
-   * numbers of errors found.
-   */
-  fatalErrorCount?: number;
-
-  /**
-   * numbers of fixable errors found.
-   */
-  fixableErrorCount?: number;
-
-  /**
-   * numbers of fixable warning found.
-   */
-  fixableWarningCount?: number;
-
-  /**
-   * number of found warnings.
-   */
-  warningCount: number;
-
-  /**
-   * lint messages.
-   */
-  messages: LintMessage[];
-
-  /**
-   * Raw data as returned from the linter
-   */
-  raw: any;
-};
-
-export type LintMessage = {
-  /**
-   * severity of the issue.
-   */
-  severity: string;
-  /**
-   * stating column of the issue.
-   */
-  column: number;
-
-  /**
-   * line of the issue.
-   */
-  line: number;
-
-  /**
-   * end column of the issue.
-   */
-  endColumn?: number;
-
-  /**
-   * end line of the issue.
-   */
-  endLine?: number;
-
-  /**
-   * message of the issue.
-   */
-  message: string;
-
-  /**
-   * lint suggestions.
-   */
-  suggestions?: string[];
-};
-
-export type LintResults = {
-  results: ComponentLintResult[];
-  /**
-   * total errors count of the component (from all of the components).
-   */
-  totalErrorCount: number;
-  /**
-   * total fatal errors count of the component (from all of the components).
-   */
-  totalFatalErrorCount?: number;
-  /**
-   * total fixable errors count of the component (from all of the components).
-   */
-  totalFixableErrorCount?: number;
-  /**
-   * total fatal warning count of the component (from all of the components).
-   */
-  totalFixableWarningCount?: number;
-  /**
-   * total warning count of the component (from all of the components).
-   */
-  totalWarningCount: number;
-  errors: Error[];
-};
-
-export interface Linter {
-  lint(context: LinterContext): Promise<LintResults>;
-}

package/types/asset.d.ts

@@ -1,29 +0,0 @@
-declare module '*.png' {
-  const value: any;
-  export = value;
-}
-declare module '*.svg' {
-  import type { FunctionComponent, SVGProps } from 'react';
-
-  export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
-  const src: string;
-  export default src;
-}
-
-// @TODO Gilad
-declare module '*.jpg' {
-  const value: any;
-  export = value;
-}
-declare module '*.jpeg' {
-  const value: any;
-  export = value;
-}
-declare module '*.gif' {
-  const value: any;
-  export = value;
-}
-declare module '*.bmp' {
-  const value: any;
-  export = value;
-}

package/types/style.d.ts

@@ -1,42 +0,0 @@
-declare module '*.module.css' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-declare module '*.module.scss' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-declare module '*.module.sass' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.module.less' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.less' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.css' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.sass' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.scss' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.mdx' {
-  const component: any;
-  export default component;
-}