nonsense pre-commit failure (IDFGH-15310) (RDT-1312)

[bryghtlabs-richard]

Answers checklist.

• I have read the documentation ESP-IDF Programming Guide and the issue is not addressed there.
• I have updated my IDF branch (master or release) to the latest version and checked that the issue is present there.
• I have searched the issue tracker for a similar issue and not found a similar issue.

General issue report

If I mistakenly violate conventional commit requirements for this repo, the resulting error code is a unicoding fault rather than something human-readable.

Ex: this commit message works:

feat: allow provided config object to extend other configs

Ex: this commit message fails:

chore: allow provided config object to extend other configs

I would expect an error like "conventional commit parser failed: 'chore' is not allowed. Use one of: feat/docs/..."

But instead I get this:

[WARNING] top-level `default_stages` uses deprecated stage names (commit) which will be removed in a future version.  run: `pre-commit migrate-config` to automatically fix this.
Conventional Commit......................................................Failed
- hook id: conventional-precommit-linter
- exit code: 1

Traceback (most recent call last):
  File "<frozen runpy>", line 198, in _run_module_as_main
  File "<frozen runpy>", line 88, in _run_code
  File "C:\Users\RichardAllen\.cache\pre-commit\repo5i24undo\py_env-python3.13\Scripts\conventional-precommit-linter.EXE\__main__.py", line 7, in <module>
    sys.exit(main())
             ~~~~^^
  File "C:\Users\RichardAllen\.cache\pre-commit\repo5i24undo\py_env-python3.13\Lib\site-packages\conventional_precommit_linter\hook.py", line 272, in main
    print_report(commit_type, commit_scope, commit_summary, args)
    ~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\RichardAllen\.cache\pre-commit\repo5i24undo\py_env-python3.13\Lib\site-packages\conventional_precommit_linter\hook.py", line 209, in print_report
    print(full_guide_message)
    ~~~~~^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\RichardAllen\.cache\pre-commit\repo5i24undo\py_env-python3.13\Lib\site-packages\colorama\ansitowin32.py", line 47, in write
    self.__convertor.write(text)
    ~~~~~~~~~~~~~~~~~~~~~~^^^^^^
  File "C:\Users\RichardAllen\.cache\pre-commit\repo5i24undo\py_env-python3.13\Lib\site-packages\colorama\ansitowin32.py", line 177, in write
    self.write_and_convert(text)
    ~~~~~~~~~~~~~~~~~~~~~~^^^^^^
  File "C:\Users\RichardAllen\.cache\pre-commit\repo5i24undo\py_env-python3.13\Lib\site-packages\colorama\ansitowin32.py", line 202, in write_and_convert
    self.write_plain_text(text, cursor, start)
    ~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\RichardAllen\.cache\pre-commit\repo5i24undo\py_env-python3.13\Lib\site-packages\colorama\ansitowin32.py", line 210, in write_plain_text
    self.wrapped.write(text[start:end])
    ~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^
  File "C:\Python313\Lib\encodings\cp1252.py", line 19, in encode
    return codecs.charmap_encode(input,self.errors,encoding_table)[0]
           ~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
UnicodeEncodeError: 'charmap' codec can't encode character '\u274c' in position 2: character maps to <undefined>

[igrr]

Looking at this part of the traceback,

  File "C:\Users\RichardAllen\.cache\pre-commit\repo5i24undo\py_env-python3.13\Lib\site-packages\colorama\ansitowin32.py", line 202, in write_and_convert
    self.write_plain_text(text, cursor, start)
    ~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\RichardAllen\.cache\pre-commit\repo5i24undo\py_env-python3.13\Lib\site-packages\colorama\ansitowin32.py", line 210, in write_plain_text
    self.wrapped.write(text[start:end])
    ~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^
  File "C:\Python313\Lib\encodings\cp1252.py", line 19, in encode
    return codecs.charmap_encode(input,self.errors,encoding_table)[0]
           ~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
UnicodeEncodeError: 'charmap' codec can't encode character '\u274c' in position 2: character maps to <undefined>

it seems that the issue has to do with printing the ❌ (\u274c) character to the console. Could you please add more information about your build environment? Which console application are you using?

[bryghtlabs-richard]

Could you please add more information about your build environment?

I think this one was near esp-idf master branch today. Usually I'm on a fork of 5.1.x

Which console application are you using?

I'm using git-bash, default console option.

[tomassebestik]

Hi @bryghtlabs-richard,

I believe this is the same problem as reported in this issue.

Since conventional-precommit-linter version 1.9.0, the tool doesn't use special Unicode characters (due to this kind of problems on Windows machines).

If you want to confirm that it is the same issue, you can try running:

pre-commit autoupdate --repo https://github.com/espressif/conventional-precommit-linter

This will upgrade local version of conventional-precommit-linter hook. Then stage the updated .pre-commit-config.yaml and test it again with same message.

The result should then look as you described you would expect it:

---

I think this one was near esp-idf master branch today.

On current ESP-IDF master (and v5.5 / v5.4 / v5.3), we still indeed have version v1.7.0 of this linter.

I'm sorry for the troubles, and thank you for reporting this.

@igrr I'll prepare a quick change on ESP-IDF master and a back-port for v5.5 with the latest v1.10.0, WDYT?

[bryghtlabs-richard]

Thanks Tomas! I enabled UTF8 support, and now it's working. I also updated precommit-linter, but only after enabling UTF8 console support.

[Indastri]

Hi @bryghtlabs-richard, if the issue is solved, can you please close it?

Cheers!