UNPKG

clang-format-git

Version:

Node wrapper for git-clang-format Python script as a standalone native binary to allow execution without a Python dependency.🐉

clang-format-node.lumir.page

48 lines (47 loc) • 2.65 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
"use strict"; /** * @fileoverview `getGitClangFormatPath` and `getClangFormatGitPath` APIs. */ /* eslint-disable n/prefer-node-protocol -- DO NOT USE `node:` namespace for backward compatibility */ // -------------------------------------------------------------------------------- // Require // -------------------------------------------------------------------------------- const { existsSync } = require('fs'); const { resolve } = require('path'); // -------------------------------------------------------------------------------- // Declaration // -------------------------------------------------------------------------------- /** * Returns the ABSOLUTE path to the `git-clang-format` executable binary based on the OS platform and architecture. * * The possible combinations are `darwin-arm64`, `darwin-x64`, `linux-arm`, `linux-arm64`, `linux-ppc64`, `linux-s390x`, `linux-x64`, `win32-x64`. * * Throws an error if the executable is not found. * @param {string} osPlatform The current operating system platform. (e.g., `darwin`, `linux`, `win32`) * @param {string} architecture The current system architecture. (e.g., `arm`, `arm64`, `ppc64`, `s390x`, `x64`) * @returns {string} The ABSOLUTE path to the `git-clang-format` executable binary. * @throws `Error` Throws an error if the executable binary is not found for the specified OS platform and architecture. * @alias `getClangFormatGitPath`. See {@link getClangFormatGitPath}. * @version `v1.2.0` Initial release. * @see https://clang-format-node.lumir.page/docs/apis/clang-format-git */ function getGitClangFormatPath(osPlatform, architecture) { const gitClangFormatPath = resolve(__dirname, `..`, `..`, `bin`, `cfg-${osPlatform}-${architecture}`, `git-clang-format${osPlatform === 'win32' ? '.exe' : ''}`); if (!existsSync(gitClangFormatPath)) throw new Error(`No executable found for '${osPlatform}(OS platform)-${architecture}(architecture)'\nThe possible combinations are 'darwin-arm64', 'darwin-x64', 'linux-arm', 'linux-arm64', 'linux-ppc64', 'linux-s390x', 'linux-x64', 'win32-x64'`); return gitClangFormatPath; } /** * Alias for `getGitClangFormatPath`. * @alias `getGitClangFormatPath`. See {@link getGitClangFormatPath}. * @version `v1.2.0` Initial release. * @see https://clang-format-node.lumir.page/docs/apis/clang-format-git */ const getClangFormatGitPath = getGitClangFormatPath; // -------------------------------------------------------------------------------- // Exports // -------------------------------------------------------------------------------- module.exports = { getGitClangFormatPath, getClangFormatGitPath, };