PluginCore

https://github.com/yiyungent/plugincore
Admin
PluginCore is an ASP.NET Core lightweight plugin framework featuring Vue.js frontend and JavaScript...
Tokens:10,039
Snippets:60
Trust Score:9.9
License:LGPL-3.0
Update:1 year ago
Show doc for...
Tokens:
Raw
### Project Setup and Development Commands

Source: https://github.com/yiyungent/plugincore/blob/main/plugincore-admin-frontend/README.md

Provides essential commands for cloning the project, installing dependencies, and starting the development server. It utilizes npm for package management and opens the application at http://localhost:9528.

```bash
git clone https://github.com/yiyungent/plugincore-admin-frontend.git

cd plugincore-admin-frontend

npm install

npm run dev
```

--------------------------------

### Install PluginCore Template using dotnet CLI

Source: https://github.com/yiyungent/plugincore/blob/main/docs/docs/zh/PluginDev/Guide/README.md

Installs the PluginCore plugin template globally using the .NET CLI. This template provides a starting point for creating new plugins.

```shell
dotnet new --install PluginCore.Template
```

--------------------------------

### Create a new Plugin project using dotnet CLI

Source: https://github.com/yiyungent/plugincore/blob/main/docs/docs/zh/PluginDev/Guide/README.md

Creates a new plugin project using the installed PluginCore template. The `-n` flag specifies the project name.

```shell
dotnet new plugincore -n MyFirstPlugin
```

--------------------------------

### Plugin Settings JSON Configuration

Source: https://github.com/yiyungent/plugincore/blob/main/docs/docs/zh/PluginDev/Guide/README.md

An example of a settings.json file used to configure plugin-specific settings. The structure of this JSON should match the properties defined in the plugin's SettingsModel.

```json
{
	"Hello": "哈哈哈哈哈或或或或或或"
}
```

--------------------------------

### Plugin README Markdown Documentation

Source: https://github.com/yiyungent/plugincore/blob/main/docs/docs/zh/PluginDev/Guide/README.md

An optional README.md file for plugin documentation. This markdown file can include instructions, notes, and other relevant information for users or developers.

```markdown
## 说明文档（可选）

- [ ] 这是一个示例插件
- [x] 感谢使用
```

--------------------------------

### Install Project Dependencies

Source: https://github.com/yiyungent/plugincore/blob/main/plugincore-admin-frontend/README-zh.md

Installs project dependencies using npm. It also provides an alternative command to use the Taobao registry for faster downloads.

```bash
npm install

# Recommended to avoid slow npm downloads
npm install --registry=https://registry.npm.taobao.org
```

--------------------------------

### Plugin Info JSON Configuration

Source: https://github.com/yiyungent/plugincore/blob/main/docs/docs/zh/PluginDev/Guide/README.md

Specifies the required info.json file for a plugin, containing metadata such as PluginId, DisplayName, Description, Author, Version, SupportedVersions, and DependPlugins.

```json
{
	"PluginId": "HelloWorldPlugin",
	"DisplayName": "获取一个用户",
	"Description": "这是一个示例插件2号。",
	"Author": "yiyun",
	"Version": "0.1.0",
	"SupportedVersions": [ "0.0.1" ],
	"DependPlugins": [ ]
}
```

--------------------------------

### Create a SayHelloMiddleware in C#

Source: https://github.com/yiyungent/plugincore/blob/main/docs/docs/zh/PluginDev/Guide/README.md

Defines a custom ASP.NET Core middleware that handles requests starting with '/SayHello'. It demonstrates how to access `HttpContext`, query strings, and utilize dependency injection for `IPluginFinder` within the middleware.

```csharp
public class SayHelloMiddleware
{
    private readonly RequestDelegate _next;

    /// <summary>
    /// 在 <see cref="PluginApplicationBuilder"/> Build 时, 将会 new Middleware(), 最终将所有 Middleware 包装为一个 <see cref="RequestDelegate"/>
    /// </summary>
    /// <param name="next"></param>
    public SayHelloMiddleware(RequestDelegate next)
    {
        _next = next;
    }


    /// <summary>
    /// 
    /// </summary>
    /// <param name="httpContext"></param>
    /// <param name="pluginFinder">测试，是否运行时添加的Middleware，是否可以依赖注入</param>
    /// <returns></returns>
    public async Task InvokeAsync(HttpContext httpContext, IPluginFinder pluginFinder)
    {
        // 测试: 成功
        List<IPlugin> plugins = pluginFinder.EnablePlugins()?.ToList();

        bool isMatch = false;

        isMatch = httpContext.Request.Path.Value.StartsWith("/SayHello");

        if (isMatch)
        {
            await httpContext.Response.WriteAsync($"Hello World! {DateTime.Now:yyyy-MM-dd HH:mm:ss} <br>" +
                                                  $"{httpContext.Request.Path} <br>" +
                                                  $"{httpContext.Request.QueryString.Value}", Encoding.UTF8);
        }
        else
        {
            // Call the next delegate/middleware in the pipeline
            await _next(httpContext);
        }
    }

}
```

--------------------------------

### Start Development Server

Source: https://github.com/yiyungent/plugincore/blob/main/plugincore-admin-frontend/README-zh.md

Starts the development server for the vue-admin-template project. The application will be accessible at http://localhost:9528.

```bash
npm run dev
```

--------------------------------

### Install and Update Docfx

Source: https://github.com/yiyungent/plugincore/blob/main/docfx_project/index.md

Installs or updates the Docfx command-line tool globally using .NET Core SDK. This is a prerequisite for generating API documentation.

```bash
dotnet tool update -g docfx
```

--------------------------------

### Plugin Project File Configuration (csproj)

