Skip to content

Updated code style guide #18833

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
przemyslaw-zan merged 4 commits into from
Jul 11, 2025
Merged

Updated code style guide #18833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8b487a8
Updated code style guide.
przemyslaw-zan Jul 9, 2025
77c5e90
Bumped stylelint-config-ckeditor5
przemyslaw-zan Jul 10, 2025
6a2cbb8
Bumped missing packages.
przemyslaw-zan Jul 10, 2025
a0c12a7
Merge branch 'master' into ck/18805
przemyslaw-zan Jul 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .stylelintrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"extends": "stylelint-config-ckeditor5",
"plugins": [
"stylelint-plugin-ckeditor5-rules/lib/license-header"
"stylelint-plugin-ckeditor5-rules"
],
"ignoreFiles": [
"**/dist/**",
Expand Down
26 changes: 26 additions & 0 deletions docs/framework/contributing/code-style.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1228,3 +1228,29 @@ This rule ensures that SVG files are imported and exported only in the `@ckedito
### Valid changelog entries

This rule ensures that changelog entry files are populated with proper data and a clear description of the change. For a full guide on how to populate changelog entries, see the {@link framework/contributing/changelog-entries Changelog entries} guide.

## CKEditor 5 custom Stylelint rules

In addition to the rules provided by Stylelint, CKEditor 5 uses a few custom rules described below.

### Names of CSS variables within `.ck-content`: `ckeditor5-rules/ck-content-variable-name`

This rule aims to enforce convention of all variables targeting styling of elements within the editor (`.ck-content`) using a common prefix (`--ck-content-*`)

👎  Example of incorrect code for this rule:

```css
.ck-content {
width: var(--variable-name);
}
```

👍  Example of correct code for this rule:

```css
.ck-content {
width: var(--ck-content-variable-name);
}
```

[History of the change.](https://github.com/ckeditor/ckeditor5/issues/18805)
6 changes: 3 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,9 @@
"date-fns": "^4.0.0",
"esbuild": "^0.25.0",
"eslint": "^9.26.0",
"eslint-config-ckeditor5": "^11.0.0",
"eslint-config-ckeditor5": "^12.0.0",
"eslint-formatter-stylish": "^8.40.0",
"eslint-plugin-ckeditor5-rules": "^11.0.0",
"eslint-plugin-ckeditor5-rules": "^12.0.0",
"eslint-plugin-import": "^2.31.0",
"estree-walker": "^3.0.3",
"fs-extra": "^11.0.0",
Expand All @@ -160,7 +160,7 @@
"schema-utils": "^4.2.0",
"sharp": "^0.34.2",
"stylelint": "^16.0.0",
"stylelint-config-ckeditor5": "^11.0.0",
"stylelint-config-ckeditor5": "^12.0.0",
"svgo": "^3.3.2",
"table": "^6.8.1",
"terser-webpack-plugin": "^5.0.0",
Expand Down