From c904ec7380656a247954aa118d33694b1a0bf044 Mon Sep 17 00:00:00 2001 From: Roy Li Date: Sun, 26 Jul 2020 22:51:05 +0800 Subject: [PATCH] feat: change config key --- docs/guide/custom-provider.md | 2 +- lib/provider/CustomProvider.ts | 2 +- lib/types.ts | 2 +- lib/utils/index.ts | 52 ++++++++++++++++---------------- test/snapshots/cli.test.ts.md | 4 +-- test/snapshots/cli.test.ts.snap | Bin 3282 -> 3280 bytes test/utils/index.test.ts | 2 +- 7 files changed, 32 insertions(+), 32 deletions(-) diff --git a/docs/guide/custom-provider.md b/docs/guide/custom-provider.md index 357ed0488..169d9f178 100644 --- a/docs/guide/custom-provider.md +++ b/docs/guide/custom-provider.md @@ -419,7 +419,7 @@ module.exports = { 2. 请不要随意将证书检查关闭； ::: -### nodeConfig['underlying-proxy'] +### nodeConfig.underlyingProxy - 类型: `String` - 默认值: `undefined` diff --git a/lib/provider/CustomProvider.ts b/lib/provider/CustomProvider.ts index 496ae1453..359c751d2 100644 --- a/lib/provider/CustomProvider.ts +++ b/lib/provider/CustomProvider.ts @@ -18,7 +18,7 @@ export default class CustomProvider extends Provider { mptcp: Joi.boolean().strict(), binPath: Joi.string(), localPort: Joi.number(), - 'underlying-proxy': Joi.string(), + underlyingProxy: Joi.string(), }) .unknown(); const schema = Joi.object({ diff --git a/lib/types.ts b/lib/types.ts index b7f833ef7..12aba4f3f 100644 --- a/lib/types.ts +++ b/lib/types.ts @@ -264,7 +264,7 @@ export interface SimpleNodeConfig { clashConfig?: CommandConfig['clashConfig']; hostnameIp?: ReadonlyArray; provider?: Provider; - 'underlying-proxy'?: string; + underlyingProxy?: string; } export interface PlainObject { readonly [name: string]: any } diff --git a/lib/utils/index.ts b/lib/utils/index.ts index 370782f29..82ffd52f8 100644 --- a/lib/utils/index.ts +++ b/lib/utils/index.ts @@ -185,9 +185,9 @@ export const getSurgeNodes = function( config.hostname, config.port, 'encrypt-method=' + config.method, - ...pickAndFormatStringList(config, ['password', 'udp-relay', 'obfs', 'obfs-host', 'tfo', 'underlying-proxy']), - ...(typeof config.mptcp === 'boolean' ? [ - `mptcp=${config.mptcp}`, + ...pickAndFormatStringList(config, ['password', 'udp-relay', 'obfs', 'obfs-host', 'tfo', 'mptcp']), + ...(typeof config.underlyingProxy === 'string' ? [ + `underlying-proxy=${config.underlyingProxy}`, ] : []), ].join(', ') ].join(' = ')); @@ -203,9 +203,9 @@ export const getSurgeNodes = function( config.method, config.password, 'https://raw.githubusercontent.com/ConnersHua/SSEncrypt/master/SSEncrypt.module', - ...pickAndFormatStringList(config, ['udp-relay', 'obfs', 'obfs-host', 'tfo', 'underlying-proxy']), - ...(typeof config.mptcp === 'boolean' ? [ - `mptcp=${config.mptcp}`, + ...pickAndFormatStringList(config, ['udp-relay', 'obfs', 'obfs-host', 'tfo', 'mptcp']), + ...(typeof config.underlyingProxy === 'string' ? [ + `underlying-proxy=${config.underlyingProxy}`, ] : []), ].join(', ') ].join(' = ')); @@ -222,19 +222,13 @@ export const getSurgeNodes = function( config.port, config.username, config.password, - ...(typeof config.tls13 === 'boolean' ? [ - `tls13=${config.tls13}`, - ] : []), ...(typeof config.skipCertVerify === 'boolean' ? [ `skip-cert-verify=${config.skipCertVerify}`, ] : []), - ...(typeof config.tfo === 'boolean' ? [ - `tfo=${config.tfo}`, - ] : []), - ...(typeof config.mptcp === 'boolean' ? [ - `mptcp=${config.mptcp}`, + ...(typeof config.underlyingProxy === 'string' ? [ + `underlying-proxy=${config.underlyingProxy}`, ] : []), - ...pickAndFormatStringList(config, ['sni', 'underlying-proxy']), + ...pickAndFormatStringList(config, ['sni', 'tfo', 'mptcp', 'tls13']), ].join(', ') ].join(' = ')); } @@ -250,7 +244,10 @@ export const getSurgeNodes = function( config.port, config.username, config.password, - ...pickAndFormatStringList(config, ['underlying-proxy']), + ...(typeof config.underlyingProxy === 'string' ? [ + `underlying-proxy=${config.underlyingProxy}`, + ] : []), + ...pickAndFormatStringList(config, ['tfo', 'mptcp']), ].join(', ') ].join(' = ')); } @@ -264,13 +261,10 @@ export const getSurgeNodes = function( 'snell', config.hostname, config.port, - ...pickAndFormatStringList(config, ['psk', 'obfs', 'obfs-host', 'version', 'underlying-proxy']), - ...(typeof config.tfo === 'boolean' ? [ - `tfo=${config.tfo}`, - ] : []), - ...(typeof config.mptcp === 'boolean' ? [ - `mptcp=${config.mptcp}`, + ...(typeof config.underlyingProxy === 'string' ? [ + `underlying-proxy=${config.underlyingProxy}`, ] : []), + ...pickAndFormatStringList(config, ['psk', 'obfs', 'obfs-host', 'version', 'tfo', 'mptcp']), ].join(', '), ].join(' = ')); } @@ -380,8 +374,8 @@ export const getSurgeNodes = function( configList.push(`mptcp=${config.mptcp}`); } - if (config['underlying-proxy']) { - configList.push(`underlying-proxy=${config['underlying-proxy']}`); + if (config['underlyingProxy']) { + configList.push(`underlying-proxy=${config['underlyingProxy']}`); } return ([ @@ -435,7 +429,10 @@ export const getSurgeNodes = function( nodeConfig.hostname, `${nodeConfig.port}`, `password=${nodeConfig.password}`, - ...pickAndFormatStringList(nodeConfig, ['tfo', 'mptcp', 'sni', 'underlying-proxy']), + ...pickAndFormatStringList(nodeConfig, ['tfo', 'mptcp', 'sni', 'tls13']), + ...(typeof nodeConfig.underlyingProxy === 'string' ? [ + `underlying-proxy=${nodeConfig.underlyingProxy}`, + ] : []), ...(typeof nodeConfig.skipCertVerify === 'boolean' ? [ `skip-cert-verify=${nodeConfig.skipCertVerify}`, ] : []), @@ -454,7 +451,10 @@ export const getSurgeNodes = function( nodeConfig.tls === true ? "socks5-tls": "socks5", nodeConfig.hostname, nodeConfig.port, - ...pickAndFormatStringList(nodeConfig, ['username', 'password', 'sni', 'tfo', 'underlying-proxy']), + ...(typeof nodeConfig.underlyingProxy === 'string' ? [ + `underlying-proxy=${nodeConfig.underlyingProxy}`, + ] : []), + ...pickAndFormatStringList(nodeConfig, ['username', 'password', 'sni', 'tfo', 'mptcp', 'tls13']), ] if (nodeConfig.tls === true) { diff --git a/test/snapshots/cli.test.ts.md b/test/snapshots/cli.test.ts.md index 6952abb95..9453562fe 100644 --- a/test/snapshots/cli.test.ts.md +++ b/test/snapshots/cli.test.ts.md @@ -13,7 +13,7 @@ Generated by [AVA](https://avajs.dev). 🇺🇸US 2 = ss, us.example.com, 443, encrypt-method=chacha20-ietf-poly1305, password=password, tfo=true, mptcp=true␊ 🇺🇲 US = ss, us.example.com, 443, encrypt-method=chacha20-ietf-poly1305, password=password, udp-relay=true, obfs=tls, obfs-host=gateway-carry.icloud.com, tfo=true, mptcp=true␊ Snell = snell, us.example.com, 443, psk=password, obfs=tls␊ - HTTPS = https, us.example.com, 443, username, password, tls13=true, tfo=true␊ + HTTPS = https, us.example.com, 443, username, password, tfo=true, tls13=true␊ trojan node = trojan, trojan.example.com, 443, password=password␊ 🇺🇸US 1 = ss, us.example.com, 443, encrypt-method=chacha20-ietf-poly1305, password=password, obfs=tls, obfs-host=gateway-carry.icloud.com␊ 🇺🇸US 2 = ss, us.example.com, 444, encrypt-method=chacha20-ietf-poly1305, password=password␊ @@ -649,7 +649,7 @@ Generated by [AVA](https://avajs.dev). ss2 = ss, server, 443, encrypt-method=chacha20-ietf-poly1305, password=password, udp-relay=true, obfs=tls, obfs-host=www.bing.com␊ vmess = vmess, server, 443, username=uuid␊ vmess custom header = vmess, server, 443, username=uuid, ws=true, ws-path=/path, ws-headers="host:server|user-agent:Mozilla/5.0 (iPhone; CPU iPhone OS 13_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.1.1 Mobile/15E148 Safari/604.1|edge:www.baidu.com", tls=true, tls13=true, skip-cert-verify=false, sni=server␊ - http 1 = https, server, 443, username, password, tls13=true, skip-cert-verify=false␊ + http 1 = https, server, 443, username, password, skip-cert-verify=false, tls13=true␊ http 2 = http, server, 443, username, password␊ snell = snell, server, 44046, psk=yourpsk, obfs=http␊ ss4 = ss, server, 443, encrypt-method=chacha20-ietf-poly1305, password=password, udp-relay=true, obfs=tls, obfs-host=example.com␊ diff --git a/test/snapshots/cli.test.ts.snap b/test/snapshots/cli.test.ts.snap index 0072fce7fac76b4a1862888165d498b9b8691714..8ba62311f179d510e4780c7ec4e2ee1eae1a6a25 100644 GIT binary patch delta 2602 zcmV+_3f1+}8PFLbK~_N^Q*L2!b7*gLAa*he0sxWQg;{67?-c;BuwrDQ$;FW(Zvy$| zk&|Zx*Yh%=k^XvrXk~8KYP+@vE5dN(sv~mDf|QE^Ijh<~3aH*fYW1{{XhQ=`{JL`x z)u9Ou1Ea;?Qvi>gK}!3SZXX>zz>M}?cQlPx&w;iHhA?7>#et|u4T{6Ht@nT_m`KSG zNqScCztbSag|lXgnN0!k2&g z`G0=@E7Ia8Lx>SbRq~6g#+3&O*p?c5JKen&6n9#?9kHqHK=G>9+7Wm6Iza2}wxHBS zHI5x$HOG!P0&c%uBZqwmG-x~RGDe^<9KMg~i=YQhS2?hr>xKbpt!iC(O@Gk0O!&HR z^T9)b9t-z>k!CiITY{kvpl|?GT=3+Ius=ey9>dOE-L37^TNr#xcL6sr9DR+!GE#7uY%?(5y=3KrC`TVhPA0U5E%y@9Qs= zsEHBd%vl#04mxoL`bbov?TRPR*1MCi+|=6)S0%@P3CtB@58aycAc5%1MbY;;nrkN< zr+E$#SRqpd{@14;fBEYV5fpgpVpTP;7DE*klxv=2*9=PqMh(HPIgTxoGt|Do?qRhr ziw<)l$-C7$`jyxlM%)dJCVOqjoB-&ElDsFX-41(;#hhSOs>;W%t`4Ak3_Q2b-g%!T zhOQkyBZ`RN@lb2Aw+-0a0O)kM>R8@(B&mLtz1W$@YmYhU*bofHK$5CM3!-u&In;u- zi>?yV=w3~;k==m!fskO6xC2#LqeuqziV%#i;gK935xFAkh5yO;UjzSZ;(y{8OOx$% z6@fN2LPrE1GX0JROxGKFhWmsD7)~E(*4VMsfz#%_358gVq63O9a9q(EK{GJwpx0)l zR{+2{Rg-1}H-Cx9hXNvf)(?W($*4z34|+1!hH7BU!MQilVtuN)44}pOP%AHDH3!;$KlQFy^9vjS*Lb+TXG((1pEFcy{u zo?>D3h5F9RcF?$0#1)~zJI5NbbqC}tzpn`lVn4du@(S0%Bj zT?5!KK2T$!Pz=}^<6wmDw}OL|5DF8OF!j^80XucJII=C*QZ1t$i#hnKD44gwupP-L z7Ra#pxyT{g(9L?499vBIzzrJneD?W40C(6(pSBK;4#xM6M&qYX?mgG! ztCMH@*ON|K?b^ujdb-&r3PkX2H*VmQ?Zz8O*8T}mEmShi7rWfEEpODuiltkxZr`eJ zU%j=xx4V5~pE=%pc(^Usr4k=D=EX;L1agTFRex6?Nn|_omt>>Fh3ywlA!Nh^ikvoj zJ(Z8UOLk6{YEE5(L@~~iT{R<~aU2ePE)Jwo@+VzaC>W-(<8V;K<4^w(+C%p`ED1cdo~Ri6s;#a^-n6#PVRLp8EC~ z@x&sHWensrK)3JufQaj=8o=p4u&vX{O@GVm>b(*Q>rQp(C?!D<1$Q!n3POuc1VPnD zebiV&dJIc$!Lz0cmwX__K_sMvN3_{{9FPlDb}zed@qh!MT6uT8dVgQt$(ZuxFtBbFxZ^W;9k8j{z5x4hd~nLa6AIfwHS`V zY!i#r52-j-d}cgPN6cngD2Hzch70XG=!x=9liCA6ZbFEi$Ua3P@YlZuBUrQsPT|<) z1-U4<^2)g7xLXuvpu_>tbW1^}T*+qTn zEcwdG>=!+zzpk-aOnhM$6Q`^qOkJ+FSrk#kqKNeDYLUY!2~W+8Ln!&qdEET>H!k8! z`DcJb+a>F}cJuD0*OPZeDu1)d%P-09CNIBcdHHFR0EwWmXILFz2wfe|9vm1~a{WvEE`_3eZ}=37mMlv7lC2 zl@OM1c+Ts2>6I6)w<0JXqt7S8qq>Bri3-A$&+bs-dOW}#ftDt z*VR#bLHuRDTj$C1iq<`zk>y;~Z*5s-4a`MhICH>|C4Dr-_ht%HIzrl&1ffu@p-anC zsw7Fwm@<$m3A&R;3z2_B)^dbds8Gi*hR(|5H`5WD*ijUpk zei}_?yL&=Y_G!)~S#tPY`lH+H%^kWw|HSfa^v&!oRphqI)Ae<>rx4pN*4M`rWvvKQ z>i#!=z-K+$VK&Vrh?9w$6}3?us*O8^m;#Ip1v&6PRLhj#-y^ZtiBco0aZ%!;TrO z*NrBGHuke`cQ^cc09DS)kZV_ M2VMGfGu3MV0601Hs{jB1 delta 2606 zcmV+}3eok@8PXXdK~_N^Q*L2!b7*gLAa*he0sz;F2{b*E1j-XUCl9cKOAV1CZvr{* zk&|Zx(|MWHk^XvrC^5HdwO!kT6=67X)e$*nLCVE|oJIDJ0-{?8RZkm$z?ipw_C^h1c{4eanQe z3pXD;6zH*ka35)Ac7@*i z7E}k;72y#=pj&25YT$c>1FNGOuqL(Ml$v|OA?N~IM-?=yQaKQdoR3(7>X0r(6;AK# zFO;Z>ISY&#F>GC6IOxO~=p#{uwkw`MTklT7a#L@AGhCG%CoortJ#=f%g9NHyE~bE>=|oYcW(&LAmBRcFnL>gJ8vgj};lDu23qhE==VZ`0gXtLLa%n5*wD9L-G+U>BnSj-7lrK)`F>goWx$G~&@ z?49>S*~-whV^kxm@OY@T*xLr|Z2)vS966S^9Z9NRWiNK-@!DffIyMA@F_5I{(1NI( zNDj52?V_usYILur*~o4{{6JV?ld}U=S*wu@>J=dvU&A9gJR)*M)(iiW@xKQC*TnzC zF_tFV=_&$kYJ`pmJY@PE516hu^bGe24KSQO(5$gzsRO6YdlL$=8bt>bUEsK)HG*bf z)IqP!O0NKbb4Zh61UG-2s}KPqebx_x+R3O#Ne_B5Q$rLOb8zlWv{;{NE(2(>KGe#K zXV&jotZ!hiynqNP0iszV4t(1W2oxF*WTl+VwfC(HZ#YstGYT&lWmW)ki0Q$eZSvBN>DktgwG6;YPvCCK?iXL;3T{ zkt8;?YXBR@2Wl)7iUB)g9E{NYR&bCKLSdp3hCYoOuv2G?BinK<)iT<#n1jEHf_WPZ z+mVc7feeeEiyX2I-KC(rh;C!Ms~wUOcVbhAwqh~V39+`uQ>jW>|2{S%^EsAQTicDZL;-l&ZgOSfL# zzE$78dTV=ccl*XZbG-NPa9gfRB|dD-i;wIGTIl-4Z)Xw;Yv3&y4YheX>;c{7J#Z6(Mqv zW8H^DD$akBos+FKr!GOF7-z|@ni0=94u?J$2hu3{lddZi4Aa5Ga^{j&MDG^!)9kHz)URO6F6!zN5Z%>$%#{PSoK$*JHuN5{eVK@;n-1d9YJY zefx}fVv)u&267sp+jo6H#C25-;PfBZ*6HM?Wp;n{UI~SDr#f_$k|2nJI~hR*p+zTx zpz5POYAhi=h9$S)SyP2eK9J%d5>mn=T8#W_MJS`zFOzd$8)AzJ$R!jhDgrfh0SrvLt^2@^11su7sD;L3T4!9b{Hp7W*Bazax+08MA9UMwS z*DrrX&4bzq=dCj~66M3~D?%-(*gIu0p*rY_0!8@o2WOWaNg3oQypY#oRTyUm8D1UT7};D2i!_;- zNf%T)tocBSHLM8Vi(^*NAi0J{6@_IhYXX062~I8yHs>?AS1*je(2mSukOVm#kHB*+ zhNCds#3J=WDvlMO8PC%ZvzZpk;oE`XLi-MSqP)|j_P~#u5Mn2?Pmu`x^>4ul7OjC( zICgnKF3PREGHyBU7KIroaR4;k)CQKUn3l;fa-6Zz7VU#L{LNrnc=Jxb6Q0KM7&3oZ z-Pst{$gbhYxd497==ySgD`A%*xgt*&2k~ps(s^|r68^7WTQgzKEK3tegP-Ey6=Lix zsuFg>_WCJRRs>O6D-sjU1IENjb8(~)H#2FQLR#_3a z%p6x|a7VeE)#fp2T1Favo;QQO@E(6AGi8*&!DE(-F366bLSC31X2z)izm4GsPcThH zG9|^$GI_Qky3lbMUa-%AMsXu(_h4cQ|A@(GC{`$^6*l69VStazqBt3!MWHJ}84D8g zgAn=JxR7&KnF2Xp5b2E=dJObfW{w-oag#X?jbv0KV-av6(=muNBE>>YMcb2*32c8{ zU8!qXlf=S#-#wQ^_#$n zw;Ky;l~oC0`G)7bo|j&E(RwR_@-g~+B0Q=~c$%mnO!@47l|Wn24q^GBrL#$tkLryz z-&d>%zjR$4wHL%+=DT&CJg;co;~81bRsGhMW!Au46oxYg3|Z1gQ+#ixFr_1;T}f0F ziZyg;`I;)pDrQU>NR>prlR^uTf0eA|2=_kJdQc&f1G?s6(Pba>m=!br3UI9a#9i|@ zx=$6~v<>dl>!)?few}lxEIIrx{n739<__JTe`0wy`eyc)DstQ9>H0d`Q;2OB>+55R zvQ`8tb^jYb;Ikg>Fq>@;*^9qzUOI+z*hViMNW=GDmVrQRPFlV6g|WPAd`@$LsC`Rv z9`}G!w3O~0%fidHXY6u&#L^zIEX}Zn+!bfmHi+pebH3XmCNRb19J4O-+}zD>H!I!k zh8;6luN!xGj##?qo;uddtqj|UsVn`cTU5nPN1JmxLPy { }, tfo: true, mptcp: true, - 'underlying-proxy': 'another-proxy', + underlyingProxy: 'another-proxy', }]; const txt1 = utils.getSurgeNodes(nodeList).split('\n'); const txt2 = utils.getSurgeNodes(nodeList, nodeConfig => nodeConfig.nodeName === 'Test Node 1');