Source: https://github.com/yiyungent/plugincore/blob/main/docs/docs/zh/PluginDev/Guide/README.md

Configures the .csproj file for a PluginCore plugin. It sets the target framework, enables dynamic loading, excludes runtime assets from framework references, and includes plugin metadata files for deployment.

```xml
<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFramework>net6.0</TargetFramework>
    <EnableDynamicLoading>true</EnableDynamicLoading>
  </PropertyGroup>

  <ItemGroup>
    <FrameworkReference Include="Microsoft.AspNetCore.App">
			<ExcludeAssets>runtime</ExcludeAssets>
		</FrameworkReference>
  </ItemGroup>

  <ItemGroup>
    <PackageReference Include="PluginCore.IPlugins.AspNetCore" Version="0.1.0">
			<ExcludeAssets>runtime</ExcludeAssets>
		</PackageReference>
  </ItemGroup>

  <!-- 发布插件相关文件 -->
  <ItemGroup>
    <Content Include="info.json">
      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
    </Content>
    <Content Include="README.md">
      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
    </Content>
    <Content Include="settings.json">
      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
    </Content>
  </ItemGroup>

  <!-- 发布 wwwroot -->
  <ItemGroup>
    <Content Include="wwwroot\**\*">
      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
    </Content>
  </ItemGroup>

</Project>
```

--------------------------------

### Add PluginCore.IPlugins.AspNetCore NuGet Package

Source: https://github.com/yiyungent/plugincore/blob/main/docs/docs/zh/PluginDev/Guide/README.md

Demonstrates different methods to add the PluginCore.IPlugins.AspNetCore NuGet package to a project, which is essential for integrating plugins with ASP.NET Core.

```shell
Install-Package PluginCore.IPlugins.AspNetCore
```

```shell
dotnet add package PluginCore.IPlugins.AspNetCore
```

```xml
<PackageReference Include="PluginCore.IPlugins.AspNetCore" Version="0.0.1">
  <ExcludeAssets>runtime</ExcludeAssets>
</PackageReference>
```

--------------------------------

### Install PluginCore ASP.NET Core Package

Source: https://github.com/yiyungent/plugincore/blob/main/README_zh.md

Installs the PluginCore NuGet package for ASP.NET Core applications using the Package Manager Console in Visual Studio.

```powershell
PM> Install-Package PluginCore.AspNetCore
```

--------------------------------

### User Controller for Plugin

Source: https://github.com/yiyungent/plugincore/blob/main/docs/docs/zh/PluginDev/Guide/README.md

Defines a user controller for a PluginCore plugin, demonstrating how to inject services and access plugin settings. It retrieves user information and custom settings to construct a response string.

```csharp
using Microsoft.AspNetCore.Mvc;
using PluginCore.AspNetCore;
using PluginCore.IPlugins;

[Route("api/plugins/[controller]")]
[ApiController]
public class UserHelloController : ControllerBase
{
    private readonly IUserInfoService _userInfoService;

    public UserHelloController(IUserInfoService userInfoService)
    {
        this._userInfoService = userInfoService;
    }

    public ActionResult Get()
    {
        UserInfo userInfo = _userInfoService.FirstOrDefaultAsync(m => !m.IsDeleted).Result;
        SettingsModel settingsModel = PluginSettingsModelFactory.Create<SettingsModel>("HelloWorldPlugin");
        string rtn = $"用户名: {userInfo.UserName}, 创建时间: {userInfo.CreateTime.ToString()}, Hello: {settingsModel.Hello}";

        return Ok(rtn);
    }
}
```

--------------------------------

### Implement a Plugin Class in C#

Source: https://github.com/yiyungent/plugincore/blob/main/docs/docs/zh/PluginDev/Guide/README.md

Shows how to create a C# class for a plugin by inheriting from `BasePlugin` and implementing `IStartupXPlugin`. It includes methods for plugin lifecycle events like `AfterEnable` and `BeforeDisable`, and configuration methods for services and the application pipeline.

```csharp
public class HelloWorldPlugin : BasePlugin, IStartupXPlugin
{
    public override (bool IsSuccess, string Message) AfterEnable()
    {
        Console.WriteLine($"{nameof(HelloWorldPlugin)}: {nameof(AfterEnable)}");
        return base.AfterEnable();
    }

    public override (bool IsSuccess, string Message) BeforeDisable()
    {
        Console.WriteLine($"{nameof(HelloWorldPlugin)}: {nameof(BeforeDisable)}");
        return base.BeforeDisable();
    }

    public void ConfigureServices(IServiceCollection services)
    {

    }

    public void Configure(IApplicationBuilder app)
    {
        app.UseMiddleware<SayHelloMiddleware>();
    }

    public int ConfigureOrder
    {
        get
        {
            return 2;
        }
    }


    public int ConfigureServicesOrder
    {
        get
        {
            return 2;
        }
    }
}
```

--------------------------------

### Install PluginCore via npm

Source: https://github.com/yiyungent/plugincore/blob/main/plugincore-js-sdk/README.md

Install the PluginCore JavaScript SDK as a dependency in your Node.js project using npm. This is the recommended method for project integration.

```bash
npm install @yiyungent/plugincore --save
```

--------------------------------

### Initialize and Start PluginCore from HTML (JS)

Source: https://github.com/yiyungent/plugincore/blob/main/plugincore-js-sdk/README.md

Embed PluginCore within an HTML page by including the SDK via a script tag and then initializing it with a base URL and starting its services. This is suitable for direct browser usage.

```javascript
var p = new PluginCore({
                baseUrl: "your PluginCore url"
            });

            p.start();
```

--------------------------------

### Plugin Settings Model

