wehub-resource-sync
115 lines
4.1 KiB
JavaScript
115 lines
4.1 KiB
JavaScript
import {
|
|
chmodSync,
|
|
mkdirSync,
|
|
readFileSync,
|
|
rmSync,
|
|
statSync,
|
|
writeFileSync,
|
|
mkdtempSync
|
|
} from 'node:fs'
|
|
import { tmpdir } from 'node:os'
|
|
import path from 'node:path'
|
|
import { describe, expect, it } from 'vitest'
|
|
import { verifyPackageCliBin } from './verify-cli-bin.mjs'
|
|
|
|
/** Builds a temporary Orca-style project fixture with a compiled CLI entrypoint. */
|
|
function makeProjectWithCli(
|
|
content,
|
|
{ mode = 0o755, rootPackageType, writeOutPackageJson = true } = {}
|
|
) {
|
|
const projectDir = mkdtempSync(path.join(tmpdir(), 'orca-cli-bin-'))
|
|
const cliPath = path.join(projectDir, 'out', 'cli', 'index.js')
|
|
const outPackageJsonPath = path.join(projectDir, 'out', 'package.json')
|
|
mkdirSync(path.dirname(cliPath), { recursive: true })
|
|
writeFileSync(
|
|
path.join(projectDir, 'package.json'),
|
|
JSON.stringify({ bin: { orca: './out/cli/index.js' }, type: rootPackageType }),
|
|
'utf8'
|
|
)
|
|
if (writeOutPackageJson) {
|
|
writeFileSync(outPackageJsonPath, JSON.stringify({ type: 'commonjs' }), 'utf8')
|
|
}
|
|
writeFileSync(cliPath, content, 'utf8')
|
|
if (process.platform !== 'win32') {
|
|
chmodSync(cliPath, mode)
|
|
}
|
|
return { projectDir, cliPath, outPackageJsonPath }
|
|
}
|
|
|
|
describe('verifyPackageCliBin', () => {
|
|
it('accepts a non-empty Node entrypoint and can run help through Node', () => {
|
|
const { projectDir, cliPath } = makeProjectWithCli(
|
|
'#!/usr/bin/env node\nif (process.argv.includes("--help")) process.exit(0)\n'
|
|
)
|
|
|
|
expect(verifyPackageCliBin({ projectDir, runHelp: true })).toMatchObject({
|
|
binPath: cliPath
|
|
})
|
|
})
|
|
|
|
it('rejects an empty package bin target', () => {
|
|
const { projectDir } = makeProjectWithCli('')
|
|
|
|
expect(() => verifyPackageCliBin({ projectDir })).toThrow('bin.orca target is empty')
|
|
})
|
|
|
|
it('rejects package bin targets without a Node shebang', () => {
|
|
const { projectDir } = makeProjectWithCli('console.log("orca")\n')
|
|
|
|
expect(() => verifyPackageCliBin({ projectDir })).toThrow('Node shebang')
|
|
})
|
|
|
|
it('writes a CommonJS package boundary for the compiled CLI directory', () => {
|
|
const { projectDir, outPackageJsonPath } = makeProjectWithCli(
|
|
'#!/usr/bin/env node\nexports.ok = true\nif (process.argv.includes("--help")) process.exit(0)\n',
|
|
{ rootPackageType: 'module', writeOutPackageJson: false }
|
|
)
|
|
|
|
expect(() => verifyPackageCliBin({ projectDir, runHelp: true })).toThrow(
|
|
'compiled CLI package boundary is missing'
|
|
)
|
|
verifyPackageCliBin({ projectDir, fixPackageJson: true, runHelp: true })
|
|
|
|
expect(JSON.parse(readFileSync(outPackageJsonPath, 'utf8'))).toEqual({
|
|
name: 'orca-compiled-output',
|
|
type: 'commonjs',
|
|
private: true
|
|
})
|
|
})
|
|
|
|
it('rejects a CLI package boundary that is not CommonJS', () => {
|
|
const { projectDir, outPackageJsonPath } = makeProjectWithCli(
|
|
'#!/usr/bin/env node\nconsole.log("orca")\n'
|
|
)
|
|
writeFileSync(outPackageJsonPath, JSON.stringify({ type: 'module' }), 'utf8')
|
|
|
|
expect(() => verifyPackageCliBin({ projectDir })).toThrow('type=commonjs')
|
|
})
|
|
|
|
it.skipIf(process.platform === 'win32')('can repair the POSIX executable bit', () => {
|
|
const { projectDir, cliPath } = makeProjectWithCli(
|
|
'#!/usr/bin/env node\nconsole.log("orca")\n',
|
|
{ mode: 0o644 }
|
|
)
|
|
|
|
expect(() => verifyPackageCliBin({ projectDir })).toThrow('not executable')
|
|
verifyPackageCliBin({ projectDir, fixExecutable: true })
|
|
expect(statSync(cliPath).mode & 0o111).not.toBe(0)
|
|
expect(readFileSync(cliPath, 'utf8')).toContain('#!/usr/bin/env node')
|
|
})
|
|
|
|
it('repairs both the package boundary and POSIX executable bit together', () => {
|
|
const { projectDir, cliPath, outPackageJsonPath } = makeProjectWithCli(
|
|
'#!/usr/bin/env node\nconsole.log("orca")\n',
|
|
{ mode: 0o644, writeOutPackageJson: false }
|
|
)
|
|
|
|
verifyPackageCliBin({ projectDir, fixExecutable: true, fixPackageJson: true })
|
|
expect(JSON.parse(readFileSync(outPackageJsonPath, 'utf8')).type).toBe('commonjs')
|
|
if (process.platform !== 'win32') {
|
|
expect(statSync(cliPath).mode & 0o111).not.toBe(0)
|
|
}
|
|
rmSync(projectDir, { recursive: true, force: true })
|
|
})
|
|
})
|