如何将自定义插件添加到CKEditor 5版本中?

时间:2019-11-01 13:12:22

标签: javascript npm webpack ckeditor ckeditor5

使用的工具:

简介

我正在学习如何使用CKEditor 5以及如何添加和创建插件。通过遵循本教程,我已成功添加了现有的官方插件:

https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/installing-plugins.html#adding-a-plugin-to-a-build

据说在CKEditor 5中有两种添加插件的方法。基本上,您可以使用现成的版本并向其中添加插件,也可以更改编辑器的创建设置。

修改内部版本的优点是,创建CKEditor实例后,您不再需要配置任何内容,因为所有内容均已使用所需的设置进行了构建。另外,客户端应用程序不需要使用Webpack导入代码进行新发行。

我是如何进行的

我在开发过程中未使用Git / GitHub,因此我从this Git repository下载了ckeditor5-build-classic zip文件,然后将内部内容移动到了所需的文件夹中。使用Visual Studio代码,我将文件夹作为一个项目打开,并按照上述教程中描述的相同步骤开始对其进行操作:

npm install

然后:

npm install --save-dev @ckeditor/ckeditor5-alignment

我对src/ckeditor.js源代码进行了相同的修改,最后使用以下命令创建了构建:

npm run build

创建了构建后,我将所有3个结果文件(ckeditor.js,ckeditor.js.map和translations文件夹)与一个index.html页面放在一起:

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <script type="text/javascript" src="ckeditor.js"></script>
    <script type="text/javascript" src="jquery-3.4.1.min.js"></script>
    <script type="text/javascript" src="app.js"></script>
    <link rel="stylesheet" href="styles.css">
</head>
<body>
    <div id="editor-container">
        <div id="editor">CKEditor content.</div>
    </div>
</body>
</html>

我的目录结构:

 Test App+
 |---index.html
 |---app.js
 |---jquery-3.4.1.min.js
 |---ckeditor.js
 |---ckeditor.js.map
 |---translations (folder)
 |---styles.css

这是我的app.js:

$( document ).ready(function() {
    ClassicEditor
        .create(document.querySelector('#editor'))
        .then(editor => {
            console.log('CKEditor is ready.');
        })
        .catch(error => {
           console.error('Error: ' + error); 
        });
});

当我打开index.html时,CKEditor 5可以很好地工作,并且包括添加的插件。