Source: https://github.com/yiyungent/plugincore/blob/main/docs/docs/zh/PluginDev/Guide/README.md

Defines a C# class that inherits from PluginSettingsModel to represent the settings for a plugin. This model is used to deserialize settings from a JSON file.

```csharp
public class SettingsModel : PluginSettingsModel
{
    public string Hello { get; set; }
}
```

--------------------------------

### Install PluginCore via CDN

Source: https://github.com/yiyungent/plugincore/blob/main/plugincore-js-sdk/README.md

Include the PluginCore JavaScript SDK in your HTML file using a CDN link. This makes the SDK available globally for use in your web application.

```html
<script src="https://cdn.jsdelivr.net/npm/@yiyungent/plugincore/dist/PluginCore.min.js"></script>
```

--------------------------------

### Load External Scripts and Listen for Load Events

Source: https://github.com/yiyungent/plugincore/blob/main/plugincore-js-sdk/Releases.md

Illustrates loading external JavaScript files and listening for their completion using an event listener. The example shows how to conditionally execute code after a specific script has loaded, ensuring all necessary resources are available.

```html
<link rel="stylesheet" href="https://unpkg.com/aplayer@1.10.1/dist/APlayer.min.css">
<div id="aplayer"></div>
<script src="https://unpkg.com/aplayer@1.10.1/dist/APlayer.min.js"></script>
<script>
    // p 为 PluginCore 对象实例
    p.addEventListener("load", (src) => {

        if (src != "https://unpkg.com/aplayer@1.10.1/dist/APlayer.min.js") {
            return;
        }

        // 参考:  
        // https://aplayer.js.org/config.js
        // https://api.i-meto.com/meting/api/index.php?server=netease
        const ap = new APlayer({
            container: document.getElementById('aplayer'),
            theme: '#F57F17',
            lrcType: 3,
            audio: [{
                name: '光るなら',
                artist: 'Goose house',
                url: 'https://api.i-meto.com/meting/api?server=netease&type=url&id=35847388&auth=ea47006318283154c3dc1e60fe3b37f0a20a2657',
                cover: 'https://api.i-meto.com/meting/api?server=netease&type=pic&id=109951164852190706&auth=b55cdaa7ac51009b74388bf15a392a3a6adabd17',
                lrc: 'https://api.meto.com/meting/api?server=netease&type=lrc&id=1464110291&auth=c1dd39b39f416702f68fa15d44953e8c4950bdd2',
                theme: '#ebd0c2'
            }, {
                name: 'トリカゴ',
                artist: 'XX:me',
                url: 'https://api.meto.com/meting/api?server=netease&type=url&id=33166086&auth=35fd43fe4c336c1368c99b707e2d688dbf4d2fb2',
                cover: 'https://api.meto.com/meting/api?server=netease&type=pic&id=109951164852190706&auth=b55cdaa7ac51009b74388bf15a392a3a6adabd17',
                lrc: 'https://api.meto.com/meting/api?server=netease&type=lrc&id=1464110291&auth=c1dd39b39f416702f68fa15d44953e8c4950bdd2',
                theme: '#46718b'
            }, {
                name: '前前前世',
                artist: 'RADWIMPS',
                url: 'https://api.meto.com/meting/api?server=netease&type=url&id=35847388&auth=ea47006318283154c3dc1e60fe3b37f0a20a2657',
                cover: 'https://api.meto.com/meting/api?server=netease&type=pic&id=109951164852190706&auth=b55cdaa7ac51009b74388bf15a392a3a6adabd17',
                lrc: 'https://api.meto.com/meting/api?server=netease&type=lrc&id=1464110291&auth=c1dd39b39f416702f68fa15d44953e8c4950bdd2',
                theme: '#505d6b'
            }]
        });

    })
</script>
```

--------------------------------

### Add Custom Request Headers with Plugincore

Source: https://github.com/yiyungent/plugincore/blob/main/plugincore-js-sdk/Releases.md

Demonstrates how to add custom request headers when starting the plugincore instance. This is useful for passing specific information, like authentication tokens or custom identifiers, in HTTP requests.

```javascript
plugincoreInstance.start(null, {'X-Custom-Header': 'foobar'});
```

--------------------------------

### Get GitHub Access Token in ASP.NET Core

Source: https://github.com/yiyungent/plugincore/blob/main/plugins/GitHubApiPlugin/README.md

Retrieves the GitHub Access Token from the session in an ASP.NET Core application. This token is typically stored after a successful OAuth authorization flow. Ensure you have the necessary session management configured in your ASP.NET Core application.

```csharp
var accessToken = Session.GetString("GitHub.AccessToken");
```

--------------------------------

### Configure ASP.NET Core Startup for PluginCore

Source: https://github.com/yiyungent/plugincore/blob/main/README.md

Demonstrates how to configure services and the HTTP request pipeline in the Startup.cs file to enable PluginCore functionality. It involves adding services and using the PluginCore middleware.

```C#
using PluginCore.AspNetCore.Extensions;

// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();

    // 1. Add PluginCore
    services.AddPluginCore();
}

// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseHttpsRedirection();

    app.UseRouting();

    // 2. Use PluginCore
    app.UsePluginCore();

    app.UseAuthorization();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}
```

--------------------------------

### Generate and Serve API Documentation with Docfx

Source: https://github.com/yiyungent/plugincore/blob/main/docfx_project/index.md

Navigates to the Docfx project directory, generates API metadata, builds the documentation into HTML, and serves it locally for preview. Requires a docfx.json configuration file.

```bash
cd docfx_project
docfx metadata
docfx build
docfx docfx.json --serve
```

--------------------------------

### Build Project for Deployment

