search

ckeditor / ckeditor5

Powerful rich text editor framework with a modular architecture, modern integrations, and features like collaborative editing.
https://ckeditor.com/ckeditor-5
Other
9.61k stars 3.7k forks source link

Define package keywords #551

Closed Reinmar closed 7 years ago

Reinmar commented 7 years ago

There are a couple of groups of packages:

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 commented 7 years ago

@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 commented 7 years ago

Webpack

No keywords in package.json.

Babel

The same like Webpack – no keywords:

Gulp

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

d3

The common keyword is d3-module:

Angular.js

No common keyword:

Situation of Angular is similar to Angular.js

ESLint

Common keyword for plugins is eslint:

Reinmar commented 7 years ago

Thanks!

Reinmar commented 7 years ago

OK, so I'd propose doing this

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

WDYT?

Reinmar commented 7 years ago

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 commented 7 years ago

Done.