docs: overhaul branding and add new logo (#6147)

* branding

* Fixed remaining markdownlint violations

* Switch back to typescript-eslint

* Standardize backticks before monorepo

* Trim down reasoning

* Fixed TypeScript logo blue

* Sentence

* Replace: TypeScript ESLint -> typescript-eslint

* chore: update safari pinned tab icon

* Fix snapshot

* bikeshed: ts-eslint

Co-authored-by: “JamesHenry” <james@henry.sc>

.cspell.json

@@ -52,6 +52,7 @@
     "bigint",
     "bivariant",
     "blockless",
+    "blurple",
     "camelcase",
     "Cena",
     "codebases",

.github/SECURITY.md

@@ -1,6 +1,6 @@
-# Security Policiy
+# Security Policy
 
-The TypeScript ESLint team and community take all security vulnerabilities seriously.
+The typescript-eslint team and community take all security vulnerabilities seriously.
 If you have a vulnerability or other security issues to disclose:
 
 - Thank you very much, please do!

.github/SPONSORSHIPS.md

@@ -1,14 +1,14 @@
 # Sponsorship
 
-TypeScript ESLint is an entirely volunteer-run project.
+typescript-eslint is an entirely volunteer-run project.
 We are not associated with any company or organization; our development is funded solely from community donations.
 
-## Why Sponsor TypeScript ESLint?
+## Why Sponsor typescript-eslint?
 
 Our tooling is used by the vast majority of TypeScript applications today, including nearly 10,000 dependent projects and 20 million weekly downloads on npm.
 Our packages enable both ESLint and Prettier to run on TypeScript code.
 We additionally provide a comprehensive suite of TypeScript-focused ESLint rules that, by enabling access to TypeScript's type checking APIs, can detect classifications of application bugs more advanced than ESLint alone can.
-Sponsoring TypeScript ESLint helps keep our development process running reliably, which in turn directly allows us to:
+Sponsoring typescript-eslint helps keep our development process running reliably, which in turn directly allows us to:
 
 - Support new versions of TypeScript sooner after their release
 - Continue improving our documentation and first-run experiences
@@ -36,9 +36,9 @@ You can always view all financial contributors on [opencollective.com/typescript
 
 ### Project Direction
 
-TypeScript ESLint is always appreciative of organizations sponsoring the project.
+typescript-eslint is always appreciative of organizations sponsoring the project.
 However, we do not factor sponsorship amounts into issue prioritization or pull request reviews.
-If you have a need to push forward an area of work in TypeScript ESLint more urgently than a general donation can provide, consider donating engineering time as well.
+If you have a need to push forward an area of work in typescript-eslint more urgently than a general donation can provide, consider donating engineering time as well.
 
 ### Website Placement
 

.markdownlint.json

@@ -99,11 +99,11 @@
   // MD044/proper-names - Proper names should have the correct capitalization
   "MD044": {
     "names": [
+      "ESLint",
       "JavaScript",
-      "TypeScript",
       "TSLint",
-      "ESLint",
-      "typescript-eslint"
+      "typescript-eslint",
+      "TypeScript"
     ],
     "code_blocks": false
   },

LICENSE

@@ -1,4 +1,4 @@
-TypeScript ESLint
+typescript-eslint
 
 Originally extracted from:
 
@@ -8,11 +8,11 @@ Copyright JS Foundation and other contributors, https://js.foundation
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
-  * Redistributions of source code must retain the above copyright
-    notice, this list of conditions and the following disclaimer.
-  * Redistributions in binary form must reproduce the above copyright
-    notice, this list of conditions and the following disclaimer in the
-    documentation and/or other materials provided with the distribution.
+- Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

README.md

@@ -1,6 +1,6 @@
-<h1 align="center">TypeScript ESLint</h1>
+<h1 align="center">typescript-eslint</h1>
 
-<p align="center">Monorepo for all the tooling which enables ESLint to support TypeScript</p>
+<p align="center">Monorepo for the tooling that enables ESLint and Prettier to support TypeScript</p>
 
 <p align="center">
     <img src="https://github.com/typescript-eslint/typescript-eslint/workflows/CI/badge.svg" alt="CI" />
@@ -44,4 +44,4 @@ In addition to submitting code and documentation updates, you can help us sustai
 
 ## License
 
-TypeScript ESLint inherits from the original TypeScript ESLint Parser license, as the majority of the work began there. It is licensed under a permissive BSD 2-clause license.
+typescript-eslint inherits from the original TypeScript ESLint Parser license, as the majority of the work began there. It is licensed under a permissive BSD 2-clause license.

docs/Contributing.mdx

@@ -3,7 +3,7 @@ id: contributing
 title: Contributing
 ---
 
-Thank you for your interest in contributing to TypeScript ESLint! 💜
+Thank you for your interest in contributing to typescript-eslint! 💜
 
 Although typescript-eslint's packages are already downloaded millions of times per month and power high profile projects across our industry, this is a 100% community-driven project.
 From the second you install one of the packages from this monorepo, you are a part of that community.

docs/architecture/Parser.mdx

@@ -21,7 +21,7 @@ TS's AST is optimized for its use case of parsing incomplete code and typechecki
 ESTree is unoptimized and intended for "general purpose" use-cases of traversing the AST.
 
 :::tip
-You can select `@typescript-eslint/parser` on the [TypeScript ESLint playground](https://typescript-eslint.io/play#showAST=es)'s left sidebar under _Options_ > _AST Explorer_ by selecting _ESTree_.
+You can select `@typescript-eslint/parser` on the [typescript-eslint playground](https://typescript-eslint.io/play#showAST=es)'s left sidebar under _Options_ > _AST Explorer_ by selecting _ESTree_.
 :::
 
 ## Configuration

docs/contributing/Local_Development.mdx

@@ -3,7 +3,7 @@ id: local-development
 title: Local Development
 ---
 
-Thank you for your interest in developing on TypeScript ESLint! ❤️‍🔥
+Thank you for your interest in developing on typescript-eslint! ❤️‍🔥
 
 > See [Contributing](../Contributing.mdx) and [Issues](./Issues.mdx) for details on our general contribution flows.
 

docs/linting/CONFIGURATIONS.mdx

@@ -88,12 +88,12 @@ We recommend a TypeScript project extend from `plugin:@typescript-eslint/strict`
 
 ## Other Configurations
 
-TypeScript ESLint includes a scattering of utility configurations used by the recommended configurations.
+typescript-eslint includes a scattering of utility configurations used by the recommended configurations.
 We don't recommend using these directly; instead, extend from an earlier recommended rule.
 
 ### `all`
 
-Enables each the rules provided as a part of TypeScript ESLint.
+Enables each the rules provided as a part of typescript-eslint.
 Note that many rules are not applicable in all codebases, or are meant to be configured.
 
 See [`configs/all.ts`](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/all.ts) for the exact contents of this config.
@@ -105,7 +105,7 @@ Many rules conflict with each other and/or are intended to be configured per-pro
 
 ### `base`
 
-A minimal ruleset that sets only the required parser and plugin options needed to run TypeScript ESLint.
+A minimal ruleset that sets only the required parser and plugin options needed to run typescript-eslint.
 
 <configuration-contents expanded name="base" />
 
@@ -136,6 +136,6 @@ If you feel strongly that a specific rule should (or should not) be one of these
 
 ## Formatting
 
-None of the preset configs provided by TypeScript ESLint enable formatting rules (rules that only serve to enforce code whitespace and other trivia).
+None of the preset configs provided by typescript-eslint enable formatting rules (rules that only serve to enforce code whitespace and other trivia).
 We strongly recommend you use Prettier or an equivalent for formatting your code, not ESLint formatting rules.
 See [What About Formatting? > Suggested Usage](./troubleshooting/formatting#suggested-usage).

docs/linting/Troubleshooting.md

@@ -125,7 +125,7 @@ See [#2041](https://github.com/typescript-eslint/typescript-eslint/issues/2041)
 ESLint core contains the rule [`no-restricted-syntax`](https://eslint.org/docs/rules/no-restricted-syntax).
 This generic rule allows you to specify a [selector](https://eslint.org/docs/developer-guide/selectors) for the code you want to ban, along with a custom error message.
 
-You can use an AST visualization tool such as [TypeScript ESLint playground](https://typescript-eslint.io/play#showAST=es) > _Options_ > _AST Explorer_ on its left sidebar by selecting _ESTree_ to help in figuring out the structure of the AST that you want to ban.
+You can use an AST visualization tool such as [typescript-eslint playground](https://typescript-eslint.io/play#showAST=es) > _Options_ > _AST Explorer_ on its left sidebar by selecting _ESTree_ to help in figuring out the structure of the AST that you want to ban.
 
 For example, you can ban enums (or some variation of) using one of the following configs:
 

docs/maintenance/BRANDING.md

@@ -0,0 +1,37 @@
+---
+id: branding
+title: Branding
+---
+
+This document serves as a guide for how we generally describe or represent typescript-eslint.
+It's fine if you don't always adhere to it.
+
+## Terminology
+
+### Name
+
+<!-- markdownlint-disable proper-names -->
+
+Our project name is **_"typescript-eslint"_**.
+We sometimes refer to it as _"ts-eslint"_ for short.
+
+_"typescript-eslint"_ is preferred over _"TypeScript ESLint"_ or _"TypeScript-ESLint"_ because ESLint and TypeScript are written in abbreviated Pascal Case.
+Combining lowercase with a dash helps differentiate us.
+
+<!-- markdownlint-enable proper-names -->
+
+### Slogan
+
+> The tooling that enables ESLint and Prettier to support TypeScript.
+
+## Visuals
+
+Our primary brand color is `#2656c7`, the halfway point between ESLint's `#4b32c3` purple and TypeScript's `#007acc` blue.
+You can call it _blurple_ if you want.
+
+Our logo is also a halfway between [ESLint's logo](https://en.wikipedia.org/wiki/ESLint#/media/File:ESLint_logo.svg) and [TypeScript's logo](https://en.wikipedia.org/wiki/TypeScript#/media/File:Typescript.svg):
+
+<img alt="typescript-eslint logo" src="/img/logo.svg" height="128px" width="128px" />
+
+- [Logo PNG download](/img/logo.png)
+- [Logo SVG download](/img/logo.svg)

packages/ast-spec/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 TypeScript ESLint and other contributors
+Copyright (c) 2019 typescript-eslint and other contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

packages/eslint-plugin-tslint/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 TypeScript ESLint and other contributors
+Copyright (c) 2019 typescript-eslint and other contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

packages/eslint-plugin/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 TypeScript ESLint and other contributors
+Copyright (c) 2019 typescript-eslint and other contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

packages/eslint-plugin/tools/generate-breaking-changes.ts

@@ -32,7 +32,7 @@ async function main(): Promise<void> {
       <td>Being added, deprecated, or removed</td>
       <td>
         <ul>
-          <li>🆕 = newly added to TypeScript-ESLint</li>
+          <li>🆕 = newly added to typescript-eslint</li>
           <li>🙅 = deprecated in the next major</li>
           <li>➖️ = to be removed from the plugin in the next version</li>
         </ul>

packages/experimental-utils/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 TypeScript ESLint and other contributors
+Copyright (c) 2019 typescript-eslint and other contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

packages/parser/LICENSE

@@ -4,11 +4,11 @@ Copyright JS Foundation and other contributors, https://js.foundation
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
-  * Redistributions of source code must retain the above copyright
-    notice, this list of conditions and the following disclaimer.
-  * Redistributions in binary form must reproduce the above copyright
-    notice, this list of conditions and the following disclaimer in the
-    documentation and/or other materials provided with the distribution.
+- Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

packages/scope-manager/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 TypeScript ESLint and other contributors
+Copyright (c) 2019 typescript-eslint and other contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

packages/type-utils/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 TypeScript ESLint and other contributors
+Copyright (c) 2021 typescript-eslint and other contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

packages/types/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 TypeScript ESLint and other contributors
+Copyright (c) 2019 typescript-eslint and other contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

packages/typescript-estree/LICENSE

@@ -8,11 +8,11 @@ Copyright JS Foundation and other contributors, https://js.foundation
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
-  * Redistributions of source code must retain the above copyright
-    notice, this list of conditions and the following disclaimer.
-  * Redistributions in binary form must reproduce the above copyright
-    notice, this list of conditions and the following disclaimer in the
-    documentation and/or other materials provided with the distribution.
+- Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

packages/typescript-estree/src/create-program/createProjectProgram.ts

@@ -105,7 +105,7 @@ function createProjectProgram(
       `- Change ESLint's list of included files to not include this file`,
       `- Change ${describedSpecifiers} to include this file`,
       `- Create a new TSConfig that includes this file and include it in your parserOptions.project`,
-      `See the TypeScript ESLint docs for more info: https://typescript-eslint.io/linting/troubleshooting##i-get-errors-telling-me-eslint-was-configured-to-run--however-that-tsconfig-does-not--none-of-those-tsconfigs-include-this-file`,
+      `See the typescript-eslint docs for more info: https://typescript-eslint.io/linting/troubleshooting##i-get-errors-telling-me-eslint-was-configured-to-run--however-that-tsconfig-does-not--none-of-those-tsconfigs-include-this-file`,
     );
   }