create tools/eslint-format

[rubiagatra]

Closes #1076

Tasks

• Create the tools/eslint-format.js to has the same behavior with tools/clang-format.js.
• Using steps suggested by @mhdawson, update file by file to conform to new linter standard (discussed on Add linting for JavaScript code #1063)

Note

• I changed CLANG_FORMAT_START -> FORMAT_START

Example

@mhdawson I created tools/eslint-format.js do you mind checking this one out? the example looks like this when pre-commit

Eslint error:
/Users/rubiagatra/github/node-addon-api/test/addon.js
  6:5  error  'a' is defined but never used  no-unused-vars

✖ 1 problem (1 error, 0 warnings)


ERROR: please run "npm run lint:fix" to format changes in your commit
    Note that when running the command locally, please keep your local
    main branch and working branch up to date with nodejs/node-addon-api
    to exclude un-related complains.
    Or you can run "env FORMAT_START=upstream/main npm run lint:fix".
    Also fix JS files by yourself if necessary.
pre-commit:
pre-commit: We've failed to pass the specified git pre-commit hooks as the `lint`
pre-commit: hook returned an exit code (1). If you're feeling adventurous you can
pre-commit: skip the git pre-commit hooks by adding the following flags to your commit:
pre-commit:
pre-commit:   git commit -n (or --no-verify)
pre-commit:
pre-commit: This is ill-advised since the commit is broken.
pre-commit:

[mhdawson]

@rubiagatra thanks, on my list to review, just have not gotten to it yet.

[mhdawson]

I tried this out today, but it does not seem to run the linter/find changed files in this case:

1. Check out the main branch
2. Apply the patch from this PR
3. Modify test/version_management.js to introduce something that should be reported
4. run npm run lint

I expect you probably tested when you were on a branch other than main, but I think we need this scenario to work as well as I think it's what will run in the CI.

If I modify test/version_management.cc' in a way that introduces something that should be reported and run npm run lint` I do get a report.

@rubiagatra can you take a look?

[mhdawson]

@rubiagatra just a reminder that I ran into a few issues and was hoping you could take a look.

[rubiagatra]

thank you @mhdawson for the reminder, I will take a look today and tomorrow.

sorry, I am not in GitHub for a while

[rubiagatra]

I am still continuing checking out this will give an update on friday

[rubiagatra]

@mhdawson I follow your instruction.

1. Check out the main branch
2. Apply the patch from this PR
3. Modify test/version_management.js to introduce something that should be reported
4. run npm run lint

it will have outcome.

➜ node-addon-api (main) ✔ nvim test/version_management.js
➜ node-addon-api (main) ✗ npm run lint

> node-addon-api@4.2.0 lint
> node tools/eslint-format && node tools/clang-format

Eslint error:
/Users/rubiagatra/github/node-addon-api/test/version_management.js
  7:7  error  'a' is assigned a value but never used  no-unused-vars

✖ 1 problem (1 error, 0 warnings)


ERROR: please run "npm run lint:fix" to format changes in your commit
    Note that when running the command locally, please keep your local
    main branch and working branch up to date with nodejs/node-addon-api
    to exclude un-related complains.
    Or you can run "env FORMAT_START=upstream/main npm run lint:fix".
    Also fix JS files by yourself if necessary.

maybe the linter of your code editor automatically fixes your update to the code?

I am just creating no-unused-vars error for example. For styling issue it will fix automatically with my code editor

[mhdawson]

I've not had a chance yet but will try to take a look sometime this week.

[mhdawson]

@rubiagatra I'm not sure what I was doing before, I went through the steps again and all seems to be working as expected sorry for the noise.

[mhdawson]

LGTM

[mhdawson]

Landed in 706b199

[rubiagatra]

thanks! @mhdawson