const Attendant = require('turndown-attendant');
const TurndownService = require('../lib/turndown.cjs');
const attendant = new Attendant({
file: `${__dirname}/index.html`,
TurndownService: TurndownService,
});
const test = attendant.test;
attendant.run();
test('malformed documents', function(t) {
t.plan(0);
const turndownService = new TurndownService();
turndownService.turndown('');
t.end();
});
test('null input', function(t) {
t.plan(1);
const turndownService = new TurndownService();
t.throws(
function() { turndownService.turndown(null); }, /null is not a string/
);
});
test('undefined input', function(t) {
t.plan(1);
const turndownService = new TurndownService();
t.throws(
function() { turndownService.turndown(void (0)); },
/undefined is not a string/
);
});
test('#addRule returns the instance', function(t) {
t.plan(1);
const turndownService = new TurndownService();
const rule = {
filter: ['del', 's', 'strike'],
replacement: function(content) {
return `~~${content}~~`;
},
};
t.equal(turndownService.addRule('strikethrough', rule), turndownService);
});
test('#addRule adds the rule', function(t) {
t.plan(2);
const turndownService = new TurndownService();
const rule = {
filter: ['del', 's', 'strike'],
replacement: function(content) {
return `~~${content}~~`;
},
};
// Assert rules#add is called
turndownService.rules.add = function(key, r) {
t.equal(key, 'strikethrough');
t.equal(rule, r);
};
turndownService.addRule('strikethrough', rule);
});
test('#use returns the instance for chaining', function(t) {
t.plan(1);
const turndownService = new TurndownService();
t.equal(turndownService.use(function plugin() {}), turndownService);
});
test('#use with a single plugin calls the fn with instance', function(t) {
t.plan(1);
const turndownService = new TurndownService();
function plugin(service) {
t.equal(service, turndownService);
}
turndownService.use(plugin);
});
test('#use with multiple plugins calls each fn with instance', function(t) {
t.plan(2);
const turndownService = new TurndownService();
function plugin1(service) {
t.equal(service, turndownService);
}
function plugin2(service) {
t.equal(service, turndownService);
}
turndownService.use([plugin1, plugin2]);
});
test('#keep keeps elements as HTML', function(t) {
t.plan(2);
const turndownService = new TurndownService();
const input = 'Hello worldWorld
';
// Without `.keep(['del', 'ins'])`
t.equal(turndownService.turndown(input), 'Hello worldWorld');
// With `.keep(['del', 'ins'])`
turndownService.keep(['del', 'ins']);
t.equal(
turndownService.turndown('Hello worldWorld
'),
'Hello worldWorld'
);
});
test('#keep returns the TurndownService instance for chaining', function(t) {
t.plan(1);
const turndownService = new TurndownService();
t.equal(turndownService.keep(['del', 'ins']), turndownService);
});
test('keep rules are overridden by the standard rules', function(t) {
t.plan(1);
const turndownService = new TurndownService();
turndownService.keep('p');
t.equal(turndownService.turndown('Hello world
'), 'Hello world');
});
test('keepReplacement can be customised', function(t) {
t.plan(1);
const turndownService = new TurndownService({
keepReplacement: function(content, node) {
return `\n\n${node.outerHTML}\n\n`;
},
});
turndownService.keep(['del', 'ins']);
t.equal(turndownService.turndown(
'Hello worldWorld
'),
'Hello \n\nworld\n\nWorld'
);
});
test('#remove removes elements', function(t) {
t.plan(2);
const turndownService = new TurndownService();
const input = 'Please redact me';
// Without `.remove('del')`
t.equal(turndownService.turndown(input), 'Please redact me');
// With `.remove('del')`
turndownService.remove('del');
t.equal(turndownService.turndown(input), '');
});
test('#remove returns the TurndownService instance for chaining', function(t) {
t.plan(1);
const turndownService = new TurndownService();
t.equal(turndownService.remove(['del', 'ins']), turndownService);
});
test('remove elements are overridden by rules', function(t) {
t.plan(1);
const turndownService = new TurndownService();
turndownService.remove('p');
t.equal(turndownService.turndown('Hello world
'), 'Hello world');
});
test('remove elements are overridden by keep', function(t) {
t.plan(1);
const turndownService = new TurndownService();
turndownService.keep(['del', 'ins']);
turndownService.remove(['del', 'ins']);
t.equal(turndownService.turndown(
'Hello worldWorld
'),
'Hello worldWorld'
);
});