Ckeditor5: Define package keywords

[Reinmar]

There are a couple of groups of packages:

• builds
• editor creators
• framework
• utils / API

It'd be good to mark each package with one or more keywords.

Right now we only marked builds, but with the ckeditor5-build keyword, which I think should be differently formatted, so we don't have ckeditor5-creator, ckeditor5-framework keywords (which might look like package names).

We need to check what kind of word separator we could use – maybe simply a space?

[Reinmar]

@pomek, could you make a quick research what kind of characters work in keywords and how similar (multi-package) projects use keywords? Like webpack, Babel, gulp, d3, etc.

[pomek]

Webpack

No keywords in package.json.

• Webpack,
• Webpack Style-Loader,
• Webpack CSS-Loader.

Babel

The same like Webpack – no keywords:

• Babel,
• Babel-preset-es2017,
• Babel-preset-es2016,
• Babel-preset-es2015.

Gulp

All plugins use a few words. The common one is gulpplugin:

• Gulp,
• Gulp-pug,
• Gulp-if,
• Gulp-rename,
• Gulp-eslint.

d3

The common keyword is d3-module:

• d3,
• d3-queue,
• d3-shape,
• d3-hexbin.

Angular.js

No common keyword:

• Angular.js,
• Angular new router,
• Angular-translate.

Situation of Angular is similar to Angular.js

ESLint

Common keyword for plugins is eslint:

• typescript-eslint-parser,
• eslint-transforms,
• eslint-plugin-markdown.

[Reinmar]

Thanks!

[Reinmar]

OK, so I'd propose doing this

1. All packages should have "ckeditor5" keyword.
2. Additionally, specific groups can be marked:
3. core libs don't need to be marked because this set is closed,
4. editors should be marked with "ckeditor5-editor",
5. features should be marked with "ckeditor5-feature",
6. themes with "ckeditor5-theme",
7. and builds are already marked with "ckeditor5-build".

WDYT?

[Reinmar]

OK, so with 2 👍 I'm going to introduce these keywords. However, in the meantime I thought that core libs could be marked with "ckeditor5-lib" anyway.

[Reinmar]

Done.