创建我自己的插件(问题

以这种方式安装插件非常容易且实用,因此我尝试创建自己的插件并执行相同的过程进行安装。为此,我一直遵循以下指示:

https://ckeditor.com/docs/ckeditor5/latest/framework/guides/tutorials/implementing-a-block-widget.html https://ckeditor.com/docs/ckeditor5/latest/framework/guides/creating-simple-plugin.html https://github.com/ckeditor/ckeditor5-alignment

我的项目符合以下结构:

 MyPlugin+
 |---package.json
 |---package-lock.json
 |---src+
 |---|---myplugin.js
 |---|---myplugin_ui.js
 |---|---myplugin_editing.js
 |---node_modules+
 |---|---lodash-es (folder)
 |---|---ckeditor5 (folder)
 |---|---@ckeditor (folder)

package.json:

{
  "name": "myplugin",
  "version": "1.0.0",
  "description": "My first CKEditor 5 plugin project.",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "RDS",
  "license": "ISC",
  "dependencies": {
    "@ckeditor/ckeditor5-core": "^15.0.0",
    "@ckeditor/ckeditor5-ui": "^15.0.0"
  }
}

myplugin.js:

import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
import MyPlugin_ui from './myplugin_ui';
import MyPlugin_editing from './myplugin_editing';

export default class MyPlugin extends Plugin
{
    static get requires()
    {
        return [MyPlugin_editing , MyPlugin_ui];
    }
}

myplugin_ui.js:

import Plugin from '@ckeditor/ckeditor5-core/src/plugin';

export default class MyPlugin_ui extends Plugin
{
    init()
    {
        console.log('MyPlugin_ui#init() has been called.');
    }
}

myplugin_editing.js:

import Plugin from '@ckeditor/ckeditor5-core/src/plugin';

export default class MyPlugin_editing extends Plugin
{
    init()
    {
        console.log('MyPlugin_editing#init() has been called.');
    }
}

当我在CKEditor 5项目中安装插件时,构建已成功创建。但是,在测试编辑器时,浏览器显示以下问题:

ckeditor-duplicated-modules

https://ckeditor.com/docs/ckeditor5/latest/framework/guides/support/error-codes.html#error-ckeditor-duplicated-modules

在所示的链接中说:

  

因此,除非您将您的插件添加到现有版本中,否则绝不能添加。   插件没有依赖性。

但是,与此同时,在教程页面上似乎可以教相反的东西:

https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/installing-plugins.html#adding-a-plugin-to-a-build

我对使用Node JS或npm没有太多经验。我确定我的项目中存在一些配置错误,但我不知道在哪里。我相信它可能在我的package.json文件中。

我尝试过的

  1. 从插件项目中删除node_modulespackage-lock.json文件。

后果:

在使用已安装的插件构建CKEditor构建时,Webpack会说:

ERROR in ../MyPlugin/src/myplugin.js
Module not found: Error: Can't resolve '@ckeditor/ckeditor5-core/src/plugin' in 'C:\Users\RDS\Desktop\CKEditor\MyPlugin\src'
 @ ../MyPlugin/src/myplugin.js 1:0-57 5:38-44
 @ ./src/ckeditor.js

ERROR in ../MyPlugin/src/myplugin_editing.js
Module not found: Error: Can't resolve '@ckeditor/ckeditor5-core/src/plugin' in 'C:\Users\RDS\Desktop\CKEditor\MyPlugin\src'
 @ ../MyPlugin/src/myplugin_editing.js 1:0-57 3:46-52
 @ ../MyPlugin/src/myplugin.js
 @ ./src/ckeditor.js

ERROR in ../MyPlugin/src/myplugin_ui.js
Module not found: Error: Can't resolve '@ckeditor/ckeditor5-core/src/plugin' in 'C:\Users\RDS\Desktop\CKEditor\MyPlugin\src'
 @ ../MyPlugin/src/myplugin_ui.js 1:0-57 3:41-47
 @ ../MyPlugin/src/myplugin.js
 @ ./src/ckeditor.js

ERROR in chunk main [entry]
ckeditor.js
C:\Users\RDS\Desktop\CKEditor\ckeditor5-build-classic-master\src\ckeditor.js 15684830ec81692702e020bf47ce4f65
Unexpected token (4:26)
| 
| 
| class MyPlugin_ui extends !(function webpackMissingModule() { var e = new Error("Cannot find module '@ckeditor/ckeditor5-core/src/plugin'"); e.code = 'MODULE_NOT_FOUND'; throw e; }())
| {
|     init()
npm ERR! code ELIFECYCLE
npm ERR! errno 2
npm ERR! @ckeditor/ckeditor5-build-classic@15.0.0 build: `webpack --mode production`
npm ERR! Exit status 2
npm ERR!
npm ERR! Failed at the @ckeditor/ckeditor5-build-classic@15.0.0 build script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\Users\RDS\AppData\Roaming\npm-cache\_logs\2019-11-01T12_40_26_177Z-debug.log
  1. 更改dependencies中设置的devDependenciespackage.json属性之间的依赖性。

后果:发生同样的事情。

所有CKEditor 5项目依赖项均在package.json中的devDependencies上设置。我的插件在CKEditor 5项目中的安装已通过两种现有模式完成:

再次显示相同的问题。啊!另外,发生了一些奇怪的事情。我已经说过,我已经正确执行了CKeditor 5对齐插件的安装。我什至展示了这是如何完成的。解决所有这些问题后,我尝试在本地安装对齐插件。我从存储库下载了该文件,并通过链接和文件进行了相同的安装。如前所述,采用这种方法,该插件神秘地给我带来了ckeditor-duplicated-modules问题。

我不知道从CKEditor 5本身本地安装此插件的正确方法,而不必从Internet下载(使用npm install <module name>从npm存储库下载) )。我很清楚自己做错了什么,但是我无法确定是什么。如果有人可以给我提示,替代方法,当然还有解决方案,我将不胜感激。我已经尝试了几天,但我不知道自己能做什么和不能做什么。如果有人可以帮助我,我将非常感激。

2 个答案:

答案 0 :(得分:0)

也许这只是措辞,但您不必“安装”自定义插件。只需将插件信息添加到\ src \ ckeditor.js文件(导入,builtinPlugins [],工具栏[]等)即可。然后执行npm运行build并将其包含在\ build \ ckeditor.js

除了引用本地插件外,您将按照与对齐插件相同的步骤更改\ src \ ckeditor.js。只要确保您的自定义插件的名称匹配即可。

由于您没有UI工具栏代码,因此我认为您需要的只是导入和ClassicEditor.builtInPlugins = [...,MyPlugin]中的一个条目

这应该足以测试init

答案 1 :(得分:0)

在这里无法找到解决方案的时候,我得知我可以在ckeditor git存储库中寻求帮助。请按照以下地址进行解决:

https://github.com/ckeditor/ckeditor5/issues/5699