summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.changeset/strange-avocados-double.md5
-rw-r--r--packages/astro/src/cli/index.ts15
-rw-r--r--packages/astro/src/cli/open.ts32
3 files changed, 49 insertions, 3 deletions
diff --git a/.changeset/strange-avocados-double.md b/.changeset/strange-avocados-double.md
new file mode 100644
index 000000000..e6379955d
--- /dev/null
+++ b/.changeset/strange-avocados-double.md
@@ -0,0 +1,5 @@
+---
+'astro': patch
+---
+
+Add `astro docs` command which opens the Astro docs in your preferred browser.
diff --git a/packages/astro/src/cli/index.ts b/packages/astro/src/cli/index.ts
index df2d2c2a8..5d6612b43 100644
--- a/packages/astro/src/cli/index.ts
+++ b/packages/astro/src/cli/index.ts
@@ -12,12 +12,13 @@ import add from '../core/add/index.js';
import devServer from '../core/dev/index.js';
import preview from '../core/preview/index.js';
import { check } from './check.js';
+import { openInBrowser } from './open.js';
import { loadConfig } from '../core/config.js';
import { printHelp, formatErrorMessage, formatConfigErrorMessage } from '../core/messages.js';
import { createSafeError } from '../core/util.js';
type Arguments = yargs.Arguments;
-type CLICommand = 'help' | 'version' | 'add' | 'dev' | 'build' | 'preview' | 'reload' | 'check';
+type CLICommand = 'help' | 'version' | 'add' | 'docs' | 'dev' | 'build' | 'preview' | 'reload' | 'check';
/** Display --help flag */
function printAstroHelp() {
@@ -26,6 +27,7 @@ function printAstroHelp() {
headline: 'Futuristic web development tool.',
commands: [
['add', 'Add an integration to your configuration.'],
+ ['docs', 'Launch Astro\'s Doc site directly from the terminal. '],
['dev', 'Run Astro in development mode.'],
['build', 'Build a pre-compiled production-ready site.'],
['preview', 'Preview your build locally before deploying.'],
@@ -58,11 +60,10 @@ async function printVersion() {
function resolveCommand(flags: Arguments): CLICommand {
const cmd = flags._[2] as string;
if (cmd === 'add') return 'add';
-
if (flags.version) return 'version';
else if (flags.help) return 'help';
- const supportedCommands = new Set(['dev', 'build', 'preview', 'check']);
+ const supportedCommands = new Set(['dev', 'build', 'preview', 'check', 'docs']);
if (supportedCommands.has(cmd)) {
return cmd as CLICommand;
}
@@ -145,6 +146,14 @@ export async function cli(args: string[]) {
}
}
+ case 'docs': {
+ try {
+ return await openInBrowser('https://docs.astro.build/')
+ } catch (err) {
+ return throwAndExit(err)
+ }
+ }
+
default: {
throw new Error(`Error running ${cmd}`);
}
diff --git a/packages/astro/src/cli/open.ts b/packages/astro/src/cli/open.ts
new file mode 100644
index 000000000..ad803513e
--- /dev/null
+++ b/packages/astro/src/cli/open.ts
@@ -0,0 +1,32 @@
+import type { ExecaChildProcess } from 'execa';
+import { execa } from 'execa';
+
+/**
+ * Credit: Azhar22
+ * @see https://github.com/azhar22k/ourl/blob/master/index.js
+ */
+const getPlatformSpecificCommand = (): [string]|[string, string[]] => {
+ const isGitPod = Boolean(process.env.GITPOD_REPO_ROOT);
+ const platform = isGitPod ? 'gitpod' : process.platform;
+
+ switch (platform) {
+ case 'android':
+ case 'linux':
+ return ['xdg-open'];
+ case 'darwin':
+ return ['open'];
+ case 'win32':
+ return ['cmd', ['/c', 'start']];
+ case 'gitpod':
+ return ['/ide/bin/remote-cli/gitpod-code', ['--openExternal']];
+ default:
+ throw new Error(
+ `It looks like your platform ("${platform}") isn't supported!\nTo view Astro's docs, please visit https://docs.astro.build`
+ );
+ }
+};
+
+export async function openInBrowser(url: string): Promise<ExecaChildProcess> {
+ const [command, args = []] = getPlatformSpecificCommand();
+ return execa(command, [...args, encodeURI(url)]);
+};