-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat(astro): improve info command * chore: update browser field
- Loading branch information
1 parent
7a894ee
commit 5f3a44a
Showing
3 changed files
with
88 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
'astro': patch | ||
--- | ||
|
||
Improve `astro info` command formatting, allow users to copy info automatically |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,50 +1,100 @@ | ||
/* eslint-disable no-console */ | ||
import type yargs from 'yargs-parser'; | ||
import * as colors from 'kleur/colors'; | ||
import { arch, platform } from 'node:os'; | ||
import whichPm from 'which-pm'; | ||
import type yargs from 'yargs-parser'; | ||
import prompts from 'prompts'; | ||
import { resolveConfig } from '../../core/config/index.js'; | ||
import { ASTRO_VERSION } from '../../core/constants.js'; | ||
import { flagsToAstroInlineConfig } from '../flags.js'; | ||
import { execSync } from 'node:child_process'; | ||
|
||
interface InfoOptions { | ||
flags: yargs.Arguments; | ||
} | ||
|
||
export async function printInfo({ flags }: InfoOptions) { | ||
const rows: Array<[string, string | string[]]> = [ | ||
['Astro', `v${ASTRO_VERSION}`], | ||
['Node', process.version], | ||
['System', getSystem()], | ||
['Package Manager', getPackageManager()], | ||
] | ||
|
||
const inlineConfig = flagsToAstroInlineConfig(flags); | ||
const packageManager = await whichPm(process.cwd()); | ||
let adapter = "Couldn't determine."; | ||
let integrations = []; | ||
|
||
const MAX_PADDING = 25; | ||
function printRow(label: string, value: string) { | ||
const padding = MAX_PADDING - label.length; | ||
console.log(`${colors.bold(label)}` + ' '.repeat(padding) + `${colors.green(value)}`); | ||
try { | ||
const { userConfig } = await resolveConfig(inlineConfig, 'info'); | ||
rows.push(['Output', userConfig.output ?? 'static']) | ||
rows.push(['Adapter', userConfig.adapter?.name ?? 'none']) | ||
const integrations = (userConfig?.integrations ?? []) | ||
.filter(Boolean) | ||
.flat() | ||
.map((i: any) => i?.name) | ||
.filter(Boolean); | ||
rows.push(['Integrations', integrations.length > 0 ? integrations : 'none']); | ||
} catch {} | ||
|
||
let output = ''; | ||
for (const [label, value] of rows) { | ||
output += printRow(label, value); | ||
} | ||
|
||
await copyToClipboard(output.trim()); | ||
} | ||
|
||
const SUPPORTED_SYSTEM = new Set(['darwin', 'win32']); | ||
async function copyToClipboard(text: string) { | ||
const system = platform(); | ||
if (!SUPPORTED_SYSTEM.has(system)) return; | ||
|
||
console.log(); | ||
const { shouldCopy } = await prompts({ | ||
type: 'confirm', | ||
name: 'shouldCopy', | ||
message: 'Copy to clipboard?', | ||
initial: true, | ||
}) | ||
if (!shouldCopy) return; | ||
const command = system === 'darwin' ? 'pbcopy' : 'clip'; | ||
try { | ||
const { userConfig } = await resolveConfig(inlineConfig, 'info'); | ||
if (userConfig.adapter?.name) { | ||
adapter = userConfig.adapter.name; | ||
} | ||
if (userConfig.integrations) { | ||
integrations = (userConfig?.integrations ?? []) | ||
.filter(Boolean) | ||
.flat() | ||
.map((i: any) => i?.name); | ||
execSync(`echo ${JSON.stringify(text.trim())} | ${command}`, { encoding: 'utf8', stdio: 'ignore' }); | ||
} catch (e) { | ||
console.error(colors.red(`\nSorry, something went wrong!`) + ` Please copy the text above manually.`); | ||
} | ||
} | ||
|
||
const PLATFORM_TO_OS: Partial<Record<ReturnType<typeof platform>, string>> = { | ||
darwin: 'macOS', | ||
win32: 'Windows', | ||
linux: 'Linux', | ||
} | ||
|
||
function getSystem() { | ||
const system = PLATFORM_TO_OS[platform()] ?? platform(); | ||
return `${system} (${arch()})`; | ||
} | ||
|
||
function getPackageManager() { | ||
if (!process.env.npm_config_user_agent) { | ||
return 'unknown' | ||
} | ||
const specifier = process.env.npm_config_user_agent.split(' ')[0]; | ||
const name = specifier.substring(0, specifier.lastIndexOf('/')); | ||
return name === 'npminstall' ? 'cnpm' : name; | ||
} | ||
|
||
const MAX_PADDING = 25; | ||
function printRow(label: string, value: string | string[]) { | ||
const padding = MAX_PADDING - label.length; | ||
const [first, ...rest] = Array.isArray(value) ? value : [value]; | ||
let plaintext = `${label}${' '.repeat(padding)}${first}`; | ||
let richtext = `${colors.bold(label)}${' '.repeat(padding)}${colors.green(first)}`; | ||
if (rest.length > 0) { | ||
for (const entry of rest) { | ||
plaintext += `\n${' '.repeat(MAX_PADDING)}${entry}`; | ||
richtext += `\n${' '.repeat(MAX_PADDING)}${colors.green(entry)}` | ||
} | ||
} catch (_e) {} | ||
console.log(); | ||
const packageManagerName = packageManager?.name ?? "Couldn't determine."; | ||
printRow('Astro version', `v${ASTRO_VERSION}`); | ||
printRow('Package manager', packageManagerName); | ||
printRow('Platform', platform()); | ||
printRow('Architecture', arch()); | ||
printRow('Adapter', adapter); | ||
let integrationsString = "None or couldn't determine."; | ||
if (integrations.length > 0) { | ||
integrationsString = integrations.join(', '); | ||
} | ||
printRow('Integrations', integrationsString); | ||
plaintext += '\n'; | ||
console.log(richtext); | ||
return plaintext; | ||
} |