Source: https://github.com/yiyungent/plugincore/blob/main/plugincore-admin-frontend/README-zh.md

Builds the project for different environments. 'build:stage' is for the staging environment, and 'build:prod' is for the production environment.

```bash
npm run build:stage

npm run build:prod
```

--------------------------------

### Advanced Commands for Previewing and Linting

Source: https://github.com/yiyungent/plugincore/blob/main/plugincore-admin-frontend/README.md

Includes commands for previewing the application's effect in release environments, optionally with static resource analysis. It also provides options for code formatting checks and auto-fixing using linting tools.

```bash
npm run preview

npm run preview -- --report

npm run lint

npm run lint -- --fix
```

--------------------------------

### Build Plugincore .NET Projects

Source: https://github.com/yiyungent/plugincore/blob/main/docfx_project/index.md

Builds the various .NET projects within the Plugincore solution in Release configuration. These commands compile the source code.

```bash
dotnet build src/PluginCore.IPlugins/PluginCore.IPlugins.csproj --configuration Release
dotnet build src/PluginCore/PluginCore.csproj --configuration Release
dotnet build src/PluginCore.IPlugins.AspNetCore/PluginCore.IPlugins.AspNetCore.csproj --configuration Release
dotnet build src/PluginCore.AspNetCore/PluginCore.AspNetCore.csproj --configuration Release
```

--------------------------------

### Preview Project Build

Source: https://github.com/yiyungent/plugincore/blob/main/plugincore-admin-frontend/README-zh.md

Previews the built project. An optional flag '--report' can be added to include a static resource analysis.

```bash
npm run preview

npm run preview -- --report
```

--------------------------------

### Build Commands for Different Environments

Source: https://github.com/yiyungent/plugincore/blob/main/plugincore-admin-frontend/README.md

These commands facilitate building the application for various deployment scenarios, including staging, production, and CDN environments. They are executed using npm scripts.

```bash
npm run build:stage

npm run build:prod

npm run build:cdn
```

--------------------------------

### Integrate PluginCore into ASP.NET Core Startup

Source: https://github.com/yiyungent/plugincore/blob/main/README_zh.md

Demonstrates how to integrate PluginCore into an ASP.NET Core application by adding services in ConfigureServices and using the middleware in Configure within the Startup.cs file.

```csharp
using PluginCore.AspNetCore.Extensions;

// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();

    // 1. 添加 PluginCore
    services.AddPluginCore();
}

// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseHttpsRedirection();

    app.UseRouting();

    // 2. 使用 PluginCore
    app.UsePluginCore();

    app.UseAuthorization();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}
```

--------------------------------

### Matomo Tag Manager Initialization

Source: https://github.com/yiyungent/plugincore/blob/main/docfx_project/index.md

Initializes the Matomo Tag Manager script for website analytics. This script asynchronously loads the Matomo tracking code.

```javascript
var _mtm = window._mtm = window._mtm || [];
_mtm.push({'mtm.startTime': (new Date().getTime()), 'event': 'mtm.Start'});
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.async=true; g.src='https://matomo.moeci.com/js/container_TkIZmeCT.js'; s.parentNode.insertBefore(g,s);
```

--------------------------------

### GitHub Login API

Source: https://github.com/yiyungent/plugincore/blob/main/plugins/GitHubApiPlugin/README.md

Initiates the GitHub OAuth login process.

```APIDOC
## GET /api/GitHub/Login

### Description
Initiates the GitHub OAuth login process. Users will be redirected to GitHub for authorization.

### Method
GET

### Endpoint
/api/GitHub/Login

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (302 Redirect)
- **Location** (string) - The URL to redirect the user to for GitHub authorization.

#### Response Example
(Redirect to GitHub's authorization URL)
```

--------------------------------

### Rebuild API Documentation Locally

Source: https://github.com/yiyungent/plugincore/blob/main/docfx_project/index.md

Rebuilds the API documentation website after local changes have been made. This command should be run in a new terminal to ensure the latest changes are reflected.

```bash
docfx docfx.json
```

--------------------------------

### Configure and Initialize APlayer Music Player

Source: https://github.com/yiyungent/plugincore/blob/main/plugins/HexoPlugin/footer.html

This JavaScript code configures and initializes the APlayer music player. It listens for the 'load' event on the 'p' element, specifically targeting the APlayer.min.js script. The player is configured with a list of songs, including name, artist, URL, cover art, LRC lyrics, and theme color, fetched from external API endpoints.

```javascript
p.addEventListener("load", (src) => { if (src != "https://unpkg.com/aplayer@1.10.1/dist/APlayer.min.js") { return; } // 参考: // https://aplayer.js.org/config.js // https://api.i-meto.com/meting/api/index.php?server=netease&type=url&id=35847388&auth=ea47006318283154c3dc1e60fe3b37f0a20a2657 const ap = new APlayer({ container: document.getElementById('aplayer'), theme: '#F57F17', lrcType: 3, audio: [{ name: '光るなら', artist: 'Goose house', url: 'https://api.i-meto.com/meting/api?server=netease&type=url&id=35847388&auth=ea47006318283154c3dc1e60fe3b37f0a20a2657', cover: 'https://api.i-meto.com/meting/api?server=netease&type=pic&id=109951164852190706&auth=b55cdaa7ac51009b74388bf15a392a3a6adabd17', lrc: 'https://api.i-meto.com/meting/api?server=netease&type=lrc&id=1464110291&auth=c1dd39b39f416702f68fa15d44953e8c4950bdd2', theme: '#ebd0c2' }, { name: 'トリカゴ', artist: 'XX:me', url: 'https://api.i-meto.com/meting/api?server=netease&type=url&id=33166086&auth=35fd43fe4c336c1368c99b707e2d688dbf4d2fb2', cover: 'https://api.i-meto.com/meting/api?server=netease&type=pic&id=109951164852190706&auth=b55cdaa7ac51009b74388bf15a392a3a6adabd17', lrc: 'https://api.meto.com/meting/api?server=netease&type=lrc&id=1464110291&auth=c1dd39b39f416702f68fa15d44953e8c4950bdd2', theme: '#46718b' }, { name: '前前前世', artist: 'RADWIMPS', url: 'https://api.i-meto.com/meting/api?server=netease&type=url&id=35847388&auth=ea47006318283154c3dc1e60fe3b37f0a20a2657', cover: 'https://api.i-meto.com/meting/api?server=netease&type=pic&id=109951164852190706&auth=b55cdaa7ac51009b74388bf15a392a3a6adabd17', lrc: 'https://api.i-meto.com/meting/api?server=netease&type=lrc&id=1464110291&auth=c1dd39b39f416702f68fa15d44953e8c4950bdd2', theme: '#505d6b' }] }); })
```

