OpenClaw 插件Development and scale

my-plugin/
├── package.json          # 插件元data and 依赖
├── README.md             # 插件documentation
├── src/
│   ├── index.js          # 插件主入口
│   ├── commands/         # commands定义
│   ├── events/           # eventprocessing
│   ├── config/           # configurationmanagement
│   └── utils/            # toolfunction
└── test/                 # testfile

// package.json example
{
  "name": "my-openclaw-plugin",
  "version": "1.0.0",
  "description": "My custom OpenClaw plugin",
  "main": "src/index.js",
  "keywords": [
    "openclaw",
    "plugin",
    "extension"
  ],
  "author": "Your Name",
  "license": "MIT",
  "openclaw": {
    "plugin": true,
    "name": "My Plugin",
    "version": "1.0.0",
    "description": "My custom OpenClaw plugin",
    "author": "Your Name",
    "commands": [
      {
        "command": "myplugin.helloWorld",
        "title": "Hello World"
      }
    ],
    "contributes": {
      "configuration": {
        "title": "My Plugin Configuration",
        "properties": {
          "myplugin.enableFeature": {
            "type": "boolean",
            "default": true,
            "description": "Enable the feature"
          }
        }
      }
    }
  },
  "dependencies": {
    "openclaw-plugin-api": "^1.0.0"
  }
}

// src/index.js example
const { OpenClawPlugin } = require('openclaw-plugin-api');

class MyPlugin extends OpenClawPlugin {
    // 插件激活时调用
    activate(context) {
        console.log('My Plugin activated');
        
        // registercommands
        this.registerCommand('myplugin.helloWorld', () => {
            this.showMessage('Hello from My Plugin!');
        });
        
        // registerevent监听器
        this.on('fileOpened', (file) => {
            console.log('File opened:', file);
        });
        
        // store on  under 文
        this.context = context;
    }
    
    // 插件停用时调用
    deactivate() {
        console.log('My Plugin deactivated');
    }
    
    // 自定义method
    showMessage(message) {
        this.context.window.showInformationMessage(message);
    }
}

// export插件
module.exports = MyPlugin;

// registercommandsexample
//  in activatemethodin
this.registerCommand('myplugin.generateComponent', async () => {
    // 获取user输入
    const componentName = await this.context.window.showInputBox({
        prompt: 'Enter component name:',
        placeHolder: 'MyComponent'
    });
    
    if (!componentName) return;
    
    // 生成componentcode
    const componentCode = this.generateComponentCode(componentName);
    
    // creation new file
    await this.context.workspace.createFile(
        `src/components/${componentName}.js`,
        componentCode
    );
    
    // 显示成功message
    this.context.window.showInformationMessage(
        `Component ${componentName} created successfully!`
    );
});

// 生成componentcode method
generateComponentCode(name) {
    return `import React from 'react';

const ${name} = () => {
    return (
        

            
${name}
            
This is the ${name} component.
        
    );
};

export default ${name};`;
}

// event监听器example
//  in activatemethodin
this.on('fileOpened', (file) => {
    console.log('File opened:', file.path);
    // 可以 in 这里添加file打开时 processing逻辑
});

this.on('fileSaved', (file) => {
    console.log('File saved:', file.path);
    // 可以 in 这里添加file保存时 processing逻辑
});

this.on('commandExecuted', (command) => {
    console.log('Command executed:', command.id);
    // 可以 in 这里添加commands执行 after  processing逻辑
});

this.on('error', (error) => {
    console.error('Error occurred:', error);
    // 可以 in 这里添加errorprocessing逻辑
});

// 显示informationmessage
this.context.window.showInformationMessage('Operation completed successfully');

// 显示warningmessage
this.context.window.showWarningMessage('This operation may take a while');

// 显示errormessage
this.context.window.showErrorMessage('An error occurred');

// 显示输入框
const input = await this.context.window.showInputBox({
    prompt: 'Enter your name:',
    placeHolder: 'John Doe',
    value: 'Default value'
});

// 显示选择框
const options = ['Option 1', 'Option 2', 'Option 3'];
const choice = await this.context.window.showQuickPick(options, {
    placeHolder: 'Select an option'
});

// 显示确认 for 话框
const confirmed = await this.context.window.showQuickPick(['Yes', 'No'], {
    placeHolder: 'Are you sure?'
});

if (confirmed === 'Yes') {
    // user确认
} else {
    // user取消
}

// 读取file
const content = await this.context.workspace.readFile('package.json');
console.log('File content:', content);

// 写入file
await this.context.workspace.writeFile('new-file.js', 'console.log("Hello World");');

// creationfile夹
await this.context.workspace.createFolder('new-folder');

// 列出file夹 in 容
const files = await this.context.workspace.listFiles('src');
console.log('Files in src:', files);

// findfile
const matches = await this.context.workspace.findFiles('**/*.js');
console.log('Found files:', matches);

// 打开file
const document = await this.context.workspace.openFile('src/index.js');

// 保存file
await document.save();

// 获取当 before 编辑器
const editor = this.context.window.activeTextEditor;
if (!editor) return;

