浏览代码

Moved docs bulder to ckeditor5-dev-builder repository.

Szymon Kupś 9 年之前
父节点
当前提交
b82f506426
共有 4 个文件被更改,包括 19 次插入98 次删除
  1. 0 33
      dev/tasks/docs/plugins/comment-fixer.js
  2. 0 47
      dev/tasks/docs/tasks.js
  3. 18 14
      gulpfile.js
  4. 1 4
      package.json

+ 0 - 33
dev/tasks/docs/plugins/comment-fixer.js

@@ -1,33 +0,0 @@
-/**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-module.exports = {
-	handlers: {
-		/**
-		 * @see http://usejsdoc.org/about-plugins.html#event-beforeparse
-		 * @param evt
-		 */
-		beforeParse( evt ) {
-			'use strict'; // WAT... JSDoc fails when you move it to the top of the file.
-
-			let className;
-			let foundClassName = /export default class ([A-Za-z]+)/.exec( evt.source );
-
-			// Fix for {@link https://github.com/jsdoc3/jsdoc/issues/1137}. Export default class is not parsed by jsdoc 3.4.
-			if ( foundClassName ) {
-				className = foundClassName[ 1 ];
-				evt.source =
-					evt.source.replace( 'export default class', 'class' ) +
-					'\nexport default ' + className + ';\n';
-			}
-
-			// TODO: jsdoc fail to parse method with expanded argument list
-			evt.source = evt.source.replace( '...}', '}' );
-
-			// Make code in comments indented with one tab so it will not be shifted.
-			evt.source = evt.source.replace( /\*\t\t/g, '*\t' );
-		}
-	}
-};

+ 0 - 47
dev/tasks/docs/tasks.js