--------------------------------

### Initialize hexo-encrypt-token for automatic decryption

Source: https://github.com/yiyungent/plugincore/blob/main/plugins/HexoPlugin/footer.html

This snippet initializes the hexo-encrypt-token to automatically decrypt content after the password has been obtained on the first visit. It relies on the window.het object and the hbeLoader method.

```javascript
// hexo-encrypt-token: 用于第一次访问时, 在获取到 password 后, 自动解密 window.onload = function () { window.het.hbeLoader(); }
```

--------------------------------

### Plugin Loading and Management Interfaces

Source: https://github.com/yiyungent/plugincore/blob/main/docs/docs/zh/Advanced/Design/README.md

Defines the core interfaces for interacting with plugins, including loading assemblies, managing plugin contexts, and finding enabled plugins.

```C#
public interface IPluginContext {
    IEnumerable<Assembly> Assemblies {
        get;
    }

    Assembly LoadFromAssemblyName(AssemblyName assemblyName);
    void Unload();
}

public interface IPluginContextPack {
    // 将 此插件 打包 到一个 IPluginContext 中
    IPluginContext Pack(string pluginId);
}

public interface IPluginContextManager {
    List<IPluginContext> All();
    bool Any(string pluginId);
    void Remove(string pluginId);
    IPluginContext Get(string pluginId);
    void Add(string pluginId, IPluginContext context);
}

public interface IPluginFinder {
    IEnumerable<TPlugin> EnablePlugins<TPlugin>() where TPlugin : class;
    IEnumerable<IPlugin> EnablePlugins();
    IPlugin Plugin(string pluginId);
}

public interface IPluginManager {
    void LoadPlugin(string pluginId);
    void UnloadPlugin(string pluginId);
}
```

--------------------------------

### Plugin Context and Assembly Loading Implementation

Source: https://github.com/yiyungent/plugincore/blob/main/docs/docs/zh/Advanced/Design/README.md

Provides concrete implementations for plugin context management and assembly loading, including a collectible assembly load context for isolated plugin loading.

```C#
public class PluginLoadContext : CollectibleAssemblyLoadContext {
    private AssemblyDependencyResolver _resolver;

    protected override Assembly Load(AssemblyName assemblyName) {
        // ... implementation details ...
        return base.Load(assemblyName);
    }

    protected internal override IntPtr LoadUnmanagedDll(string unmanagedDllName) {
        // ... implementation details ...
        return base.LoadUnmanagedDll(unmanagedDllName);
    }
}

public class PluginContextPack : IPluginContextPack {
    // 将 此插件 打包 到一个 IPluginContext 中
    public IPluginContext Pack(string pluginId) {
        // ... implementation details ...
        return null;
    }
}

public class PluginContextManager : IPluginContextManager {
    private Dictionary<string, IPluginContext> _pluginContexts : PluginContextStore.PluginContexts;

    public List<IPluginContext> All() {
        // ... implementation details ...
        return null;
    }

    public bool Any(string pluginId) {
        // ... implementation details ...
        return false;
    }

    public void Remove(string pluginId) {
        // ... implementation details ...
    }

    public IPluginContext Get(string pluginId) {
        // ... implementation details ...
        return null;
    }

    public void Add(string pluginId, IPluginContext context) {
        // ... implementation details ...
    }
}

public static class PluginContextStore {
    // fixed: 由于 IPluginContextManager 单例失败, 因此临时解决方案
    public static Dictionary<string, IPluginContext> PluginContexts = new Dictionary<string, IPluginContext>();
}
```

--------------------------------

### Clone vue-admin-template Project

Source: https://github.com/yiyungent/plugincore/blob/main/plugincore-admin-frontend/README-zh.md

Clones the vue-admin-template project from GitHub to your local machine.

```bash
git clone https://github.com/PanJiaChen/vue-admin-template.git
```

--------------------------------

### Project Structure Visualization

Source: https://github.com/yiyungent/plugincore/blob/main/README_zh.md

A Mermaid diagram illustrating the dependency relationships between the various components of the PluginCore project, including its .NET Core libraries and frontend SDK.

```mermaid
graph BT
    iplugins_aspnetcore(PluginCore.IPlugins.AspNetCore) --> iplugins(PluginCore.IPlugins)
    aspnetcore(PluginCore.AspNetCore) --> iplugins_aspnetcore
    plugincore(PluginCore) --> iplugins
    aspnetcore(PluginCore.AspNetCore) --> plugincore
    admin_frontend(plugincore-admin-frontend) --> aspnetcore
    jssdk(plugincore-js-sdk) --> aspnetcore
```

--------------------------------

### Plugin Discovery and Management Implementations

