@docusaurus/remark-plugin-npm2yarn 3.6.3 → 3.7.0
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/README.md +3 -2
- package/lib/index.d.ts +1 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +11 -1
- package/lib/index.js.map +1 -1
- package/package.json +2 -2
- package/src/index.ts +13 -2
package/README.md
CHANGED
|
@@ -63,11 +63,11 @@ module.exports = {
|
|
|
63
63
|
| Property | Type | Default | Description |
|
|
64
64
|
| --- | --- | --- | --- |
|
|
65
65
|
| `sync` | `boolean` | `false` | Syncing tab choices (Yarn and npm). See https://docusaurus.io/docs/markdown-features/#syncing-tab-choices for details. |
|
|
66
|
-
| `converters` | `array` | `'yarn'`, `'pnpm'` | The list of converters to use. The order of the converters is important, as the first converter will be used as the default choice. |
|
|
66
|
+
| `converters` | `array` | `'yarn'`, `'pnpm'`, `'bun'` | The list of converters to use. The order of the converters is important, as the first converter will be used as the default choice. |
|
|
67
67
|
|
|
68
68
|
## Custom converters
|
|
69
69
|
|
|
70
|
-
In case you want to convert npm commands to something else than `yarn` or `
|
|
70
|
+
In case you want to convert npm commands to something else than `yarn`, `pnpm` or `bun`, you can use custom converters:
|
|
71
71
|
|
|
72
72
|
```ts
|
|
73
73
|
type CustomConverter = [name: string, cb: (npmCode: string) => string];
|
|
@@ -83,6 +83,7 @@ type CustomConverter = [name: string, cb: (npmCode: string) => string];
|
|
|
83
83
|
converters: [
|
|
84
84
|
'yarn',
|
|
85
85
|
'pnpm',
|
|
86
|
+
'bun',
|
|
86
87
|
['Turbo', (code) => code.replace(/npm/g, 'turbo')],
|
|
87
88
|
],
|
|
88
89
|
},
|
package/lib/index.d.ts
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
6
6
|
*/
|
|
7
7
|
type Plugin<T> = any;
|
|
8
|
-
type KnownConverter = 'yarn' | 'pnpm';
|
|
8
|
+
type KnownConverter = 'yarn' | 'pnpm' | 'bun';
|
|
9
9
|
type CustomConverter = [name: string, cb: (npmCode: string) => string];
|
|
10
10
|
type Converter = CustomConverter | KnownConverter;
|
|
11
11
|
type PluginOptions = {
|
package/lib/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAeH,KAAK,MAAM,CAAC,CAAC,IAAI,GAAG,CAAC;AAErB,KAAK,cAAc,GAAG,MAAM,GAAG,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAeH,KAAK,MAAM,CAAC,CAAC,IAAI,GAAG,CAAC;AAErB,KAAK,cAAc,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC;AAE9C,KAAK,eAAe,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC;AAEvE,KAAK,SAAS,GAAG,eAAe,GAAG,cAAc,CAAC;AAElD,KAAK,aAAa,GAAG;IACnB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;CAC1B,CAAC;AAuJF,QAAA,MAAM,MAAM,EAAE,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,CAkCpC,CAAC;AAIF,SAAS,MAAM,CAAC"}
|
package/lib/index.js
CHANGED
|
@@ -46,7 +46,7 @@ const transformNode = (node, isSync, converters) => {
|
|
|
46
46
|
code: (0, npm_to_yarn_1.default)(npmCode, converter),
|
|
47
47
|
node,
|
|
48
48
|
value: converter,
|
|
49
|
-
label: converter
|
|
49
|
+
label: getLabelForConverter(converter),
|
|
50
50
|
});
|
|
51
51
|
}
|
|
52
52
|
const [converterName, converterFn] = converter;
|
|
@@ -56,6 +56,16 @@ const transformNode = (node, isSync, converters) => {
|
|
|
56
56
|
value: converterName,
|
|
57
57
|
});
|
|
58
58
|
}
|
|
59
|
+
function getLabelForConverter(converter) {
|
|
60
|
+
switch (converter) {
|
|
61
|
+
case 'yarn':
|
|
62
|
+
return 'Yarn';
|
|
63
|
+
case 'bun':
|
|
64
|
+
return 'Bun';
|
|
65
|
+
default:
|
|
66
|
+
return converter;
|
|
67
|
+
}
|
|
68
|
+
}
|
|
59
69
|
return [
|
|
60
70
|
{
|
|
61
71
|
type: 'mdxJsxFlowElement',
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,sEAAoC;AA0BpC,SAAS,eAAe,CACtB,aAAqB,EACrB,cAAwC;IAExC,OAAO;QACL,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,aAAa;QACnB,KAAK,EAAE,cAAc;KACtB,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,EACrB,IAAI,EACJ,IAAI,EACJ,KAAK,EACL,KAAK,GAMN;IACC,OAAO;QACL,IAAI,EAAE,mBAAmB;QACzB,IAAI,EAAE,SAAS;QACf,UAAU,EAAE;YACV,eAAe,CAAC,OAAO,EAAE,KAAK,CAAC;YAC/B,KAAK,IAAI,eAAe,CAAC,OAAO,EAAE,KAAK,CAAC;SACzC,CAAC,MAAM,CAAC,CAAC,IAAI,EAA2B,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1D,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,KAAK,EAAE,IAAI;aACZ;SACF;KACF,CAAC;AACJ,CAAC;AAED,MAAM,aAAa,GAAG,CACpB,IAAU,EACV,MAAe,EACf,UAAuB,EACvB,EAAE;IACF,MAAM,WAAW,GAAG,MAAM;QACxB,CAAC,CAAC;YACE,IAAI,EAAE,iBAAiB;YACvB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,UAAU;SAClB;QACH,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC;IAE3B,SAAS,sBAAsB,CAAC,SAAoB;QAClD,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;YAClC,OAAO,aAAa,CAAC;gBACnB,IAAI,EAAE,IAAA,qBAAS,EAAC,OAAO,EAAE,SAAS,CAAC;gBACnC,IAAI;gBACJ,KAAK,EAAE,SAAS;gBAChB,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,sEAAoC;AA0BpC,SAAS,eAAe,CACtB,aAAqB,EACrB,cAAwC;IAExC,OAAO;QACL,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,aAAa;QACnB,KAAK,EAAE,cAAc;KACtB,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,EACrB,IAAI,EACJ,IAAI,EACJ,KAAK,EACL,KAAK,GAMN;IACC,OAAO;QACL,IAAI,EAAE,mBAAmB;QACzB,IAAI,EAAE,SAAS;QACf,UAAU,EAAE;YACV,eAAe,CAAC,OAAO,EAAE,KAAK,CAAC;YAC/B,KAAK,IAAI,eAAe,CAAC,OAAO,EAAE,KAAK,CAAC;SACzC,CAAC,MAAM,CAAC,CAAC,IAAI,EAA2B,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1D,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,KAAK,EAAE,IAAI;aACZ;SACF;KACF,CAAC;AACJ,CAAC;AAED,MAAM,aAAa,GAAG,CACpB,IAAU,EACV,MAAe,EACf,UAAuB,EACvB,EAAE;IACF,MAAM,WAAW,GAAG,MAAM;QACxB,CAAC,CAAC;YACE,IAAI,EAAE,iBAAiB;YACvB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,UAAU;SAClB;QACH,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC;IAE3B,SAAS,sBAAsB,CAAC,SAAoB;QAClD,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;YAClC,OAAO,aAAa,CAAC;gBACnB,IAAI,EAAE,IAAA,qBAAS,EAAC,OAAO,EAAE,SAAS,CAAC;gBACnC,IAAI;gBACJ,KAAK,EAAE,SAAS;gBAChB,KAAK,EAAE,oBAAoB,CAAC,SAAS,CAAC;aACvC,CAAC,CAAC;QACL,CAAC;QACD,MAAM,CAAC,aAAa,EAAE,WAAW,CAAC,GAAG,SAAS,CAAC;QAC/C,OAAO,aAAa,CAAC;YACnB,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;YAC1B,IAAI;YACJ,KAAK,EAAE,aAAa;SACrB,CAAC,CAAC;IACL,CAAC;IAED,SAAS,oBAAoB,CAAC,SAAyB;QACrD,QAAQ,SAAS,EAAE,CAAC;YAClB,KAAK,MAAM;gBACT,OAAO,MAAM,CAAC;YAChB,KAAK,KAAK;gBACR,OAAO,KAAK,CAAC;YACf;gBACE,OAAO,SAAS,CAAC;QACrB,CAAC;IACH,CAAC;IAED,OAAO;QACL;YACE,IAAI,EAAE,mBAAmB;YACzB,IAAI,EAAE,MAAM;YACZ,UAAU,EAAE,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;YACzC,QAAQ,EAAE;gBACR,aAAa,CAAC,EAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAC,CAAC;gBAClD,GAAG,UAAU,CAAC,OAAO,CAAC,sBAAsB,CAAC;aAC9C;SACF;KACO,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,IAAU,EAAmB,EAAE,CACtD,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC;AAC3B,uEAAuE;AACvE,MAAM,YAAY,GAAG,CAAC,IAAU,EAAW,EAAE,CAC3C,eAAe,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;AAE9D,MAAM,QAAQ,GAAG,CAAC,IAAU,EAAkB,EAAE,CAC9C,KAAK,CAAC,OAAO,CAAE,IAAe,CAAC,QAAQ,CAAC,CAAC;AAC3C,MAAM,UAAU,GAAG,CAAC,IAAU,EAAgB,EAAE,CAC9C,IAAI,CAAC,IAAI,KAAK,MAAM,IAAK,IAAa,CAAC,IAAI,KAAK,UAAU,CAAC;AAE7D,SAAS,gBAAgB;IACvB,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,KAAK,EACH,sEAAsE;QACxE,IAAI,EAAE;YACJ,MAAM,EAAE;gBACN,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE;oBACJ;wBACE,IAAI,EAAE,mBAAmB;wBACzB,UAAU,EAAE;4BACV;gCACE,IAAI,EAAE,wBAAwB;gCAC9B,KAAK,EAAE,EAAC,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAC;6BAC1C;yBACF;wBACD,MAAM,EAAE;4BACN,IAAI,EAAE,SAAS;4BACf,KAAK,EAAE,aAAa;4BACpB,GAAG,EAAE,eAAe;yBACrB;qBACF;oBACD;wBACE,IAAI,EAAE,mBAAmB;wBACzB,UAAU,EAAE;4BACV;gCACE,IAAI,EAAE,wBAAwB;gCAC9B,KAAK,EAAE,EAAC,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,SAAS,EAAC;6BAC7C;yBACF;wBACD,MAAM,EAAE;4BACN,IAAI,EAAE,SAAS;4BACf,KAAK,EAAE,gBAAgB;4BACvB,GAAG,EAAE,kBAAkB;yBACxB;qBACF;iBACF;gBACD,UAAU,EAAE,QAAQ;aACrB;SACF;KACF,CAAC;AACJ,CAAC;AAED,MAAM,MAAM,GAA6B,CAAC,OAAO,GAAG,EAAE,EAAe,EAAE;IACrE,mCAAmC;IACnC,MAAM,EAAC,IAAI,GAAG,KAAK,EAAE,UAAU,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAAC,GAAG,OAAO,CAAC;IAC9D,OAAO,KAAK,EAAE,IAAI,EAAE,EAAE;QACpB,MAAM,EAAC,KAAK,EAAC,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,CAAC;QAEjD,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,IAAI,eAAe,GAAG,KAAK,CAAC;QAE5B,KAAK,CAAC,IAAI,EAAE,CAAC,IAAU,EAAE,EAAE;YACzB,IAAI,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvB,eAAe,GAAG,IAAI,CAAC;YACzB,CAAC;YAED,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnB,IAAI,KAAK,GAAG,CAAC,CAAC;gBACd,OAAO,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;oBACpC,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAE,CAAC;oBACpC,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;wBACtB,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;wBACtD,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,MAAM,CAAC,CAAC;wBAC1C,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC;wBACvB,WAAW,GAAG,IAAI,CAAC;oBACrB,CAAC;yBAAM,CAAC;wBACN,KAAK,IAAI,CAAC,CAAC;oBACb,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,WAAW,IAAI,CAAC,eAAe,EAAE,CAAC;YACnC,IAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACxD,CAAC;IACH,CAAC,CAAC;AACJ,CAAC,CAAC;AAIF,iBAAS,MAAM,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docusaurus/remark-plugin-npm2yarn",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.7.0",
|
|
4
4
|
"description": "Remark plugin for converting npm commands to Yarn commands as tabs.",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"publishConfig": {
|
|
@@ -32,5 +32,5 @@
|
|
|
32
32
|
"engines": {
|
|
33
33
|
"node": ">=18.0"
|
|
34
34
|
},
|
|
35
|
-
"gitHead": "
|
|
35
|
+
"gitHead": "dd59750c16fe6908a26f18806a54d4c3dbe6db43"
|
|
36
36
|
}
|
package/src/index.ts
CHANGED
|
@@ -20,7 +20,7 @@ import type {Transformer} from 'unified';
|
|
|
20
20
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
21
21
|
type Plugin<T> = any; // TODO fix this asap
|
|
22
22
|
|
|
23
|
-
type KnownConverter = 'yarn' | 'pnpm';
|
|
23
|
+
type KnownConverter = 'yarn' | 'pnpm' | 'bun';
|
|
24
24
|
|
|
25
25
|
type CustomConverter = [name: string, cb: (npmCode: string) => string];
|
|
26
26
|
|
|
@@ -90,7 +90,7 @@ const transformNode = (
|
|
|
90
90
|
code: npmToYarn(npmCode, converter),
|
|
91
91
|
node,
|
|
92
92
|
value: converter,
|
|
93
|
-
label: converter
|
|
93
|
+
label: getLabelForConverter(converter),
|
|
94
94
|
});
|
|
95
95
|
}
|
|
96
96
|
const [converterName, converterFn] = converter;
|
|
@@ -101,6 +101,17 @@ const transformNode = (
|
|
|
101
101
|
});
|
|
102
102
|
}
|
|
103
103
|
|
|
104
|
+
function getLabelForConverter(converter: KnownConverter) {
|
|
105
|
+
switch (converter) {
|
|
106
|
+
case 'yarn':
|
|
107
|
+
return 'Yarn';
|
|
108
|
+
case 'bun':
|
|
109
|
+
return 'Bun';
|
|
110
|
+
default:
|
|
111
|
+
return converter;
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
|
|
104
115
|
return [
|
|
105
116
|
{
|
|
106
117
|
type: 'mdxJsxFlowElement',
|