Change Request: docs: add example code for eslint.lintText

[milahu]

ESLint version

8.29.0

What problem do you want to solve?

no example code for eslint.lintText at

https://eslint.org/docs/latest/developer-guide/nodejs-api#eslint-class

What do you think is the correct solution?

add example code, something like

const { ESLint } = require("eslint");

let text = `
console.log("hello")
`

(async function main() {
  // 1. Create an instance with the `fix` option and some config.
  const eslint = new ESLint({
    fix: true,
    useEslintrc: false,
    overrideConfig: {
      "extends": [
        "eslint:recommended",
      ],
      "parserOptions": {
        "sourceType": "module",
        "ecmaVersion": "latest",
      },
      "env": {
        "es2022": true,
      },
    },
  });

  // 2. Lint text. Store fixed text in results[0].output.
  const results = await eslint.lintText(text, {filePath: "/script.js"});

  // 3. Format the messages.
  const formatter = await eslint.loadFormatter("stylish");
  const messages = formatter.format(results);

  // 4. Print the messages.
  console.log(messages);

  // 5 Print the new text.
  const newText = results[0].output;
  console.log(newText);
})().catch((error) => {
  process.exitCode = 1;
  console.error(error);
});

Participation

• I am willing to submit a pull request for this change.

Additional comments

No response

[nzakas]

Sorry we missed this! We can definitely add an example there. Is that something you'd like to submit a pull request for?

[milahu]

Is that something you'd like to submit a pull request for?

nope, sorry

[siva-kannan3]

@nzakas , I have created and tested a basic example. Here is the screenshot. Would love to give a PR for the same.