Source: https://github.com/yiyungent/plugincore/blob/main/docs/docs/zh/Advanced/Design/README.md

Implements the plugin finder and manager interfaces, enabling the discovery of enabled plugins and the loading/unloading of plugins within the system.

```C#
public class PluginFinder : IPluginFinder {
    public IPluginContextManager PluginContextManager { get; set; }

    public IEnumerable<TPlugin> EnablePlugins<TPlugin>() where TPlugin : class {
        // ... implementation details ...
        return null;
    }

    public IEnumerable<IPlugin> EnablePlugins() {
        // ... implementation details ...
        return null;
    }

    public IPlugin Plugin(string pluginId) {
        // ... implementation details ...
        return null;
    }
}

public class PluginManager : IPluginManager {
    public IPluginContextManager PluginContextManager { get; set; }
    public IPluginContextPack PluginContextPack { get; set; }

    public void LoadPlugin(string pluginId) {
        // ... implementation details ...
    }

    public void UnloadPlugin(string pluginId) {
        // ... implementation details ...
    }
}

public class AspNetCorePluginManager : IPluginManager {
    public IPluginContextManager PluginContextManager { get; set; }
    public IPluginContextPack PluginContextPack { get; set; }

    public void LoadPlugin(string pluginId) {
        // ... implementation details ...
    }

    public void UnloadPlugin(string pluginId) {
        // ... implementation details ...
    }
}
```

--------------------------------

### JavaScript Module Initialization and Loading

Source: https://github.com/yiyungent/plugincore/blob/main/plugincore-admin-frontend/dist/index.html

This snippet defines the core functionality for initializing and loading JavaScript modules. It sets up a system for managing module definitions, handling dependencies, and executing modules. It also includes logic for asynchronous loading of code chunks, which is crucial for optimizing application performance by loading only necessary code when needed.

```javascript
(function(e){function n(n){for(var r,c,o=n[0],f=n[1],d=n[2],i=0,l=[];i<o.length;i++)c=o[i],Object.prototype.hasOwnProperty.call(u,c)&&u[c]&&l.push(u[c][0]),u[c]=0;for(r in f)Object.prototype.hasOwnProperty.call(f,r)&&(e[r]=f[r]);h&&h(n);while(l.length)l.shift()();return a.push.apply(a,d||[]),t()}function t(){for(var e,n=0;n<a.length;n++){for(var t=a[n],r=!0,c=1;c<t.length;c++){var o=t[c];0!==u[o]&&(r=!1)}r&&(a.splice(n--,1),e=f(f.s=t[0]))}return e}var r={},c={runtime:0},u={runtime:0},a=[];function o(e){return f.p+"static/js/"+({"chunk-06f436d7":"f3984a1c","chunk-15b907ab":"5e690ffe","chunk-2d0af66c":"81c90987","chunk-5088bd5d":"2b157bdf","chunk-52071f51":"283bfdd2","chunk-b3f42312":"21c47115","chunk-7ddfc226":"fdd25d64","chunk-ab13d2fa":"e4469315","chunk-c938429e":"b37cddaa","chunk-fc73330c":"cd7ac57b","chunk-fde25176":"196125da"}[e]||e)+".js"}function f(n){if(r[n])return r[n].exports;var t=r[n]={i:n,l:!1,exports:{}};return e[n].call(t.exports,t,t.exports,f),t.l=!0,t.exports}f.e=function(e){var n=[],t={"chunk-15b907ab":1,"chunk-5088bd5d":1,"chunk-52071f51":1,"chunk-b3f42312":1,"chunk-7ddfc226":1,"chunk-ab13d2fa":1,"chunk-c938429e":1,"chunk-fde25176":1};c[e]?n.push(c[e]):0!==c[e]&&t[e]&&n.push(c[e]=new Promise((function(n,t){for(var r="static/css/"+({"chunk-06f436d7":"31d6cfe0","chunk-15b907ab":"0972299d","chunk-2d0af66c":"31d6cfe0","chunk-5088bd5d":"9a9361c6","chunk-52071f51":"7862223c","chunk-b3f42312":"aa9de892","chunk-7ddfc226":"faa01ea3","chunk-ab13d2fa":"13a7e89e","chunk-c938429e":"b43adc50","chunk-fc73330c":"31d6cfe0","chunk-fde25176":"ec03d586"}[e]||e)+".css",u=f.p+r,a=document.getElementsByTagName("link"),o=0;o<a.length;o++){var d=a[o],i=d.getAttribute("data-href")||d.getAttribute("href");if("stylesheet"===d.rel&&(i===r||i===u))return n()}var l=document.getElementsByTagName("style");for(o=0;o<l.length;o++){d=l[o],i=d.getAttribute("data-href");if(i===r||i===u)return n()}var h=document.createElement("link");h.rel="stylesheet",h.type="text/css",h.onload=n,h.onerror=function(n){var r=n&&n.target&&n.target.src||u,a=new Error("Loading CSS chunk "+e+" failed.\n("+r+")");a.code="CSS_CHUNK_LOAD_FAILED",a.request=r,delete c[e],h.parentNode.removeChild(h),t(a)},h.href=u;var s=document.getElementsByTagName("head")[0];s.appendChild(h)})).then((function(){c[e]=0})));var r=u[e];if(0!==r)if(r)n.push(r[2]);else{var a=new Promise((function(n,t){r=u[e]=[n,t]}));n.push(r[2]=a);var d,i=document.createElement("script");i.charset="utf-8",i.timeout=120,f.nc&&i.setAttribute("nonce",f.nc),i.src=o(e);var l=new Error;d=function(n){i.onerror=i.onload=null,clearTimeout(h);var t=u[e];if(0!==t){if(t){var r=n&&("load"===n.type?"missing":n.type),c=n&&n.target&&n.target.src;l.message="Loading chunk "+e+" failed.\n("+r+": "+c+")",l.name="ChunkLoadError",l.type=r,l.request=c,t[1](l)}u[e]=void 0}};var h=setTimeout((function(){d({type:"timeout",target:i})}),12e4);i.onerror=i.onload=d,document.head.appendChild(i)}return Promise.all(n)},f.m=e,f.c=r,f.d=function(e,n,t){f.o(e,n)||Object.defineProperty(e,n,{enumerable:!0,get:t})},f.r=function(e){"undefined"!==typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},f.t=function(e,n){if(1&n&&(e=f(e)),8&n)return e;if(4&n&&"object"===typeof e&&e&&e.__esModule)return e;var t=Object.create(null);if(f.r(t),Object.defineProperty(t,"default",{enumerable:!0,value:e}),2&n&&"string"!=typeof e)for(var r in e)f.d(t,r,function(n){return e[n]}.bind(null,r));return t},f.n=function(e){var n=e&&e.__esModule?function(){return e["default"]}:function(){return e};return f.d(n,"a",n),n},f.o=function(e,n){return Object.prototype.hasOwnProperty.call(e,n)},f.p="/PluginCore/Admin/",f.oe=function(e){throw console.error(e),e};var d=window["webpackJsonp"]=window["webpackJsonp"]||[];var i=d.push.bind(d);d.push=n,d=d.slice();for(var l=0;l<d.length;l++)n(d[l]);var h=i;t()})([])
```

