|
| 1 | +/** |
| 2 | + * @author Toru Nagashima |
| 3 | + * See LICENSE file in root directory for full license. |
| 4 | + */ |
| 5 | +"use strict" |
| 6 | + |
| 7 | +const path = require("path") |
| 8 | +const matcher = require("ignore") |
| 9 | + |
| 10 | +const getConvertPath = require("../util/get-convert-path") |
| 11 | +const getPackageJson = require("../util/get-package-json") |
| 12 | +const getNpmignore = require("../util/get-npmignore") |
| 13 | + |
| 14 | +const NODE_SHEBANG = "#!/usr/bin/env node\n" |
| 15 | +const SHEBANG_PATTERN = /^(#!.+?)?(\r)?\n/u |
| 16 | +const NODE_SHEBANG_PATTERN = |
| 17 | + /^#!\/usr\/bin\/env(?: -\S+)*(?: [^\s=-]+=\S+)* node(?: [^\r\n]+?)?\n/u |
| 18 | + |
| 19 | +function simulateNodeResolutionAlgorithm(filePath, binField) { |
| 20 | + const possibilities = [filePath] |
| 21 | + let newFilePath = filePath.replace(/\.js$/u, "") |
| 22 | + possibilities.push(newFilePath) |
| 23 | + newFilePath = newFilePath.replace(/[/\\]index$/u, "") |
| 24 | + possibilities.push(newFilePath) |
| 25 | + return possibilities.includes(binField) |
| 26 | +} |
| 27 | + |
| 28 | +/** |
| 29 | + * Checks whether or not a given path is a `bin` file. |
| 30 | + * |
| 31 | + * @param {string} filePath - A file path to check. |
| 32 | + * @param {string|object|undefined} binField - A value of the `bin` field of `package.json`. |
| 33 | + * @param {string} basedir - A directory path that `package.json` exists. |
| 34 | + * @returns {boolean} `true` if the file is a `bin` file. |
| 35 | + */ |
| 36 | +function isBinFile(filePath, binField, basedir) { |
| 37 | + if (!binField) { |
| 38 | + return false |
| 39 | + } |
| 40 | + if (typeof binField === "string") { |
| 41 | + return simulateNodeResolutionAlgorithm( |
| 42 | + filePath, |
| 43 | + path.resolve(basedir, binField) |
| 44 | + ) |
| 45 | + } |
| 46 | + return Object.keys(binField).some(key => |
| 47 | + simulateNodeResolutionAlgorithm( |
| 48 | + filePath, |
| 49 | + path.resolve(basedir, binField[key]) |
| 50 | + ) |
| 51 | + ) |
| 52 | +} |
| 53 | + |
| 54 | +/** |
| 55 | + * Gets the shebang line (includes a line ending) from a given code. |
| 56 | + * |
| 57 | + * @param {SourceCode} sourceCode - A source code object to check. |
| 58 | + * @returns {{length: number, bom: boolean, shebang: string, cr: boolean}} |
| 59 | + * shebang's information. |
| 60 | + * `retv.shebang` is an empty string if shebang doesn't exist. |
| 61 | + */ |
| 62 | +function getShebangInfo(sourceCode) { |
| 63 | + const m = SHEBANG_PATTERN.exec(sourceCode.text) |
| 64 | + |
| 65 | + return { |
| 66 | + bom: sourceCode.hasBOM, |
| 67 | + cr: Boolean(m && m[2]), |
| 68 | + length: (m && m[0].length) || 0, |
| 69 | + shebang: (m && m[1] && `${m[1]}\n`) || "", |
| 70 | + } |
| 71 | +} |
| 72 | + |
| 73 | +/** @type {import('eslint').Rule.RuleModule} */ |
| 74 | +module.exports = { |
| 75 | + meta: { |
| 76 | + docs: { |
| 77 | + description: "require correct usage of hashbang", |
| 78 | + recommended: true, |
| 79 | + url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/hashbang.md", |
| 80 | + }, |
| 81 | + type: "problem", |
| 82 | + fixable: "code", |
| 83 | + schema: [ |
| 84 | + { |
| 85 | + type: "object", |
| 86 | + properties: { |
| 87 | + convertPath: getConvertPath.schema, |
| 88 | + ignoreUnpublished: { type: "boolean" }, |
| 89 | + additionalExecutables: { |
| 90 | + type: "array", |
| 91 | + items: { type: "string" }, |
| 92 | + }, |
| 93 | + }, |
| 94 | + additionalProperties: false, |
| 95 | + }, |
| 96 | + ], |
| 97 | + messages: { |
| 98 | + unexpectedBOM: "This file must not have Unicode BOM.", |
| 99 | + expectedLF: "This file must have Unix linebreaks (LF).", |
| 100 | + expectedHashbangNode: |
| 101 | + 'This file needs shebang "#!/usr/bin/env node".', |
| 102 | + expectedHashbang: "This file needs no shebang.", |
| 103 | + }, |
| 104 | + }, |
| 105 | + create(context) { |
| 106 | + const sourceCode = context.sourceCode ?? context.getSourceCode() // TODO: just use context.sourceCode when dropping eslint < v9 |
| 107 | + const filePath = context.filename ?? context.getFilename() |
| 108 | + if (filePath === "<input>") { |
| 109 | + return {} |
| 110 | + } |
| 111 | + |
| 112 | + const p = getPackageJson(filePath) |
| 113 | + if (!p) { |
| 114 | + return {} |
| 115 | + } |
| 116 | + |
| 117 | + const packageDirectory = path.dirname(p.filePath) |
| 118 | + |
| 119 | + const originalAbsolutePath = path.resolve(filePath) |
| 120 | + const originalRelativePath = path |
| 121 | + .relative(packageDirectory, originalAbsolutePath) |
| 122 | + .replace(/\\/gu, "/") |
| 123 | + |
| 124 | + const convertedRelativePath = |
| 125 | + getConvertPath(context)(originalRelativePath) |
| 126 | + const convertedAbsolutePath = path.resolve( |
| 127 | + packageDirectory, |
| 128 | + convertedRelativePath |
| 129 | + ) |
| 130 | + |
| 131 | + const { additionalExecutables = [] } = context.options?.[0] ?? {} |
| 132 | + |
| 133 | + const executable = matcher() |
| 134 | + executable.add(additionalExecutables) |
| 135 | + const isExecutable = executable.test(convertedRelativePath) |
| 136 | + |
| 137 | + if ( |
| 138 | + (additionalExecutables.length === 0 || |
| 139 | + isExecutable.ignored === false) && |
| 140 | + context.options?.[0]?.ignoreUnpublished === true |
| 141 | + ) { |
| 142 | + const npmignore = getNpmignore(convertedAbsolutePath) |
| 143 | + |
| 144 | + if (npmignore.match(convertedRelativePath)) { |
| 145 | + return {} |
| 146 | + } |
| 147 | + } |
| 148 | + |
| 149 | + const needsShebang = |
| 150 | + isExecutable.ignored === true || |
| 151 | + isBinFile(convertedAbsolutePath, p.bin, packageDirectory) |
| 152 | + const info = getShebangInfo(sourceCode) |
| 153 | + |
| 154 | + return { |
| 155 | + Program() { |
| 156 | + const loc = { |
| 157 | + start: { line: 1, column: 0 }, |
| 158 | + end: { line: 1, column: sourceCode.lines.at(0).length }, |
| 159 | + } |
| 160 | + |
| 161 | + if ( |
| 162 | + needsShebang |
| 163 | + ? NODE_SHEBANG_PATTERN.test(info.shebang) |
| 164 | + : !info.shebang |
| 165 | + ) { |
| 166 | + // Good the shebang target. |
| 167 | + // Checks BOM and \r. |
| 168 | + if (needsShebang && info.bom) { |
| 169 | + context.report({ |
| 170 | + loc, |
| 171 | + messageId: "unexpectedBOM", |
| 172 | + fix(fixer) { |
| 173 | + return fixer.removeRange([-1, 0]) |
| 174 | + }, |
| 175 | + }) |
| 176 | + } |
| 177 | + if (needsShebang && info.cr) { |
| 178 | + context.report({ |
| 179 | + loc, |
| 180 | + messageId: "expectedLF", |
| 181 | + fix(fixer) { |
| 182 | + const index = sourceCode.text.indexOf("\r") |
| 183 | + return fixer.removeRange([index, index + 1]) |
| 184 | + }, |
| 185 | + }) |
| 186 | + } |
| 187 | + } else if (needsShebang) { |
| 188 | + // Shebang is lacking. |
| 189 | + context.report({ |
| 190 | + loc, |
| 191 | + messageId: "expectedHashbangNode", |
| 192 | + fix(fixer) { |
| 193 | + return fixer.replaceTextRange( |
| 194 | + [-1, info.length], |
| 195 | + NODE_SHEBANG |
| 196 | + ) |
| 197 | + }, |
| 198 | + }) |
| 199 | + } else { |
| 200 | + // Shebang is extra. |
| 201 | + context.report({ |
| 202 | + loc, |
| 203 | + messageId: "expectedHashbang", |
| 204 | + fix(fixer) { |
| 205 | + return fixer.removeRange([0, info.length]) |
| 206 | + }, |
| 207 | + }) |
| 208 | + } |
| 209 | + }, |
| 210 | + } |
| 211 | + }, |
| 212 | +} |
0 commit comments