Skip to content

Lint changelog entries #18827

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
pomek merged 3 commits into from
Jul 10, 2025
Merged

Lint changelog entries #18827

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e75cf07
Lint changelog entries
filipsobol Jul 9, 2025
300be20
Update based on review feedback.
filipsobol Jul 10, 2025
2fb31d5
Add new ESLint rule to `Code style` guide.
filipsobol Jul 10, 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
4 changes: 4 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 @@ -1224,3 +1224,7 @@ import { AIAssistant } from 'ckeditor5-premium-features';
### SVG imports only in the `@ckeditor/ckeditor5-icons` package

This rule ensures that SVG files are imported and exported only in the `@ckeditor/ckeditor5-icons` package. This package should include all icons used in CKEditor 5.

### 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.
27 changes: 26 additions & 1 deletion eslint.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,29 @@
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
*/

import { readdirSync } from 'fs';
import globals from 'globals';
import { defineConfig } from 'eslint/config';
import ckeditor5Rules from 'eslint-plugin-ckeditor5-rules';
import ckeditor5Config from 'eslint-config-ckeditor5';
import ts from 'typescript-eslint';
import eslintPluginImport from 'eslint-plugin-import';

import rootPkgJson from './package.json' with { type: 'json' };
import { CKEDITOR5_PACKAGES_PATH } from './scripts/constants.mjs';

const disallowedImports = Object.keys( rootPkgJson.devDependencies ).filter( pkgName => {
return pkgName.match( /^(@ckeditor\/)?ckeditor5-(?!dev-)/ );
} );

const projectPackages = readdirSync( CKEDITOR5_PACKAGES_PATH, { withFileTypes: true } )
.filter( dirent => dirent.isDirectory() )
.map( dirent => dirent.name );

export default defineConfig( [
{
ignores: [
'.*/',
'!.changelog/',
'build/**',
'coverage/**',
'dist/**',
Expand Down Expand Up @@ -179,5 +185,24 @@ export default defineConfig( [
rules: {
'ckeditor5-rules/ckeditor-imports': 'off'
}
},
{
extends: ckeditor5Config,

files: [ '.changelog/**/*.md' ],

plugins: {
'ckeditor5-rules': ckeditor5Rules
},

rules: {
'ckeditor5-rules/validate-changelog-entry': [ 'error', {
allowedScopes: [
...projectPackages,
'ckeditor5'
],
repositoryType: 'mono'
} ]
}
}
] );
9 changes: 4 additions & 5 deletions scripts/constants.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,13 @@
*/

import upath from 'upath';
import { fileURLToPath } from 'url';
import { PACKAGES_DIRECTORY } from './release/utils/constants.mjs';
const __filename = fileURLToPath( import.meta.url );
const __dirname = upath.dirname( __filename );

export const CKEDITOR5_ROOT_PATH = upath.join( __dirname, '..' );
export const CKEDITOR5_ROOT_PATH = upath.join( import.meta.dirname, '..' );
export const CKEDITOR5_PACKAGES_PATH = upath.join( CKEDITOR5_ROOT_PATH, PACKAGES_DIRECTORY );
export const CKEDITOR5_COMMERCIAL_PATH = upath.join( CKEDITOR5_ROOT_PATH, 'external', 'ckeditor5-commercial' );
export const CKEDITOR5_PREMIUM_FEATURES_PATH = upath.join( CKEDITOR5_COMMERCIAL_PATH, PACKAGES_DIRECTORY, 'ckeditor5-premium-features' );
export const CKEDITOR5_COMMERCIAL_PACKAGES_PATH = upath.join( CKEDITOR5_COMMERCIAL_PATH, PACKAGES_DIRECTORY );
export const CKEDITOR5_PREMIUM_FEATURES_PATH = upath.join( CKEDITOR5_COMMERCIAL_PACKAGES_PATH, 'ckeditor5-premium-features' );

export const CKEDITOR5_INDEX = upath.join( CKEDITOR5_ROOT_PATH, 'src', 'index.ts' );
export const CKEDITOR5_PREMIUM_FEATURES_INDEX = upath.join( CKEDITOR5_PREMIUM_FEATURES_PATH, 'src', 'index.ts' );