Merge branch 'Jay-Karia-feat/npx-conversions'

nebrelbug · Aug 29, 2024 · ef16684 · ef16684
2 parents c06d07c + 013cb35
commit ef16684
Show file tree

Hide file tree

Showing 9 changed files with 272 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -31,8 +31,12 @@ import convert from 'npm-to-yarn'
 // var convert = require('npm-to-yarn')
 
 convert('npm install squirrelly', 'yarn')
-
 // yarn add squirrelly
+
+// npx conversions
+
+convert('npx create-next-app', 'yarn')
+// yarn dlx create-next-app
 ```
 
 `npm-to-yarn` exposes a UMD build, so you can also install it with a CDN (it exposes global variable `n2y`)

diff --git a/dist/npm-to-yarn.mjs b/dist/npm-to-yarn.mjs
@@ -47,6 +47,12 @@ var yarnCLICommands = [
     'workspace',
     'workspaces'
 ];
+var executorCommands = {
+    "npm": "npx",
+    "yarn": "yarn dlx",
+    "pnpm": "pnpm dlx",
+    "bun": "bun x"
+};
 
 function parse(command) {
     var args = [];
@@ -619,7 +625,11 @@ function npmToBun(_m, command) {
  * Converts between npm and yarn command
  */
 function convert(str, to) {
-    if (to === 'npm') {
+    if (str.includes('npx') || str.includes('yarn dlx') || str.includes('pnpm dlx') || str.includes('bun x')) {
+        var executor = str.includes('npx') ? 'npx' : str.includes('yarn dlx') ? 'yarn dlx' : str.includes('pnpm dlx') ? 'pnpm dlx' : 'bun x';
+        return str.replace(executor, executorCommands[to]);
+    }
+    else if (to === 'npm') {
         return str.replace(/yarn(?: +([^&\n\r]*))?/gm, yarnToNPM);
     }
     else if (to === 'pnpm') {

diff --git a/dist/npm-to-yarn.mjs.map b/dist/npm-to-yarn.mjs.map
diff --git a/dist/npm-to-yarn.umd.js b/dist/npm-to-yarn.umd.js
diff --git a/dist/npm-to-yarn.umd.js.map b/dist/npm-to-yarn.umd.js.map
diff --git a/dist/types/utils.d.ts b/dist/types/utils.d.ts
@@ -1,3 +1,9 @@
 export declare const unchangedCLICommands: string[];
 export declare const yarnCLICommands: string[];
 export declare const npmCLICommands: string[];
+export declare const executorCommands: {
+    npm: string;
+    yarn: string;
+    pnpm: string;
+    bun: string;
+};
diff --git a/src/index.ts b/src/index.ts
@@ -3,11 +3,16 @@ import { npmToYarn } from './npmToYarn'
 import { npmToPnpm } from './npmToPnpm'
 import { npmToBun } from './npmToBun'
 
+import { executorCommands } from './utils'
+
 /**
  * Converts between npm and yarn command
  */
-export default function convert (str: string, to: 'npm' | 'yarn' | 'pnpm' | 'bun'): string {
-  if (to === 'npm') {
+export default function convert(str: string, to: 'npm' | 'yarn' | 'pnpm' | 'bun'): string {
+  if (str.includes('npx') || str.includes('yarn dlx') || str.includes('pnpm dlx') || str.includes('bun x')) {
+    const executor = str.includes('npx') ? 'npx' : str.includes('yarn dlx') ? 'yarn dlx' : str.includes('pnpm dlx') ? 'pnpm dlx' : 'bun x'
+    return str.replace(executor, executorCommands[to])
+  } else if (to === 'npm') {
     return str.replace(/yarn(?: +([^&\n\r]*))?/gm, yarnToNPM)
   } else if (to === 'pnpm') {
     return str.replace(/npm(?: +([^&\n\r]*))?/gm, npmToPnpm)
@@ -16,4 +21,4 @@ export default function convert (str: string, to: 'npm' | 'yarn' | 'pnpm' | 'bun
   } else {
     return str.replace(/npm(?: +([^&\n\r]*))?/gm, npmToYarn)
   }
-}
+}
diff --git a/src/utils.ts b/src/utils.ts
@@ -108,3 +108,10 @@ export const npmCLICommands = [
   'view',
   'whoami'
 ]
+
+export const executorCommands = {
+  "npm": "npx",
+  "yarn": "yarn dlx",
+  "pnpm": "pnpm dlx",
+  "bun": "bun x"
+}
diff --git a/test/index.spec.ts b/test/index.spec.ts
@@ -427,3 +427,225 @@ describe('Yarn to NPM tests', () => {
     expect(convert(yarnValue, 'npm')).toEqual(npmValue)
   })
 })
+
+describe('to yarn dlx tests', () => {
+  const tests: [npm: string, yarn: string][] = [
+    // npx -> ...
+    [
+      'npx create-next-app',
+      'yarn dlx create-next-app',
+    ],
+    [
+      'npx prettier --help',
+      'yarn dlx prettier --help',
+    ],
+    [
+      'npx prettier -w .',
+      'yarn dlx prettier -w .',
+    ],
+    [
+      'npx @neutrinojs/create-project my-app',
+      'yarn dlx @neutrinojs/create-project my-app',
+    ],
+    [
+      'npx create-react-app my-app --template typescript',
+      'yarn dlx create-react-app my-app --template typescript',
+    ],
+    // pnpm dlx -> ...
+    [
+      'pnpm dlx create-next-app',
+      'yarn dlx create-next-app',
+    ],
+    [
+      'pnpm dlx prettier --help',
+      'yarn dlx prettier --help',
+    ],
+    [
+      'pnpm dlx prettier -w .',
+      'yarn dlx prettier -w .',
+    ],
+    [
+      'pnpm dlx @neutrinojs/create-project my-app',
+      'yarn dlx @neutrinojs/create-project my-app',
+    ],
+    [
+      'pnpm dlx create-react-app my-app --template typescript',
+      'yarn dlx create-react-app my-app --template typescript',
+    ],
+    // bun x -> ...
+    [
+      'bun x create-next-app',
+      'yarn dlx create-next-app',
+    ],
+    [
+      'bun x prettier --help',
+      'yarn dlx prettier --help',
+    ],
+    [
+      'bun x prettier -w .',
+      'yarn dlx prettier -w .',
+    ],
+    [
+      'bun x @neutrinojs/create-project my-app',
+      'yarn dlx @neutrinojs/create-project my-app',
+    ],
+    [
+      'bun x create-react-app my-app --template typescript',
+      'yarn dlx create-react-app my-app --template typescript',
+    ],
+  ]
+
+  describe('to Yarn', () => {
+    it.each(tests)('%s', (npmValue, yarnValue) => {
+      expect(convert(npmValue, 'yarn')).toEqual(yarnValue)
+    })
+  })
+})
+
+describe('to pnpm dlx tests', () => {
+  const tests: [npm: string, pnpm: string][] = [
+    // npx -> ...
+    [
+      'npx create-next-app',
+      'pnpm dlx create-next-app',
+    ],
+    [
+      'npx prettier --help',
+      'pnpm dlx prettier --help',
+    ],
+    [
+      'npx prettier -w .',
+      'pnpm dlx prettier -w .',
+    ],
+    [
+      'npx @neutrinojs/create-project my-app',
+      'pnpm dlx @neutrinojs/create-project my-app',
+    ],
+    [
+      'npx create-react-app my-app --template typescript',
+      'pnpm dlx create-react-app my-app --template typescript',
+    ],
+    // yarn dlx -> ...
+    [
+      'yarn dlx create-next-app',
+      'pnpm dlx create-next-app',
+    ],
+    [
+      'yarn dlx prettier --help',
+      'pnpm dlx prettier --help',
+    ],
+    [
+      'yarn dlx prettier -w .',
+      'pnpm dlx prettier -w .',
+    ],
+    [
+      'yarn dlx @neutrinojs/create-project my-app',
+      'pnpm dlx @neutrinojs/create-project my-app',
+    ],
+    [
+      'yarn dlx create-react-app my-app --template typescript',
+      'pnpm dlx create-react-app my-app --template typescript',
+    ],
+    // bun x -> ...
+    [
+      'bun x create-next-app',
+      'pnpm dlx create-next-app',
+    ],
+    [
+      'bun x prettier --help',
+      'pnpm dlx prettier --help',
+    ],
+    [
+      'bun x prettier -w .',
+      'pnpm dlx prettier -w .',
+    ],
+    [
+      'bun x @neutrinojs/create-project my-app',
+      'pnpm dlx @neutrinojs/create-project my-app',
+    ],
+    [
+      'bun x create-react-app my-app --template typescript',
+      'pnpm dlx create-react-app my-app --template typescript',
+    ],
+  ]
+
+  describe('to PNPM', () => {
+    it.each(tests)('%s', (npmValue, pnpmValue) => {
+      expect(convert(npmValue, 'pnpm')).toEqual(pnpmValue)
+    })
+  })
+})
+
+describe('to bun x tests', () => {
+  const tests: [npm: string, bun: string][] = [
+    // npx -> ...
+    [
+      'npx create-next-app',
+      'bun x create-next-app',
+    ],
+    [
+      'npx prettier --help',
+      'bun x prettier --help',
+    ],
+    [
+      'npx prettier -w .',
+      'bun x prettier -w .',
+    ],
+    [
+      'npx @neutrinojs/create-project my-app',
+      'bun x @neutrinojs/create-project my-app',
+    ],
+    [
+      'npx create-react-app my-app --template typescript',
+      'bun x create-react-app my-app --template typescript',
+    ],
+    // yarn dlx -> ...
+    [
+      'yarn dlx create-next-app',
+      'bun x create-next-app',
+    ],
+    [
+      'yarn dlx prettier --help',
+      'bun x prettier --help',
+    ],
+    [
+      'yarn dlx prettier -w .',
+      'bun x prettier -w .',
+    ],
+    [
+      'yarn dlx @neutrinojs/create-project my-app',
+      'bun x @neutrinojs/create-project my-app',
+    ],
+    [
+      'yarn dlx create-react-app my-app --template typescript',
+      'bun x create-react-app my-app --template typescript',
+    ],
+    // pnpm dlx -> ...
+    [
+      'pnpm dlx create-next-app',
+      'bun x create-next-app',
+    ],
+    [
+      'pnpm dlx prettier --help',
+      'bun x prettier --help',
+    ],
+    [
+      'pnpm dlx prettier -w .',
+      'bun x prettier -w .',
+    ],
+    [
+      'pnpm dlx @neutrinojs/create-project my-app',
+      'bun x @neutrinojs/create-project my-app',
+    ],
+    [
+      'pnpm dlx create-react-app my-app --template typescript',
+      'bun x create-react-app my-app --template typescript',
+    ],
+  ]
+
+  describe('to Bun', () => {
+    it.each(tests)('%s', (npmValue, bunValue) => {
+      expect(convert(npmValue, 'bun')).toEqual(bunValue)
+    })
+  })
+})