// 获取编辑器 in 容
const content = editor.document.getText();
console.log('Editor content:', content);

// 获取选in 文本
const selection = editor.selection;
const selectedText = editor.document.getText(selection);
console.log('Selected text:', selectedText);

//  in 光标位置插入文本
editor.edit(editbuilder => {
    editbuilder.insert(editor.selection.active, 'Inserted text');
});

// replace选in 文本
editor.edit(editbuilder => {
    editbuilder.replace(selection, 'Replacement text');
});

// 获取光标位置
const position = editor.selection.active;
console.log('Cursor position:', position.line, position.character);

// 设置光标位置
const newPosition = new this.context.Position(10, 5);
const newSelection = new this.context.Selection(newPosition, newPosition);
editor.selection = newSelection;

// 生成code
const generatedCode = await this.context.ai.generateCode({
    prompt: 'Create a Python function that calculates the factorial of a number',
    language: 'python',
    options: {
        temperature: 0.7,
        maxTokens: 500
    }
});
console.log('Generated code:', generatedCode);

// analysiscode
const analysis = await this.context.ai.analyzeCode({
    code: 'function factorial(n) { return n <= 1 ? 1 : n * factorial(n-1); }',
    language: 'javascript'
});
console.log('Code analysis:', analysis);

// 解释code
const explanation = await this.context.ai.explainCode({
    code: 'const result = array.filter(item => item > 0).map(item => item * 2);',
    language: 'javascript'
});
console.log('Code explanation:', explanation);

// 修复error
const fixedCode = await this.context.ai.fixCode({
    code: 'function calculateAverage(numbers) { let sum = 0; for (let i = 0; i < numbers.length; i++); sum += numbers[i]; return sum / numbers.length; }',
    language: 'javascript'
});
console.log('Fixed code:', fixedCode);

// package.json in configuration定义
"openclaw": {
    "plugin": true,
    "name": "My Plugin",
    "contributes": {
        "configuration": {
            "title": "My Plugin Configuration",
            "properties": {
                "myplugin.apiKey": {
                    "type": "string",
                    "default": "",
                    "description": "API key for external service"
                },
                "myplugin.enableFeature": {
                    "type": "boolean",
                    "default": true,
                    "description": "Enable the feature"
                },
                "myplugin.maxResults": {
                    "type": "number",
                    "default": 10,
                    "minimum": 1,
                    "maximum": 100,
                    "description": "Maximum number of results"
                },
                "myplugin.defaultLanguage": {
                    "type": "string",
                    "default": "javascript",
                    "enum": ["javascript", "python", "java", "cpp"],
                    "description": "Default programming language"
                }
            }
        }
    }
}

// 读取configuration
const config = this.context.configuration.get('myplugin');
console.log('Plugin config:', config);

// 读取specificconfiguration项
const apiKey = this.context.configuration.get('myplugin.apiKey');
const enableFeature = this.context.configuration.get('myplugin.enableFeature');

// modifyconfiguration
await this.context.configuration.update('myplugin.maxResults', 20);

// 监听configuration变化
this.on('configurationChanged', (change) => {
    if (change.section === 'myplugin') {
        console.log('Plugin configuration changed:', change);
        // processingconfiguration变化
    }
});

# My OpenClaw Plugin

A custom OpenClaw plugin that adds awesome features.

## Features

- Feature 1: Description of feature 1
- Feature 2: Description of feature 2
- Feature 3: Description of feature 3

## Installation

### From OpenClaw Marketplace

1. Open OpenClaw
2. Go to Extensions
3. Search for "My Plugin"
4. Click Install

### From VSIX

1. Download the latest VSIX file from [releases](https://github.com/yourusername/my-openclaw-plugin/releases)
2. Open OpenClaw
3. Go to Extensions
4. Click the three dots (...) and select "Install from VSIX..."
5. Select the downloaded VSIX file

## Usage

### Command 1

1. Press Ctrl+Shift+P to open the command palette
2. Type "My Plugin: Command 1"
3. Press Enter

### Command 2

1. Right-click in the editor
2. Select "My Plugin: Command 2" from the context menu

## Configuration

The plugin can be configured in OpenClaw settings:

- `myplugin.apiKey`: API key for external service
- `myplugin.enableFeature`: Enable/disable feature
- `myplugin.maxResults`: Maximum number of results
- `myplugin.defaultLanguage`: Default programming language

## Keyboard Shortcuts

- `Ctrl+Alt+M`: Run Command 1
- `Ctrl+Alt+N`: Run Command 2

## Requirements

- OpenClaw 1.0.0 or higher
- Node.js 14.0 or higher (for development)

## Extension Settings

See Configuration section above.

## Known Issues

- Issue 1: Description of issues 1
- Issue 2: Description of issues 2

## Release Notes

### 1.0.0

- Initial release
- Added Feature 1
- Added Feature 2

### 1.0.1

- Fixed Issue 1
- Improved Feature 2

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for details.

## License

This extension is licensed under the MIT License. See [LICENSE](LICENSE) for details.