--------------------------------

### C#: IStartupXPlugin Interface for Plugin Service Configuration

Source: https://github.com/yiyungent/plugincore/blob/main/docs/docs/zh/PluginDev/PluginSDK/IStartupXPlugin.md

Defines the IStartupXPlugin interface for experimental plugins. It includes methods to configure services and the HTTP request pipeline, with properties to control execution order. This interface is designed for hot-reloading capabilities.

```csharp
namespace PluginCore.IPlugins
{
    /// <summary>
    /// 实验阶段
    /// <para>热插拔: 已有效化</para>
    /// </summary>
    public interface IStartupXPlugin : IPlugin
    {
        /// <summary>
        /// This method gets called by the runtime. Use this method to add services to the container.
        /// <para>未有效化</para>
        /// </summary>
        /// <param name="services"></param>
        void ConfigureServices(IServiceCollection services);


        int ConfigureServicesOrder { get; }

        /// <summary>
        /// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        /// </summary>
        /// <param name="app"></param>
        /// <param name="env"></param>
        void Configure(IApplicationBuilder app);

        int ConfigureOrder { get; }
    }
}
```

--------------------------------

### Navigate to Project Directory

Source: https://github.com/yiyungent/plugincore/blob/main/plugincore-admin-frontend/README-zh.md

Changes the current directory to the cloned vue-admin-template project folder.

```bash
cd vue-admin-template
```

--------------------------------

### Search GitHub Repositories API

Source: https://github.com/yiyungent/plugincore/blob/main/plugins/GitHubApiPlugin/README.md

Searches for GitHub repositories based on a query parameter.

```APIDOC
## GET /api/GitHub/SearchRepos

### Description
Searches for GitHub repositories based on a query parameter.

### Method
GET

### Endpoint
/api/GitHub/SearchRepos

### Parameters
#### Query Parameters
- **q** (string) - Required - The search query string (e.g., "vue").

#### Request Body
None

### Response
#### Success Response (200 OK)
- **repositories** (array) - A list of repository objects matching the search query.

#### Response Example
```json
{
  "repositories": [
    {
      "name": "vuejs",
      "description": "A progressive, incrementally-adoptable JavaScript framework for building UI.",
      "url": "https://github.com/vuejs/vue"
    }
  ]
}
```
```

--------------------------------

### Run PluginCore via Docker

Source: https://github.com/yiyungent/plugincore/blob/main/README.md

Command to run PluginCore in a Docker container, exposing port 5004 and setting the ASP.NET Core URLs. This allows for local testing and experimentation with PluginCore.

```bash
docker run -d -p 5004:80 -e ASPNETCORE_URLS="http://*:80" --name plugincore-aspnetcore3-1 yiyungent/plugincore-aspnetcore3-1
```

--------------------------------

### My GitHub Repositories API

Source: https://github.com/yiyungent/plugincore/blob/main/plugins/GitHubApiPlugin/README.md

Retrieves a list of the authenticated user's GitHub repositories. This is the default page after successful authorization.

```APIDOC
## GET /api/GitHub/Index

### Description
Retrieves a list of the authenticated user's GitHub repositories. This endpoint is typically accessed after successful GitHub OAuth authorization.

### Method
GET

### Endpoint
/api/GitHub/Index

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200 OK)
- **repositories** (array) - A list of repository objects, each containing details like name, description, URL, etc.

#### Response Example
```json
{
  "repositories": [
    {
      "name": "my-repo",
      "description": "A sample repository",
      "url": "https://github.com/user/my-repo"
    }
  ]
}
```
```

--------------------------------

### Apply Plugin Hook in Controller

Source: https://github.com/yiyungent/plugincore/blob/main/README.md

Shows how to inject `PluginFinder` into an ASP.NET Core controller and use it to find and invoke the `Say()` method on all enabled plugins implementing the `ITestPlugin` interface.

