|
| 1 | +/** |
| 2 | + * Copyright (c) Meta Platforms, Inc. and 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 | + * @noflow |
| 8 | + * @format |
| 9 | + */ |
| 10 | + |
| 11 | +'use strict'; |
| 12 | + |
| 13 | +const { |
| 14 | + IS_META_CHECKOUT, |
| 15 | + commandVersion, |
| 16 | + findMetaTool, |
| 17 | +} = require('./format-utils'); |
| 18 | +const {spawnSync} = require('node:child_process'); |
| 19 | +const fs = require('node:fs'); |
| 20 | +const path = require('node:path'); |
| 21 | +const {globSync} = require('tinyglobby'); |
| 22 | + |
| 23 | +const REPO_ROOT = path.resolve(__dirname, '..'); |
| 24 | +const CONFIG = path.join(REPO_ROOT, '.swift-format'); |
| 25 | +const GENERATED_MARKER = Buffer.from('@' + 'generated'); |
| 26 | +const MINIMUM_SWIFT_FORMAT_MAJOR = 6; |
| 27 | +const MINIMUM_SWIFT_FORMAT_MINOR = 3; |
| 28 | +const MAX_FILES_PER_PROCESS = 100; |
| 29 | +const MAX_HEADER_BYTES = 4096; |
| 30 | +const IGNORE = ['**/Pods/**', '**/build/**', '**/node_modules/**']; |
| 31 | + |
| 32 | +function isGenerated(file) { |
| 33 | + let fd; |
| 34 | + try { |
| 35 | + fd = fs.openSync(path.resolve(REPO_ROOT, file), 'r'); |
| 36 | + const header = Buffer.alloc(MAX_HEADER_BYTES); |
| 37 | + const bytesRead = fs.readSync(fd, header, 0, header.length, 0); |
| 38 | + return header.subarray(0, bytesRead).includes(GENERATED_MARKER); |
| 39 | + } catch (error) { |
| 40 | + const message = error instanceof Error ? error.message : String(error); |
| 41 | + throw new Error(`Unable to inspect ${file}: ${message}`, {cause: error}); |
| 42 | + } finally { |
| 43 | + if (fd != null) { |
| 44 | + fs.closeSync(fd); |
| 45 | + } |
| 46 | + } |
| 47 | +} |
| 48 | + |
| 49 | +function parseSwiftFormatVersion(output) { |
| 50 | + const version = |
| 51 | + /swift-format(?: version)?[:\s]+(\d+)\.(\d+)/i.exec(output) ?? |
| 52 | + /Swift version\s+(\d+)\.(\d+)/i.exec(output) ?? |
| 53 | + /^\s*(\d+)\.(\d+)/.exec(output); |
| 54 | + if (version == null) { |
| 55 | + return null; |
| 56 | + } |
| 57 | + const reportedMajor = Number(version[1]); |
| 58 | + return reportedMajor >= 100 |
| 59 | + ? [Math.floor(reportedMajor / 100), reportedMajor % 100] |
| 60 | + : [reportedMajor, Number(version[2])]; |
| 61 | +} |
| 62 | + |
| 63 | +function findSwiftFormat() { |
| 64 | + const candidates = []; |
| 65 | + if (process.env.SWIFT_FORMAT != null && process.env.SWIFT_FORMAT !== '') { |
| 66 | + candidates.push([process.env.SWIFT_FORMAT, []]); |
| 67 | + } else { |
| 68 | + const metaSwiftFormat = findMetaTool( |
| 69 | + 'tools', |
| 70 | + 'lint', |
| 71 | + 'swift-format', |
| 72 | + 'swift-format', |
| 73 | + ); |
| 74 | + if (metaSwiftFormat != null) { |
| 75 | + candidates.push([ |
| 76 | + metaSwiftFormat.command, |
| 77 | + metaSwiftFormat.prefixArguments, |
| 78 | + ]); |
| 79 | + } |
| 80 | + candidates.push(['swift-format', []], ['swift', ['format']]); |
| 81 | + } |
| 82 | + for (const [command, prefixArguments] of candidates) { |
| 83 | + const result = commandVersion(command, prefixArguments); |
| 84 | + const version = parseSwiftFormatVersion(result.output); |
| 85 | + if ( |
| 86 | + result.status === 0 && |
| 87 | + version != null && |
| 88 | + (version[0] > MINIMUM_SWIFT_FORMAT_MAJOR || |
| 89 | + (version[0] === MINIMUM_SWIFT_FORMAT_MAJOR && |
| 90 | + version[1] >= MINIMUM_SWIFT_FORMAT_MINOR)) |
| 91 | + ) { |
| 92 | + return {command, prefixArguments}; |
| 93 | + } |
| 94 | + } |
| 95 | + const instructions = IS_META_CHECKOUT |
| 96 | + ? 'Meta: unset SWIFT_FORMAT and run `tools/lint/swift-format/swift-format --version` from the fbsource root. If that fails, repair your Meta DotSlash setup.' |
| 97 | + : 'Please install Swift 6.3 or newer and make sure `swift-format` or `swift` is in your PATH, or set SWIFT_FORMAT=/path/to/swift-format.'; |
| 98 | + console.warn( |
| 99 | + 'warning: Skipping Swift formatting because swift-format 6.3 or newer was not found.\n' + |
| 100 | + instructions, |
| 101 | + ); |
| 102 | + return null; |
| 103 | +} |
| 104 | + |
| 105 | +function main() { |
| 106 | + const check = process.argv[2] === '--check'; |
| 107 | + const swiftFormat = findSwiftFormat(); |
| 108 | + if (swiftFormat == null) { |
| 109 | + return; |
| 110 | + } |
| 111 | + const files = globSync('**/*.swift', {cwd: REPO_ROOT, ignore: IGNORE}).filter( |
| 112 | + file => !isGenerated(file), |
| 113 | + ); |
| 114 | + |
| 115 | + let exitStatus = 0; |
| 116 | + for (let i = 0; i < files.length; i += MAX_FILES_PER_PROCESS) { |
| 117 | + const result = spawnSync( |
| 118 | + swiftFormat.command, |
| 119 | + [ |
| 120 | + ...swiftFormat.prefixArguments, |
| 121 | + check ? 'lint' : 'format', |
| 122 | + '--configuration', |
| 123 | + CONFIG, |
| 124 | + ...(check ? ['--strict'] : ['--in-place']), |
| 125 | + ...files.slice(i, i + MAX_FILES_PER_PROCESS), |
| 126 | + ], |
| 127 | + { |
| 128 | + cwd: REPO_ROOT, |
| 129 | + env: {...process.env, PWD: REPO_ROOT}, |
| 130 | + stdio: 'inherit', |
| 131 | + }, |
| 132 | + ); |
| 133 | + if (result.error != null) { |
| 134 | + throw result.error; |
| 135 | + } |
| 136 | + if (result.signal != null) { |
| 137 | + throw new Error(`swift-format was terminated by ${result.signal}`); |
| 138 | + } |
| 139 | + if (result.status !== 0) { |
| 140 | + exitStatus = result.status ?? 1; |
| 141 | + } |
| 142 | + } |
| 143 | + process.exitCode = exitStatus; |
| 144 | +} |
| 145 | + |
| 146 | +main(); |
![meta-codesync[bot]](https://avatars.githubusercontent.com/in/1373969?v=4&size=40){kind=avatar}
0 commit comments