-
- это специальный символ в шаблонах Lua. Чтобы сделать буквальное совпадение, ваш второй аргумент string.find
должен быть '%-%-'
.
В качестве альтернативы, если вы не хотите иметь дело с семантикой шаблона, вы можете передать 4-й аргумент true
string.find
сказать, что второй аргумент следует принимать как буквенную строку, а не как шаблон:
string.find("i want this to work --", "--", 1, true)