Skip to content

Commit

Permalink
Cleanup.
Browse files Browse the repository at this point in the history
  • Loading branch information
przemyslaw-zan committed Feb 11, 2025
1 parent e81506f commit 5cadc9d
Show file tree
Hide file tree
Showing 18 changed files with 4 additions and 105 deletions.
1 change: 0 additions & 1 deletion .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ jobs:
- tests
- scripts
- 'packages/*/tests'
- 'packages/ckeditor5-build-*/build/**'
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3
with:
Expand Down
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
**/node_modules
build/
dist/
!packages/ckeditor5-build-*/build
docs/api/output.json
yarn.lock
package-lock.json
Expand Down
32 changes: 0 additions & 32 deletions docs/framework/contributing/code-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -1033,38 +1033,6 @@ class ClassWithSecrets {
}
```

### Importing a predefined build: `ckeditor5-rules/no-build-extensions`

<info-box info>
This rule only applies to code snippets from the documentation.
</info-box>

While importing a predefined build, only this build is allowed to be imported, like this:

```js
// Assume we edit a file located in the path: `packages/ckeditor5-alignment/docs/_snippets/features/text-alignment.js`.

import ClassicEditor from '@ckeditor/ckeditor5-build-classic';
```

Importing anything from the `src` directory to extend a CKEditor&nbsp;5 build is not allowed. Other directories from a predefined build are not published on npm, so such imports will not work.

👎&nbsp; Examples of incorrect code for this rule:

```js
// Assume we edit a file located in the path: `packages/ckeditor5-alignment/docs/_snippets/features/text-alignment.js`.

import ClassicEditor from '@ckeditor/ckeditor5-build-classic/src/ckeditor';
```

```js
// Assume we edit a file located in the path: `docs/_snippets/features/placeholder.js`.

