10000 docs: overhaul branding and add new logo (#6147) · esjs/typescript-eslint@47241bb · GitHub
[go: up one dir, main page]
Skip to content

Commit 47241bb

Browse files
JoshuaKGoldbergJamesHenry
JoshuaKGoldberg
and
JamesHenry
authored
docs: overhaul branding and add new logo (typescript-eslint#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>
1 parent 32f12b2 commit 47241bb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+216
-107
lines changed

‎.cspell.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@
5252
"bigint",
5353
"bivariant",
5454
"blockless",
55+
"blurple",
5556
"camelcase",
5657
"Cena",
5758
"codebases",

‎.github/SECURITY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Security Policiy
1+
# Security Policy
22

3-
The TypeScript ESLint team and community take all security vulnerabilities seriously.
3+
The typescript-eslint team and community take all security vulnerabilities seriously.
44
If you have a vulnerability or other security issues to disclose:
55

66
- Thank you very much, please do!

‎.github/SPONSORSHIPS.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Sponsorship
22

3-
TypeScript ESLint is an entirely volunteer-run project.
3+
typescript-eslint is an entirely volunteer-run project.
44
We are not associated with any company or organization; our development is funded solely from community donations.
55

6-
## Why Sponsor TypeScript ESLint?
6+
## Why Sponsor typescript-eslint?
77

88
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.
99
Our packages enable both ESLint and Prettier to run on TypeScript code.
1010
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.
11-
Sponsoring TypeScript ESLint helps keep our development process running reliably, which in turn directly allows us to:
11+
Sponsoring typescript-eslint helps keep our development process running reliably, which in turn directly allows us to:
1212

1313
- Support new versions of TypeScript sooner after their release
1414
- Continue improving our documentation and first-run experiences
@@ -36,9 +36,9 @@ You can always view all financial contributors on [opencollective.com/typescript
3636

3737
### Project Direction
3838

39-
TypeScript ESLint is always appreciative of organizations sponsoring the project.
39+
typescript-eslint is always appreciative of organizations sponsoring the project.
4040
However, we do not factor sponsorship amounts into issue prioritization or pull request reviews.
41-
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.
41+
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.
4242

4343
### Website Placement
4444

‎.markdownlint.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,11 +99,11 @@
9999
// MD044/proper-names - Proper names should have the correct capitalization
100100
"MD044": {
101101
"names": [
102+
"ESLint",
102103
"JavaScript",
103-
"TypeScript",
104104
"TSLint",
105-
"ESLint",
106-
"typescript-eslint"
105+
"typescript-eslint",
106+
"TypeScript"
107107
],
108108
"code_blocks": false
109109
},

‎LICENSE

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
TypeScript ESLint
1+
typescript-eslint
22

33
Originally extracted from:
44

@@ -8,11 +8,11 @@ Copyright JS Foundation and other contributors, https://js.foundation
88
Redistribution and use in source and binary forms, with or without
99
modification, are permitted provided that the following conditions are met:
1010

11-
* Redistributions of source code must retain the above copyright
12-
notice, this list of conditions and the following disclaimer.
13-
* Redistributions in binary form must reproduce the above copyright
14-
notice, this list of conditions and the following disclaimer in the
15-
documentation and/or other materials provided with the distribution.
11+
- Redistributions of source code must retain the above copyright
12+
notice, this list of conditions and the following disclaimer.
13+
- Redistributions in binary form must reproduce the above copyright
14+
notice, this list of conditions and the following disclaimer in the
15+
documentation and/or other materials provided with the distribution.
1616

1717
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
1818
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

‎README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
<h1 align="center">TypeScript ESLint</h1>
1+
<h1 align="center">typescript-eslint</h1>
22

3-
<p align="center">Monorepo for all the tooling which enables ESLint to support TypeScript</p>
3+
<p align="center">Monorepo for the tooling that enables ESLint and Prettier to support TypeScript</p>
44

55
<p align="center">
66
<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
4444

4545
## License
4646

47-
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.
47+
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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: contributing
33
title: Contributing
44
---
55

6-
Thank you for your interest in contributing to TypeScript ESLint! 💜
6+
Thank you for your interest in contributing to typescript-eslint! 💜
77

88
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.
99
From the second you install one of the packages from this monorepo, you are a part of that community.

‎docs/architecture/Parser.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ TS's AST is optimized for its use case of parsing incomplete code and typechecki
2121
ESTree is unoptimized and intended for "general purpose" use-cases of traversing the AST.
2222

2323
:::tip
24-
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_.
24+
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_.
2525
:::
2626

2727
## Configuration

‎docs/contributing/Local_Development.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: local-development
33
title: Local Development
44
---
55

6-
Thank you for your interest in developing on TypeScript ESLint! ❤️‍🔥
6+
Thank you for your interest in developing on typescript-eslint! ❤️‍🔥
77

88
> See [Contributing](../Contributing.mdx) and [Issues](./Issues.mdx) for details on our general contribution flows.
99

‎docs/linting/CONFIGURATIONS.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,12 +88,12 @@ We recommend a TypeScript project extend from `plugin:@typescript-eslint/strict`
8888

8989
## Other Configurations
9090

91-
TypeScript ESLint includes a scattering of utility configurations used by the recommended configurations.
91+
typescript-eslint includes a scattering of utility configurations used by the recommended configurations.
9292
We don't recommend using these directly; instead, extend from an earlier recommended rule.
9393

9494
### `all`
9595

96-
Enables each the rules provided as a part of TypeScript ESLint.
96+
Enables each the rules provided as a part of typescript-eslint.
9797
Note that many rules are not applicable in all codebases, or are meant to be configured.
9898

9999
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
105105

106106
### `base`
107107

108-
A minimal ruleset that sets only the required parser and plugin options needed to run TypeScript ESLint.
108+
A minimal ruleset that sets only the required parser and plugin options needed to run typescript-eslint.
109109

110110
<configuration-contents expanded name="base" />
111111

@@ -136,6 +136,6 @@ If you feel strongly that a specific rule should (or should not) be one of these
136136

137137
## Formatting
138138

139-
None of the preset configs provided by TypeScript ESLint enable formatting rules (rules that only serve to enforce code whitespace and other trivia).
139+
None of the preset configs provided by typescript-eslint enable formatting rules (rules that only serve to enforce code whitespace and other trivia).
140140
We strongly recommend you use Prettier or an equivalent for formatting your code, not ESLint formatting rules.
141141
See [What About Formatting? > Suggested Usage](./troubleshooting/formatting#suggested-usage).

0 commit comments

Comments
 (0)
0