Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #16288 from ckeditor/add-exports-validator
Internal: Added a new script to verify that all packages are exported in the `ckeditor5` package.
- Loading branch information
Showing
4 changed files
with
177 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| /** | ||
| * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved. | ||
| * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license | ||
| */ | ||
|
|
||
| /* eslint-env node */ | ||
|
|
||
| import fs from 'fs'; | ||
| import { parseArgs } from 'util'; | ||
| import { createRequire } from 'module'; | ||
| import chalk from 'chalk'; | ||
| import upath from 'upath'; | ||
| import { parse } from 'acorn'; | ||
| import { walk } from 'estree-walker'; | ||
| import { globSync } from 'glob'; | ||
| import constants from './release/utils/constants.js'; | ||
|
|
||
| const require = createRequire( import.meta.url ); | ||
|
|
||
| /** | ||
| * List of paths to the allowed `input` packages. | ||
| */ | ||
| const paths = { | ||
| 'ckeditor5': constants.CKEDITOR5_INDEX, | ||
| 'ckeditor5-premium-features': constants.CKEDITOR5_PREMIUM_FEATURES_INDEX | ||
| }; | ||
|
|
||
| /** | ||
| * List of packages that are not meant to be exported in the main entry files. | ||
| */ | ||
| const exceptions = [ | ||
| ...Object.keys( paths ), | ||
|
|
||
| // 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', | ||
| 'ckeditor5-collaboration' | ||
| ]; | ||
|
|
||
| /** | ||
| * Parse CLI arguments. | ||
| */ | ||
| const { values } = parseArgs( { | ||
| options: { | ||
| /* | ||
| * Name of the package to check. Valid options: | ||
| * - `ckeditor5`. | ||
| * - `ckeditor5-premium-features`. | ||
| */ | ||
| 'input': { type: 'string' } | ||
| }, | ||
|
|
||
| // Skip `node ./scripts/check-exports.mjs`. | ||
| args: process.argv.slice( 2 ), | ||
|
|
||
| // Fail when unknown argument is used. | ||
| strict: true | ||
| } ); | ||
|
|
||
| /** | ||
| * Resolve paths based on the `input` value. | ||
| */ | ||
| const inputPath = paths[ values.input ]; | ||
|
|
||
| if ( !inputPath ) { | ||
| throw new Error( `Invalid input value: ${ values.input }` ); | ||
| } | ||
|
|
||
| /** | ||
| * Get names of all packages in the `packages` directory. | ||
| */ | ||
| const globPath = upath.join( process.cwd(), constants.PACKAGES_DIRECTORY, '*', 'package.json' ); | ||
|
|
||
| const packages = globSync( globPath ) | ||
| .map( path => require( path ) ) | ||
| .map( pkg => pkg.name ); | ||
|
|
||
| /** | ||
| * Parse the main entry file. | ||
| */ | ||
| const ast = parse( fs.readFileSync( inputPath, 'utf8' ), { | ||
| sourceType: 'module', | ||
| ecmaVersion: 'latest' | ||
| } ); | ||
|
|
||
| const exports = []; | ||
|
|
||
| /** | ||
| * Walk through the AST and collect names of all exported packages. | ||
| */ | ||
| walk( ast, { | ||
| enter( node ) { | ||
| if ( node.type !== 'ExportAllDeclaration' && node.type !== 'ExportNamedDeclaration' ) { | ||
| return; | ||
| } | ||
|
|
||
| const path = node.source.value; | ||
|
|
||
| if ( path.startsWith( '.' ) || path.startsWith( '/' ) ) { | ||
| return; | ||
| } | ||
|
|
||
| const packageName = path | ||
| .split( '/' ) | ||
| .slice( 0, path.startsWith( '@' ) ? 2 : 1 ) | ||
| .join( '/' ); | ||
|
|
||
| exports.push( packageName ); | ||
| } | ||
| } ); | ||
|
|
||
| /** | ||
| * Names of the packages that are not exported in the main entry file. | ||
| */ | ||
| const missingExports = packages.filter( name => !exports.includes( name ) && !exceptions.includes( name ) ); | ||
|
|
||
| /** | ||
| * Names of the packages that are not present in the packages directory, but are exported in the main entry file. | ||
| */ | ||
| const missingPackages = exports.filter( name => !packages.includes( name ) ); | ||
|
|
||
| if ( !missingExports.length && !missingPackages.length ) { | ||
| console.log( chalk.green( 'All packages are exported in the main entry file.' ) ); | ||
| process.exit( 0 ); | ||
| } | ||
|
|
||
| if ( missingExports.length ) { | ||
| console.log( | ||
| chalk.red.bold( `The following packages are not exported from the "${ values.input }" package:` ) | ||
| ); | ||
|
|
||
| missingExports.forEach( pkg => console.log( chalk.red( ` - ${ pkg }` ) ) ); | ||
| } | ||
|
|
||
| if ( missingPackages.length ) { | ||
| console.log( | ||
| chalk.red.bold( `The following exports in the "${ values.input }" package are not present in the "packages" directory:` ) | ||
| ); | ||
|
|
||
| missingPackages.forEach( pkg => console.log( chalk.red( ` - ${ pkg }` ) ) ); | ||
| } | ||
|
|
||
| process.exit( 1 ); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters