Skip to content
This repository has been archived by the owner on Mar 7, 2024. It is now read-only.

Commit

Permalink
feat: 支持运行时插件
Browse files Browse the repository at this point in the history
close #983
  • Loading branch information
yesmeck committed May 22, 2020
1 parent 0bc1028 commit 0864094
Show file tree
Hide file tree
Showing 30 changed files with 5,569 additions and 9 deletions.
60 changes: 55 additions & 5 deletions docs/guide/advanced/plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ module.exports = {

## 编写插件

Remax 的插件是一个简单的方法,这个方法返回一个对象,对象中的 key Remax 提供的 hook 名。通过这些 hook,可以改变 Remax 构建小程序时的行为
Remax 插件分为编译时插件和运行时插件,插件是一个 Object,Object 的 key 对应 Remax 提供的 hook 名。

还是以 `@remax/plugin-less` 为例,我们可以通过 `configWebpack` 这个 hook 新增一条处理 less 文件的规则。

```js
// 第一个参数是插件的配置
const lessPlugin = options => {
// 因为需要接受参数,所以这里用一个方法来返回插件。
export default options => {
return {
configWebpack({ config, addCSSRule }) {
addCSSRule({
Expand All @@ -49,8 +49,6 @@ const lessPlugin = options => {
},
};
};

export default lessPlugin;
```

## Hooks
Expand Down Expand Up @@ -81,6 +79,58 @@ export default lessPlugin;
}
```

### registerRuntimePlugin

注册运行时插件。

```js
{
registerRuntimePlugin() {
return path.resolve(__dirname, './runtime.js'),
}
}
```

## 运行时 Hooks

### onAppConfig

修改 App 的配置。

```js
{
onAppConfig(config) {
const onLaunch = config.onLaunch;
config.onLaunch = () => {
console.log('onLaunch');
if (onLaunch) {
onLaunch();
}
}
return config;
}
}
```

### onPageConfig

修改 Page 的配置。

```js
{
onPageConfig(config) {
const onLoad = config.onLoad;
config.onLoad = () => {
console.log('onLoad');
if (onLoad) {
onLoad();
}
}
return config;
}
}
```

## 官方插件库

[https://github.com/remaxjs/plugins](https://github.com/remaxjs/plugins)
10 changes: 10 additions & 0 deletions packages/remax-cli/src/API.ts
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,16 @@ export default class API {
});
}

getRuntimePluginFiles() {
return this.plugins
.map(plugin => {
if (typeof plugin.registerRuntimePlugin === 'function') {
return plugin.registerRuntimePlugin();
}
})
.filter(Boolean);
}

public registerAdapterPlugins(targetName: Platform, remaxConfig: Options) {
this.adapter.target = targetName;
this.adapter.name = targetName;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
require('./runtime.js');
require('./remax-vendors.js');
(my["webpackJsonp"] = my["webpackJsonp"] || []).push([[1],[
/* 0 */
/***/ (function(module, exports, __webpack_require__) {

module.exports = __webpack_require__(1);


/***/ }),
/* 1 */
/***/ (function(module, __webpack_exports__, __webpack_require__) {

"use strict";
__webpack_require__.r(__webpack_exports__);
/* harmony import */ var _remax_runtime__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(2);
/* harmony import */ var react__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(14);
/* harmony import */ var react__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(react__WEBPACK_IMPORTED_MODULE_1__);
function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }

function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }

function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }

function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }

function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }

function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }

function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function () { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }

function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } return _assertThisInitialized(self); }

function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }

function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }

function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }




var _App = /*#__PURE__*/function (_React$Component) {
_inherits(_App, _React$Component);

var _super = _createSuper(_App);

function _App() {
_classCallCheck(this, _App);

return _super.apply(this, arguments);
}

_createClass(_App, [{
key: "render",
value: function render() {
return this.props.children;
}
}]);

return _App;
}(react__WEBPACK_IMPORTED_MODULE_1__["Component"]);

/* harmony default export */ __webpack_exports__["default"] = (App(Object(_remax_runtime__WEBPACK_IMPORTED_MODULE_0__["createAppConfig"])(_App)));

/***/ }),
/* 2 */,
/* 3 */,
/* 4 */
/***/ (function(module, exports) {

module.exports = require("react-reconciler");

/***/ }),
/* 5 */,
/* 6 */
/***/ (function(module, exports) {

module.exports = require("scheduler");

/***/ }),
/* 7 */,
/* 8 */,
/* 9 */,
/* 10 */,
/* 11 */,
/* 12 */,
/* 13 */,
/* 14 */
/***/ (function(module, exports) {

module.exports = require("react");

/***/ })
],[[0,0,2]]]);
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"pages": [
"pages/index"
]
}
Loading

0 comments on commit 0864094

Please sign in to comment.