ckeditor / ckeditor5-package-generator / 983

pending completion

Build # 983

Build Type

cron

travis-ci-com

Committed by

web-flow

Commit Message

Merge pull request #134 from ckeditor/ci/2269

Internal: Use `ckeditor5-dev-ci-notify-travis-status` script from new package `ckeditor5-dev-ci`.

Run Details

111 of 111 branches covered (100.0%)

Branch coverage included in aggregate %.

412 of 412 relevant lines covered (100.0%)

8.13 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

100.0

/packages/ckeditor5-package-generator/lib/utils/copy-files.js

/**
 * @license Copyright (c) 2020-2022, CKSource Holding sp. z o.o. All rights reserved.
 * For licensing, see LICENSE.md.
 */

'use strict';

const chalk = require( 'chalk' );
const fs = require( 'fs' );
const glob = require( 'glob' );
const mkdirp = require( 'mkdirp' );
const path = require( 'path' );
const template = require( 'lodash.template' );

const TEMPLATE_PATH = path.join( __dirname, '..', 'templates' );

/**
 * If the package name is not valid, prints the error and exits the process.
 *
 * @param {Logger} logger
 * @param {Object} options
 * @param {String} packageName
 * @param {FormattedNames} options.formattedNames
 * @param {String} options.directoryPath
 * @param {String} options.packageManager
 * @param {String} options.programmingLanguage
 * @param {Object} options.packageVersions
 */
module.exports = function copyFiles( logger, options ) {
        logger.process( 'Copying files...' );

        const templateGlobs = [
                'common/**/*',
                `${ options.programmingLanguage }/**/*`
        ];

        const templatesToCopy = templateGlobs.flatMap( globPattern => {
                return glob.sync( globPattern, {
                        cwd: TEMPLATE_PATH,
                        dot: true,
                        nodir: true
                } );
        } );

        for ( const templatePath of templatesToCopy ) {
                logger.verboseInfo( `* Copying "${ chalk.gray( templatePath ) }"...` );

                const data = {
                        cliSeparator: options.packageManager === 'npm' ? '-- ' : '',
                        now: new Date(),
                        ...options
                };

                copyTemplate( templatePath, options.directoryPath, data );
        }
};

/**
 * Copies all files into the package directory. If any file has any template placeholders, they are filled.
 *
 * @param {String} templatePath The relative path to the "templates/" directory of the file to copy.
 * @param {String} packagePath The destination directory where the new package is created.
 * @param {Object} data The data to fill in the template file.
 */
function copyTemplate( templatePath, packagePath, data ) {
        const rawFile = fs.readFileSync( path.join( TEMPLATE_PATH, templatePath ), 'utf-8' );
        const filledFile = template( rawFile )( data );

        const processedTemplatePath = templatePath
                // Remove sub-directory inside templates to merge results into one directory.
                .replace( /^(?:common|js|ts)(?:\\|\/)/, '' )
                // We use the ".txt" file extension to circumvent syntax errors in templates and npm not publishing the ".gitignore" file.
                .replace( /\.txt$/, '' )
                // Replace placeholder filenames with the class name.
                .replace( /_PLACEHOLDER_/, data.formattedNames.plugin.lowerCaseMerged );

        const destinationPath = path.join( packagePath, processedTemplatePath );

        // Make sure that the destination directory exists.
        mkdirp.sync( path.dirname( destinationPath ) );
        fs.writeFileSync( destinationPath, filledFile );
}

1	/**
2	* @license Copyright (c) 2020-2022, CKSource Holding sp. z o.o. All rights reserved.
3	* For licensing, see LICENSE.md.
4	*/
5
6	'use strict';
7
8	const chalk = require( 'chalk' );	11✔
9	const fs = require( 'fs' );	11✔
10	const glob = require( 'glob' );	11✔
11	const mkdirp = require( 'mkdirp' );	11✔
12	const path = require( 'path' );	11✔
13	const template = require( 'lodash.template' );	11✔
14
15	const TEMPLATE_PATH = path.join( __dirname, '..', 'templates' );	11✔
16
17	/**
18	* If the package name is not valid, prints the error and exits the process.
19	*
20	* @param {Logger} logger
21	* @param {Object} options
22	* @param {String} packageName
23	* @param {FormattedNames} options.formattedNames
24	* @param {String} options.directoryPath
25	* @param {String} options.packageManager
26	* @param {String} options.programmingLanguage
27	* @param {Object} options.packageVersions
28	*/
29	module.exports = function copyFiles( logger, options ) {	11✔
30	logger.process( 'Copying files...' );	10✔
31
32	const templateGlobs = [	10✔
33	'common/*/',
34	`${ options.programmingLanguage }/*/`
35	];
36
37	const templatesToCopy = templateGlobs.flatMap( globPattern => {	10✔
38	return glob.sync( globPattern, {	20✔
39	cwd: TEMPLATE_PATH,
40	dot: true,
41	nodir: true
42	} );
43	} );
44
45	for ( const templatePath of templatesToCopy ) {	10✔
46	logger.verboseInfo( `* Copying "${ chalk.gray( templatePath ) }"...` );	42✔
47
48	const data = {	42✔
49	cliSeparator: options.packageManager === 'npm' ? '-- ' : '',	42✔
50	now: new Date(),
51	...options
52	};
53
54	copyTemplate( templatePath, options.directoryPath, data );	42✔
55	}
56	};
57
58	/**
59	* Copies all files into the package directory. If any file has any template placeholders, they are filled.
60	*
61	* @param {String} templatePath The relative path to the "templates/" directory of the file to copy.
62	* @param {String} packagePath The destination directory where the new package is created.
63	* @param {Object} data The data to fill in the template file.
64	*/
65	function copyTemplate( templatePath, packagePath, data ) {
66	const rawFile = fs.readFileSync( path.join( TEMPLATE_PATH, templatePath ), 'utf-8' );	42✔
67	const filledFile = template( rawFile )( data );	42✔
68
69	const processedTemplatePath = templatePath	42✔
70	// Remove sub-directory inside templates to merge results into one directory.
71	.replace( /^(?:common\|js\|ts)(?:\\\|\/)/, '' )
72	// We use the ".txt" file extension to circumvent syntax errors in templates and npm not publishing the ".gitignore" file.
73	.replace( /\.txt$/, '' )
74	// Replace placeholder filenames with the class name.
75	.replace( /_PLACEHOLDER_/, data.formattedNames.plugin.lowerCaseMerged );
76
77	const destinationPath = path.join( packagePath, processedTemplatePath );	42✔
78
79	// Make sure that the destination directory exists.
80	mkdirp.sync( path.dirname( destinationPath ) );	42✔
81	fs.writeFileSync( destinationPath, filledFile );	42✔
82	}

ckeditor / ckeditor5-package-generator / 983

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous