code-style.md 17 KB


category: framework-contributing

order: 30

Code style

The {@link framework/guides/contributing/development-environment CKEditor 5 development environment} has ESLint enabled both as a pre-commit hook and on CI which means that code style issues are automatically detected. Additionally, .editorconfig files are present in every repository to automatically adjust your IDEs settings (if it is configured to read them).

However, here goes a quick summary of these rules.

General

  • LF for line endings. Never CRLF.
  • Maximum recommended line length is 120 chars, but can't be longer than 140 chars.

Whitespace

  • No trailing spaces. Empty lines should not contain any spaces.

Whitespace inside parenthesis and before and after operators:

function foo( a, b, c, d, e ) {
	if ( a > b ) {
		c = ( d + e ) * 2;
	}
}

foo( bar() );

No whitespace for empty parenthesis:

const a = () => {
	// Statements...
};

a();

No whitespace before colon and semicolon:

let a, b;

a( 1, 2, 3 );

for ( const i = 0; i < 100; i++ ) {
	// Statements...
}

Indentation

  • Indentation with TAB, for both code and comments. Never use spaces.
  • If you want to have the code readable, set TAB to 4 spaces in your IDE.
class Bar {
	a() {
		while ( b in a ) {
			if ( b == c ) {
				// Statements...
			}
		}
	}
}

Multiple lines condition. Use one tab for each line:

if (
	some != really.complex &&
	condition || with &&
	( multiple == lines )
) {
	// Statements...
}

while (
	some != really.complex &&
	condition || with &&
	( multiple == lines )
) {
	// Statements...
}

We do our best to avoid complex conditions. As a rule of thumb, we first recommend finding a way to move the complexity out of the condition – e.g. to a separate function with early returns for each "sentence" in such a condition.

However, overdoing things is not good as well and sometimes such a condition can be perfectly readable (which is the ultimate goal here).

Braces

Braces start at the same line as the head statement and end aligned with it:

function a() {
	// Statements...
}

if ( a ) {
	// Statements...
} else if ( b ) {
	// Statements...
} else {
	// Statements...
}

try {
	// Statements...
} catch ( e ) {
	// Statements...
}

Blank lines

The code should read like a book, so put blank lines between "paragraphs" of code. This is an open and contextual rule, but some recommendations would be to separate the following sections:

  • variable, classes and function declarations,
  • if(), for() and similar blocks,
  • steps of an algorithm,
  • return statements,
  • comment sections (comments should be preceded with a blank line, but if they are the "paragraph" themselves, they should also be followed with one),
  • etc.

Example:

class Foo extends Plugin {
	constructor( editor ) {
		super( editor );

		/**
		 * Some docs...
		 */
		this.foo = new Foo();

		/**
		 * Some docs...
		 */
		this.isBar = false;
	}

	method( bar ) {
		const editor = this.editor;
		const selection = editor.model.document.selection;

		for ( const range of selection.getRanges() ) {
			const position = range.start;

			if ( !position ) {
				return false;
			}

			// At this stage this and this need to happen.
			// We considered doing this differently, but it has its shortcomings.
			// Refer to the tests and issue #3456 to learn more.

			const result = editor.model.checkSomething( position );

			if ( result ) {
				return true;
			}
		}

		return true;
	}

	performAlgorithm() {
		// 1. Do things A and B.
		this.a();
		this.b();

		// 2. Check C.
		if ( c() ) {
			d();
		}

		// 3. Check whether we are fine.
		const areWeFine = 1 || 2 || 3;

		this.check( areWeFine );

		// 4. Finalize.
		this.finalize( areWeFine );

		return areWeFine;
	}
}

Multi-line statements and calls

Whenever there is a multi-line function call:

  • put the first param in a new line,
  • put every param in a separate line indented by one tab,
  • put the last closing parenthesis in new line, at the same indendation as the call beginning.

Examples:

const myObj = new MyClass(
	'Some long params',
	'To make this',
	'Multi line'
);

fooBar(
	() => {
		// Statements...
	}
);

fooBar(
	new MyClass(
		'Some long params',
		'To make this',
		'Multi line'
	)
);

fooBar(
	'A very long string',
	() => {
		// ... some kind
		// ... of a
		// ... callback
	},
	5,
	new MyClass(
		'It looks well',
		paramA,
		paramB,
		new ShortClass( 2, 3, 5 ),
		'Even when nested'
	)
);

Note that the above examples are just showcasing how such function calls can be structured. However, it is best to avoid them.

It is generally recommended to avoid having functions that accept more than 3 arguments. Instead, it is better to wrap them in an object so all params can be named.

It is also recommended to split such long statements into multiple shorter ones (e.g. extract some longer params to separate variables).

Strings

Use single quotes:

const a = 'I\'m an example for quotes';

