@docusaurus/utils 3.1.1 → 3.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/cliUtils.d.ts +14 -0
- package/lib/cliUtils.d.ts.map +1 -0
- package/lib/cliUtils.js +50 -0
- package/lib/cliUtils.js.map +1 -0
- package/lib/emitUtils.d.ts.map +1 -1
- package/lib/emitUtils.js +6 -3
- package/lib/emitUtils.js.map +1 -1
- package/lib/gitUtils.d.ts +6 -6
- package/lib/gitUtils.d.ts.map +1 -1
- package/lib/gitUtils.js +21 -10
- package/lib/gitUtils.js.map +1 -1
- package/lib/globUtils.d.ts.map +1 -1
- package/lib/globUtils.js +2 -2
- package/lib/globUtils.js.map +1 -1
- package/lib/index.d.ts +6 -3
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +12 -7
- package/lib/index.js.map +1 -1
- package/lib/jsUtils.d.ts +0 -8
- package/lib/jsUtils.d.ts.map +1 -1
- package/lib/jsUtils.js +1 -25
- package/lib/jsUtils.js.map +1 -1
- package/lib/lastUpdateUtils.d.ts +28 -0
- package/lib/lastUpdateUtils.d.ts.map +1 -0
- package/lib/lastUpdateUtils.js +88 -0
- package/lib/lastUpdateUtils.js.map +1 -0
- package/lib/markdownUtils.js +2 -2
- package/lib/markdownUtils.js.map +1 -1
- package/lib/pathUtils.d.ts +8 -0
- package/lib/pathUtils.d.ts.map +1 -1
- package/lib/pathUtils.js +15 -1
- package/lib/pathUtils.js.map +1 -1
- package/lib/routeUtils.d.ts +13 -0
- package/lib/routeUtils.d.ts.map +1 -0
- package/lib/routeUtils.js +21 -0
- package/lib/routeUtils.js.map +1 -0
- package/lib/urlUtils.d.ts +0 -6
- package/lib/urlUtils.d.ts.map +1 -1
- package/lib/urlUtils.js +1 -18
- package/lib/urlUtils.js.map +1 -1
- package/package.json +6 -4
- package/src/cliUtils.ts +65 -0
- package/src/emitUtils.ts +7 -3
- package/src/gitUtils.ts +44 -20
- package/src/globUtils.ts +1 -2
- package/src/index.ts +13 -9
- package/src/jsUtils.ts +0 -24
- package/src/lastUpdateUtils.ts +132 -0
- package/src/markdownUtils.ts +2 -2
- package/src/pathUtils.ts +14 -0
- package/src/routeUtils.ts +19 -0
- package/src/urlUtils.ts +0 -17
package/lib/markdownUtils.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"markdownUtils.js","sourceRoot":"","sources":["../src/markdownUtils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,wEAAwC;AACxC,sEAAiC;AACjC,uCAA2E;AAM3E,6EAA6E;AAC7E,6EAA6E;AAC7E,qEAAqE;AAErE;;;;;;GAMG;AACH,SAAgB,sBAAsB,CAAC,OAAe;IAQpD,MAAM,oBAAoB,GAAG,mCAAmC,CAAC;IACjE,MAAM,OAAO,GAAG,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACnD,IAAI,OAAO,EAAE;QACX,OAAO;YACL,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAE,EAAE,EAAE,CAAC;YACtC,EAAE,EAAE,OAAO,CAAC,MAAO,CAAC,EAAG;SACxB,CAAC;KACH;IACD,OAAO,EAAC,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,SAAS,EAAC,CAAC;AACxC,CAAC;AAjBD,wDAiBC;AAED;;;GAGG;AACH,SAAgB,wBAAwB,CAAC,OAAe;IACtD,MAAM,qBAAqB,GAAG,wBAAwB,CAAC;IACvD,OAAO,OAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE,CAAC,SAAS,EAAE,EAAE;IAC7D,+CAA+C;IAC/C,SAAS;SACN,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,6BAA6B;SAC5B,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CAC7B,CAAC;AACJ,CAAC;AATD,4DASC;AAED;;;;;;;;GAQG;AACH,SAAgB,mBAAmB,CAAC,OAAe;IACjD,kEAAkE;IAClE,MAAM,OAAO,GACX,
|
|
1
|
+
{"version":3,"file":"markdownUtils.js","sourceRoot":"","sources":["../src/markdownUtils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,wEAAwC;AACxC,sEAAiC;AACjC,uCAA2E;AAM3E,6EAA6E;AAC7E,6EAA6E;AAC7E,qEAAqE;AAErE;;;;;;GAMG;AACH,SAAgB,sBAAsB,CAAC,OAAe;IAQpD,MAAM,oBAAoB,GAAG,mCAAmC,CAAC;IACjE,MAAM,OAAO,GAAG,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACnD,IAAI,OAAO,EAAE;QACX,OAAO;YACL,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAE,EAAE,EAAE,CAAC;YACtC,EAAE,EAAE,OAAO,CAAC,MAAO,CAAC,EAAG;SACxB,CAAC;KACH;IACD,OAAO,EAAC,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,SAAS,EAAC,CAAC;AACxC,CAAC;AAjBD,wDAiBC;AAED;;;GAGG;AACH,SAAgB,wBAAwB,CAAC,OAAe;IACtD,MAAM,qBAAqB,GAAG,wBAAwB,CAAC;IACvD,OAAO,OAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE,CAAC,SAAS,EAAE,EAAE;IAC7D,+CAA+C;IAC/C,SAAS;SACN,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,6BAA6B;SAC5B,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CAC7B,CAAC;AACJ,CAAC;AATD,4DASC;AAED;;;;;;;;GAQG;AACH,SAAgB,mBAAmB,CAAC,OAAe;IACjD,kEAAkE;IAClE,MAAM,OAAO,GACX,kGAAkG,CAAC;IACrG,MAAM,OAAO,GACX,oGAAoG,CAAC;IAEvG,8DAA8D;IAC9D,MAAM,QAAQ,GAAG,CAAC,SAAiB,EAAE,GAAG,IAAW,EAAE,EAAE;QACrD,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3B,OAAO,GAAG,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,GAAG,EAAE,CAAC;IAC1D,CAAC,CAAC;IAEF,OAAO,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AAC7E,CAAC;AAdD,kDAcC;AAED;;;;;;;;GAQG;AACH,SAAgB,+BAA+B,CAC7C,OAAe,EACf,6BAAuC;IAEvC,iEAAiE;IACjE,+DAA+D;IAE/D,MAAM,kBAAkB,GAAG,IAAI,6BAA6B,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;IAC1E,MAAM,MAAM,GAAG,IAAI,MAAM,CACvB,+DAA+D,kBAAkB,kBAAkB,EACnG,IAAI,CACL,CAAC;IAEF,OAAO,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE,GAAG,IAAW,EAAE,EAAE;QAC9D,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAE3B,OAAO,GAAG,MAAM,CAAC,KAAK,IAAI,EAAE,GAAG,MAAM,CAAC,WAAW,IAAI,EAAE,GACrD,MAAM,CAAC,SACT,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC;IACtB,CAAC,CAAC,CAAC;AACL,CAAC;AApBD,0EAoBC;AAED,gFAAgF;AAChF,wDAAwD;AACxD;;;;;;;;;GASG;AACH,SAAgB,aAAa,CAAC,UAAkB;IAC9C,MAAM,SAAS,GAAG,UAAU;SACzB,SAAS,EAAE;QACZ,kCAAkC;SACjC,OAAO,CAAC,qBAAqB,EAAE,EAAE,CAAC;SAClC,KAAK,CAAC,OAAO,CAAC,CAAC;IAClB,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,IAAI,aAAa,GAAG,EAAE,CAAC;IAEvB,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;QAChC,yCAAyC;QACzC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,QAAQ,EAAE;YAChC,QAAQ,GAAG,KAAK,CAAC;SAClB;QAED,mBAAmB;QACnB,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE;YACpB,SAAS;SACV;QAED,kCAAkC;QAClC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE;YACpE,QAAQ,GAAG,IAAI,CAAC;YAChB,SAAS;SACV;QAED,wBAAwB;QACxB,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;YACrC,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAE,CAAC,CAAC,CAAE,CAAC;YACpD,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,GAAG,IAAI,CAAC;gBACd,aAAa,GAAG,SAAS,CAAC;gBAC1B,wEAAwE;gBACxE,YAAY;aACb;iBAAM,IAAI,SAAS,CAAC,MAAM,IAAI,aAAa,CAAC,MAAM,EAAE;gBACnD,MAAM,GAAG,KAAK,CAAC;aAChB;YACD,SAAS;SACV;aAAM,IAAI,MAAM,EAAE;YACjB,SAAS;SACV;QAED,MAAM,WAAW,GAAG,QAAQ;YAC1B,oBAAoB;aACnB,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;YACxB,uBAAuB;aACtB,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC;YAC3B,sCAAsC;aACrC,OAAO,CAAC,sCAAsC,EAAE,IAAI,CAAC;YACtD,mBAAmB;aAClB,OAAO,CAAC,sCAAsC,EAAE,IAAI,CAAC;YACtD,yBAAyB;aACxB,OAAO,CAAC,sBAAsB,EAAE,IAAI,CAAC;YACtC,iBAAiB;aAChB,OAAO,CAAC,+BAA+B,EAAE,IAAI,CAAC;YAC/C,oBAAoB;aACnB,OAAO,CAAC,sBAAsB,EAAE,EAAE,CAAC;YACpC,uBAAuB;aACtB,OAAO,CAAC,8BAA8B,EAAE,IAAI,CAAC;YAC9C,sBAAsB;aACrB,OAAO,CAAC,iBAAiB,EAAE,IAAI,CAAC;YACjC,sBAAsB;aACrB,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC;YAC7B,gCAAgC;aAC/B,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;YACrB,iEAAiE;aAChE,OAAO,CAAC,sBAAsB,EAAE,EAAE,CAAC;YACpC,qCAAqC;aACpC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC;aAC3B,IAAI,EAAE,CAAC;QAEV,IAAI,WAAW,EAAE;YACf,OAAO,WAAW,CAAC;SACpB;KACF;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AA9ED,sCA8EC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,2BAA2B,CAAC,WAAmB;IAM7D,0DAA0D;IAC1D,4EAA4E;IAC5E,MAAM,EAAC,IAAI,EAAE,OAAO,EAAC,GAAG,IAAA,qBAAM,EAAC,WAAW,CAAC,CAAC;IAE5C,gEAAgE;IAChE,0GAA0G;IAC1G,6EAA6E;IAC7E,kEAAkE;IAClE,+DAA+D;IAC/D,MAAM,WAAW;IACf,yEAAyE;IACzE,iDAAiD;IACjD,sDAAsD;IACtD,uEAAuE;IACvE,OAAO,CAAC,GAAG,CAAC,cAAc;QACxB,CAAC,CAAC,IAAA,qBAAM,EAAC,WAAW,EAAE,EAAE,CAAC,CAAC,IAAI;QAC9B,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAE5B,OAAO;QACL,WAAW;QACX,OAAO,EAAE,OAAO,CAAC,IAAI,EAAE;KACxB,CAAC;AACJ,CAAC;AA5BD,kEA4BC;AAEM,MAAM,0BAA0B,GAA4B,KAAK,EACtE,MAAM,EACN,EAAE,CAAC,2BAA2B,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;AAFxC,QAAA,0BAA0B,8BAEc;AAErD,SAAS,kBAAkB,CAAC,YAAoB;IAC9C,OAAO,YAAY,CAAC,OAAO,CAAC,mBAAmB,EAAE,SAAS,CAAC,CAAC;AAC9D,CAAC;AAYD;;;;;;;;;;GAUG;AACH,SAAgB,yBAAyB,CACvC,gBAAwB,EACxB,OAA0C;IAO1C,MAAM,wBAAwB,GAAG,OAAO,EAAE,kBAAkB,IAAI,KAAK,CAAC;IAEtE,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,EAAE,CAAC;IACxC,yEAAyE;IACzE,8EAA8E;IAC9E,yEAAyE;IACzE,MAAM,oBAAoB,GAAG,OAAO;SACjC,OAAO,CAAC,kDAAkD,EAAE,EAAE,CAAC;SAC/D,IAAI,EAAE,CAAC;IAEV,MAAM,iBAAiB,GAAG,uCAAuC,CAAC,IAAI,CACpE,oBAAoB,CACrB,CAAC;IACF,MAAM,mBAAmB,GAAG,iCAAiC,CAAC,IAAI,CAChE,oBAAoB,CACrB,CAAC;IAEF,MAAM,UAAU,GAAG,iBAAiB,IAAI,mBAAmB,CAAC;IAC5D,IAAI,CAAC,UAAU,EAAE;QACf,OAAO,EAAC,OAAO,EAAE,YAAY,EAAE,SAAS,EAAC,CAAC;KAC3C;IACD,MAAM,UAAU,GAAG,wBAAwB;QACzC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAE,EAAE,EAAE,CAAC;QACrC,CAAC,CAAC,OAAO,CAAC;IACZ,IAAI,iBAAiB,EAAE;QACrB,OAAO;YACL,OAAO,EAAE,UAAU,CAAC,IAAI,EAAE;YAC1B,YAAY,EAAE,kBAAkB,CAC9B,iBAAiB;iBACd,MAAO,CAAC,KAAM,CAAC,IAAI,EAAE;iBACrB,OAAO,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAC1C,CAAC,IAAI,EAAE;SACT,CAAC;KACH;IACD,OAAO;QACL,OAAO,EAAE,UAAU,CAAC,IAAI,EAAE;QAC1B,YAAY,EAAE,kBAAkB,CAC9B,mBAAoB,CAAC,MAAO,CAAC,KAAM,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CACjE,CAAC,IAAI,EAAE;KACT,CAAC;AACJ,CAAC;AAjDD,8DAiDC;AAED;;;;;GAKG;AACI,KAAK,UAAU,iBAAiB,CAAC,EACtC,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,kBAAkB,GAKgB;IAalC,IAAI;QACF,MAAM,EAAC,WAAW,EAAE,OAAO,EAAE,yBAAyB,EAAC,GACrD,MAAM,gBAAgB,CAAC;YACrB,QAAQ;YACR,WAAW;YACX,uBAAuB,EAAE,kCAA0B;SACpD,CAAC,CAAC;QAEL,MAAM,EAAC,OAAO,EAAE,YAAY,EAAC,GAAG,yBAAyB,CACvD,yBAAyB,EACzB,EAAC,kBAAkB,EAAC,CACrB,CAAC;QAEF,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;QAEvC,OAAO;YACL,WAAW;YACX,OAAO;YACP,YAAY;YACZ,OAAO;SACR,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,gBAAM,CAAC,KAAK,CAAC;kHACiG,CAAC,CAAC;QAChH,MAAM,GAAG,CAAC;KACX;AACH,CAAC;AAhDD,8CAgDC;AAED,SAAS,mBAAmB,CAAC,IAAY;IACvC,OAAO,IAAI,CAAC,OAAO,CACjB,8BAA8B,EAC9B,CAAC,KAAK,EAAE,EAAU,EAAE,EAAE,CAAC,EAAE,CAC1B,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CACnB,IAAY,EACZ,OAAgB,EAChB,YAAqB;IAErB,IAAI,YAAY,GAAG,CAAC,CAAC;IACrB,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,GAAG,EAAE;QACxC,YAAY,IAAI,CAAC,CAAC;KACnB;IAED,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,OAAO,EAAE,CAAC;IACvD,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;IAClD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE;QACjE,YAAY;KACb,CAAC,CAAC;IAEH,OAAO,GAAG,aAAa,GAAG,WAAW,MAAM,IAAI,GAAG,CAAC;AACrD,CAAC;AAOD;;;;GAIG;AACH,SAAgB,sBAAsB,CACpC,OAAe,EACf,UAAiC,EAAC,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAC;IAExE,MAAM,EAAC,YAAY,GAAG,KAAK,EAAE,SAAS,GAAG,KAAK,EAAC,GAAG,OAAO,CAAC;IAC1D,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAClC,MAAM,OAAO,GAAG,IAAA,uBAAa,GAAE,CAAC;IAEhC,uEAAuE;IACvE,oEAAoE;IACpE,IAAI,CAAC,SAAS,EAAE;QACd,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,MAAM,aAAa,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC;YACnD,IAAI,aAAa,CAAC,EAAE,EAAE;gBACpB,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;aAChC;QACH,CAAC,CAAC,CAAC;KACJ;IAED,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,OAAO,KAAK;SACT,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACZ,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;YAC1B,MAAM,GAAG,CAAC,MAAM,CAAC;YACjB,OAAO,IAAI,CAAC;SACb;QACD,gEAAgE;QAChE,IAAI,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;YACpC,OAAO,IAAI,CAAC;SACb;QACD,MAAM,aAAa,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAEnD,wCAAwC;QACxC,IAAI,aAAa,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE;YAClC,OAAO,IAAI,CAAC;SACb;QACD,OAAO,YAAY,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;IACjE,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAvCD,wDAuCC"}
|
package/lib/pathUtils.d.ts
CHANGED
|
@@ -36,6 +36,14 @@ export declare function toMessageRelativeFilePath(filePath: string): string;
|
|
|
36
36
|
* Example: some/path/to/website/docs/foo.md -> @site/docs/foo.md
|
|
37
37
|
*/
|
|
38
38
|
export declare function aliasedSitePath(filePath: string, siteDir: string): string;
|
|
39
|
+
/**
|
|
40
|
+
* Converts back the aliased site path (starting with "@site/...") to a relative path
|
|
41
|
+
*
|
|
42
|
+
* TODO method this is a workaround, we shouldn't need to alias/un-alias paths
|
|
43
|
+
* we should refactor the codebase to not have aliased site paths everywhere
|
|
44
|
+
* We probably only need aliasing for client-only paths required by Webpack
|
|
45
|
+
*/
|
|
46
|
+
export declare function aliasedSitePathToRelativePath(filePath: string): string;
|
|
39
47
|
/**
|
|
40
48
|
* When you have a path like C:\X\Y
|
|
41
49
|
* It is not safe to use directly when generating code
|
package/lib/pathUtils.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pathUtils.d.ts","sourceRoot":"","sources":["../src/pathUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAeH,eAAO,MAAM,aAAa,QAAS,MAAM,KAAG,OAMgC,CAAC;AAE7E,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAiB7C;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAO7C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAElE;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAKzE;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAK9C;AAED,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAK5D"}
|
|
1
|
+
{"version":3,"file":"pathUtils.d.ts","sourceRoot":"","sources":["../src/pathUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAeH,eAAO,MAAM,aAAa,QAAS,MAAM,KAAG,OAMgC,CAAC;AAE7E,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAiB7C;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAO7C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAElE;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAKzE;AAED;;;;;;GAMG;AACH,wBAAgB,6BAA6B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAKtE;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAK9C;AAED,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAK5D"}
|
package/lib/pathUtils.js
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
* LICENSE file in the root directory of this source tree.
|
|
7
7
|
*/
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
-
exports.addTrailingPathSeparator = exports.escapePath = exports.aliasedSitePath = exports.toMessageRelativeFilePath = exports.posixPath = exports.shortName = exports.isNameTooLong = void 0;
|
|
9
|
+
exports.addTrailingPathSeparator = exports.escapePath = exports.aliasedSitePathToRelativePath = exports.aliasedSitePath = exports.toMessageRelativeFilePath = exports.posixPath = exports.shortName = exports.isNameTooLong = void 0;
|
|
10
10
|
const tslib_1 = require("tslib");
|
|
11
11
|
const path_1 = tslib_1.__importDefault(require("path"));
|
|
12
12
|
// Based on https://github.com/gatsbyjs/gatsby/pull/21518/files
|
|
@@ -84,6 +84,20 @@ function aliasedSitePath(filePath, siteDir) {
|
|
|
84
84
|
return `@site/${relativePath}`;
|
|
85
85
|
}
|
|
86
86
|
exports.aliasedSitePath = aliasedSitePath;
|
|
87
|
+
/**
|
|
88
|
+
* Converts back the aliased site path (starting with "@site/...") to a relative path
|
|
89
|
+
*
|
|
90
|
+
* TODO method this is a workaround, we shouldn't need to alias/un-alias paths
|
|
91
|
+
* we should refactor the codebase to not have aliased site paths everywhere
|
|
92
|
+
* We probably only need aliasing for client-only paths required by Webpack
|
|
93
|
+
*/
|
|
94
|
+
function aliasedSitePathToRelativePath(filePath) {
|
|
95
|
+
if (filePath.startsWith('@site/')) {
|
|
96
|
+
return filePath.replace('@site/', '');
|
|
97
|
+
}
|
|
98
|
+
throw new Error(`Unexpected, filePath is not site-aliased: ${filePath}`);
|
|
99
|
+
}
|
|
100
|
+
exports.aliasedSitePathToRelativePath = aliasedSitePathToRelativePath;
|
|
87
101
|
/**
|
|
88
102
|
* When you have a path like C:\X\Y
|
|
89
103
|
* It is not safe to use directly when generating code
|
package/lib/pathUtils.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pathUtils.js","sourceRoot":"","sources":["../src/pathUtils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,wDAAwB;AAExB,+DAA+D;AAC/D,qEAAqE;AACrE,qBAAqB;AACrB,MAAM,sBAAsB,GAAG,GAAG,CAAC;AACnC,MAAM,sBAAsB,GAAG,GAAG,CAAC;AACnC,0EAA0E;AAC1E,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAE/B,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC;AACpD,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC;AAE9C,MAAM,aAAa,GAAG,CAAC,GAAW,EAAW,EAAE;AACpD,qEAAqE;AACrE,OAAO,EAAE,IAAI,SAAS,EAAE;IACtB,CAAC,CAAC,oEAAoE;QACpE,GAAG,CAAC,MAAM,GAAG,mBAAmB,GAAG,sBAAsB;IAC3D,CAAC,CAAC,oBAAoB;QACpB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,mBAAmB,GAAG,sBAAsB,CAAC;AANhE,QAAA,aAAa,iBAMmD;AAE7E,SAAgB,SAAS,CAAC,GAAW;IACnC,IAAI,OAAO,EAAE,IAAI,SAAS,EAAE,EAAE;QAC5B,MAAM,gBAAgB,GAAG,GAAG,CAAC,MAAM,GAAG,sBAAsB,CAAC;QAC7D,OAAO,GAAG,CAAC,KAAK,CACd,CAAC,EACD,GAAG,CAAC,MAAM,GAAG,gBAAgB,GAAG,mBAAmB,GAAG,CAAC,CACxD,CAAC;KACH;IACD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnC,MAAM,gBAAgB,GACpB,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,sBAAsB,CAAC;IACxD,OAAO,SAAS;SACb,KAAK,CACJ,CAAC,EACD,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,gBAAgB,GAAG,mBAAmB,GAAG,CAAC,CAC1E;SACA,QAAQ,EAAE,CAAC;AAChB,CAAC;AAjBD,8BAiBC;AAED;;;;;;;;;GASG;AACH,SAAgB,SAAS,CAAC,GAAW;IACnC,MAAM,oBAAoB,GAAG,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAEvD,IAAI,oBAAoB,EAAE;QACxB,OAAO,GAAG,CAAC;KACZ;IACD,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACjC,CAAC;AAPD,8BAOC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,yBAAyB,CAAC,QAAgB;IACxD,OAAO,SAAS,CAAC,cAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC3D,CAAC;AAFD,8DAEC;AAED;;;;GAIG;AACH,SAAgB,eAAe,CAAC,QAAgB,EAAE,OAAe;IAC/D,MAAM,YAAY,GAAG,SAAS,CAAC,cAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;IACjE,0DAA0D;IAC1D,8CAA8C;IAC9C,OAAO,SAAS,YAAY,EAAE,CAAC;AACjC,CAAC;AALD,0CAKC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAgB,UAAU,CAAC,GAAW;IACpC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAEpC,uCAAuC;IACvC,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AAClD,CAAC;AALD,gCAKC;AAED,SAAgB,wBAAwB,CAAC,GAAW;IAClD,OAAO,GAAG,CAAC,QAAQ,CAAC,cAAI,CAAC,GAAG,CAAC;QAC3B,CAAC,CAAC,GAAG;QACL,CAAC,CAAC,sEAAsE;YACtE,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,GAAG,cAAI,CAAC,GAAG,EAAE,CAAC;AAChD,CAAC;AALD,4DAKC"}
|
|
1
|
+
{"version":3,"file":"pathUtils.js","sourceRoot":"","sources":["../src/pathUtils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,wDAAwB;AAExB,+DAA+D;AAC/D,qEAAqE;AACrE,qBAAqB;AACrB,MAAM,sBAAsB,GAAG,GAAG,CAAC;AACnC,MAAM,sBAAsB,GAAG,GAAG,CAAC;AACnC,0EAA0E;AAC1E,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAE/B,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC;AACpD,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC;AAE9C,MAAM,aAAa,GAAG,CAAC,GAAW,EAAW,EAAE;AACpD,qEAAqE;AACrE,OAAO,EAAE,IAAI,SAAS,EAAE;IACtB,CAAC,CAAC,oEAAoE;QACpE,GAAG,CAAC,MAAM,GAAG,mBAAmB,GAAG,sBAAsB;IAC3D,CAAC,CAAC,oBAAoB;QACpB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,mBAAmB,GAAG,sBAAsB,CAAC;AANhE,QAAA,aAAa,iBAMmD;AAE7E,SAAgB,SAAS,CAAC,GAAW;IACnC,IAAI,OAAO,EAAE,IAAI,SAAS,EAAE,EAAE;QAC5B,MAAM,gBAAgB,GAAG,GAAG,CAAC,MAAM,GAAG,sBAAsB,CAAC;QAC7D,OAAO,GAAG,CAAC,KAAK,CACd,CAAC,EACD,GAAG,CAAC,MAAM,GAAG,gBAAgB,GAAG,mBAAmB,GAAG,CAAC,CACxD,CAAC;KACH;IACD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnC,MAAM,gBAAgB,GACpB,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,sBAAsB,CAAC;IACxD,OAAO,SAAS;SACb,KAAK,CACJ,CAAC,EACD,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,gBAAgB,GAAG,mBAAmB,GAAG,CAAC,CAC1E;SACA,QAAQ,EAAE,CAAC;AAChB,CAAC;AAjBD,8BAiBC;AAED;;;;;;;;;GASG;AACH,SAAgB,SAAS,CAAC,GAAW;IACnC,MAAM,oBAAoB,GAAG,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAEvD,IAAI,oBAAoB,EAAE;QACxB,OAAO,GAAG,CAAC;KACZ;IACD,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACjC,CAAC;AAPD,8BAOC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,yBAAyB,CAAC,QAAgB;IACxD,OAAO,SAAS,CAAC,cAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC3D,CAAC;AAFD,8DAEC;AAED;;;;GAIG;AACH,SAAgB,eAAe,CAAC,QAAgB,EAAE,OAAe;IAC/D,MAAM,YAAY,GAAG,SAAS,CAAC,cAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;IACjE,0DAA0D;IAC1D,8CAA8C;IAC9C,OAAO,SAAS,YAAY,EAAE,CAAC;AACjC,CAAC;AALD,0CAKC;AAED;;;;;;GAMG;AACH,SAAgB,6BAA6B,CAAC,QAAgB;IAC5D,IAAI,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;QACjC,OAAO,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;KACvC;IACD,MAAM,IAAI,KAAK,CAAC,6CAA6C,QAAQ,EAAE,CAAC,CAAC;AAC3E,CAAC;AALD,sEAKC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAgB,UAAU,CAAC,GAAW;IACpC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAEpC,uCAAuC;IACvC,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AAClD,CAAC;AALD,gCAKC;AAED,SAAgB,wBAAwB,CAAC,GAAW;IAClD,OAAO,GAAG,CAAC,QAAQ,CAAC,cAAI,CAAC,GAAG,CAAC;QAC3B,CAAC,CAAC,GAAG;QACL,CAAC,CAAC,sEAAsE;YACtE,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,GAAG,cAAI,CAAC,GAAG,EAAE,CAAC;AAChD,CAAC;AALD,4DAKC"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
import type { RouteConfig } from '@docusaurus/types';
|
|
8
|
+
/**
|
|
9
|
+
* Recursively flatten routes and only return the "leaf routes"
|
|
10
|
+
* Parent routes are filtered out
|
|
11
|
+
*/
|
|
12
|
+
export declare function flattenRoutes(routeConfig: RouteConfig[]): RouteConfig[];
|
|
13
|
+
//# sourceMappingURL=routeUtils.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"routeUtils.d.ts","sourceRoot":"","sources":["../src/routeUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,mBAAmB,CAAC;AAEnD;;;GAGG;AACH,wBAAgB,aAAa,CAAC,WAAW,EAAE,WAAW,EAAE,GAAG,WAAW,EAAE,CAKvE"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
4
|
+
*
|
|
5
|
+
* This source code is licensed under the MIT license found in the
|
|
6
|
+
* LICENSE file in the root directory of this source tree.
|
|
7
|
+
*/
|
|
8
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
+
exports.flattenRoutes = void 0;
|
|
10
|
+
/**
|
|
11
|
+
* Recursively flatten routes and only return the "leaf routes"
|
|
12
|
+
* Parent routes are filtered out
|
|
13
|
+
*/
|
|
14
|
+
function flattenRoutes(routeConfig) {
|
|
15
|
+
function flatten(route) {
|
|
16
|
+
return route.routes ? route.routes.flatMap(flatten) : [route];
|
|
17
|
+
}
|
|
18
|
+
return routeConfig.flatMap(flatten);
|
|
19
|
+
}
|
|
20
|
+
exports.flattenRoutes = flattenRoutes;
|
|
21
|
+
//# sourceMappingURL=routeUtils.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"routeUtils.js","sourceRoot":"","sources":["../src/routeUtils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAIH;;;GAGG;AACH,SAAgB,aAAa,CAAC,WAA0B;IACtD,SAAS,OAAO,CAAC,KAAkB;QACjC,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAChE,CAAC;IACD,OAAO,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACtC,CAAC;AALD,sCAKC"}
|
package/lib/urlUtils.d.ts
CHANGED
|
@@ -54,12 +54,6 @@ export declare function serializeURLPath(urlPath: URLPath): string;
|
|
|
54
54
|
* router)
|
|
55
55
|
*/
|
|
56
56
|
export declare function resolvePathname(to: string, from?: string): string;
|
|
57
|
-
/** Appends a leading slash to `str`, if one doesn't exist. */
|
|
58
|
-
export declare function addLeadingSlash(str: string): string;
|
|
59
|
-
/** Appends a trailing slash to `str`, if one doesn't exist. */
|
|
60
|
-
export declare function addTrailingSlash(str: string): string;
|
|
61
|
-
/** Removes the trailing slash from `str`. */
|
|
62
|
-
export declare function removeTrailingSlash(str: string): string;
|
|
63
57
|
/** Constructs an SSH URL that can be used to push to GitHub. */
|
|
64
58
|
export declare function buildSshUrl(githubHost: string, organizationName: string, projectName: string, githubPort?: string): string;
|
|
65
59
|
/** Constructs an HTTP URL that can be used to push to GitHub. */
|
package/lib/urlUtils.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"urlUtils.d.ts","sourceRoot":"","sources":["../src/urlUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;
|
|
1
|
+
{"version":3,"file":"urlUtils.d.ts","sourceRoot":"","sources":["../src/urlUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,CAoFtD;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CACxB,gBAAgB,EAAE,MAAM,EACxB,OAAO,CAAC,EAAE,MAAM,GACf,MAAM,GAAG,SAAS,CAKpB;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAQ/C;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAKnD;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAUpD;AAED,MAAM,MAAM,OAAO,GAAG;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAC,CAAC;AAKzE,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CA2CxE;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAIzD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAIjE;AAED,gEAAgE;AAChE,wBAAgB,WAAW,CACzB,UAAU,EAAE,MAAM,EAClB,gBAAgB,EAAE,MAAM,EACxB,WAAW,EAAE,MAAM,EACnB,UAAU,CAAC,EAAE,MAAM,GAClB,MAAM,CAKR;AAED,iEAAiE;AACjE,wBAAgB,aAAa,CAC3B,cAAc,EAAE,MAAM,EACtB,UAAU,EAAE,MAAM,EAClB,gBAAgB,EAAE,MAAM,EACxB,WAAW,EAAE,MAAM,EACnB,UAAU,CAAC,EAAE,MAAM,GAClB,MAAM,CAKR;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAU7D"}
|
package/lib/urlUtils.js
CHANGED
|
@@ -6,10 +6,9 @@
|
|
|
6
6
|
* LICENSE file in the root directory of this source tree.
|
|
7
7
|
*/
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
-
exports.hasSSHProtocol = exports.buildHttpsUrl = exports.buildSshUrl = exports.
|
|
9
|
+
exports.hasSSHProtocol = exports.buildHttpsUrl = exports.buildSshUrl = exports.resolvePathname = exports.serializeURLPath = exports.parseURLPath = exports.isValidPathname = exports.encodePath = exports.fileToPath = exports.getEditUrl = exports.normalizeUrl = void 0;
|
|
10
10
|
const tslib_1 = require("tslib");
|
|
11
11
|
const resolve_pathname_1 = tslib_1.__importDefault(require("resolve-pathname"));
|
|
12
|
-
const jsUtils_1 = require("./jsUtils");
|
|
13
12
|
/**
|
|
14
13
|
* Much like `path.join`, but much better. Takes an array of URL segments, and
|
|
15
14
|
* joins them into a reasonable URL.
|
|
@@ -203,22 +202,6 @@ function resolvePathname(to, from) {
|
|
|
203
202
|
return (0, resolve_pathname_1.default)(to, from);
|
|
204
203
|
}
|
|
205
204
|
exports.resolvePathname = resolvePathname;
|
|
206
|
-
/** Appends a leading slash to `str`, if one doesn't exist. */
|
|
207
|
-
function addLeadingSlash(str) {
|
|
208
|
-
return (0, jsUtils_1.addPrefix)(str, '/');
|
|
209
|
-
}
|
|
210
|
-
exports.addLeadingSlash = addLeadingSlash;
|
|
211
|
-
// TODO deduplicate: also present in @docusaurus/utils-common
|
|
212
|
-
/** Appends a trailing slash to `str`, if one doesn't exist. */
|
|
213
|
-
function addTrailingSlash(str) {
|
|
214
|
-
return (0, jsUtils_1.addSuffix)(str, '/');
|
|
215
|
-
}
|
|
216
|
-
exports.addTrailingSlash = addTrailingSlash;
|
|
217
|
-
/** Removes the trailing slash from `str`. */
|
|
218
|
-
function removeTrailingSlash(str) {
|
|
219
|
-
return (0, jsUtils_1.removeSuffix)(str, '/');
|
|
220
|
-
}
|
|
221
|
-
exports.removeTrailingSlash = removeTrailingSlash;
|
|
222
205
|
/** Constructs an SSH URL that can be used to push to GitHub. */
|
|
223
206
|
function buildSshUrl(githubHost, organizationName, projectName, githubPort) {
|
|
224
207
|
if (githubPort) {
|
package/lib/urlUtils.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"urlUtils.js","sourceRoot":"","sources":["../src/urlUtils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,gFAAqD;
|
|
1
|
+
{"version":3,"file":"urlUtils.js","sourceRoot":"","sources":["../src/urlUtils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,gFAAqD;AAErD;;;;;;;;;;;GAWG;AACH,SAAgB,YAAY,CAAC,OAAiB;IAC5C,MAAM,IAAI,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC;IAC1B,MAAM,WAAW,GAAG,EAAE,CAAC;IAEvB,IAAI,gBAAgB,GAAG,KAAK,CAAC;IAC7B,IAAI,cAAc,GAAG,KAAK,CAAC;IAE3B,MAAM,eAAe,GAAG,CAAC,GAAa,EAAgC,EAAE,CACtE,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;IAEjB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE;QAC1B,OAAO,EAAE,CAAC;KACX;IAED,2EAA2E;IAC3E,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;QACpD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,EAAG,CAAC;QAC5B,IAAI,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YACxD,wEAAwE;YACxE,8BAA8B;YAC9B,IAAI,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;SAClC;aAAM;YACL,IAAI,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;SAC3B;KACF;IAED,2DAA2D;IAC3D,gCAAgC;IAChC,MAAM,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC;IACvE,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,0BAA0B,EAAE,WAAW,CAAC,CAAC;IAEnE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;QACvC,IAAI,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAExB,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YACjC,MAAM,IAAI,SAAS,CAAC,kCAAkC,OAAO,SAAS,EAAE,CAAC,CAAC;SAC3E;QAED,IAAI,SAAS,KAAK,EAAE,EAAE;YACpB,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,cAAc,EAAE;gBAC3C,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACvB;YACD,SAAS;SACV;QAED,IAAI,SAAS,KAAK,GAAG,EAAE;YACrB,IAAI,CAAC,GAAG,CAAC,EAAE;gBACT,kEAAkE;gBAClE,SAAS,GAAG,SAAS,CAAC,OAAO,CAC3B,MAAM;gBACN,2DAA2D;gBAC3D,2BAA2B;gBAC3B,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAC1D,CAAC;aACH;YAED,cAAc,GAAG,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YACzC,uEAAuE;YACvE,mEAAmE;YACnE,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;SACvE;QAED,gBAAgB,GAAG,IAAI,CAAC;QACxB,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;KAC7B;IAED,IAAI,GAAG,GAAG,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChC,8EAA8E;IAC9E,6BAA6B;IAE7B,mDAAmD;IACnD,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,0BAA0B,EAAE,IAAI,CAAC,CAAC;IAEpD,kCAAkC;IAClC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7B,GAAG,GAAG,KAAK,CAAC,KAAK,EAAG,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEvE,wEAAwE;IACxE,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,4BAA4B,EAAE,IAAI,CAAC,CAAC;IAEtD,uDAAuD;IACvD,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IAEhC,OAAO,GAAG,CAAC;AACb,CAAC;AApFD,oCAoFC;AAED;;;;GAIG;AACH,SAAgB,UAAU,CACxB,gBAAwB,EACxB,OAAgB;IAEhB,OAAO,OAAO;QACZ,CAAC,CAAC,sEAAsE;YACtE,YAAY,CAAC,CAAC,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC;AARD,gCAQC;AAED;;;GAGG;AACH,SAAgB,UAAU,CAAC,IAAY;IACrC,MAAM,OAAO,GAAG,+CAA+C,CAAC;IAChE,MAAM,KAAK,GAAG,uBAAuB,CAAC;IAEtC,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;KACrC;IACD,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;AAC3D,CAAC;AARD,gCAQC;AAED;;;;;;GAMG;AACH,SAAgB,UAAU,CAAC,QAAgB;IACzC,OAAO,QAAQ;SACZ,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;SACvC,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AALD,gCAKC;AAED;;;GAGG;AACH,SAAgB,eAAe,CAAC,GAAW;IACzC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QACxB,OAAO,KAAK,CAAC;KACd;IACD,IAAI;QACF,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC,QAAQ,CAAC;QACnE,OAAO,cAAc,KAAK,GAAG,IAAI,cAAc,KAAK,SAAS,CAAC,GAAG,CAAC,CAAC;KACpE;IAAC,MAAM;QACN,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAVD,0CAUC;AAID,kEAAkE;AAClE,qEAAqE;AACrE,sEAAsE;AACtE,SAAgB,YAAY,CAAC,OAAe,EAAE,QAAiB;IAC7D,SAAS,QAAQ,CAAC,GAAW,EAAE,IAAmB;QAChD,IAAI;YACF,0DAA0D;YAC1D,OAAO,IAAI,GAAG,CAAC,GAAG,EAAE,IAAI,IAAI,qBAAqB,CAAC,CAAC;SACpD;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CACb,mBAAmB,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAC3D,EAAC,KAAK,EAAE,CAAC,EAAC,CACX,CAAC;SACH;IACH,CAAC;IAED,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACvD,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAEpC,MAAM,EAAC,QAAQ,EAAC,GAAG,GAAG,CAAC;IAEvB,qCAAqC;IACrC,kBAAkB;IAClB,YAAY;IACZ,qBAAqB;IACrB,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM;QACvB,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACrB,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;YACvB,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,SAAS,CAAC;IAEd,mCAAmC;IACnC,kBAAkB;IAClB,YAAY;IACZ,qBAAqB;IACrB,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI;QACnB,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QACnB,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;YACvB,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO;QACL,QAAQ;QACR,MAAM;QACN,IAAI;KACL,CAAC;AACJ,CAAC;AA3CD,oCA2CC;AAED,SAAgB,gBAAgB,CAAC,OAAgB;IAC/C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IACxE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;IAClE,OAAO,GAAG,OAAO,CAAC,QAAQ,GAAG,MAAM,GAAG,IAAI,EAAE,CAAC;AAC/C,CAAC;AAJD,4CAIC;AAED;;;;GAIG;AACH,SAAgB,eAAe,CAAC,EAAU,EAAE,IAAa;IACvD,uDAAuD;IACvD,qEAAqE;IACrE,OAAO,IAAA,0BAAqB,EAAC,EAAE,EAAE,IAAI,CAAC,CAAC;AACzC,CAAC;AAJD,0CAIC;AAED,gEAAgE;AAChE,SAAgB,WAAW,CACzB,UAAkB,EAClB,gBAAwB,EACxB,WAAmB,EACnB,UAAmB;IAEnB,IAAI,UAAU,EAAE;QACd,OAAO,aAAa,UAAU,IAAI,UAAU,IAAI,gBAAgB,IAAI,WAAW,MAAM,CAAC;KACvF;IACD,OAAO,OAAO,UAAU,IAAI,gBAAgB,IAAI,WAAW,MAAM,CAAC;AACpE,CAAC;AAVD,kCAUC;AAED,iEAAiE;AACjE,SAAgB,aAAa,CAC3B,cAAsB,EACtB,UAAkB,EAClB,gBAAwB,EACxB,WAAmB,EACnB,UAAmB;IAEnB,IAAI,UAAU,EAAE;QACd,OAAO,WAAW,cAAc,IAAI,UAAU,IAAI,UAAU,IAAI,gBAAgB,IAAI,WAAW,MAAM,CAAC;KACvG;IACD,OAAO,WAAW,cAAc,IAAI,UAAU,IAAI,gBAAgB,IAAI,WAAW,MAAM,CAAC;AAC1F,CAAC;AAXD,sCAWC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAAC,aAAqB;IAClD,IAAI;QACF,IAAI,IAAI,GAAG,CAAC,aAAa,CAAC,CAAC,QAAQ,KAAK,MAAM,EAAE;YAC9C,OAAO,IAAI,CAAC;SACb;QACD,OAAO,KAAK,CAAC;KACd;IAAC,MAAM;QACN,oCAAoC;QACpC,OAAO,+BAA+B,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;KAC5D;AACH,CAAC;AAVD,wCAUC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docusaurus/utils",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.2.1",
|
|
4
4
|
"description": "Node utility functions for Docusaurus packages.",
|
|
5
5
|
"main": "./lib/index.js",
|
|
6
6
|
"types": "./lib/index.d.ts",
|
|
@@ -18,7 +18,8 @@
|
|
|
18
18
|
},
|
|
19
19
|
"license": "MIT",
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@docusaurus/logger": "3.
|
|
21
|
+
"@docusaurus/logger": "3.2.1",
|
|
22
|
+
"@docusaurus/utils-common": "3.2.1",
|
|
22
23
|
"@svgr/webpack": "^6.5.1",
|
|
23
24
|
"escape-string-regexp": "^4.0.0",
|
|
24
25
|
"file-loader": "^6.2.0",
|
|
@@ -30,6 +31,7 @@
|
|
|
30
31
|
"js-yaml": "^4.1.0",
|
|
31
32
|
"lodash": "^4.17.21",
|
|
32
33
|
"micromatch": "^4.0.5",
|
|
34
|
+
"prompts": "^2.4.2",
|
|
33
35
|
"resolve-pathname": "^3.0.0",
|
|
34
36
|
"shelljs": "^0.8.5",
|
|
35
37
|
"tslib": "^2.6.0",
|
|
@@ -40,7 +42,7 @@
|
|
|
40
42
|
"node": ">=18.0"
|
|
41
43
|
},
|
|
42
44
|
"devDependencies": {
|
|
43
|
-
"@docusaurus/types": "3.
|
|
45
|
+
"@docusaurus/types": "3.2.1",
|
|
44
46
|
"@types/dedent": "^0.7.0",
|
|
45
47
|
"@types/github-slugger": "^1.3.0",
|
|
46
48
|
"@types/micromatch": "^4.0.2",
|
|
@@ -56,5 +58,5 @@
|
|
|
56
58
|
"optional": true
|
|
57
59
|
}
|
|
58
60
|
},
|
|
59
|
-
"gitHead": "
|
|
61
|
+
"gitHead": "f268e15264e208e6faf26117258162e988b53773"
|
|
60
62
|
}
|
package/src/cliUtils.ts
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
import prompts, {type Choice} from 'prompts';
|
|
9
|
+
import logger from '@docusaurus/logger';
|
|
10
|
+
|
|
11
|
+
type PreferredLanguage = 'javascript' | 'typescript';
|
|
12
|
+
|
|
13
|
+
type AskPreferredLanguageOptions = {
|
|
14
|
+
fallback: PreferredLanguage | undefined;
|
|
15
|
+
exit: boolean;
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
const DefaultOptions: AskPreferredLanguageOptions = {
|
|
19
|
+
fallback: undefined,
|
|
20
|
+
exit: false,
|
|
21
|
+
};
|
|
22
|
+
|
|
23
|
+
const ExitChoice: Choice = {title: logger.yellow('[Exit]'), value: '[Exit]'};
|
|
24
|
+
|
|
25
|
+
export async function askPreferredLanguage(
|
|
26
|
+
options: Partial<AskPreferredLanguageOptions> = {},
|
|
27
|
+
): Promise<'javascript' | 'typescript'> {
|
|
28
|
+
const {fallback, exit} = {...DefaultOptions, ...options};
|
|
29
|
+
|
|
30
|
+
const choices: Choice[] = [
|
|
31
|
+
{title: logger.bold('JavaScript'), value: 'javascript'},
|
|
32
|
+
{title: logger.bold('TypeScript'), value: 'typescript'},
|
|
33
|
+
];
|
|
34
|
+
if (exit) {
|
|
35
|
+
choices.push(ExitChoice);
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
const {language} = await prompts(
|
|
39
|
+
{
|
|
40
|
+
type: 'select',
|
|
41
|
+
name: 'language',
|
|
42
|
+
message: 'Which language do you want to use?',
|
|
43
|
+
choices,
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
onCancel() {
|
|
47
|
+
exit && process.exit(0);
|
|
48
|
+
},
|
|
49
|
+
},
|
|
50
|
+
);
|
|
51
|
+
|
|
52
|
+
if (language === ExitChoice.value) {
|
|
53
|
+
process.exit(0);
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
if (!language) {
|
|
57
|
+
if (fallback) {
|
|
58
|
+
logger.info`Falling back to language=${fallback}`;
|
|
59
|
+
return fallback;
|
|
60
|
+
}
|
|
61
|
+
process.exit(0);
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
return language;
|
|
65
|
+
}
|
package/src/emitUtils.ts
CHANGED
|
@@ -12,6 +12,10 @@ import {findAsyncSequential} from './jsUtils';
|
|
|
12
12
|
|
|
13
13
|
const fileHash = new Map<string, string>();
|
|
14
14
|
|
|
15
|
+
const hashContent = (content: string): string => {
|
|
16
|
+
return createHash('md5').update(content).digest('hex');
|
|
17
|
+
};
|
|
18
|
+
|
|
15
19
|
/**
|
|
16
20
|
* Outputs a file to the generated files directory. Only writes files if content
|
|
17
21
|
* differs from cache (for hot reload performance).
|
|
@@ -38,7 +42,7 @@ export async function generate(
|
|
|
38
42
|
// first "A" remains in cache. But if the file never existed in cache, no
|
|
39
43
|
// need to register it.
|
|
40
44
|
if (fileHash.get(filepath)) {
|
|
41
|
-
fileHash.set(filepath,
|
|
45
|
+
fileHash.set(filepath, hashContent(content));
|
|
42
46
|
}
|
|
43
47
|
return;
|
|
44
48
|
}
|
|
@@ -50,11 +54,11 @@ export async function generate(
|
|
|
50
54
|
// overwriting and we can reuse old file.
|
|
51
55
|
if (!lastHash && (await fs.pathExists(filepath))) {
|
|
52
56
|
const lastContent = await fs.readFile(filepath, 'utf8');
|
|
53
|
-
lastHash =
|
|
57
|
+
lastHash = hashContent(lastContent);
|
|
54
58
|
fileHash.set(filepath, lastHash);
|
|
55
59
|
}
|
|
56
60
|
|
|
57
|
-
const currentHash =
|
|
61
|
+
const currentHash = hashContent(content);
|
|
58
62
|
|
|
59
63
|
if (lastHash !== currentHash) {
|
|
60
64
|
await fs.outputFile(filepath, content);
|
package/src/gitUtils.ts
CHANGED
|
@@ -6,7 +6,16 @@
|
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
8
|
import path from 'path';
|
|
9
|
-
import
|
|
9
|
+
import fs from 'fs-extra';
|
|
10
|
+
import _ from 'lodash';
|
|
11
|
+
import shell from 'shelljs'; // TODO replace with async-first version
|
|
12
|
+
|
|
13
|
+
const realHasGitFn = () => !!shell.which('git');
|
|
14
|
+
|
|
15
|
+
// The hasGit call is synchronous IO so we memoize it
|
|
16
|
+
// The user won't install Git in the middle of a build anyway...
|
|
17
|
+
const hasGit =
|
|
18
|
+
process.env.NODE_ENV === 'test' ? realHasGitFn : _.memoize(realHasGitFn);
|
|
10
19
|
|
|
11
20
|
/** Custom error thrown when git is not found in `PATH`. */
|
|
12
21
|
export class GitNotFoundError extends Error {}
|
|
@@ -24,7 +33,7 @@ export class FileNotTrackedError extends Error {}
|
|
|
24
33
|
* @throws Also throws when `git log` exited with non-zero, or when it outputs
|
|
25
34
|
* unexpected text.
|
|
26
35
|
*/
|
|
27
|
-
export function getFileCommitDate(
|
|
36
|
+
export async function getFileCommitDate(
|
|
28
37
|
/** Absolute path to the file. */
|
|
29
38
|
file: string,
|
|
30
39
|
args: {
|
|
@@ -36,12 +45,12 @@ export function getFileCommitDate(
|
|
|
36
45
|
/** Use `includeAuthor: true` to get the author information as well. */
|
|
37
46
|
includeAuthor?: false;
|
|
38
47
|
},
|
|
39
|
-
): {
|
|
48
|
+
): Promise<{
|
|
40
49
|
/** Relevant commit date. */
|
|
41
50
|
date: Date;
|
|
42
|
-
/** Timestamp
|
|
51
|
+
/** Timestamp returned from git, converted to **milliseconds**. */
|
|
43
52
|
timestamp: number;
|
|
44
|
-
}
|
|
53
|
+
}>;
|
|
45
54
|
/**
|
|
46
55
|
* Fetches the git history of a file and returns a relevant commit date.
|
|
47
56
|
* It gets the commit date instead of author date so that amended commits
|
|
@@ -52,7 +61,7 @@ export function getFileCommitDate(
|
|
|
52
61
|
* @throws Also throws when `git log` exited with non-zero, or when it outputs
|
|
53
62
|
* unexpected text.
|
|
54
63
|
*/
|
|
55
|
-
export function getFileCommitDate(
|
|
64
|
+
export async function getFileCommitDate(
|
|
56
65
|
/** Absolute path to the file. */
|
|
57
66
|
file: string,
|
|
58
67
|
args: {
|
|
@@ -63,15 +72,16 @@ export function getFileCommitDate(
|
|
|
63
72
|
age?: 'oldest' | 'newest';
|
|
64
73
|
includeAuthor: true;
|
|
65
74
|
},
|
|
66
|
-
): {
|
|
75
|
+
): Promise<{
|
|
67
76
|
/** Relevant commit date. */
|
|
68
77
|
date: Date;
|
|
69
|
-
/** Timestamp
|
|
78
|
+
/** Timestamp returned from git, converted to **milliseconds**. */
|
|
70
79
|
timestamp: number;
|
|
71
80
|
/** The author's name, as returned from git. */
|
|
72
81
|
author: string;
|
|
73
|
-
}
|
|
74
|
-
|
|
82
|
+
}>;
|
|
83
|
+
|
|
84
|
+
export async function getFileCommitDate(
|
|
75
85
|
file: string,
|
|
76
86
|
{
|
|
77
87
|
age = 'oldest',
|
|
@@ -80,18 +90,18 @@ export function getFileCommitDate(
|
|
|
80
90
|
age?: 'oldest' | 'newest';
|
|
81
91
|
includeAuthor?: boolean;
|
|
82
92
|
},
|
|
83
|
-
): {
|
|
93
|
+
): Promise<{
|
|
84
94
|
date: Date;
|
|
85
95
|
timestamp: number;
|
|
86
96
|
author?: string;
|
|
87
|
-
} {
|
|
88
|
-
if (!
|
|
97
|
+
}> {
|
|
98
|
+
if (!hasGit()) {
|
|
89
99
|
throw new GitNotFoundError(
|
|
90
100
|
`Failed to retrieve git history for "${file}" because git is not installed.`,
|
|
91
101
|
);
|
|
92
102
|
}
|
|
93
103
|
|
|
94
|
-
if (!
|
|
104
|
+
if (!(await fs.pathExists(file))) {
|
|
95
105
|
throw new Error(
|
|
96
106
|
`Failed to retrieve git history for "${file}" because the file does not exist.`,
|
|
97
107
|
);
|
|
@@ -105,11 +115,24 @@ export function getFileCommitDate(
|
|
|
105
115
|
.filter(Boolean)
|
|
106
116
|
.join(' ');
|
|
107
117
|
|
|
108
|
-
const result =
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
118
|
+
const result = await new Promise<{
|
|
119
|
+
code: number;
|
|
120
|
+
stdout: string;
|
|
121
|
+
stderr: string;
|
|
122
|
+
}>((resolve) => {
|
|
123
|
+
shell.exec(
|
|
124
|
+
`git log ${args} -- "${path.basename(file)}"`,
|
|
125
|
+
{
|
|
126
|
+
// Setting cwd is important, see: https://github.com/facebook/docusaurus/pull/5048
|
|
127
|
+
cwd: path.dirname(file),
|
|
128
|
+
silent: true,
|
|
129
|
+
},
|
|
130
|
+
(code, stdout, stderr) => {
|
|
131
|
+
resolve({code, stdout, stderr});
|
|
132
|
+
},
|
|
133
|
+
);
|
|
112
134
|
});
|
|
135
|
+
|
|
113
136
|
if (result.code !== 0) {
|
|
114
137
|
throw new Error(
|
|
115
138
|
`Failed to retrieve the git history for file "${file}" with exit code ${result.code}: ${result.stderr}`,
|
|
@@ -136,8 +159,9 @@ export function getFileCommitDate(
|
|
|
136
159
|
);
|
|
137
160
|
}
|
|
138
161
|
|
|
139
|
-
const
|
|
140
|
-
const
|
|
162
|
+
const timestampInSeconds = Number(match.groups!.timestamp);
|
|
163
|
+
const timestamp = timestampInSeconds * 1_000;
|
|
164
|
+
const date = new Date(timestamp);
|
|
141
165
|
|
|
142
166
|
if (includeAuthor) {
|
|
143
167
|
return {date, timestamp, author: match.groups!.author!};
|
package/src/globUtils.ts
CHANGED
|
@@ -9,8 +9,7 @@
|
|
|
9
9
|
|
|
10
10
|
import path from 'path';
|
|
11
11
|
import Micromatch from 'micromatch'; // Note: Micromatch is used by Globby
|
|
12
|
-
import {addSuffix} from '
|
|
13
|
-
|
|
12
|
+
import {addSuffix} from '@docusaurus/utils-common';
|
|
14
13
|
/** A re-export of the globby instance. */
|
|
15
14
|
export {default as Globby} from 'globby';
|
|
16
15
|
|
package/src/index.ts
CHANGED
|
@@ -35,12 +35,7 @@ export {
|
|
|
35
35
|
getPluginI18nPath,
|
|
36
36
|
localizePath,
|
|
37
37
|
} from './i18nUtils';
|
|
38
|
-
export {
|
|
39
|
-
removeSuffix,
|
|
40
|
-
removePrefix,
|
|
41
|
-
mapAsyncSequential,
|
|
42
|
-
findAsyncSequential,
|
|
43
|
-
} from './jsUtils';
|
|
38
|
+
export {mapAsyncSequential, findAsyncSequential} from './jsUtils';
|
|
44
39
|
export {
|
|
45
40
|
normalizeUrl,
|
|
46
41
|
getEditUrl,
|
|
@@ -50,9 +45,6 @@ export {
|
|
|
50
45
|
resolvePathname,
|
|
51
46
|
parseURLPath,
|
|
52
47
|
serializeURLPath,
|
|
53
|
-
addLeadingSlash,
|
|
54
|
-
addTrailingSlash,
|
|
55
|
-
removeTrailingSlash,
|
|
56
48
|
hasSSHProtocol,
|
|
57
49
|
buildHttpsUrl,
|
|
58
50
|
buildSshUrl,
|
|
@@ -91,6 +83,7 @@ export {
|
|
|
91
83
|
posixPath,
|
|
92
84
|
toMessageRelativeFilePath,
|
|
93
85
|
aliasedSitePath,
|
|
86
|
+
aliasedSitePathToRelativePath,
|
|
94
87
|
escapePath,
|
|
95
88
|
addTrailingPathSeparator,
|
|
96
89
|
} from './pathUtils';
|
|
@@ -117,3 +110,14 @@ export {
|
|
|
117
110
|
} from './dataFileUtils';
|
|
118
111
|
export {isDraft, isUnlisted} from './contentVisibilityUtils';
|
|
119
112
|
export {escapeRegexp} from './regExpUtils';
|
|
113
|
+
export {askPreferredLanguage} from './cliUtils';
|
|
114
|
+
export {flattenRoutes} from './routeUtils';
|
|
115
|
+
|
|
116
|
+
export {
|
|
117
|
+
getGitLastUpdate,
|
|
118
|
+
getLastUpdate,
|
|
119
|
+
readLastUpdateData,
|
|
120
|
+
LAST_UPDATE_FALLBACK,
|
|
121
|
+
type LastUpdateData,
|
|
122
|
+
type FrontMatterLastUpdate,
|
|
123
|
+
} from './lastUpdateUtils';
|
package/src/jsUtils.ts
CHANGED
|
@@ -5,30 +5,6 @@
|
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
|
-
/** Adds a given string prefix to `str`. */
|
|
9
|
-
export function addPrefix(str: string, prefix: string): string {
|
|
10
|
-
return str.startsWith(prefix) ? str : `${prefix}${str}`;
|
|
11
|
-
}
|
|
12
|
-
|
|
13
|
-
/** Adds a given string suffix to `str`. */
|
|
14
|
-
export function addSuffix(str: string, suffix: string): string {
|
|
15
|
-
return str.endsWith(suffix) ? str : `${str}${suffix}`;
|
|
16
|
-
}
|
|
17
|
-
|
|
18
|
-
/** Removes a given string suffix from `str`. */
|
|
19
|
-
export function removeSuffix(str: string, suffix: string): string {
|
|
20
|
-
if (suffix === '') {
|
|
21
|
-
// str.slice(0, 0) is ""
|
|
22
|
-
return str;
|
|
23
|
-
}
|
|
24
|
-
return str.endsWith(suffix) ? str.slice(0, -suffix.length) : str;
|
|
25
|
-
}
|
|
26
|
-
|
|
27
|
-
/** Removes a given string prefix from `str`. */
|
|
28
|
-
export function removePrefix(str: string, prefix: string): string {
|
|
29
|
-
return str.startsWith(prefix) ? str.slice(prefix.length) : str;
|
|
30
|
-
}
|
|
31
|
-
|
|
32
8
|
/**
|
|
33
9
|
* `Array#map` for async operations where order matters.
|
|
34
10
|
* @param array The array to traverse.
|