7j/2 dZddlmZddlmZddlmZddlmZm Z ddl m Z ddl m Z mZmZmZddlmZmZdd lmZdd lmZdd lmZmZdd lmZgd ZegdZddgZ dZ!d1dZ"d1dZ#d1dZ$dZ%dZ&dZ'dZ(dZ)dZ*dZ+dZ,dZ-dZ.d Z/d!Z0ejbd"d#d$%ejbd&d'd(ee d)*ejbd+d,d-.ejdd/ee d0Z3y)2zFCommand to look over a keyboard/keymap and check for common mistakes. )dotty)Path)cli)automagic_keyboardautomagic_keymap) info_json)keyboard_completerkeyboard_folder_or_allis_all_keyboardslist_keyboards) locate_keymap list_keymaps)keyboard)git_get_ignored_files)c_source_filespreprocess_c_file) json_load)zchconf.hz halconf.hz mcuconf.hzboard.h) encoder_mapdip_switch_mapcombo tap_danceviarvialcddg}|jtt}t|dD])}||vs|j ds|j |+|S)z5Return default like keymaps for a given keyboard ansiisoF)include_userspacedefault)extendINVALID_KM_NAMESsetr startswithadd)kb defaultishkeymapsxs E/home/hanthebot/chat/keyboard/qmk_firmware/lib/python/qmk/cli/lint.py_list_defaultish_keymapsr)s_%J&'eG " 6 ?all95 KKN NNcx|rt||jn t|}g}|sQt|jd}|jddD]'}||z }|j |j d)|j dD]$}|sd|jvr|j|&t|S)z2Return potential keyboard/keymap readme files rNz *readme.mdz **/*readme.mdr& r parentrrpartsrglobappendr!)r$km search_path readme_files current_path path_partfiles r(_get_readme_filesr8&s35-B'..(2,KL K--a01 $**12. AI')3L    1 1, ? @ A  1"i4::- D! " | r*cV|rt||jn t|}g}|s@t}|jD]'}||z }|j |j d)|j dD]$}|sd|jvr|j|&t|S)z1Return potential keyboard/keymap build files z *rules.mkz **/*rules.mkr&r-)r$r2r3 build_filesr5r6r7s r(_get_build_filesr;<s35-B'..(2,KK v $** ?I')3L   |00= > ?  0!i4::- 4 ! { r*cz|rt||jn t|}g}|s`t}|jD]G}||z }|j |j d|j |j dIt|gD]$}|sd|jvr|j|&|S)z0Return potential keyboard/keymap code files z*.hz*.cr&) r r.rrr/rr0rr1)r$r2r3 code_filesr5r6r7s r(_get_code_filesr>Rs35-B'..(2,KJ v $** 8I')3L   l//6 7   l//6 7 8  }- i4::- $  r*cgd}|jdjdD]tfd|Dsyy)z0Check if file contains any unfilled content )z %KEYBOARD%z %REAL_NAME%z %USER_NAME%zimage replace me!z+A short description of the keyboard/projectzThe PCBs, controllers supportedz)Links to where you can find this hardwareutf-8encoding c3&K|]}|v ywN).0tokenlines r( z%_is_invalid_readme..ws1u}1sTF) read_textsplitany)r7tokensrIs @r(_is_invalid_readmerOisGF066t< 1&1 1 r*c|jdjdD]5}t|dkDs|jr#|j dr5yy).Check if file contains any useful content r@rArCr#FT)rKrLlenisspacer"r7rIs r(_is_empty_rulesrV|sO066t< t9q=8L r*ct|jdD]5}t|dkDs|jr#|j dr5yy)rQrCrz #pragma onceFT)rrLrSrTr"rUs r(_is_empty_includerXsI"$'--d3 t9q=8W r*crt|jj}|jdS)z$Check file has a license header )z/*z//)openreadlinerstripr")r7flines r( _has_licenser^s0 J   ! ( ( *E   L ))r*cd}|dr$d}tjj|dtjjj r)|dr$d}tjj|d|S)z-Convert any json errors into lint errors T parse_errorsFz): Errors found when generating info.json.parse_warningszA: Warnings found when generating info.json (Strict mode enabled.))rlogerrorconfiglintstrict)r$infooks r(_handle_json_errorsrisi B N   EFG zz$'7"8   ]^_ Ir*cd}t|jdg}|tzD](}d}tjj |d|*|S)zJCheck for features that should never be enabled at the keyboard level TfeaturesFz,: Invalid keyboard level feature detected - )r!getINVALID_KB_FEATURESrrbrc)r$rgrhrkfounds r(_handle_invalid_featuresros] B488J+,H//R   HPQR Ir*cp|jddk(r"tjj|dy)z,Check for invalid keyboard level config urlzT: Invalid keyboard level config detected - Optional field "url" should not be empty.T)rlrrbwarning)r$rgs r(_handle_invalid_configrts/ xx" 2$rst r*c t|jD]<\}}d|jd|vsd|jd|d|d|jd cSy) zJCheck the ChibiOS conf.h for the correct inclusion of the next conf.h z#include_next ""zFound `#include_next "z "` on line z of z, should be `#include_next ` (use angle brackets, not quotes)N) enumeraterZname)targetirIs r(_chibios_conf_includenext_checkr{swV[[]+`4 V[[M +t 3+FKK= A3d6(Rnouozozn{|_` `` r*c g}d}t|jD]i\}}|j}d|vr|d|jd}|r||z}d}|s:|ddk(r|dd}H|sKd|vsP|j d|d|d|k|S) zICheck the keyboard-level rules.mk to ensure it only has assignments. NrR\=zNon-assignment code on line + : )rwrZstripindexr1)rules_mkerrors continuationrzrIs r(_rules_mk_assignment_onlyrsFLX]]_-V4zz| $;(C)D $&DL Bx4#CRy 4 =aS(2dVTU!V$ Mr*c dfd ttd}t|}|D]D\}}|j|}||k(stj j |d|d|dFy)Nc3Kt|D][}|r|d|n|}t||tr|||Ed{6t||tr |||fS|||f]y7.w)zIPrint the info.json in a plain text format with dot-joined keys. .N)sorted isinstancedictlist) kb_info_jsonprefixkey new_prefix_collect_dotted_outputs r(rzA_handle_duplicating_code_defaults.._collect_dotted_outputs,' 6C.4F81SE*#J,s+T21,s2CZPPPL-t4!<#455!<#455 6Qs_Y$   GGOOrd*SE1PQZP[[\] ^_ r*c d}t||}|s%d}tjjd|||S|tvr%d}tjjd|||St |j j}|D],}tjj|d|d|dd}.t||D]}t|s*tjj|d|d|dd}|jtvsKt|}|Ytjj|d|d |d}|S) z%Perform the keymap level checks. TFz%s: Can't find %s keymap.z#%s: The keymap %s should not exist!/ : The file "" should not exist!!" does not have a license header!r) r rrbrcr rr.as_posixr>r^rxCHIBIOS_CONF_CHECKSr{)r$r2rh keymap_path invalid_filesr7 check_errors r( keymap_checkrsE BB'K    12r:     ;RD *+*<*<*E*E*GHM  AbTdV3FGH  B' D! GGMMRD"\$7XY ZB 99+ +9$?K& AbTK=9:  Ir*cd}t|}t||sd}t||sd}t||sd}t ||sd}t d|d}|D].}d|vrt jj|d|dd}0t|s$t jj|dd}t|D]5}t|st jj|d|d d}7t|D]}t|r't jj|d|d d}|jd vsDt|}|sRd}t jjd ||D]!}t jj|#t|D]}t!|s't jj|d|d d}|j"dvr2t%|r't jj|d|d d}|j"t&vst)|}|t jj|d|d}|S)z'Perform the keyboard level checks. TFz keyboards/rkeymaprrz: Is missing a readme.md file!z!" still contains template tokens!z-" is effectively empty and should be removed!)zrules.mkzL%s: Non-assignment code found in rules.mk. Move it to post_rules.mk instead.r)zconfig.hr)rrirortrrrrbrcr8rOr;rVsuffixrr>r^rxrXrr{)r$rhkb_inforr7rules_mk_assignment_errorsassignment_errorrs r(keyboard_checkrsW BmG r7 +  $B 0  !"g .  ,R 9 )Jrd!*<=M t    L.ABC   R   :;< !"% d # GGMMRD TF2ST UB !$ 4 4 GGMMRD TF2_` aB ;;, &)B4)H &) lnpq(B4$GGMM"234 4 #D! GGMMRD TF2ST UB 99 $ & L6cde 99+ +9$?K& B{m45 Ir*z--strict store_truezTreat warnings as errors)actionhelpz-kbz --keyboardr1z0Keyboard to check. May be passed multiple times.)rtype completerrz-kmz--keymapzThe keymap to check)rz.Check keyboard and keymap for common mistakes.c |jjjs-|jj d|j yt |jjjtr"|jjjg}nctd|jjDr t}n2tt|jjj}g}|D]}|jjdk(r t|}n^|jjjr"|jjjh}nt|}|j!dd}t#|sd}|D]}t%||rd}|r|j'||r,|jj ddj)|y|jj+d y) z3Check keyboard and keymap for common mistakes. z&Missing required arguments: --keyboardFc32K|]}t|ywrE)r )rGr$s r(rJzlint..ns >b b ! >sallrTzLint check failed for: %sz, zLint check passed!)rdrerrbrc print_helprstrrMargsr rr!rrr)r#rrr1joinrg)r keyboard_listfailedr$r&rhrs r(rere\s ::?? # #  >?#**//**C0112 >CHH,=,= > >&( S!9!9:; F 88??e #"2&G ZZ__ # #zz--.G.r2G KK " b!B FF+   MM" 16  1499V3DEGGLL%& r*rE)4__doc__ dotty_dictrpathlibrmilcrqmk.decoratorsrrqmk.infor qmk.keyboardr r r r qmk.keymapr rqmk.pathrqmk.gitr qmk.c_parserrqmk.json_schemarrr!rmr r)r8r;r>rOrVrXr^rirortr{rrrrargument subcommandrerFr*r(rs'?ee2)9%GXY6?  ,,.&* 44!H@Fj4NO e\(9O[mugh eZ&;<@A4B=hP 4r*