chore: check prettier properly in CI

felixfbecker · felixfbecker · commit fd4cb0d817e9 · 2020-12-23T16:48:17.000+01:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -35,7 +35,7 @@ jobs:
       - name: Install npm dependencies
         run: npm ci
       - name: Prettier
-        run: npm run prettier
+        run: npm run prettier-check
       - name: Lint
         run: npm run tslint
       - name: Build VS Code extension
diff --git a/.prettierrc b/.prettierrc
@@ -7,6 +7,7 @@
   "singleQuote": true,
   "printWidth": 120,
   "proseWrap": "preserve",
+  "arrowParens": "avoid",
   "overrides": [
     {
       "files": "{*.js?(on),*.yml,.*.yml,.prettierrc,*.md}",
diff --git a/package.json b/package.json
@@ -98,6 +98,7 @@
     "lint": "npm run tslint && npm run prettier",
     "tslint": "tslint -c tslint.json 'src/**/*.ts'",
     "prettier": "prettier \"**/{*.json,*.yml,.*.yml,*.ts,.prettierrc,*.md}\" --write --list-different",
+    "prettier-check": "npm run prettier -- --write=false",
     "semantic-release": "semantic-release",
     "commitmsg": "validate-commit-msg"
   },
diff --git a/src/paths.ts b/src/paths.ts
@@ -53,7 +53,10 @@ export function convertClientPathToDebugger(localPath: string, pathMapping?: { [
     let localSourceRoot: string | undefined
     let serverSourceRoot: string | undefined
     // XDebug always lowercases Windows drive letters in file URIs
-    let localFileUri = fileUrl(localPath.replace(/^[A-Z]:\\/, match => match.toLowerCase()), { resolve: false })
+    let localFileUri = fileUrl(
+        localPath.replace(/^[A-Z]:\\/, match => match.toLowerCase()),
+        { resolve: false }
+    )
     let serverFileUri: string
     if (pathMapping) {
         for (const mappedServerPath of Object.keys(pathMapping)) {
diff --git a/src/phpDebug.ts b/src/phpDebug.ts
@@ -315,11 +315,7 @@ class PhpDebugSession extends vscode.DebugSession {
                     this.sendEvent(new vscode.OutputEvent(util.inspect(error) + '\n'))
                     this.sendErrorResponse(response, <Error>error)
                 })
-                server.listen(
-                    args.port || 9000,
-                    args.hostname,
-                    () => resolve()
-                )
+                server.listen(args.port || 9000, args.hostname, () => resolve())
             })
         try {
             if (!args.noDebug) {
diff --git a/src/terminal.ts b/src/terminal.ts
@@ -46,15 +46,23 @@ export class Terminal {
 }
 
 interface ITerminalService {
-    launchInTerminal(dir: string, args: string[], envVars: { [key: string]: string | undefined }): Promise<CP.ChildProcess | undefined>
+    launchInTerminal(
+        dir: string,
+        args: string[],
+        envVars: { [key: string]: string | undefined }
+    ): Promise<CP.ChildProcess | undefined>
     killTree(pid: number): Promise<any>
     isOnPath(program: string): boolean
 }
 
 class DefaultTerminalService implements ITerminalService {
     protected static TERMINAL_TITLE = 'VS Code Console'
 
-    public launchInTerminal(dir: string, args: string[], envVars: { [key: string]: string }): Promise<CP.ChildProcess | undefined> {
+    public launchInTerminal(
+        dir: string,
+        args: string[],
+        envVars: { [key: string]: string }
+    ): Promise<CP.ChildProcess | undefined> {
         throw new Error('launchInTerminal not implemented')
     }
 
@@ -100,7 +108,11 @@ class DefaultTerminalService implements ITerminalService {
 class WindowsTerminalService extends DefaultTerminalService {
     private static CMD = 'cmd.exe'
 
-    public launchInTerminal(dir: string, args: string[], envVars: { [key: string]: string }): Promise<CP.ChildProcess | undefined> {
+    public launchInTerminal(
+        dir: string,
+        args: string[],
+        envVars: { [key: string]: string }
+    ): Promise<CP.ChildProcess | undefined> {
         return new Promise<CP.ChildProcess | undefined>((resolve, reject) => {
             const title = `"${dir} - ${WindowsTerminalService.TERMINAL_TITLE}"`
             const command = `""${args.join('" "')}" & pause"` // use '|' to only pause on non-zero exit code
@@ -143,14 +155,16 @@ class LinuxTerminalService extends DefaultTerminalService {
     private static LINUX_TERM = '/usr/bin/gnome-terminal' // private const string LINUX_TERM = "/usr/bin/x-terminal-emulator";
     private static WAIT_MESSAGE = 'Press any key to continue...'
 
-    public launchInTerminal(dir: string, args: string[], envVars: { [key: string]: string }): Promise<CP.ChildProcess | undefined> {
+    public launchInTerminal(
+        dir: string,
+        args: string[],
+        envVars: { [key: string]: string }
+    ): Promise<CP.ChildProcess | undefined> {
         return new Promise<CP.ChildProcess | undefined>((resolve, reject) => {
             if (!FS.existsSync(LinuxTerminalService.LINUX_TERM)) {
                 reject(
                     new Error(
-                        `Cannot find '${
-                            LinuxTerminalService.LINUX_TERM
-                        }' for launching the node program. See http://go.microsoft.com/fwlink/?linkID=534832#_20002`
+                        `Cannot find '${LinuxTerminalService.LINUX_TERM}' for launching the node program. See http://go.microsoft.com/fwlink/?linkID=534832#_20002`
                     )
                 )
                 return
@@ -193,7 +207,11 @@ class LinuxTerminalService extends DefaultTerminalService {
 class MacTerminalService extends DefaultTerminalService {
     private static OSASCRIPT = '/usr/bin/osascript' // osascript is the AppleScript interpreter on OS X
 
-    public launchInTerminal(dir: string, args: string[], envVars: { [key: string]: string }): Promise<CP.ChildProcess | undefined> {
+    public launchInTerminal(
+        dir: string,
+        args: string[],
+        envVars: { [key: string]: string }
+    ): Promise<CP.ChildProcess | undefined> {
         return new Promise<CP.ChildProcess | undefined>((resolve, reject) => {
             // first fix the PATH so that 'runtimePath' can be found if installed with 'brew'
             // Utilities.FixPathOnOSX();
diff --git a/src/test/adapter.ts b/src/test/adapter.ts
@@ -102,10 +102,12 @@ describe('PHP Debug Adapter', () => {
         describe('line breakpoints', () => {
             async function testBreakpointHit(program: string, line: number): Promise<void> {
                 await Promise.all([client.launch({ program }), client.waitForEvent('initialized')])
-                const breakpoint = (await client.setBreakpointsRequest({
-                    breakpoints: [{ line }],
-                    source: { path: program },
-                })).body.breakpoints[0]
+                const breakpoint = (
+                    await client.setBreakpointsRequest({
+                        breakpoints: [{ line }],
+                        source: { path: program },
+                    })
+                ).body.breakpoints[0]
                 assert.isTrue(breakpoint.verified, 'breakpoint verification mismatch: verified')
                 assert.equal(breakpoint.line, line, 'breakpoint verification mismatch: line')
                 await Promise.all([
@@ -124,10 +126,12 @@ describe('PHP Debug Adapter', () => {
             it('should support removing a breakpoint', async () => {
                 await Promise.all([client.launch({ program }), client.waitForEvent('initialized')])
                 // set two breakpoints
-                let breakpoints = (await client.setBreakpointsRequest({
-                    breakpoints: [{ line: 3 }, { line: 5 }],
-                    source: { path: program },
-                })).body.breakpoints
+                let breakpoints = (
+                    await client.setBreakpointsRequest({
+                        breakpoints: [{ line: 3 }, { line: 5 }],
+                        source: { path: program },
+                    })
+                ).body.breakpoints
                 assert.lengthOf(breakpoints, 2)
                 assert.isTrue(breakpoints[0].verified, 'breakpoint verification mismatch: verified')
                 assert.equal(breakpoints[0].line, 3, 'breakpoint verification mismatch: line')
@@ -139,10 +143,12 @@ describe('PHP Debug Adapter', () => {
                     client.configurationDoneRequest(),
                 ])
                 // remove second
-                breakpoints = (await client.setBreakpointsRequest({
-                    breakpoints: [{ line: 3 }],
-                    source: { path: program },
-                })).body.breakpoints
+                breakpoints = (
+                    await client.setBreakpointsRequest({
+                        breakpoints: [{ line: 3 }],
+                        source: { path: program },
+                    })
+                ).body.breakpoints
                 assert.lengthOf(breakpoints, 1)
                 assert.isTrue(breakpoints[0].verified, 'breakpoint verification mismatch: verified')
                 assert.equal(breakpoints[0].line, 3, 'breakpoint verification mismatch: line')
@@ -243,9 +249,11 @@ describe('PHP Debug Adapter', () => {
                 async function getErrorScope(): Promise<ErrorScope> {
                     const frameId = (await client.stackTraceRequest({ threadId: threadId! })).body.stackFrames[0].id
                     const errorScope = (await client.scopesRequest({ frameId })).body.scopes[0]
-                    const variables = (await client.variablesRequest({
-                        variablesReference: errorScope.variablesReference,
-                    })).body.variables
+                    const variables = (
+                        await client.variablesRequest({
+                            variablesReference: errorScope.variablesReference,
+                        })
+                    ).body.variables
                     const errorInfo: ErrorScope = { name: errorScope.name }
                     const type = variables.find(variable => variable.name === 'type')
                     if (type) {
@@ -301,30 +309,36 @@ describe('PHP Debug Adapter', () => {
 
             it('should stop on a conditional breakpoint when condition is true', async () => {
                 await Promise.all([client.launch({ program }), client.waitForEvent('initialized')])
-                const bp = (await client.setBreakpointsRequest({
-                    breakpoints: [{ line: 10, condition: '$anInt === 123' }],
-                    source: { path: program },
-                })).body.breakpoints[0]
+                const bp = (
+                    await client.setBreakpointsRequest({
+                        breakpoints: [{ line: 10, condition: '$anInt === 123' }],
+                        source: { path: program },
+                    })
+                ).body.breakpoints[0]
                 assert.equal(bp.verified, true, 'breakpoint verification mismatch: verified')
                 assert.equal(bp.line, 10, 'breakpoint verification mismatch: line')
                 const [, { frame }] = await Promise.all([
                     client.configurationDoneRequest(),
                     assertStoppedLocation('breakpoint', program, 10),
                 ])
-                const result = (await client.evaluateRequest({
-                    context: 'watch',
-                    frameId: frame.id,
-                    expression: '$anInt',
-                })).body.result
+                const result = (
+                    await client.evaluateRequest({
+                        context: 'watch',
+                        frameId: frame.id,
+                        expression: '$anInt',
+                    })
+                ).body.result
                 assert.equal(result, '123')
             })
 
             it('should not stop on a conditional breakpoint when condition is false', async () => {
                 await Promise.all([client.launch({ program }), client.waitForEvent('initialized')])
-                const bp = (await client.setBreakpointsRequest({
-                    breakpoints: [{ line: 10, condition: '$anInt !== 123' }],
-                    source: { path: program },
-                })).body.breakpoints[0]
+                const bp = (
+                    await client.setBreakpointsRequest({
+                        breakpoints: [{ line: 10, condition: '$anInt !== 123' }],
+                        source: { path: program },
+                    })
+                ).body.breakpoints[0]
                 assert.equal(bp.verified, true, 'breakpoint verification mismatch: verified')
                 assert.equal(bp.line, 10, 'breakpoint verification mismatch: line')
                 await Promise.all([client.configurationDoneRequest(), client.waitForEvent('terminated')])
@@ -337,9 +351,11 @@ describe('PHP Debug Adapter', () => {
             it('should stop on a function breakpoint', async () => {
                 await client.launch({ program })
                 await client.waitForEvent('initialized')
-                const breakpoint = (await client.setFunctionBreakpointsRequest({
-                    breakpoints: [{ name: 'a_function' }],
-                })).body.breakpoints[0]
+                const breakpoint = (
+                    await client.setFunctionBreakpointsRequest({
+                        breakpoints: [{ name: 'a_function' }],
+                    })
+                ).body.breakpoints[0]
                 assert.strictEqual(breakpoint.verified, true)
                 await Promise.all([client.configurationDoneRequest(), assertStoppedLocation('breakpoint', program, 5)])
             })
@@ -434,9 +450,11 @@ describe('PHP Debug Adapter', () => {
                 assert.isDefined(aLargeArray)
                 assert.propertyVal(aLargeArray!, 'value', 'array(100)')
                 assert.property(aLargeArray!, 'variablesReference')
-                const largeArrayItems = (await client.variablesRequest({
-                    variablesReference: aLargeArray!.variablesReference,
-                })).body.variables
+                const largeArrayItems = (
+                    await client.variablesRequest({
+                        variablesReference: aLargeArray!.variablesReference,
+                    })
+                ).body.variables
                 assert.lengthOf(largeArrayItems, 100)
                 assert.propertyVal(largeArrayItems[0], 'name', '0')
                 assert.propertyVal(largeArrayItems[0], 'value', '"test"')
@@ -449,9 +467,11 @@ describe('PHP Debug Adapter', () => {
                 assert.isDefined(arrayWithSpaceKey)
                 assert.propertyVal(arrayWithSpaceKey!, 'value', 'array(1)')
                 assert.property(arrayWithSpaceKey!, 'variablesReference')
-                const arrayWithSpaceKeyItems = (await client.variablesRequest({
-                    variablesReference: arrayWithSpaceKey!.variablesReference,
-                })).body.variables
+                const arrayWithSpaceKeyItems = (
+                    await client.variablesRequest({
+                        variablesReference: arrayWithSpaceKey!.variablesReference,
+                    })
+                ).body.variables
                 assert.lengthOf(arrayWithSpaceKeyItems, 1)
                 assert.propertyVal(arrayWithSpaceKeyItems[0], 'name', 'space key')
                 assert.propertyVal(arrayWithSpaceKeyItems[0], 'value', '1')
@@ -461,9 +481,11 @@ describe('PHP Debug Adapter', () => {
         // support for user defined constants was added in 2.3.0
         if (!process.env['XDEBUG_VERSION'] || semver.gte(process.env['XDEBUG_VERSION'], '2.3.0')) {
             it('should report user defined constants correctly', async () => {
-                const constants = (await client.variablesRequest({
-                    variablesReference: constantsScope!.variablesReference,
-                })).body.variables
+                const constants = (
+                    await client.variablesRequest({
+                        variablesReference: constantsScope!.variablesReference,
+                    })
+                ).body.variables
                 assert.lengthOf(constants, 1)
                 assert.propertyVal(constants[0], 'name', 'TEST_CONSTANT')
                 assert.propertyVal(constants[0], 'value', '123')

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`	`"singleQuote": true,`
`8`	`8`	`"printWidth": 120,`
`9`	`9`	`"proseWrap": "preserve",`
	`10`	`+ "arrowParens": "avoid",`
`10`	`11`	`"overrides": [`
`11`	`12`	`{`
`12`	`13`	`"files": "{.js?(on),.yml,..yml,.prettierrc,.md}",`