Попробуйте использовать идентификатор в родительском элементе. Может быть только один идентификатор.
wp = $('#T2_METALBAR').find('.badge-success').text();
Я как бы сократил ваш код, и он работает. Обратите внимание, что у меня есть два div с классом «badge-success», и он тянет только правильный. Может быть, это поможет вам увидеть, где ваш код или html отличается:
const cheerio = require('cheerio');
const html = "<div class='badge-success'>unwanted text<div class='card-box'>text<p id='T2_METALBAR'>text<span class='badge-success'>6--text I want</span><p></div></div>"
const $ = cheerio.load(html);
const res = $('#T2_METALBAR').find('.badge-success').text();
console.log(res); // logs '6--text I want'