Raycast 扩展项目教程

1. 项目的目录结构及介绍

Raycast 扩展项目的目录结构如下：

raycast/extensions
├── docs
├── examples
├── extensions
├── images
├── migrations
├── scripts
└── templates

目录介绍

• docs: 包含项目的文档文件，通常是 Markdown 格式，用于说明项目的使用方法、API 文档等。
• examples: 包含示例代码，帮助开发者理解如何使用 Raycast API 来创建扩展。
• extensions: 存放实际的扩展代码，每个扩展通常有自己的子目录。
• images: 存放项目相关的图片资源，如图标、截图等。
• migrations: 可能包含数据库迁移脚本或其他迁移相关的文件。
• scripts: 存放项目的脚本文件，如构建脚本、自动化测试脚本等。
• templates: 存放项目模板文件，帮助开发者快速开始一个新的扩展项目。

2. 项目的启动文件介绍

在 Raycast 扩展项目中，启动文件通常是 index.js 或 main.js。这些文件是扩展的入口点，负责初始化扩展并处理用户输入。

示例启动文件

// index.js
import { Action, ActionPanel, List, showToast, Toast } from "@raycast/api";

export default function Command() {
  return (
    <List>
      <List.Item
        title="Hello World"
        actions={
          <ActionPanel>
            <Action.OpenInBrowser url="https://raycast.com" />
          </ActionPanel>
        }
      />
    </List>
  );
}

启动文件功能

• 初始化扩展: 启动文件负责初始化扩展，设置扩展的基本配置。
• 处理用户输入: 启动文件通常包含处理用户输入的逻辑，如响应快捷键、处理命令等。
• 展示界面: 使用 Raycast API 提供的组件（如 List、ActionPanel 等）来展示用户界面。

3. 项目的配置文件介绍

Raycast 扩展项目的配置文件通常是 package.json 和 manifest.json。这些文件用于定义扩展的基本信息、依赖项和配置。

package.json

{
  "name": "my-raycast-extension",
  "version": "1.0.0",
  "description": "A Raycast extension example",
  "main": "index.js",
  "scripts": {
    "build": "ray build -e dist",
    "dev": "ray develop"
  },
  "dependencies": {
    "@raycast/api": "^1.0.0"
  }
}

manifest.json

{
  "name": "My Raycast Extension",
  "description": "A simple Raycast extension",
  "icon": "icon.png",
  "author": "Your Name",
  "commands": [
    {
      "name": "index",
      "title": "Hello World",
      "description": "A simple command",
      "mode": "view"
    }
  ],
  "preferences": [
    {
      "name": "apiKey",
      "type": "password",
      "required": true,
      "title": "API Key",
      "description": "Your API key for the service"
    }
  ]
}

配置文件功能

• package.json: 定义扩展的基本信息、依赖项和脚本命令。
• manifest.json: 定义扩展的元数据，如名称、描述、图标、命令和用户偏好设置。

通过以上配置文件，开发者可以定义扩展的行为、依赖项和用户界面。