Skip to content

foxpage/foxpage-plugins

Repository files navigation

Foxpage Plug-ins

Minimum node.js version typescript version yarn

A collection of plug-ins, providing the framework with a variety of scene expansion capabilities, free and flexible plug-in use.

🖥 Introduction

Plugins are a common feature of libraries and frameworks, designed with a microkernel, which allows developers to add more functionality in a safe, extensible way.

Core

The core of the plug-in mainly implements the loading and management functions of the plug-in. The core API is as follows:

  • load:Load plugin
  • registerPlugin:Register plugins
  • unregisterPlugin:Unregister plugins
  • getPlugin:get plugins
  • getList:get registered plugin list
  • hasPlugin:check exist plugin
  • mergeVisitors:merge plugin visitors
  • getHooks: get all hooks of merged
  • destroy:destroy plugins

✨ Project

<Project Root>
  └── packages
  │   ├─foxpage-plugin-common-base            // base plugins
  │   └─foxpage-plugin-content-parse          // content variable parser
  └── jest.config.js                          // jest common config

📦 Commit

commit used [angular standard](https://github.com/angular/angular/blob/master/CONTRIBUTING.md。

commit config: commitlint.config.js。 see: github

commit lint by husky

npm:

npm run commit

// or

npx git-cz

🌍 publish & Release

  1. npm run boot and succeed before publish.
  2. lerna publish --ignore-scripts --no-push to publish public packages
  3. npm run release -- --release-as patch or npm run release -- --release-as minor generate new version: standard-version.

⏳ Contributing

Please read our Contributing Guide before submitting a Pull Request to the project.

🖐 Community support

For general help using Foxpage, please refer to the official Foxpage documentation. For additional help, you can use one of these channels to ask a question:

  • GitHub (Bug reports, Contributions)

📋 Documentation

See our documentation live Docs for the Foxpage SDK.

🏷️ License

See the LICENSE file for licensing information.