Implement a Linter

Standard linter like Eslint are integrated into Bit using a Bit Aspect . For example, the Eslint Aspect. These Aspects implement the Linter's interface.

The easiest way to start implementing a Linter is to create a new Bit Aspect using the Aspect template:

bit create aspect extensions/my-linter
Copied

The aspect main runtime (e.g, my-linter.main.ts) should have the following methods:

Create an instance of a class that should implement the Linter interface. This is usually implemented in a file called <linter-name>.linter.ts

/**
 * create a eslint linter instance.
 * @param options eslint options.
 * @param ESLintModule reference to an `eslint` module.
 */
createLinter(
  context: LinterContext,
  options: ESLintOptions,
  transformers: EslintConfigTransformer[] = [],
  ESLintModule?: any
): Linter {
  const mergedOptions = getOptions(options, context);
  const configMutator = new EslintConfigMutator(mergedOptions);
  const transformerContext: EslintConfigTransformContext = { fix: !!context.fix };
  const afterMutation = runTransformersWithContext(configMutator.clone(), transformers, transformerContext);

  return new ESLintLinter(this.logger, afterMutation.raw, ESLintModule);
}
Copied

The linter should know to handle both - lint in workspace and for build.

The linter implementation uses the linter extension as a convention. For example, my-linter.linter.ts.

When implementing a workspace linting you should optimize for dev experience and performance by default The linter should implement lint method.

lint(context: LinterContext): Promise<LintResults>;
Copied

The LinterContext contains the regular ExecutionContext and the LinterOptions.

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;
}
type FixType = 'problem' | 'suggestion' | 'layout';
type FixTypes = Array<FixType>;
Copied

This function get a fileContent and return the compiled content and the output path.

Linting during build will soon be available.