trekhleb/state-of-the-art-shitcode is tracked by TopGit as a frontend project, with 6.2k stars on GitHub. ๐ฉState-of-the-art shitcode principles your project should follow to call it a proper shitcode
Snapshot summary built from the project's own GitHub metadata โ there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then โ see the READ ME tab for the original README in full.
๐ฉ Name variables in a way as if your code was already obfuscated
Fewer keystrokes, more time for you.
Good ๐๐ป
let a = 42;
Bad ๐๐ป
let age = 42;
๐ฉ Mix variable/functions naming style
Celebrate the difference.
Good ๐๐ป
let wWidth = 640;
let w_height = 480;
Bad ๐๐ป
let windowWidth = 640;
let windowHeight = 480;
๐ฉ Never write comments
No one is going to read your code anyway.
Good ๐๐ป
const cdr = 700;
Bad ๐๐ป
More often comments should contain some 'why' and not some 'what'. If the 'what' is not clear in the code, the code is probably too messy.
// The number of 700ms has been calculated empirically based on UX A/B test results.
// @see: <link to experiment or to related JIRA task or to something that explains number 700 in details>
const callbackDebounceRate = 700;
๐ฉ Always write comments in your native language
If you violated the "No comments" principle then at least try to write comments in a language that is different from the language you use to write the code. If your native language is English you may violate this principle.
let x = 5;
function square() {
x = x ** 2;
}
square(); // Now x is 25.
Bad ๐๐ป
let x = 5;
function square(num) {
return num ** 2;
}
x = square(x); // Now x is 25.
๐ฉ Create variables that you're not going to use.
Just in case.
Good ๐๐ป
function sum(a, b, c) {
const timeout = 1300;
const result = a + b;
return a + b;
}
Bad ๐๐ป
function sum(a, b) {
return a + b;
}
๐ฉ Don't specify types and/or don't do type checks if language allows you to do so.
Good ๐๐ป
function sum(a, b) {
return a + b;
}
// Having untyped fun here.
const guessWhat = sum([], {}); // -> "[object Object]"
const guessWhatAgain = sum({}, []); // -> 0
Bad ๐๐ป
function sum(a: number, b: number): ?number {
// Covering the case when we don't do transpilation and/or Flow type checks in JS.
if (typeof a !== 'number' && typeof b !== 'number') {
return undefined;
}
return a + b;
}
// This one should fail during the transpilation/compilation.
const guessWhat = sum([], {}); // -> undefined
๐ฉ You need to have an unreachable piece of code
This is your "Plan B".
Good ๐๐ป
function square(num) {
if (typeof num === 'undefined') {
return undefined;
}
else {
return num ** 2;
}
return null; // This is my "Plan B".
}
Bad ๐๐ป
function square(num) {
if (typeof num === 'undefined') {
return undefined;
}
return num ** 2;
}
๐ฉ Triangle principle
Be like a bird - nest, nest, nest.
Good ๐๐ป
function someFunction() {
if (condition1) {
if (condition2) {
asyncFunction(params, (result) => {
if (result) {
for (;;) {
if (condition3) {
}
}
}
})
}
}
}
Bad ๐๐ป
async function someFunction() {
if (!condition1 || !condition2) {
return;
}
const result = await asyncFunction(params);
if (!result) {
return;
}
for (;;) {
if (condition3) {
}
}
}
๐ฉ Mess with indentations
Avoid indentations since they make complex code take up more space in the editor. If you're not feeling like avoiding them then just mess with them.
Update your dependencies on each new installation in uncontrolled way. Why stick to the past, let's use the cutting edge libraries versions.
Good ๐๐ป
$ ls -la
package.json
Bad ๐๐ป
$ ls -la
package.json
package-lock.json
๐ฉ Always name your boolean value a flag
Leave the space for your colleagues to think what the boolean value means.
Good ๐๐ป
let flag = true;
Bad ๐๐ป
let isDone = false;
let isEmpty = false;
๐ฉ Long-read functions are better than short ones.
Don't divide a program logic into readable pieces. What if your IDE's search breaks and you will not be able to find the necessary file or function?
10000 lines of code in one file is OK.
1000 lines of a function body is OK.
Dealing with many services (3rd party and internal, also, there are some helpers, database hand-written ORM and jQuery slider) in one service.js? It's OK.
๐ฉ Avoid covering your code with tests
This is a duplicate and unnecessary amount of work.
๐ฉ As hard as you can try to avoid code linters
Write code as you want, especially if there is more than one developer in a team. This is a "freedom" principle.
๐ฉ Start your project without a README file.
And keep it that way for the time being.
๐ฉ You need to have unnecessary code
Don't delete the code your app doesn't use. At most, comment it.
Does trekhleb/state-of-the-art-shitcode have a project website?
No homepage URL was recorded for trekhleb/state-of-the-art-shitcode in TopGit's last sync. The README tab above frequently contains screenshots and demo links, or check the repository description on GitHub.
How active is development on trekhleb/state-of-the-art-shitcode?
The most recent commit recorded on trekhleb/state-of-the-art-shitcode was 11 months ago, based on the GitHub push timestamp. The repository has 335 forks โ one of the better signals of community interest.
Is trekhleb/state-of-the-art-shitcode open source?
Yes โ trekhleb/state-of-the-art-shitcode ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/trekhleb/state-of-the-art-shitcode.
What license does trekhleb/state-of-the-art-shitcode use?
trekhleb/state-of-the-art-shitcode is released under the MIT license. Always verify the LICENSE file directly on GitHub for the authoritative terms โ license strings can be edited out of sync with a project's actual stance.
What topics is trekhleb/state-of-the-art-shitcode associated with?
GitHub's repository topics for trekhleb/state-of-the-art-shitcode: "best-practice", "best-practices", "code-quality", "coding", "javascript", "principles", "programming", "style-guides", "styleguide". TopGit's editorial category is Frontend.
Where do I read more about trekhleb/state-of-the-art-shitcode?
This TopGit page is a snapshot โ the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/trekhleb/state-of-the-art-shitcode is the definitive source.
Read full README in the tab above.
Is state-of-the-art-shitcode worth your time?
ChatGPT, Claude and Perplexity can all read this page. Ask one of them what it makes of state-of-the-art-shitcode.