import ClassicEditor from '@ckeditor/ckeditor5-build-classic/src/ckeditor';
```

[History of the change.](https://github.com/ckeditor/ckeditor5/issues/13689)

### Declaring module augmentation for the core package: `ckeditor5-rules/allow-declare-module-only-in-augmentation-file`

<info-box warning>
Expand Down
4 changes: 2 additions & 2 deletions docs/framework/contributing/testing-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,8 +224,8 @@ The `--files` (alias `-f`) option is used by both the manual and automated tests
<td>Run all tests of the <a href="https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-core/tests"><code>ckeditor5-core</code></a> package.</td>
</tr>
<tr>
<td><code>build-*</code></td>
<td>Run all tests of the <code>build-*</code> packages. (<code>ckeditor5-build-classic</code>, <code>ckeditor5-build-balloon</code> etc.)</td>
<td><code>editor-*</code></td>
<td>Run all tests of the <code>editor-*</code> packages. (<code>ckeditor5-editor-classic</code>, <code>ckeditor5-editor-balloon</code> etc.)</td>
</tr>
<tr>
<td><code>!core</code></td>
Expand Down
6 changes: 0 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -85,12 +85,6 @@
"devDependencies": {
"@babel/parser": "^7.23.3",
"@ckeditor/ckeditor5-ai": "44.1.0",
"@ckeditor/ckeditor5-build-balloon": "44.1.0",
"@ckeditor/ckeditor5-build-balloon-block": "44.1.0",
"@ckeditor/ckeditor5-build-classic": "44.1.0",
"@ckeditor/ckeditor5-build-decoupled-document": "44.1.0",
"@ckeditor/ckeditor5-build-inline": "44.1.0",
"@ckeditor/ckeditor5-build-multi-root": "44.1.0",
"@ckeditor/ckeditor5-case-change": "44.1.0",
"@ckeditor/ckeditor5-comments": "44.1.0",
"@ckeditor/ckeditor5-dev-build-tools": "^46.0.0",
Expand Down
2 changes: 0 additions & 2 deletions packages/ckeditor5-editor-balloon/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ The balloon editor implementation (Medium-like editor) for CKEditor&nbsp;5.

This package contains the [`BalloonEditor`](https://ckeditor.com/docs/ckeditor5/latest/api/module_editor-balloon_ballooneditor-BalloonEditor.html) class. Follow there to learn more about this type of editor and how to initialize it.

This package contains the source version of the balloon editor. This kind of editor implementation is also available as a ready-to-use [balloon build](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-balloon). Read more about [CKEditor&nbsp;5 predefined builds](https://ckeditor.com/docs/ckeditor5/latest/getting-started/legacy/advanced/alternative-setups/predefined-builds.html) in the CKEditor&nbsp;5 documentation.

## Documentation

See the [`@ckeditor/ckeditor5-editor-balloon` package](https://ckeditor.com/docs/ckeditor5/latest/api/editor-balloon.html) page in [CKEditor&nbsp;5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).
Expand Down
2 changes: 0 additions & 2 deletions packages/ckeditor5-editor-classic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ The classic editor implementation for CKEditor&nbsp;5.

This package contains the [`ClassicEditor`](https://ckeditor.com/docs/ckeditor5/latest/api/module_editor-classic_classiceditor-ClassicEditor.html) class. Follow there to learn more about this type of editor and how to initialize it.

This package contains the source version of the classic editor. This kind of editor implementation is also available as a ready-to-use [classic build](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-classic). Read more about [CKEditor&nbsp;5 predefined builds](https://ckeditor.com/docs/ckeditor5/latest/getting-started/legacy/advanced/alternative-setups/predefined-builds.html) in the CKEditor&nbsp;5 documentation.

## Documentation

See the [`@ckeditor/ckeditor5-editor-classic` package](https://ckeditor.com/docs/ckeditor5/latest/api/editor-classic.html) page in [CKEditor&nbsp;5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).
Expand Down
2 changes: 0 additions & 2 deletions packages/ckeditor5-editor-decoupled/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ The decoupled editor implementation for CKEditor&nbsp;5.

This package contains the [`DecoupledEditor`](https://ckeditor.com/docs/ckeditor5/latest/api/module_editor-decoupled_decouplededitor-DecoupledEditor.html) class. Follow there to learn more about this type of editor and how to initialize it.

This package contains the source version of the decoupled editor. This kind of editor implementation is also available as a ready-to-use [document build](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-decoupled-document). Read more about [CKEditor&nbsp;5 predefined builds](https://ckeditor.com/docs/ckeditor5/latest/getting-started/legacy/advanced/alternative-setups/predefined-builds.html) in the CKEditor&nbsp;5 documentation.

## Documentation

See the [`@ckeditor/ckeditor5-editor-decoupled` package](https://ckeditor.com/docs/ckeditor5/latest/api/editor-decoupled.html) page in [CKEditor&nbsp;5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).
Expand Down
2 changes: 0 additions & 2 deletions packages/ckeditor5-editor-inline/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ The inline editor implementation for CKEditor&nbsp;5.

This package exposes the [`InlineEditor`](https://ckeditor.com/docs/ckeditor5/latest/api/module_editor-inline_inlineeditor-InlineEditor.html) class. Follow there to learn more about this type of editor and how to initialize it.

This package contains the source version of the inline editor. This kind of editor implementation is also available as a ready-to-use [inline build](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-inline). Read more about [CKEditor&nbsp;5 predefined builds](https://ckeditor.com/docs/ckeditor5/latest/getting-started/legacy/advanced/alternative-setups/predefined-builds.html) in the CKEditor&nbsp;5 documentation.

## Documentation

See the [`@ckeditor/ckeditor5-editor-inline` package](https://ckeditor.com/docs/ckeditor5/latest/api/editor-inline.html) page in [CKEditor&nbsp;5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).
Expand Down
1 change: 0 additions & 1 deletion packages/ckeditor5-utils/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
"es-toolkit": "1.32.0"
},
"devDependencies": {
"@ckeditor/ckeditor5-build-classic": "44.1.0",
"@ckeditor/ckeditor5-editor-classic": "44.1.0",
"@ckeditor/ckeditor5-core": "44.1.0",
"@ckeditor/ckeditor5-engine": "44.1.0",
Expand Down
3 changes: 1 addition & 2 deletions packages/ckeditor5-utils/src/version.ts
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,7 @@ if ( globalThis.CKEDITOR_VERSION ) {
* the `@ckeditor/ckeditor5-<NAME>/src/*` files, it is not recommended as it can make migration to the new installation
* methods more difficult.
*
* If you use this installation method, you should not import code from the `ckeditor5`, `ckeditor5-premium-features`,
* or `@ckeditor/ckeditor5-build-<NAME>` packages.
* If you use this installation method, you should not import code from the `ckeditor5` or `ckeditor5-premium-features` packages.
*
* Examples of valid and invalid import paths:
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

/* global document, console */

import ClassicEditor from '@ckeditor/ckeditor5-build-classic';
import ClassicEditor from '../../../../../docs/_snippets/build-classic.js';

