From 485693199bc05964b0358f2f37f8f1dbac9f9f72 Mon Sep 17 00:00:00 2001 From: Elliott Brooks <21270878+elliette@users.noreply.github.com> Date: Fri, 3 Dec 2021 14:13:50 -0800 Subject: [PATCH] Update CONTRIBUTING documentation for the debug extension --- dwds/debug_extension/CONTRIBUTING.md | 33 ++++++++++++++++++++++---- dwds/debug_extension/web/dart_dev.png | Bin 0 -> 4743 bytes 2 files changed, 29 insertions(+), 4 deletions(-) create mode 100644 dwds/debug_extension/web/dart_dev.png diff --git a/dwds/debug_extension/CONTRIBUTING.md b/dwds/debug_extension/CONTRIBUTING.md index 7ca2f97a9..5f4fc5285 100644 --- a/dwds/debug_extension/CONTRIBUTING.md +++ b/dwds/debug_extension/CONTRIBUTING.md @@ -11,13 +11,38 @@ pub run build_runner build web -o build -r ``` pub run build_runner build web -o build ``` +## Local Development + +### Update `manifest.json`: + +* Change the `default_icon` in `manifest.json` to `dart_dev.png` (Note: this is not strictly necessary, but will help you to distinguish your local version of the extension from the published version) +* [For Googlers] The developer key is needed for local development and testing. Add one of the whitelisted keys to `web/manifest.json`. IMPORTANT: DO NOT COMMIT THE KEY. + +``` +{ + "name": "Dart Debug Extension", + "key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", + ... +} +``` + +### Build and upload your local extension + +* Build the extension following the instructions above +* Visit chrome://extensions +* Toggle "Developer mode" on +* Click the "Load unpacked" button +* Select the extension directory: `/dwds/debug_extension/build/web` + +### Debug your local extension +* Click the Extensions puzzle piece, and pin the Dart Debug Extension with the dev icon (unpin the published version so you don't confuse them) +* You can now use the extension normally by clicking it when a local Dart web application has loaded in a Chrome tab +* To debug, visit chrome://extensions and click "Inspect view on background page" to open Chrome DevTools for the extension +* More debugging information can be found in the [Chrome Developers documentation](https://developer.chrome.com/docs/extensions/mv3/devguide/) + ## Deployment - Update the version number in `web/manifest.json`. - Zip `web/manifest.json`, `web/background.js`, and `dart.png`. - Upload the `.zip` to the Chrome Web Store. - -## [For Googlers] Local Development - -The developer key is needed for local development and testing. Add one of the whitelisted keys to `web/manifest.json`. \ No newline at end of file diff --git a/dwds/debug_extension/web/dart_dev.png b/dwds/debug_extension/web/dart_dev.png new file mode 100644 index 0000000000000000000000000000000000000000..8d0479209a0a4dbe62160bc2bafaaf34ce578470 GIT binary patch literal 4743 zcmY*dcQ{+WTHeHGFqa9L6qntdP0=wy$gm32BU;AqW6fBqSxp|v>Gee0k7JUdeRzA6~2mEgc#zmIHNK+fGi1x6Diwg<~3USDh!{Kll4?71bT_u(O z&@Uocj)xe`BPj&J$Hzy|=awMa!x14YDJh8%5r{IPtJct{#QrI z-qY5@=@G^W?FRp&Yi)z}!pL%P{Au*>^UpakP7eR=1%(j*YF|)g z{$!=JJe=$=I{(p^6PEcK`TuhN=_7;q)BOJ&=ATLb&R&cvM=pc-_uAyhnJnf>0D$7u zl@#=_1e@u;DAq34j~};=yeFWO>XhH$k?LemIJw;PCJJ=9mB@<(tbS@m)A8yatDf_m z>gcb_%W@s&78jpA;F=(PokQy3Uc+H!mUqod=d#FyP414q(wo*Nr2jvsonI|-$|H;i;?Bo#UN9EvP-onvETm%O)TWciXB znwuZ1OgO9X(JyQ7ZKs$C9{3u`RqQ<{ZZ9RAOE$D{;=3Bn&l+Pi+^R({g z(W$(Bvgj)`qYsH#*ksIvBsO%*Q*GsjqQ6^W0Sl{$zJwEo(hd~acF z+#r!suuO4a%k@xbw$vorfC%^a*t_V>15Iv!4@YaRN*aI~m!n?Xto)c<#l?HUkJ4Af zhn5k7lH)B~{c~shae@BZw@@Pj5OyrE-CtYNWLsp;&#p#~OPBUJgPGQ9v3TI9KE>Eb z71by}1r_;#Ra_9c=jm2G^v%XYdWZ@^E9{(Z`EYz4o4CuNf^T9>{Mv8@%pJ}uwq>pc zB9l@+V`?Z&V`Pt4b0t~5x?XeYfH|zm*k{7{gsG@x7)OutcXPh|SN0yhVbvG}>8l}yJ$ncbKJ=+nwj8Umc(d;bVQMd(J)z`*@q z+Z~r#!r@oI)WAw{D*If@w%iw!`Rs5uKEJ~2v?Z*72dd`Igx6Lzcrq?jLmWyuL6G3| zj#8mMSwkU<9?)m^LDduz4l!BuxJSvaBzvK^H|O1xFJdZ?JcHnKCMPsWD-KX%8kUQ9 zHf3sfO8_5EGi3817guO{YSYz_US?uE^|N?0bV-YxPyi^=$HnxAP?IVZ?)Z7JCY72R zd?@m!F1Dlq3RH*rkpnBfId@vqJHD$QKWvoMxi$^$B!)*JEe2NZ7T7`JMEYeTG{?=UCz}Fq1dtKttlT!hv~#@8LEWO1bX>*sRqMofHtZ*6{vqq zW+$x^3Zh5ItSC|21LXK+d;Y?JMt=n}Qnie%_$W8=W$tM`xHd7k`#zy|p%@xLeL2aT z8*OARlfEv>YR9fkI2TO9RzF(95x5zukkygcL@m#xx8NFzBm+&8XBkmn)K~UHkabmF z_=FnGqClPV%0%QPu)CP{x#LiYwq@J(RwD^O=kmCaYFspi)dBrmVYP}%~jMquT+#USfSLx>=Xt{(II z5r!lOrpY@``6-}zRD-_{X65&%V}}sojgdPdjdAra{p1`)b~Ube{#LUWV`-Cc4c}oZ zdM)6T0mttDwKn_08OC3|WUG75RFEeqynrl^`g|uMka%xkp<9pU++jP>jGN`zkPWxp z5se*9M^6;&yY=#kEf2^^P|v7iof_mbQ`vDwi)K28h^Mr zgDP+1M1q0#mV}tur*{|vpb@J5r&f z!N$3>wT>fbxdB-&$gi7kq`(n}I*5PxN*8YYHtW0o-r4YB-jy#-`nd&OM88o>RhP#b z6;H<7XDGPEZoIv|+Mj&JwkHd4in<)#cAeARoKl%Nmu;OJm`%P^sGMV;4}6yjP}Rpc(S_tx+TR{JEOa1!Q#KU6Y)e)3E5v7f^58McgD1n1E?*btmuBiZi^u5q zZXXvx+`k4QEPIa0=}Q$7f>oH-=NbC~O3YW7#dsDiK!U;cCAdH^_MK?WwR#uU_b~b8 zN|hqj_(HAWB@6G}=YvKqLb5do8J{qLqfh^=>045*Jh&XhzhaJN{W3jFtbi@zkd?sJzVhC>5q-6|czpblz=IE7nf+^9wg*{- zb!=N6F%bTD@(!6d8$;>0U&<)VQ(kpRmy09kyHT+DY4kS8s(DKQhHNkyF4_K2s5u3r zaObb5w+&f{k`mxH>7(CS#@_jq+duYf*(l0BvWZ_YX-!lg?mDU8eD~vpiW>>Ymnfj6 zY77rD`B@-&nxw}K#)eLA^wXdDR5pgCE1?;Prtb=NjaYH)wFj7&A5EeMgDEwmm4waO zdG-{dI^=t3WbQ|OG4TtmU2^dDA7u~6cve_=oB5khy|s}v-C1+0;2Nx_l{+{Pjjf55 zI*;Vp--|b^3!wnZG^5SuC%8iSuK7$lFOZNwGuXTr>OvH;z;ax%Yd34#cl2hXC*`{L zj~W<6%TQ9{1-9#3r%M`fXS(eA8seKv)wh?_E+5ECb?a@jYU*7Q)+TZ@B|(IRrXM$n z%RR@b#=t#(MwWL*E%@n2OEkHIy0fry$Tc9C8ygSW{H*EH>RE3tct7$B%kRo&6eN7X zDT!i^d=|k(nXaW?@4om!T+!9pHLNyln%$5NJvR0FxMEt?_kwWztA@a$<GP z43^c@uf~fbq`2A5*%gi65Bk4bk&#&)SR~!Z$!oC0)Xt$xNi^C~NG&Wcf9-v;rzX+D z=3H6Y$qIR0kaGV?dXzu3NnrXTFTfb0id%dQE1rq|Ww|A58O=0^s8399ajIez3k*DL z4Srf*8Nr`M9B0LR_(F(kd$LV|uD}suQxA+9E00&Su5^hGuRJH23q#yBJbgUINlMWi zyF31|&oITVTC6+{Npt=c;7nyzYy7xO%;w%0 zYk7a{0U{t*2AQ*I=2v`!xRDjrcKTk;C~0Utk2W_{ppCamKv%t2VX|!(@yh3$ppE_G z;}6Pl^*jv4(4k?O7sQ>&x)7J0RSCq+{XxZ+Twe59gowjc9J364)8e6OY4+BOqQOJj z&WsNZs%9e;`lM5rQ&SdZ&gJHD{s_gl7)VERyu*pgel33oh5q$N%xSh1*+Rf$===a>+YXOd&Cnp(kJF5yP zezSwIhQ+YuVPLs4?0K$lJN%hM7yaU+r@i!gMqjot-?`NzX&~wD75F(|p z&@VipMWLPrsv{FUe_lVBQf(C9v&##9ZH#-q(==`KT3z~1eQG*!b+kn^m9@!}>U&8^ z65ktuNElKTp9+pSFM{zCv`#0jomoJTrRVQge-BS8+T8V9;mBH3zmmHoT-t=_M_Y$) z)rY6Ihh%eg zsBTwxgCF}nJDFAk@{dMMyfNctYz_OWJE7T`v`(?eVVv}<4?{uiM3g>q!=n!#05leZ z+4~wG7xc<z7Xf>ac>#_rco34#ka7|&Az!gpGC|)`AvQR z6cQ-XEA^qG2^F9%&B@8R@kwG9cF=4~K9}rh%{NzF;EM?olhsIp7d}bW4^CNdJoLZ}~}W}wduXegmW6xd!0 z#mU&L$yFHs=4u%PFs;W*%xDWLE>&AmK7C*~2VE`JD#+jwkNc*9M7|_-uxw7Q!rA*) zZ}YDt0=P60;e?6-9!{Q}a-?SrdjM5>>uLwOX_BBkWn?+z#VFrs@-#d=s<#Sc5j$yu zLcUmt4&;;Hb1wFX;ny}q$hfv?1^cR1zXQouTXzU`(bwa=i&AmZRZz4O7Zotp-UJ`{Bt?sQ5lNS)`#+88VY62-*D!+LMCu*1_AQCHWhjX8kE9c>c!@SU)Fo^5$N zZ`t;I1Wz|oW(Ol$<6|jEC5JTH<@nK%;F#NZwBsdWli9cjxk&B2$U=~{Y}E}YAwod* z#&_4j?^%G3flzPilXkw%kDu=SELoo;33isPu4W;^K_;s0`vPFkW@zJWl#G{>`WZf2 zyOA!8&==(D05wMBP|OzNv$OJh5qZW03aPJPc&>D<>j$ScY7vMUF7#~6Z#urH(|go9 zEk!xXk23E*^%$vjo&0(z%EZrXNhzsDpGOSDTKo@waNZtbK=-xT6Hx2<`}^m}iO5}w z@UxM|h?Q$axG#CWiJsLXfIAZ54Pf_ES>>$>W_C5lIlX|I4ziLl+((nw)kV4>UCXw-&Yyb;e3FC%=4GmNuaPWMrf*B)MKu zgpNB?Djz+iO{f4_WO^lf&UMk;Z0;tjtG7&D?mkG!isuA)dG~BrIgi3&VG4Fykig#7 zYJl8!bhDa_aVasg_U@$wNl;W+_W7NasX2@WXT)Y9cL;U!txJG6CUK68@w6`Ir<)_! zJk*E9=EPWT5C-f}$n6KWzZoio`AFaV;iYYAe7}zi*gZmS-@CmpVJzN4Rqc2cr%oCe zwpigRWM^RCEeh-~8?>i{oNe)M)^RmU12Vu4sX;Qhz}j{#-?jf{tvn}yci2uI#^08C zu6!ep*E0tJE68RHY;S(8%_Exk*_+1IZK7t)j%NR-)cNHpiL5|<3QF-mzjf4=?<