bc96f0e25f
This pull request closes #2551: making sure that the keywords don't already appear in the example's title. I also added validation that checks that they are at least two characters long, as this is enforced by the homepage when type your search.
75 lines
2.1 KiB
JavaScript
75 lines
2.1 KiB
JavaScript
'use strict'
|
|
|
|
const { expect } = require('chai')
|
|
const { validateExample } = require('./transform-example')
|
|
|
|
describe('validateExample function', function() {
|
|
it('passes valid examples', function() {
|
|
const validExamples = [
|
|
{
|
|
title: 'Package manager versioning badge',
|
|
staticPreview: { message: '123' },
|
|
pattern: 'dt/:package',
|
|
namedParams: { package: 'mypackage' },
|
|
keywords: ['semver', 'management'],
|
|
},
|
|
]
|
|
|
|
validExamples.forEach(example => {
|
|
expect(() =>
|
|
validateExample(example, 0, { route: {}, name: 'mockService' })
|
|
).not.to.throw(Error)
|
|
})
|
|
})
|
|
|
|
it('rejects invalid examples', function() {
|
|
const invalidExamples = [
|
|
{},
|
|
{ staticPreview: { message: '123' } },
|
|
{
|
|
staticPreview: { message: '123' },
|
|
pattern: 'dt/:package',
|
|
namedParams: { package: 'mypackage' },
|
|
exampleUrl: 'dt/mypackage',
|
|
},
|
|
{ staticPreview: { message: '123' }, pattern: 'dt/:package' },
|
|
{
|
|
staticPreview: { message: '123' },
|
|
pattern: 'dt/:package',
|
|
previewUrl: 'dt/mypackage',
|
|
},
|
|
{
|
|
staticPreview: { message: '123' },
|
|
pattern: 'dt/:package',
|
|
exampleUrl: 'dt/mypackage',
|
|
},
|
|
{ previewUrl: 'dt/mypackage' },
|
|
{
|
|
staticPreview: { message: '123' },
|
|
pattern: 'dt/:package',
|
|
namedParams: { package: 'mypackage' },
|
|
keywords: ['a'], // Keyword too short.
|
|
},
|
|
{
|
|
staticPreview: { message: '123' },
|
|
pattern: 'dt/:package',
|
|
namedParams: { package: 'mypackage' },
|
|
keywords: ['mockService'], // No title and keyword matching the class name.
|
|
},
|
|
{
|
|
title: 'Package manager versioning badge',
|
|
staticPreview: { message: '123' },
|
|
pattern: 'dt/:package',
|
|
namedParams: { package: 'mypackage' },
|
|
keywords: ['version'], // Keyword included in title.
|
|
},
|
|
]
|
|
|
|
invalidExamples.forEach(example => {
|
|
expect(() =>
|
|
validateExample(example, 0, { route: {}, name: 'mockService' })
|
|
).to.throw(Error)
|
|
})
|
|
})
|
|
})
|