Explorar el Código

Renamed dist/ to build/.

Piotrek Koszuliński hace 9 años
padre
commit
23fa466c14

+ 8 - 8
bender.js

@@ -15,12 +15,12 @@ const config = {
 	framework: 'mocha',
 
 	applications: {
-		'ckeditor': {
+		ckeditor: {
 			path: '.',
 			files: [
 				'node_modules/requirejs/require.js'
 			],
-			basePath: '/apps/ckeditor/dist/amd/'
+			basePath: '/apps/ckeditor/build/amd/'
 		}
 	},
 
@@ -28,18 +28,18 @@ const config = {
 		all: {
 			applications: [ 'ckeditor' ],
 			paths: [
-				'dist/amd/tests/**',
-				'!dist/amd/tests/**/_*/**'
+				'build/amd/tests/**',
+				'!build/amd/tests/**/_*/**'
 			]
 		}
 	},
 
 	coverage: {
 		paths: [
-			'dist/amd/ckeditor.js',
-			'dist/amd/ckeditor5/**/*.js',
-			'dist/amd/tests/**/_*/*.js',
-			'!dist/amd/ckeditor5/*/lib/**'
+			'build/amd/ckeditor.js',
+			'build/amd/ckeditor5/**/*.js',
+			'build/amd/tests/**/_*/*.js',
+			'!build/amd/ckeditor5/*/lib/**'
 		]
 	}
 };

+ 1 - 1
dev/bender/plugins/ckeditor5/lib/index.js

@@ -18,7 +18,7 @@ module.exports = {
 
 		this.on( 'test:created', ( test ) => {
 			const moduleRegExp = /^([^\/]+)\//;
-			let name = test.displayName.replace( /^dist\/amd\/tests\//, '' );
+			let name = test.displayName.replace( /^build\/amd\/tests\//, '' );
 			let module = name.match( moduleRegExp );
 
 			if ( module ) {

+ 5 - 5
dev/tasks/build/tasks.js

@@ -17,14 +17,14 @@ const minimist = require( 'minimist' );
 const utils = require( './utils' );
 
 module.exports = ( config ) => {
-	const distDir = path.join( config.ROOT_DIR, config.DIST_DIR );
+	const buildDir = path.join( config.ROOT_DIR, config.BUILD_DIR );
 
 	const tasks = {
 		/**
-		 * Removes the dist directory.
+		 * Removes the build directory.
 		 */
 		clean() {
-			return del( distDir );
+			return del( buildDir );
 		},
 
 		src: {
@@ -114,7 +114,7 @@ module.exports = ( config ) => {
 
 		/**
 		 * The main build task which is capable of copying, watching, processing and writing all files
-		 * to the `dist/` directory.
+		 * to the `build/` directory.
 		 *
 		 * @param {Object} options
 		 * @param {String} options.formats
@@ -160,7 +160,7 @@ module.exports = ( config ) => {
 						gutil.log( `Processing '${ gutil.colors.cyan( file.path ) }'...` );
 					} )
 				);
-			const conversionStreamGenerator = utils.getConversionStreamGenerator( distDir );
+			const conversionStreamGenerator = utils.getConversionStreamGenerator( buildDir );
 			const outputStream = utils.noop();
 
 			let inputStream;

+ 8 - 8
dev/tasks/build/utils.js

@@ -55,14 +55,14 @@ require( [ 'tests' ], bender.defer(), function( err ) {
 	},
 
 	/**
-	 * Saves the files piped into this stream to the `dist/` directory.
+	 * Saves the files piped into this stream to the `build/` directory.
 	 *
-	 * @param {String} distDir The `dist/` directory path.
-	 * @param {String} format The format of the distribution (`esnext`, `amd`, or `cjs`).
+	 * @param {String} buildDir The `build/` directory path.
+	 * @param {String} format The format of the buildribution (`esnext`, `amd`, or `cjs`).
 	 * @returns {Stream}
 	 */
-	dist( distDir, format ) {
-		const destDir = path.join( distDir, format );
+	destBuild( buildDir, format ) {
+		const destDir = path.join( buildDir, format );
 
 		return gulp.dest( destDir );
 	},
@@ -71,10 +71,10 @@ require( [ 'tests' ], bender.defer(), function( err ) {
 	 * Creates a function generating convertion streams.
 	 * Used to generate `formats.reduce()` callback where `formats` is an array of formats that should be generated.
 	 *
-	 * @param {String} distDir The `dist/` directory path.
+	 * @param {String} buildDir The `build/` directory path.
 	 * @returns {Function}
 	 */
-	getConversionStreamGenerator( distDir ) {
+	getConversionStreamGenerator( buildDir ) {
 		return ( pipes, format ) => {
 			const conversionPipes = [];
 
@@ -106,7 +106,7 @@ require( [ 'tests' ], bender.defer(), function( err ) {
 			}
 
 			conversionPipes.push(
-				utils.dist( distDir, format ),
+				utils.destBuild( buildDir, format ),
 				utils.noop( ( file ) => {
 					gutil.log( `Finished writing '${ gutil.colors.cyan( file.path ) }'` );
 				} )

+ 0 - 23
dev/tasks/docs/jsdoc.json

@@ -1,23 +0,0 @@
-{
-	"opts": {
-		"encoding": "utf8",
-		"destination": "dist/docs",
-		"recurse": true,
-		"access": "all"
-	},
-	"plugins": [
-		"node_modules/jsdoc/plugins/markdown",
-		"dev/tasks/docs/plugins/comment-fixer"
-	],
-	"source": {
-		"include": [
-			"dist/esnext"
-		],
-		"exclude": [
-			"dist/esnext/test",
-			"dist/esnext/ckeditor5/core/lib"
-		],
-		"includePattern": ".+\\.js(doc)?$",
-		"excludePattern": "(^|\\/|\\\\)_"
-	}
-}

+ 25 - 5
dev/tasks/docs/tasks.js

@@ -7,13 +7,33 @@
 
 const gulp = require( 'gulp' );
 const jsdoc = require( 'gulp-jsdoc3' );
+const path = require( 'path' );
 
-module.exports = () => {
+module.exports = ( config ) => {
 	gulp.task( 'docs', [ 'build-esnext' ], function( cb ) {
-		const config = require( './jsdoc.json' );
+		const esnextBuildPath = path.join( config.ROOT_DIR, config.BUILD_DIR, 'esnext' );
+		const jsDocConfig = {
+			opts: {
+				encoding: 'utf8',
+				destination: path.join( config.BUILD_DIR, 'docs' ),
+				recurse: true,
+				access: 'all'
+			},
+			plugins: [
+				'node_modules/jsdoc/plugins/markdown',
+				'dev/tasks/docs/plugins/comment-fixer'
+			]
+		};
 
-		// Add the readme to the output.
-		gulp.src( [ 'README.md' ], { read: false } )
-			.pipe( jsdoc( config, cb ) );
+		const patterns = [
+			'README.md',
+			// Add all js and jsdoc files, including tests (which can contain utils).
+			path.join( esnextBuildPath, '**', '*.@(js|jsdoc)' ),
+			// Filter out libs.
+			'!' + path.join( esnextBuildPath, 'ckeditor5', '*', 'lib', '**', '*' )
+		];
+
+		gulp.src( patterns, { read: false } )
+			.pipe( jsdoc( jsDocConfig, cb ) );
 	} );
 };

+ 2 - 2
dev/tests/build/tasks.js

@@ -23,7 +23,7 @@ describe( 'build-tasks', () => {
 	let sandbox, tasks;
 	const config = {
 		ROOT_DIR: '.',
-		DIST_DIR: 'dist'
+		BUILD_DIR: 'build'
 	};
 
 	beforeEach( () => {
@@ -126,7 +126,7 @@ describe( 'build-tasks', () => {
 			} );
 
 			// Stub output stream.
-			sandbox.stub( utils, 'dist', () => {
+			sandbox.stub( utils, 'destBuild', () => {
 				return through( { objectMode: true }, ( file, encoding, cb ) => {
 					written++;
 

+ 11 - 11
dev/tests/build/utils.js

@@ -48,15 +48,15 @@ describe( 'build-utils', () => {
 		} );
 	} );
 
-	describe( 'dist', () => {
+	describe( 'destBuild', () => {
 		it( 'should return stream created with gulp.dest', () => {
-			const distDir = 'dist/';
+			const buildDir = 'build/';
 			const format = 'amd';
 			const destSpy = sandbox.spy( gulp, 'dest' );
-			const stream = utils.dist( distDir, format );
+			const stream = utils.destBuild( buildDir, format );
 
 			sinon.assert.calledOnce( destSpy );
-			sinon.assert.calledWithExactly( destSpy, path.join( distDir, format ) );
+			sinon.assert.calledWithExactly( destSpy, path.join( buildDir, format ) );
 			expect( stream ).to.equal( destSpy.firstCall.returnValue );
 		} );
 	} );
@@ -178,7 +178,7 @@ describe( 'build-utils', () => {
 			sandbox.stub( utils, 'getBabelOptionsForTests', () => 'tests' );
 
 			// Stub to avoid writing to the fs.
-			sandbox.stub( utils, 'dist', () => utils.noop() );
+			sandbox.stub( utils, 'destBuild', () => utils.noop() );
 
 			// The transpile converted with append to file contents what was
 			// passed to it as an options object and that's a result of getBabelOptions*,
@@ -201,9 +201,9 @@ describe( 'build-utils', () => {
 		} );
 
 		it( 'should return function that can be used for creating conversion streams', () => {
-			const distDir = 'dist/';
+			const buildDir = 'build/';
 			const formats = [ 'amd', 'cjs', 'esnext' ];
-			const fn = utils.getConversionStreamGenerator( distDir );
+			const fn = utils.getConversionStreamGenerator( buildDir );
 			const streams = formats.reduce( fn, [] );
 
 			expect( streams.length ).to.equal( formats.length );
@@ -211,9 +211,9 @@ describe( 'build-utils', () => {
 
 		describe( 'created conversion stream', () => {
 			it( 'should process source JS file', ( done ) => {
-				const distDir = 'dist/';
+				const buildDir = 'build/';
 				const formats = [ 'amd' ];
-				const fn = utils.getConversionStreamGenerator( distDir );
+				const fn = utils.getConversionStreamGenerator( buildDir );
 				const streams = formats.reduce( fn, [] );
 
 				expect( streams ).to.have.length( 1 );
@@ -237,9 +237,9 @@ describe( 'build-utils', () => {
 
 		describe( 'created conversion stream', () => {
 			it( 'should process test file', ( done ) => {
-				const distDir = 'dist/';
+				const buildDir = 'build/';
 				const formats = [ 'cjs' ];
-				const fn = utils.getConversionStreamGenerator( distDir );
+				const fn = utils.getConversionStreamGenerator( buildDir );
 				const streams = formats.reduce( fn, [] );
 
 				expect( streams ).to.have.length( 1 );

+ 1 - 1
dev/tests/lint.js

@@ -23,7 +23,7 @@ describe( 'lint', () => {
 
 	const config = {
 		ROOT_DIR: '.',
-		DIST_DIR: 'dist',
+		BUILD_DIR: 'build',
 		IGNORED_FILES: [ 'lib/**' ]
 	};
 

+ 1 - 1
gulpfile.js

@@ -6,7 +6,7 @@ const gulp = require( 'gulp' );
 
 const config = {
 	ROOT_DIR: '.',
-	DIST_DIR: 'dist',
+	BUILD_DIR: 'build',
 	WORKSPACE_DIR: '..',
 
 	// Files ignored by jshint and jscs tasks. Files from .gitignore will be added automatically during tasks execution.