@@ -1,47 +0,0 @@
-/**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-'use strict';
-
-const gulp = require( 'gulp' );
-const jsdoc = require( 'gulp-jsdoc3' );
-const path = require( 'path' );
-
-module.exports = ( config ) => {
-	const tasks = {
-		buildDocs( cb ) {
-			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'
-				]
-			};
-
-			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 ) );
-		},
-
-		register() {
-			gulp.task( 'docs', [ 'build:js:esnext' ], tasks.buildDocs );
-		}
-	};
-
-	return tasks;
-};

+ 18 - 14
gulpfile.js

@@ -24,7 +24,6 @@ const config = {
 
 require( './dev/tasks/bundle/tasks' )( config ).register();
 require( './dev/tasks/test/tasks' )( config ).register();
-require( './dev/tasks/docs/tasks' )( config ).register();
 
 // Lint tasks.
 const ckeditor5Lint = require( 'ckeditor5-dev-lint' )( config );
@@ -47,32 +46,37 @@ gulp.task( 'exec', ckeditor5DevEnv.execOnRepositories );
 
 // Build tasks.
 const ckeditor5DevBuilder = require( 'ckeditor5-dev-builder' )( config );
+const builder = ckeditor5DevBuilder.builder;
 gulp.task( 'build', callback => {
 	runSequence( 'build:clean:all', 'build:themes', 'build:js', callback );
 } );
 
-gulp.task( 'build:clean:all', ckeditor5DevBuilder.clean.all );
-gulp.task( 'build:clean:themes', ckeditor5DevBuilder.clean.themes );
-gulp.task( 'build:clean:js', () => ckeditor5DevBuilder.clean.js() );
+gulp.task( 'build:clean:all', builder.clean.all );
+gulp.task( 'build:clean:themes', builder.clean.themes );
+gulp.task( 'build:clean:js', () => builder.clean.js() );
 
 gulp.task( 'build:themes', ( callback ) => {
 	runSequence( 'build:clean:themes', 'build:icons', 'build:sass', callback );
 } );
 
-gulp.task( 'build:sass', () => ckeditor5DevBuilder.build.sass() );
-gulp.task( 'build:icons', () => ckeditor5DevBuilder.build.icons() );
-gulp.task( 'build:js', [ 'build:clean:js' ], () => ckeditor5DevBuilder.build.js() );
+gulp.task( 'build:sass', () => builder.build.sass() );
+gulp.task( 'build:icons', () => builder.build.icons() );
+gulp.task( 'build:js', [ 'build:clean:js' ], () => builder.build.js() );
 
 // Tasks specific for preparing build with unmodified source files. Uses by `gulp docs` or `gulp bundle`.
-gulp.task( 'build:clean:js:esnext', () => ckeditor5DevBuilder.clean.js( { formats: [ 'esnext' ] } ) );
-gulp.task( 'build:clean:themes:esnext', () => ckeditor5DevBuilder.clean.themes( { formats: [ 'esnext' ] } ) );
-gulp.task( 'build:sass:esnext', () => ckeditor5DevBuilder.build.sass( { formats: [ 'esnext' ] } ) );
-gulp.task( 'build:icons:esnext', () => ckeditor5DevBuilder.build.icons( { formats: [ 'esnext' ] } ) );
-gulp.task( 'build:js:esnext', [ 'build:clean:js:esnext' ], () => ckeditor5DevBuilder.build.js( { formats: [ 'esnext' ] } ) );
+gulp.task( 'build:clean:js:esnext', () => builder.clean.js( { formats: [ 'esnext' ] } ) );
+gulp.task( 'build:clean:themes:esnext', () => builder.clean.themes( { formats: [ 'esnext' ] } ) );
+gulp.task( 'build:sass:esnext', () => builder.build.sass( { formats: [ 'esnext' ] } ) );
+gulp.task( 'build:icons:esnext', () => builder.build.icons( { formats: [ 'esnext' ] } ) );
+gulp.task( 'build:js:esnext', [ 'build:clean:js:esnext' ], () => builder.build.js( { formats: [ 'esnext' ] } ) );
 gulp.task( 'build:themes:esnext', ( callback ) => {
 	runSequence( 'build:clean:themes:esnext', 'build:icons:esnext', 'build:sass:esnext', callback );
 } );
 
 // Tasks specific for testing under node.
-gulp.task( 'build:clean:js:cjs', () => ckeditor5DevBuilder.clean.js( { formats: [ 'cjs' ] } ) );
-gulp.task( 'build:js:cjs', [ 'build:clean:js:cjs' ], () => ckeditor5DevBuilder.build.js( { formats: [ 'cjs' ] } ) );
+gulp.task( 'build:clean:js:cjs', () => builder.clean.js( { formats: [ 'cjs' ] } ) );
+gulp.task( 'build:js:cjs', [ 'build:clean:js:cjs' ], () => builder.build.js( { formats: [ 'cjs' ] } ) );
+
+// Docs.
+const docsBuilder = ckeditor5DevBuilder.docs;
+gulp.task( 'docs', [ 'build:js:esnext' ], docsBuilder.buildDocs );

+ 1 - 4
package.json

@@ -34,6 +34,7 @@
     "benderjs-promise": "^0.1.0",
     "benderjs-sinon": "^0.3.0",
     "chai": "^3.4.0",
+    "ckeditor5-dev-builder": "ckeditor/ckeditor5-dev-builder",
     "ckeditor5-dev-env": "ckeditor/ckeditor5-dev-env",
     "ckeditor5-dev-lint": "ckeditor/ckeditor5-dev-lint",
     "ckeditor5-dev-utils": "ckeditor/ckeditor5-dev-utils",
@@ -43,7 +44,6 @@
     "gulp-filter": "^3.0.1",
     "gulp-filter-by": "^1.2.0",
     "gulp-istanbul": "^0.10.4",
-    "gulp-jsdoc3": "^0.2.0",
     "gulp-mirror": "^1",
     "gulp-mocha": "^2.2.0",
     "gulp-plumber": "^1.1.0",
@@ -56,8 +56,6 @@
     "gulp-watch": "^4.3.7",
     "guppy-pre-commit": "^0.3.0",
     "gzip-size": "^3.0.0",
-    "jsdoc": "^3.4.0",
-    "merge-stream": "^1.0.0",
     "minimist": "^1.2.0",
     "mkdirp": "^0.5.1",
     "mockery": "^1.4.0",
@@ -68,7 +66,6 @@
     "run-sequence": "^1.1.5",
     "semver": "^5.1.0",
     "sinon": "^1.17.0",
-    "through2": "^2.0.0",
     "vinyl": "^1.1.1"
   },
   "engines": {