get-sourcecode-from-file-path/index.d.ts

Retrieves the ESLint-generated SourceCode object of a file from its absolute path.

// must be manually maintained

import { Linter, SourceCode } from "eslint";

/**
 * Gets the ESLint-generated SourceCode object of a file from its absolute path.
 * @param {string} absolutePath The absolute path of the file.
 * @param {Object} [options] The additional options as follows:
 * @param {import('eslint').Linter} [options.linter] The Linter instance used to retrieve the SourceCode object, defaulting to a `new Linter()` per operation, ensuring each instance of the function is based on its own linter (just in case somehow some linters were to run concurrently).
 * @param {import('eslint').Linter.LanguageOptions} [options.languageOptions] The languageOptions object used by `linter.verify()`, defaulting to a version that is TypeScript- and JSX-compatible.
 * @returns The ESLint-generated SourceCode object of the file, from which the AST (`sourceCode.ast`) and all comments (`sourceCode.getAllComments()`) can be extracted.
 */
export const getSourceCodeFromFilePath: (
  absolutePath: string,
  {
    languageOptions,
    linter,
  }?: {
    linter?: Linter | undefined;
    languageOptions?: Linter.LanguageOptions | undefined;
  }
) => SourceCode;