mochajs / mocha

β˜•οΈ simple, flexible, fun javascript test framework for node.js & the browser
https://mochajs.org
MIT License
22.6k stars 3.01k forks source link

πŸ“ Docs: Standardize slogan as something without "simple" #5065

Open JoshuaKGoldberg opened 10 months ago

JoshuaKGoldberg commented 10 months ago

Documentation Request Checklist

Overview

Words like "easy" and "simple" are often used in writing to convey that something doesn't require extra complications or tooling. But they also mean in English that something should be literally "easy" or "simple" - which often isn't the case for devs new to a technology. It's good writing practice to use more precise adjectives instead.

Right now the Mocha slogan is "Simple, flexible, fun JavaScript test framework for Node.js & The Browser": https://github.com/mochajs/mocha/blob/645469e1920e2e86458ff068e74eef2e2915083e/README.md?plain=1#L5

Let's use a slogan that doesn't say "simple". Maybe just "flexible and fun" is enough?

Additional Info

https://justsimply.dev is a good resource that goes into more detail and has examples.

JoshuaKGoldberg commented 8 months ago

Food for thought, folks occasionally express a need for cross-JS-runtime tests. Example from https://twitter.com/_nicojs/status/1762508703863894472:

Nicholas C. Zakas @slicknet What I want: To write JavaScript tests once and be able to run them across Node.js, Bun, and Deno. Problem: Bun and Deno have built-in test runners you have to import from to run tests. I use Mocha. This doesn't work. Solution: ???

voxpelli commented 3 months ago

Maybe:

Classic reliable spec-style JavaScript test framework for Node.js & The Browser β˜•οΈ

Or more cheeky:

The classic spec-style JavaScript test framework for Node.js & The Browser β˜•οΈ

Simple, flexible, fun were all mantras in the beginning, now I think the focus should be more on being a reliable, trusted, no-thrills classic spec-style test runner – to maintain what works, not to push the boundaries.

JoshuaKGoldberg commented 3 months ago

I like the idea on focusing on reliable and trusted. Maybe both of those can become part of the mantra?

"spec-style" is -1 from me because many devs these don't know or care about assertion styles. This isn't a phrase many newer devs know of.

How about:

The classic reliable and trusted JavaScript test framework for Node.js & the Browser β˜•

Or with commas:

The classic, reliable, and trusted JavaScript test framework for Node.js & the Browser β˜•

JoshuaKGoldberg commented 1 month ago

Coming back to this, my vote is on:

The classic, reliable, trusted JavaScript test framework for Node.js & the Browser. β˜•

cc @mochajs/maintenance-crew

Edit: oh, and once Bun & Deno are supported per #5108 down the road:

The classic, cross-runtime, reliable JavaScript test framework for browsers, Node.js, and more. β˜•

mark-wiemer commented 3 days ago

Maybe instead of cross-runtime, you could use runtime-agnostic? Though I guess agnostic is more syllables!