# Conflicts: # packages/elastic-eslint-config-kibana/javascript.js # packages/kbn-eslint-plugin-eslint/rules/disallow_license_headers.test.js # packages/kbn-eslint-plugin-eslint/rules/no_restricted_paths.test.js # packages/kbn-eslint-plugin-eslint/rules/require_license_header.test.js # src/dev/eslint/lint_files.ts # x-pack/plugins/security_solution/public/common/components/markdown_editor/plugins/timeline/processor.tsx # yarn.lock Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
189 lines
3.6 KiB
JavaScript
189 lines
3.6 KiB
JavaScript
/*
|
|
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
|
|
* or more contributor license agreements. Licensed under the Elastic License
|
|
* 2.0 and the Server Side Public License, v 1; you may not use this file except
|
|
* in compliance with, at your election, the Elastic License 2.0 or the Server
|
|
* Side Public License, v 1.
|
|
*/
|
|
|
|
const { RuleTester } = require('eslint');
|
|
const rule = require('./require_license_header');
|
|
const dedent = require('dedent');
|
|
|
|
const ruleTester = new RuleTester({
|
|
parser: require.resolve('@babel/eslint-parser'),
|
|
parserOptions: {
|
|
ecmaVersion: 2018,
|
|
requireConfigFile: false,
|
|
},
|
|
});
|
|
|
|
ruleTester.run('@kbn/eslint/require-license-header', rule, {
|
|
valid: [
|
|
{
|
|
code: dedent`
|
|
/* license */
|
|
|
|
console.log('foo')
|
|
`,
|
|
|
|
options: [{ license: '/* license */' }],
|
|
},
|
|
{
|
|
code: dedent`
|
|
// license
|
|
|
|
console.log('foo')
|
|
`,
|
|
|
|
options: [{ license: '// license' }],
|
|
},
|
|
],
|
|
|
|
invalid: [
|
|
// missing license option
|
|
{
|
|
code: dedent`
|
|
console.log('foo')
|
|
`,
|
|
|
|
options: [],
|
|
errors: [
|
|
{
|
|
message: '"license" option is required',
|
|
},
|
|
],
|
|
},
|
|
|
|
// content cannot contain multiple block comments
|
|
{
|
|
code: dedent`
|
|
console.log('foo')
|
|
`,
|
|
|
|
options: [{ license: '/* one *//* two */' }],
|
|
errors: [
|
|
{
|
|
message: '"license" option must only include a single comment',
|
|
},
|
|
],
|
|
},
|
|
|
|
// content cannot contain multiple line comments
|
|
{
|
|
code: dedent`
|
|
console.log('foo')
|
|
`,
|
|
|
|
options: [{ license: `// one\n// two` }],
|
|
errors: [
|
|
{
|
|
message: '"license" option must only include a single comment',
|
|
},
|
|
],
|
|
},
|
|
|
|
// content cannot contain expressions
|
|
{
|
|
code: dedent`
|
|
console.log('foo')
|
|
`,
|
|
|
|
options: [
|
|
{
|
|
license: dedent`
|
|
/* license */
|
|
console.log('hello world');
|
|
`,
|
|
},
|
|
],
|
|
errors: [
|
|
{
|
|
message: '"license" option must only include a single comment',
|
|
},
|
|
],
|
|
},
|
|
|
|
// content is not a single comment
|
|
{
|
|
code: dedent`
|
|
console.log('foo')
|
|
`,
|
|
|
|
options: [{ license: `console.log('hello world');` }],
|
|
errors: [
|
|
{
|
|
message: '"license" option must only include a single comment',
|
|
},
|
|
],
|
|
},
|
|
|
|
// missing license header
|
|
{
|
|
code: dedent`
|
|
console.log('foo')
|
|
`,
|
|
|
|
options: [{ license: '/* license */' }],
|
|
errors: [
|
|
{
|
|
message: 'File must start with a license header',
|
|
},
|
|
],
|
|
|
|
output: dedent`
|
|
/* license */
|
|
|
|
console.log('foo')
|
|
`,
|
|
},
|
|
|
|
// strips newlines before the license comment
|
|
{
|
|
code:
|
|
'\n\n' +
|
|
dedent`
|
|
/* license */
|
|
|
|
console.log('foo')
|
|
`,
|
|
|
|
options: [{ license: '/* license */' }],
|
|
errors: [
|
|
{
|
|
message: 'License header must be at the very beginning of the file',
|
|
},
|
|
],
|
|
|
|
output: dedent`
|
|
/* license */
|
|
|
|
console.log('foo')
|
|
`,
|
|
},
|
|
|
|
// moves license header before other nodes if necessary
|
|
{
|
|
code: dedent`
|
|
/* not license */
|
|
/* license */
|
|
console.log('foo')
|
|
`,
|
|
|
|
options: [{ license: '/* license */' }],
|
|
errors: [
|
|
{
|
|
message: 'License header must be at the very beginning of the file',
|
|
},
|
|
],
|
|
|
|
output: dedent`
|
|
/* license */
|
|
|
|
/* not license */
|
|
|
|
console.log('foo')
|
|
`,
|
|
},
|
|
],
|
|
});
|