import '@ckeditor/ckeditor5-core/src/editor/editor.js';

Expand Down
6 changes: 0 additions & 6 deletions scripts/check-exports.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,6 @@ const exceptions = [

// Core packages.
'@ckeditor/ckeditor5-theme-lark',
'@ckeditor/ckeditor5-build-multi-root',
'@ckeditor/ckeditor5-build-inline',
'@ckeditor/ckeditor5-build-decoupled-document',
'@ckeditor/ckeditor5-build-classic',
'@ckeditor/ckeditor5-build-balloon-block',
'@ckeditor/ckeditor5-build-balloon',

// Commercial packages.
'@ckeditor/ckeditor5-operations-compressor',
Expand Down
4 changes: 0 additions & 4 deletions scripts/docs/buildapi.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,6 @@ export default function buildApiDocs() {
// Ignore not a direct sources.
'external/ckeditor5-commercial/packages/ckeditor5-operations-compressor/src/protobufdescriptions.ts',

// Ignore builds.
'packages/ckeditor5-build-*/src/**/*.ts',
'external/ckeditor5-commercial/packages/ckeditor5-build-*/src/**/*.ts',

// Ignore all declarations.
'packages/ckeditor5-*/src/**/*.d.ts',
'external/ckeditor5-commercial/packages/ckeditor5-*/src/**/*.d.ts',
Expand Down
16 changes: 0 additions & 16 deletions scripts/release/preparepackages.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ import isCKEditor5PackageFactory from './utils/isckeditor5packagefactory.mjs';
import compileTypeScriptCallback from './utils/compiletypescriptcallback.mjs';
import updatePackageEntryPoint from './utils/updatepackageentrypoint.mjs';
import prepareDllBuildsCallback from './utils/preparedllbuildscallback.mjs';
import buildCKEditor5BuildsCallback from './utils/buildckeditor5buildscallback.mjs';
import getListrOptions from './utils/getlistroptions.mjs';
import getCdnVersion from './utils/getcdnversion.mjs';
import isNonCommittableRelease from './utils/isnoncommittablerelease.mjs';
Expand Down Expand Up @@ -164,20 +163,6 @@ const tasks = new Listr( [
return buildTsAndDllForCKEditor5Root();
}
},
{
title: 'Preparing "ckeditor5-build-*" builds.',
task: ( ctx, task ) => {
return releaseTools.executeInParallel( {
packagesDirectory: PACKAGES_DIRECTORY,
packagesDirectoryFilter: packageDirectory => {
return upath.basename( packageDirectory ).startsWith( 'ckeditor5-build-' );
},
listrTask: task,
taskToExecute: buildCKEditor5BuildsCallback,
concurrency: 2
} );
}
},
{
title: 'Compiling TypeScript in `ckeditor5-*` packages.',
task: ( ctx, task ) => {
Expand Down Expand Up @@ -314,7 +299,6 @@ const tasks = new Listr( [
files: [
'package.json',
`${ PACKAGES_DIRECTORY }/*/package.json`,
`${ PACKAGES_DIRECTORY }/ckeditor5-build-*/build/**`,
...ctx.updatedFiles
]
} );
Expand Down
16 changes: 0 additions & 16 deletions scripts/release/utils/buildckeditor5buildscallback.mjs

This file was deleted.

5 changes: 0 additions & 5 deletions scripts/release/utils/buildpackageusingrollupcallback.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@
* @returns {Promise}
*/
export default async function buildPackageUsingRollupCallback( packagePath ) {
// Ignore builds as they are rather "a product to use" instead of "blocks to combine".
if ( packagePath.includes( 'ckeditor5-build-' ) ) {
return;
}

const { tools } = await import( '@ckeditor/ckeditor5-dev-utils' );

return tools.shExec( 'yarn run build:dist', {
Expand Down
4 changes: 0 additions & 4 deletions scripts/release/utils/getchangelogoptions.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,6 @@ export default function getChangelogOptions( cliArguments ) {
return 'https://www.npmjs.com/package/ckeditor5-premium-feature';
}

if ( name === 'build-*' ) {
return 'https://www.npmjs.com/search?q=keywords%3Ackeditor5-build%20maintainer%3Ackeditor';
}

if ( name === 'editor-*' ) {
return 'https://www.npmjs.com/search?q=keywords%3Ackeditor5-editor%20maintainer%3Ackeditor';
}
Expand Down

0 comments on commit 5cadc9d

Please sign in to comment.