```C#
using PluginCore;
using PluginCore.IPlugins;

namespace WebApi.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class TestController : ControllerBase
    {
        private readonly PluginFinder _pluginFinder;

        public TestController(PluginFinder pluginFinder)
        {
            _pluginFinder = pluginFinder;
        }

        public ActionResult Get()
        {
            //var plugins = PluginFinder.EnablePlugins<BasePlugin>().ToList();
            // All enabled plugins that implement ITestPlugin
            var plugins2 = _pluginFinder.EnablePlugins<ITestPlugin>().ToList();

            foreach (var item in plugins2)
            {
                // transfer
                string words = item.Say();
                Console.WriteLine(words);
            }

            return Ok("");
        }
    }
}
```

--------------------------------

### Run PluginCore via Docker using GHCR Image

Source: https://github.com/yiyungent/plugincore/blob/main/README.md

Command to run PluginCore in a Docker container using an image from GHCR (GitHub Container Registry). This is an alternative to using Docker Hub images.

```bash
docker run -d -p 5004:80 -e ASPNETCORE_URLS="http://*:80" --name plugincore-aspnetcore3-1 ghcr.io/yiyungent/plugincore-aspnetcore3-1
```

--------------------------------

### IStartupPlugin Interface Definition (C#)

Source: https://github.com/yiyungent/plugincore/blob/main/docs/docs/PluginDev/PluginSDK/IStartupPlugin.md

Defines the IStartupPlugin interface, which extends IPlugin. It includes methods for configuring services (ConfigureServices) and the application pipeline (Configure), along with their respective order properties. This interface is for experimental use and requires a site restart for changes to take effect.

```csharp
namespace PluginCore.IPlugins
{
    /// <summary>
    /// 实验阶段
    /// <para>无法热插拔: 需要启用插件后, 再 重启站点</para>
    /// </summary>
    public interface IStartupPlugin : IPlugin
    {
        /// <summary>
        /// This method gets called by the runtime. Use this method to add services to the container.
        /// </summary>
        /// <param name="services"></param>
        void ConfigureServices(IServiceCollection services);

        int ConfigureServicesOrder { get; }

        /// <summary>
        /// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        /// </summary>
        /// <param name="app"></param>
        /// <param name="env"></param>
        void Configure(IApplicationBuilder app);

        int ConfigureOrder { get; }
    }
}
```

--------------------------------

### Load External CSS and Expose Event Listeners

Source: https://github.com/yiyungent/plugincore/blob/main/plugincore-js-sdk/Releases.md

Shows how to load external CSS files using a link tag and how to make the 'addEventListener' function globally available. This enables dynamic styling and custom event handling within the plugincore environment.

```javascript
window.plugincore.addEventListener = addEventListener;
```

--------------------------------

### Initialize PluginCore using Module Manager (JS)

Source: https://github.com/yiyungent/plugincore/blob/main/plugincore-js-sdk/README.md

Import and instantiate the PluginCore SDK within your JavaScript project when using a module manager like Webpack or Parcel. This allows for direct usage of the SDK's functionalities.

```javascript
import PluginCore from '@yiyungent/plugincore';

const p = new PluginCore();
```

--------------------------------

### GitHub Callback API

Source: https://github.com/yiyungent/plugincore/blob/main/plugins/GitHubApiPlugin/README.md

The callback endpoint for GitHub OAuth authorization. This endpoint handles the response from GitHub after user authorization.

```APIDOC
## GET /api/GitHub/Callback

### Description
This is the callback endpoint for GitHub OAuth. It receives the authorization code from GitHub and exchanges it for an access token. The access token is then stored in the session.

### Method
GET

### Endpoint
/api/GitHub/Callback

### Parameters
#### Query Parameters
- **code** (string) - Required - The authorization code provided by GitHub.
- **state** (string) - Optional - The state parameter used to prevent CSRF attacks.

#### Request Body
None

### Response
#### Success Response (302 Redirect)
- **Location** (string) - Redirects the user to the configured `HomePageUrl` after successful authorization.

#### Response Example
(Redirect to configured HomePageUrl, e.g., "/")
```

--------------------------------

### Define a Custom Plugin Hook Interface

Source: https://github.com/yiyungent/plugincore/blob/main/README.md

Defines an interface `ITestPlugin` that inherits from `IPlugin`. This interface specifies a contract for plugins that need to implement a `Say()` method.

```C#
using PluginCore.IPlugins;

namespace PluginCore.IPlugins
{
    public interface ITestPlugin : IPlugin
    {
        string Say();
    }
}
```

--------------------------------

### HTML Structure for Plugin Widgets

Source: https://github.com/yiyungent/plugincore/blob/main/plugincore-js-sdk/README.md

Demonstrates how to structure HTML to define plugin widget extension points. These comments in the HTML are recognized by PluginCore to inject specific widgets or functionalities when a corresponding plugin is activated.

```html
<!DOCTYPE html>
<html>
    <head></head>
    <body>
        <div id="app">
            <h2 style="margin: 0 auto;text-align: center;">plugincore-js-sdk</h2>
            <div style="margin: 0 auto;text-align: center;">尝试使用插件 注入/修改 页面</div>
        </div>
        <!-- PluginCore.IPlugins.IWidgetPlugin.Widget(PluginCore.Admin.Footer,a,b,c) -->
        <!-- PluginCore.IPlugins.IWidgetPlugin.Widget(PluginCore.Admin.Footer,d,e) -->
        <!-- PluginCore.IPlugins.IWidgetPlugin.Widget(PluginCore.Admin.Footer,f,j) -->
    </body>
</html>
```

--------------------------------

### Lint and Fix Code

Source: https://github.com/yiyungent/plugincore/blob/main/plugincore-admin-frontend/README-zh.md

Performs code linting to check for code style issues and automatically fixes them if the '--fix' flag is provided.

```bash
npm run lint

npm run lint -- --fix
```
Tokens:
Raw