Disable path rewritting by default; allow WSRUN_* args; bump to 4.0.0 (#53)

Disable path rewritting by default; allow WSRUN_* args; bump to 4.0.0

Author: spion

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "printWidth": 100,
+  "singleQuote": true,
+  "semi": false
+}

.travis.yml

@@ -1,4 +1,4 @@
 dist: xenial
 language: node_js
 node_js: 'lts/*'
-script: yarn build && chmod +x build/index.js && yarn test
+script: yarn test -i --ci

bin/wsrun.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../build/index.js')

package.json

@@ -1,23 +1,14 @@
 {
   "name": "wsrun",
-  "version": "3.6.6",
+  "version": "4.0.0",
   "description": "executes commands on packages in parallel, but is aware of the dependencies between them",
   "main": "./build/index.js",
   "author": "hfour",
   "license": "MIT",
   "repository": "github:whoeverest/wsrun",
   "jest": {
     "verbose": false,
-    "transform": {
-      "^.+\\.tsx?$": "ts-jest"
-    },
-    "moduleFileExtensions": [
-      "ts",
-      "tsx",
-      "js",
-      "jsx",
-      "json"
-    ],
+    "preset": "ts-jest",
     "testPathIgnorePatterns": [
       "<rootDir>/tmp",
       "<rootDir>/node_modules/",
@@ -33,7 +24,7 @@
     ]
   },
   "bin": {
-    "wsrun": "./build/index.js"
+    "wsrun": "./bin/wsrun.js"
   },
   "files": [
     "build/"
@@ -61,7 +52,7 @@
   "scripts": {
     "build": "tsc",
     "watch": "tsc -w",
-    "test": "jest",
+    "test": "yarn build && jest",
     "test:watch": "jest --watch",
     "dev": "run-p test:watch watch",
     "prepublish": "tsc"

src/cmd-process.ts

@@ -3,14 +3,15 @@ import * as Bromise from 'bluebird'
 
 import originalSplit = require('split')
 
-import { Result, ResultSpecialValues } from './enums';
+import { Result, ResultSpecialValues } from './enums'
 import { defer } from './utils'
 
 export interface CmdOptions {
   rejectOnNonZeroExit: boolean
   silent?: boolean
   collectLogs: boolean
   prefixer?: (basePath: string, pkg: string, line: string) => string
+  pathRewriter?: (basePath: string, pkg: string, line: string) => string
   doneCriteria?: string
   path: string
 }
@@ -47,7 +48,7 @@ export class CmdProcess {
   }
 
   get result() {
-    return Bromise.race([this._exitCode.promise, this._cancelled.promise]);
+    return Bromise.race([this._exitCode.promise, this._cancelled.promise])
   }
 
   /**
@@ -82,14 +83,14 @@ export class CmdProcess {
     this.exitCode.then(code => {
       if (code > 0) {
         const msg = '`' + this.cmdString + '` failed with exit code ' + code
-        if (!this.opts.silent) console.error(this.autoPrefix(msg))
+        if (!this.opts.silent) console.error(this.autoAugmentLine(msg))
         if (this.opts.rejectOnNonZeroExit) return this._finished.reject(new Error(msg))
       }
       this._finished.resolve()
     })
 
     // ignore if unhandled
-    this._finished.promise.catch(() => { })
+    this._finished.promise.catch(() => {})
   }
 
   stop() {
@@ -98,13 +99,25 @@ export class CmdProcess {
       this.cp.removeAllListeners('exit')
       this.cp.kill('SIGINT')
     }
-    this._cancelled.resolve(ResultSpecialValues.Cancelled);
+    this._cancelled.resolve(ResultSpecialValues.Cancelled)
   }
 
   private autoPrefix(line: string) {
     return this.opts.prefixer ? this.opts.prefixer(this.opts.path, this.pkgName, line) : line
   }
 
+  private autoPathRewrite(line: string) {
+    return this.opts.pathRewriter
+      ? this.opts.pathRewriter(this.opts.path, this.pkgName, line)
+      : line
+  }
+
+  private autoAugmentLine(line: string) {
+    line = this.autoPathRewrite(line)
+    line = this.autoPrefix(line)
+    return line
+  }
+
   private _start(cmd: string[]) {
     let sh: string
     let args: string[]
@@ -137,21 +150,21 @@ export class CmdProcess {
     if (this.cp.stdout)
       this.cp.stdout.pipe(split()).on('data', (line: string) => {
         if (this.opts.collectLogs) stdOutBuffer.push(line)
-        else console.log(this.autoPrefix(line))
+        else console.log(this.autoAugmentLine(line))
         if (this.doneCriteria && this.doneCriteria.test(line)) this._finished.resolve()
       })
     if (this.cp.stderr)
       this.cp.stderr.pipe(split()).on('data', (line: string) => {
         if (this.opts.collectLogs) stdErrBuffer.push(line)
-        else console.error(this.autoPrefix(line))
+        else console.error(this.autoAugmentLine(line))
         if (this.doneCriteria && this.doneCriteria.test(line)) this._finished.resolve()
       })
     if (this.opts.collectLogs)
       this._closed.promise.then(() => {
         if (stdOutBuffer.length)
-          console.log(stdOutBuffer.map(line => this.autoPrefix(line)).join('\n'))
+          console.log(stdOutBuffer.map(line => this.autoAugmentLine(line)).join('\n'))
         if (stdErrBuffer.length)
-          console.error(stdErrBuffer.map(line => this.autoPrefix(line)).join('\n'))
+          console.error(stdErrBuffer.map(line => this.autoAugmentLine(line)).join('\n'))
       })
   }
 }

src/fix-paths.spec.ts

@@ -1,6 +1,6 @@
 import 'jest'
 import { fixPaths } from './fix-paths'
-import chalk from 'chalk';
+import chalk from 'chalk'
 
 describe('fix paths', () => {
   it('works', () => {
@@ -18,8 +18,8 @@ describe('fix paths', () => {
   })
 
   it('ignores absolute paths that contain @', () => {
-    let logLine = 'at (/Thing/src/node_modules/@h4bff/backend/src/rpc/serviceRegistry.ts:54:54)';
-    let res = fixPaths('/Thing/src/','/Thing/src/packages/app-lib-ca-backend', logLine)
+    let logLine = 'at (/Thing/src/node_modules/@h4bff/backend/src/rpc/serviceRegistry.ts:54:54)'
+    let res = fixPaths('/Thing/src/', '/Thing/src/packages/app-lib-ca-backend', logLine)
     expect(res).toEqual(logLine)
   })
 
@@ -37,4 +37,9 @@ describe('fix paths', () => {
     let res = fixPaths('/a/b/c', '/a/b/c/packages/p', 'Testing ' + chalk.blue('src/test.ts:12'))
     expect(res).toEqual('Testing ' + chalk.blue('packages/p/src/test.ts:12'))
   })
+
+  it('doesnt rewrite URLs', () => {
+    let res = fixPaths('/a/b/c', '/a/b/c/packages/p', 'Testing http://src/test.ts')
+    expect(res).toEqual('Testing http://src/test.ts')
+  })
 })

src/fix-paths.ts

@@ -2,7 +2,7 @@ import * as path from 'path'
 
 export function fixPaths(workspacePath: string, packagePath: string, logLine: string) {
   return logLine.replace(
-    /([\u001b][^m]*m|[^/_@0-9a-zA-Z])(([-_0-9a-zA-Z.]([^\s/'"*]*[/]){1,})([^/'"*]+)\.[0-9a-zA-Z]{1,6})/,
+    /([\u001b][^m]*m|[^/_@0-9a-zA-Z])(([-_0-9a-zA-Z.]([^\s/'"*:]*[/]){1,})([^/'"*]+)\.[0-9a-zA-Z]{1,6})/,
     (_m, before, file) => {
       return before + path.relative(workspacePath, path.resolve(packagePath, file))
     }

src/index.ts

@@ -1,5 +1,3 @@
-#!/usr/bin/env node
-
 /**
  * Tool for running command in yarn workspaces.
  */
@@ -13,6 +11,7 @@ import { RunGraph } from './run-graph'
 import { listPkgs } from './workspace'
 
 let yargsParser = yargs
+  .env('WSRUN')
   .wrap(yargs.terminalWidth() - 1)
   .updateStrings({
     'Options:': 'Other Options:'
@@ -30,7 +29,6 @@ let yargsParser = yargs
     'Runs "yarn watch" in each of the packages in stages, continuing when the process outputs "Finished"'
   )
   .example('$0 --exclude-missing test', 'Runs "yarn test" in all packages that have such a script')
-
   .group(['parallel', 'stages', 'serial'], 'Mode (choose one):')
   .options({
     parallel: {
@@ -69,6 +67,7 @@ let yargsParser = yargs
       'fast-exit',
       'collect-logs',
       'no-prefix',
+      'no-path-rewrite',
       'bin',
       'done-criteria',
       'exclude',
@@ -100,6 +99,11 @@ let yargsParser = yargs
       boolean: true,
       describe: "Don't prefix output"
     },
+    'rewrite-paths': {
+      boolean: true,
+      describe:
+        'Rewrite relative paths in the standard output, by prepending the <root_folder>/<package_name>.'
+    },
     bin: {
       default: 'yarn',
       describe: 'The program to pass the command to',
@@ -156,6 +160,8 @@ const recursive: boolean = argv.recursive || argv.r || false
 const fastExit: boolean = argv.fastExit || false
 const collectLogs: boolean = argv.collectLogs || false
 const addPrefix: boolean = argv.prefix === undefined ? true : false
+console.log(argv)
+const rewritePaths: boolean = Boolean(argv.rewritePaths)
 const doneCriteria: string = argv.doneCriteria
 const exclude: string[] =
   (argv.exclude && (Array.isArray(argv.exclude) ? argv.exclude : [argv.exclude])) || []
@@ -197,6 +203,7 @@ let runner = new RunGraph(
     fastExit,
     collectLogs,
     addPrefix,
+    rewritePaths,
     mode: mode as any,
     recursive,
     doneCriteria,

src/run-graph.ts

@@ -2,7 +2,7 @@ import * as Bromise from 'bluebird'
 import chalk from 'chalk'
 
 import { PkgJson, Dict } from './workspace'
-import { ResultSpecialValues, Result, ProcResolution } from './enums';
+import { ResultSpecialValues, Result, ProcResolution } from './enums'
 import { uniq } from 'lodash'
 import { CmdProcess } from './cmd-process'
 import minimatch = require('minimatch')
@@ -35,6 +35,7 @@ export interface GraphOptions {
   fastExit: boolean
   collectLogs: boolean
   addPrefix: boolean
+  rewritePaths: boolean
   mode: 'parallel' | 'serial' | 'stages'
   recursive: boolean
   doneCriteria: string | undefined
@@ -56,12 +57,14 @@ export class RunGraph {
   private resultMap = new Map<string, Result>()
   private throat: PromiseFnRunner = passThrough
   prefixer = new Prefixer(this.opts.workspacePath).prefixer
+  pathRewriter = fixPaths
 
   constructor(
     public pkgJsons: PkgJson[],
     public opts: GraphOptions,
     public pkgPaths: Dict<string>
   ) {
+
     this.checkResultsAndReport = this.checkResultsAndReport.bind(this)
     this.closeAll = this.closeAll.bind(this)
 
@@ -187,6 +190,7 @@ export class RunGraph {
           rejectOnNonZeroExit: this.opts.fastExit,
           collectLogs: this.opts.collectLogs,
           prefixer: this.opts.addPrefix ? this.prefixer : undefined,
+          pathRewriter: this.opts.rewritePaths ? this.pathRewriter : undefined,
           doneCriteria: this.opts.doneCriteria,
           path: this.pkgPaths[pkg]
         })

tests/basic.ts

@@ -185,17 +185,35 @@ describe('basic', () => {
     )
   })
 
-  it('should show an error for pkgs without name', async () => {
+  it('should not rewrite paths by default', async () => {
     await withScaffold(
       {
         packages: [
-          echo.makePkg({ path: 'packages/p1', dependencies: {} }),
+          echo.makePkg(
+            { name: 'app-x-frontend', dependencies: {} },
+            '',
+            'Output for path src/index.ts testing'
+          )
         ]
       },
+      async () => {
+        let tst = await wsrun('printthis', { WSRUN_REWRITE_PATHS: 'true' })
+        expect(tst.output.toString()).toContain('app-x-frontend/src/index.ts')
+      }
+    )
+  })
+
+  it('should show an error for pkgs without name', async () => {
+    await withScaffold(
+      {
+        packages: [echo.makePkg({ path: 'packages/p1', dependencies: {} })]
+      },
       async () => {
         let tst = await wsrun('doecho')
         expect(tst.status).toBeTruthy()
-        expect(String(tst.output[2])).toEqual('\nERROR: Package in directory packages/p1 has no name in package.json\n')
+        expect(String(tst.output[2])).toEqual(
+          '\nERROR: Package in directory packages/p1 has no name in package.json\n'
+        )
       }
     )
   })