@ckeditor/ckeditor5-dev-lint

Gulp linting tasks for CKEditor 5.

Usage no npm install needed!

<script type="module">
  import ckeditorCkeditor5DevLint from 'https://cdn.skypack.dev/@ckeditor/ckeditor5-dev-lint';
</script>

README

CKEditor 5 linting tasks

Gulp linting tasks for CKEditor 5.

More information about development tools packages can be found at the following URL: https://github.com/ckeditor/ckeditor5-dev.

Usage

npm i --save-dev @ckeditor/ckeditor5-dev-lint guppy-pre-commit

gulpfile.js:

'use strict';

const gulp = require( 'gulp' );

const ckeditor5Lint = require( '@ckeditor/ckeditor5-dev-lint' )();

gulp.task( 'lint', ckeditor5Lint.lint );
gulp.task( 'lint-staged', ckeditor5Lint.lintStaged );
gulp.task( 'pre-commit', [ 'lint-staged' ] );

The lint task will skip the files listed in .gitignore. You can also pass option.ignoredFiles:

const ckeditor5Lint = require( '@ckeditor/ckeditor5-dev-lint' )( {
    // Files ignored by `gulp lint` task.
    // Files from .gitignore will be added automatically during task execution.
    ignoredFiles: [
        'src/lib/**'
    ]
} );

Changelog

See the CHANGELOG.md file.

License

Licensed under the GPL, LGPL and MPL licenses, at your choice. For full details about the license, please check the LICENSE.md file.