Long strings can be concatenated with plus (+):

const html =
	'Line 1\n' +
	'Line 2\n' +
	'Line 3';

or template strings can be used (note that lines 2nd and 3rd will be indented in this case):

const html =
	`Line 1
	Line 2
	Line 3`;

Strings of HTML should use indentation for readability:

const html =
	`<p>
		<span>${ a }</span>
	</p>`;

Comments

  • Comments are always preceded by a blank line.
  • Comments start with a capital first letter and require a period at the end (since they are sentences).
  • There must be a single space at the start of the text, right after the comment token.

Block comments (/** ... */) are used for documentation only. Asterisks aligned with space:

/**
 * Documentation for the following method.
 *
 * @returns {Object} Something.
 */
someMethod() {
	// Statements...
}

All other comments use line comments (//):

// Comment about the following statement.
foo();

// Multiple line comments
// go through several
// line comments as well.

Comments related to tickets/issues, should not describe the whole issue fully. A short description should be used, together with the ticket number in parenthesis:

// Do this otherwise because of a Safari bug. (#123)
foo();

Linting

CKEditor 5 development environment uses ESLint and stylelint.

A couple of useful links:

Avoid using automatic code formatters on existing code. It is fine to automatically format code that you are editing, but you should not be changing the formatting of the code that is already written to not pollute your PRs. You should also not rely solely on automatic corrections.

Visibility levels

Each class property (including methods, symbols, getters/setters) can be public, protected or private. The default visibility is public, so you should not (because there is no need) document that a property is public.

Additional rules apply to private properties:

  • names of private and protected properties which are exposed in a class prototype (or in any other way) should be prefixed with an underscore,
  • when documenting a private variable which is not added to a class prototype (or exposed in any other way) then // comments should be used and using @private is not necessary ,
  • symbol property (e.g. this[ Symbol( 'symbolName' ) ]) should be documented as @property {Type} _symbolName.

Example:

class Foo {
	/**
	 * The constructor (public, as its visibility isn't defined).
	 */
	constructor() {
		/**
		 * Public property.
		 */
		this.foo = 1;

		/**
		 * Protected property.
		 *
		 * @protected
		 */
		this._bar = 1;

		/**
		 * @private
		 * @property {Number} _bom
		 */
		this[ Symbol( 'bom' ) ] = 1;
	}

	/**
	 * @private
	 */
	_somePrivateMethod() {}
}

// Some private helper.
//
// @returns {Number}
function doSomething() {
	return 1;
}

Accessibility

Properties accessibility:

             | Class | Package | Subclass | World
——————————————————————————————————————————————————
@public      |   y   |    y    |    y     |   y
——————————————————————————————————————————————————
@protected   |   y   |    y    |    y     |   n
——————————————————————————————————————————————————
@private     |   y   |    n    |    n     |   n

(y – accessible, n – not accessible)

For instance, a protected property is accessible from its own class in which it was defined, its whole package and from its subclasses (even if not in the same package).

Protected properties/methods are often used for testability. Since tests are located in the same package as the code they can access these properties.

Getters

You can use ES6 getters to simplify class API:

class Position {
	// ...
	get offset() {
		return this.path[ this.path.length - 1 ];
	}
}

Getter should feel like a natural property. There are several recommendations to follow when creating getters:

  • they should be fast,
  • they should not throw,
  • they should not change object state,
  • they should not return new instances of an object every time (so foo.bar == foo.bar is true); it is okay to create a new instance for the first call and cache it if it's possible.

Order within class definition

Within class definition the methods and properties should be ordered as follows:

  1. constructor,
  2. getters/setters,
  3. iterators,
  4. public instance methods,
  5. public static methods,
  6. protected instance methods,
  7. protected static methods,
  8. private instance methods,
  9. private static methods.

Order within each group is left for the implementor.

Tests

There are some special rules for tests.

  • Always use an outer describe in a test file - do not allow any globals, especially hooks (beforeEach(), after(), etc.) outside the outermost describe().
  • The outer most describe() calls should create meaningful groups, so when all tests are run together a failing TC can be identified within the code base. For example:

    describe( 'Editor', () => {
        describe( 'constructor()', () => {
            it( ... );
        } );
    
        // ...
    } );
    

    Using titles like "utils" is not fine as there are multiple utils in the entire project. "Table utils" would be better.

  • Test descriptions (it()) should be written like documentation (what do we do and what should happen) – e.g. "the foo dialog closes when the x button is clicked". Also, '...case 1', '...case 2' in test descriptions are not helpful.

  • Avoid covering multiple cases under one it(). It is ok to have multiple assertions in one test, but not to test e.g. how method foo() works when it is called with 1, then with 2, then 3, etc. There should be a separate test for each case.

  • Most often, using words like "correctly", "works fine" is a code smell. Thing about requirements – when writing them you do not say that feature X should "work fine". You document how it should work.

  • Every test should clean after itself, including destroying all editors and removing all elements that have been added.

  • Avoid using real timeouts. Use fake timers instead when possible. Timeouts make test really slow.

  • However, thinking about slow – do not overoptimize (especially that performance is not a priority in tests). In most cases it is completely fine (and hence recommended) to create a separate editor for every it().

Naming

JavaScript code names

Variable, functions, namespaces, parameters and all undocumented cases must be named in lowerCamelCase:

let a;
let myLongNamedVariable = true;

function foo() {}

function longNamedFunction( example, longNamedParameter ) {}

Classes must be named in UpperCamelCase:

class MyClass() {}

const a = new MyClass();

Mixins must be named in UpperCamelCase, postfixed with "Mixin":

const SomeMixin = {
	method1: ...,
	method2: ...
};

Global namespacing variables must be named in ALLCAPS:

const CKEDITOR_TRANSLATIONS = {};

Private properties and methods

Private properties and methods are prefixed with an underscore:

CKEDITOR._counter;
something._doInternalTask();

Methods and functions

Methods and functions are almost always verbs/actions:

// Good
execute();
this.getNextNumber()

// Bad
this.editable();
this.status();

Properties and variables

Properties and variables are almost always nouns:

const editor = this.editor;
this.name;
this.editable;

Boolean properties and variables are always prefixed by an auxiliary verb:

this.isDirty;
this.hasChildren;
this.canObserve;
this.mustRefresh;

Shortcuts

For local variables commonly accepted short versions for long names are fine:

const attr, doc, el, fn, deps, err, id, args, uid, evt, env;

The following are the only short versions accepted for property names:

this.lang;
this.config;
this.id;
this.env;

Acronyms and proper names

Acronyms and, partially, proper names are naturally written in uppercase. This may stand against code style rules described above – especially when there is a need to include acronym or proper name in variable or class name. In such case, one should follow these rules:

  • acronyms:
    • all lowercase if at the beginning of the variable name: let domError
    • default camel case at the beginning of the class name: class DomError
    • default camel case inside variable / class name: function getDomError()
  • proper names:
    • all lowercase if at the beginning of the variable: let ckeditorError
    • original case if at the beginning of the class name: class CKEditorError
    • original case inside variable / class name: function getCKEditorError()

However, two letter acronyms and proper names (if originally written uppercase) should be uppercase. So e.g. getUI (not getUi).

Two most frequently used acronyms which cause problems:

* **DOM** – it should be e.g. `getDomNode()`,
* **HTML** – it should be e.g. `toHtml()`.

CSS classes

CSS class naming pattern is based on BEM methodology and code-style. All names are in lowercase with optional dash (-) between the words.

Top–level building blocks begin with mandatory ck- prefix:

.ck-dialog
.ck-toolbar
.ck-dropdown-menu

Elements belonging to the block namespace are delimited by double underscore (__):

.ck-dialog__header
.ck-toolbar__group
.ck-dropdown-menu__button-collapser

Modifiers are delimited by a single underscore (_). Key-value modifiers follow block-or-element_key_value naming pattern:

/* Block modifier */
.ck-dialog_hidden
/* Element modifier */
.ck-toolbar__group_collapsed
/* Block modifier as key_value  */
.ck-dropdown-menu_theme_some-theme

In HTML:

<div class="ck-reset_all ck-dialog ck-dialog_theme_lark ck-dialog_visible">
	<div class="ck-dialog__top ck-dialog__top_small">
		<h1 class="ck-dialog__top-title">Title of the dialog</h1>
		...
	</div>
	...
</div>

ID attributes

HTML ID attribute naming pattern follows CSS Classes naming guidelines. Each ID must begin with ck- prefix and consist of dash–separated (-) words in lowercase:

<div id="ck">...</div>
<div id="ck-unique-div">...</div>
<div id="ck-a-very-long-unique-identifier">...</div>

File names

File and directory names must follow a standard that make their syntax easy to predict:

  • All lower-cased.
  • Only alphanumeric characters are accepted.
  • Words are separated by dashes (-) (kebab-case).
    • Code entities are considered single words, so the DataProcessor class is defined in the dataprocessor.js file.
    • However, a test file covering for "mutations in multi-root editors": mutations-in-multi-root-editors.js.
  • HTML files have the .html extension.

Examples

  • ckeditor.js
  • tools.js
  • editor.js
  • dataprocessor.js
  • build-all.js and build-min.js
  • test-core-style-system.html

Standard files

Widely used standard files do not obey the above rules:

  • README.md, LICENSE.md, CONTRIBUTING.md, CHANGES.md
  • .gitignore and all standard "dot-files"
  • node_modules