diff --git a/.cspell.json b/.cspell.json index bd8761c00efd..f1806362b478 100644 --- a/.cspell.json +++ b/.cspell.json @@ -52,6 +52,7 @@ "bigint", "bivariant", "blockless", + "blurple", "camelcase", "Cena", "codebases", diff --git a/.github/SECURITY.md b/.github/SECURITY.md index 536720ad67e8..b7d6d324c54e 100644 --- a/.github/SECURITY.md +++ b/.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! diff --git a/.github/SPONSORSHIPS.md b/.github/SPONSORSHIPS.md index 48d8ae5fc743..d746aff13ba6 100644 --- a/.github/SPONSORSHIPS.md +++ b/.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 diff --git a/.markdownlint.json b/.markdownlint.json index 5d8a01896c6d..05206c4297d1 100644 --- a/.markdownlint.json +++ b/.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 }, diff --git a/LICENSE b/LICENSE index 82e1ce3c4602..61fed5676879 100644 --- a/LICENSE +++ b/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 diff --git a/README.md b/README.md index c1934b1c4484..5241dbda4a26 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -

TypeScript ESLint

+

typescript-eslint

-

Monorepo for all the tooling which enables ESLint to support TypeScript

+

Monorepo for the tooling that enables ESLint and Prettier to support TypeScript

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. diff --git a/docs/Contributing.mdx b/docs/Contributing.mdx index 35846cdaaae0..852e503c2694 100644 --- a/docs/Contributing.mdx +++ b/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. diff --git a/docs/architecture/Parser.mdx b/docs/architecture/Parser.mdx index 185d67d35808..9f5d51a53bb6 100644 --- a/docs/architecture/Parser.mdx +++ b/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 diff --git a/docs/contributing/Local_Development.mdx b/docs/contributing/Local_Development.mdx index 294435616b70..3f85bd9c90b8 100644 --- a/docs/contributing/Local_Development.mdx +++ b/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. diff --git a/docs/linting/CONFIGURATIONS.mdx b/docs/linting/CONFIGURATIONS.mdx index 03227ce0cced..a620083fa714 100644 --- a/docs/linting/CONFIGURATIONS.mdx +++ b/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. @@ -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). diff --git a/docs/linting/Troubleshooting.md b/docs/linting/Troubleshooting.md index 98d0eddb8257..f1aff9346bb5 100644 --- a/docs/linting/Troubleshooting.md +++ b/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: diff --git a/docs/maintenance/BRANDING.md b/docs/maintenance/BRANDING.md new file mode 100644 index 000000000000..25c08b216e65 --- /dev/null +++ b/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 + + + +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. + + + +### 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): + +typescript-eslint logo + +- [Logo PNG download](/img/logo.png) +- [Logo SVG download](/img/logo.svg) diff --git a/packages/ast-spec/LICENSE b/packages/ast-spec/LICENSE index 7e7370143b26..a1164108d4d6 100644 --- a/packages/ast-spec/LICENSE +++ b/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 diff --git a/packages/eslint-plugin-tslint/LICENSE b/packages/eslint-plugin-tslint/LICENSE index 7e7370143b26..a1164108d4d6 100644 --- a/packages/eslint-plugin-tslint/LICENSE +++ b/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 diff --git a/packages/eslint-plugin/LICENSE b/packages/eslint-plugin/LICENSE index 7e7370143b26..a1164108d4d6 100644 --- a/packages/eslint-plugin/LICENSE +++ b/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 diff --git a/packages/eslint-plugin/tools/generate-breaking-changes.ts b/packages/eslint-plugin/tools/generate-breaking-changes.ts index 9b1ecafff4ca..0b7da7172872 100644 --- a/packages/eslint-plugin/tools/generate-breaking-changes.ts +++ b/packages/eslint-plugin/tools/generate-breaking-changes.ts @@ -32,7 +32,7 @@ async function main(): Promise { Being added, deprecated, or removed

diff --git a/packages/experimental-utils/LICENSE b/packages/experimental-utils/LICENSE index 7e7370143b26..a1164108d4d6 100644 --- a/packages/experimental-utils/LICENSE +++ b/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 diff --git a/packages/parser/LICENSE b/packages/parser/LICENSE index a2d896685ac9..dc04d8c91c06 100644 --- a/packages/parser/LICENSE +++ b/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 diff --git a/packages/scope-manager/LICENSE b/packages/scope-manager/LICENSE index 7e7370143b26..a1164108d4d6 100644 --- a/packages/scope-manager/LICENSE +++ b/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 diff --git a/packages/type-utils/LICENSE b/packages/type-utils/LICENSE index 7641edcfd0af..dabd464af3a2 100644 --- a/packages/type-utils/LICENSE +++ b/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 diff --git a/packages/types/LICENSE b/packages/types/LICENSE index 7e7370143b26..a1164108d4d6 100644 --- a/packages/types/LICENSE +++ b/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 diff --git a/packages/typescript-estree/LICENSE b/packages/typescript-estree/LICENSE index fda3b7546aa5..f6d73403f2f0 100644 --- a/packages/typescript-estree/LICENSE +++ b/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 diff --git a/packages/typescript-estree/src/create-program/createProjectProgram.ts b/packages/typescript-estree/src/create-program/createProjectProgram.ts index 784b44b93d4d..9869a6e4e541 100644 --- a/packages/typescript-estree/src/create-program/createProjectProgram.ts +++ b/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`, ); } diff --git a/packages/typescript-estree/tests/lib/__snapshots__/parse.test.ts.snap b/packages/typescript-estree/tests/lib/__snapshots__/parse.test.ts.snap index 108fdad11a14..369094739305 100644 --- a/packages/typescript-estree/tests/lib/__snapshots__/parse.test.ts.snap +++ b/packages/typescript-estree/tests/lib/__snapshots__/parse.test.ts.snap @@ -23,7 +23,7 @@ However, that TSConfig does not include this file. Either: - Change ESLint's list of included files to not include this file - Change that TSConfig 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" `; exports[`parseAndGenerateServices invalid file error messages "parserOptions.extraFileExtensions" is non-empty the extension matches the file isn't included 1`] = ` @@ -32,7 +32,7 @@ However, that TSConfig does not include this file. Either: - Change ESLint's list of included files to not include this file - Change that TSConfig 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" `; exports[`parseAndGenerateServices invalid file error messages project includes errors for not included files 1`] = ` @@ -41,7 +41,7 @@ However, that TSConfig does not include this file. Either: - Change ESLint's list of included files to not include this file - Change that TSConfig 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" `; exports[`parseAndGenerateServices invalid file error messages project includes errors for not included files 2`] = ` @@ -50,7 +50,7 @@ However, that TSConfig does not include this file. Either: - Change ESLint's list of included files to not include this file - Change that TSConfig 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" `; exports[`parseAndGenerateServices invalid file error messages project includes errors for not included files 3`] = ` @@ -59,7 +59,7 @@ However, that TSConfig does not include this file. Either: - Change ESLint's list of included files to not include this file - Change that TSConfig 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" `; exports[`parseAndGenerateServices invalid file error messages project includes errors for not included files 4`] = ` @@ -68,7 +68,7 @@ However, that TSConfig does not include this file. Either: - Change ESLint's list of included files to not include this file - Change that TSConfig 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" `; exports[`parseAndGenerateServices invalid project error messages throws when non of multiple projects include the file 1`] = ` @@ -79,7 +79,7 @@ However, none of those TSConfigs include this file. Either: - Change ESLint's list of included files to not include this file - Change one of those TSConfigs 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" `; exports[`parseAndGenerateServices isolated parsing should parse .js file - with JSX content - parserOptions.jsx = false 1`] = ` diff --git a/packages/utils/LICENSE b/packages/utils/LICENSE index 7e7370143b26..a1164108d4d6 100644 --- a/packages/utils/LICENSE +++ b/packages/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 diff --git a/packages/visitor-keys/LICENSE b/packages/visitor-keys/LICENSE index 7e7370143b26..a1164108d4d6 100644 --- a/packages/visitor-keys/LICENSE +++ b/packages/visitor-keys/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 diff --git a/packages/website/blog/2022-09-18-automated-rule-docs-with-docusaurus-and-remark.md b/packages/website/blog/2022-09-18-automated-rule-docs-with-docusaurus-and-remark.md index 58dd129cddf2..a1c5d205a025 100644 --- a/packages/website/blog/2022-09-18-automated-rule-docs-with-docusaurus-and-remark.md +++ b/packages/website/blog/2022-09-18-automated-rule-docs-with-docusaurus-and-remark.md @@ -2,15 +2,15 @@ authors: - image_url: https://www.joshuakgoldberg.com/img/josh.jpg name: Josh Goldberg - title: TypeScript ESLint Maintainer + title: typescript-eslint Maintainer url: https://github.com/JoshuaKGoldberg -description: How TypeScript ESLint generates much of the docs pages for each of its lint rules. +description: How typescript-eslint generates much of the docs pages for each of its lint rules. slug: automated-rule-docs-with-docusaurus-and-remark tags: [documentation, docusaurus, remark] title: Automated Rule Docs With Docusaurus and Remark --- -The TypeScript ESLint website at https://typescript-eslint.io is the canonical location for documentation on how to use ESLint on TypeScript code. +The typescript-eslint website at https://typescript-eslint.io is the canonical location for documentation on how to use ESLint on TypeScript code. The site includes a documentation page for each of the over 100 ESLint rules exposed by its ESLint plugin. Each of those rule docs pages includes a description of the rule, any options it allows, links to its source code, and other important information about its usage. @@ -87,7 +87,7 @@ The [`@typescript-eslint/no-for-in-array` rule](https://typescript-eslint.io/rul Our Remark plugin: 1. Takes in the AST and metadata of a documentation file -2. Tries to find the corresponding TypeScript ESLint rule for the file's name +2. Tries to find the corresponding typescript-eslint rule for the file's name 3. If one was found, applies a set of modifications to the AST The rest of this section of the blog post will give a high-level overview of what kinds of AST modifications take place. @@ -95,7 +95,7 @@ You can dive into [the source code of our plugin](https://github.com/typescript- ### Matching Docs to Rules -The [`@typescript-eslint/eslint-plugin` package](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin) exports an object with a `rules` property containing all the TypeScript ESLint lint rules. +The [`@typescript-eslint/eslint-plugin` package](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin) exports an object with a `rules` property containing all the typescript-eslint lint rules. Properties have names like `"array-type"` that map to the rule object exported by files like [`array-type.ts`](https://github.com/typescript-eslint/typescript-eslint/blob/39829c01906f326fec94e9b3a5fdb1730eb02002/packages/eslint-plugin/src/rules/array-type.ts#L86). Remark plugins are able to access the name of the file they're modifying by accessing `file.stem`, as in the following code snippet. @@ -144,7 +144,7 @@ root.children.splice( ``` :::info Historical context -Before typescript-eslint.io existed, the canonical documentation URL for TypeScript ESLint's lint rules was the GitHub link to their corresponding `.md` file. +Before typescript-eslint.io existed, the canonical documentation URL for typescript-eslint's lint rules was the GitHub link to their corresponding `.md` file. Now that we have a rich documentation site and have automated much of what used to be in those `.md` files, they're no longer a good place to look for documentation. ::: @@ -221,8 +221,8 @@ We'd like to extend thanks to [Joshua Chen](https://github.com/Josh-Cena), one o Without Joshua, this change would have taken us a great deal longer (if we'd have been able to tackle it at all). Thanks Joshua! 🤗 -## Supporting TypeScript ESLint +## Supporting typescript-eslint -If you enjoyed this blog post and/or or use TypeScript ESLint, please consider [supporting us on Open Collective](https://opencollective.com/typescript-eslint). +If you enjoyed this blog post and/or or use typescript-eslint, please consider [supporting us on Open Collective](https://opencollective.com/typescript-eslint). We're a small volunteer team and could use your support to make the ESLint experience on TypeScript great. Thanks! 💖 diff --git a/packages/website/blog/2022-12-05-asts-and-typescript-eslint.md b/packages/website/blog/2022-12-05-asts-and-typescript-eslint.md index 17da83da75d0..47cb9374c901 100644 --- a/packages/website/blog/2022-12-05-asts-and-typescript-eslint.md +++ b/packages/website/blog/2022-12-05-asts-and-typescript-eslint.md @@ -2,12 +2,12 @@ authors: - image_url: https://www.joshuakgoldberg.com/img/josh.jpg name: Josh Goldberg - title: TypeScript ESLint Maintainer + title: typescript-eslint Maintainer url: https://github.com/JoshuaKGoldberg description: Describing what an AST (Abstract Syntax Tree) is and why it's useful for ESLint and TypeScript tooling. slug: asts-and-typescript-eslint tags: [ast, abstract syntax tree, parser, parsing, prettier] -title: ASTs and TypeScript-ESLint +title: ASTs and typescript-eslint --- Programmers who work with tools like [ESLint](https://eslint.org) and [Prettier](https://prettier.io) often refer to ASTs. @@ -92,7 +92,7 @@ We commonly refer to the ESTree format that also includes TypeScript-specific sy ### AST Playground -The [TypeScript ESLint playground](https://typescript-eslint.io/play#showAST=es) contains an AST explorer that generates an interactive AST for any code entered into the playground. +The [typescript-eslint playground](https://typescript-eslint.io/play#showAST=es) contains an AST explorer that generates an interactive AST for any code entered into the playground. You can activate it under _Options_ > _AST Explorer_ on its left sidebar by selecting the value of _AST Viewer_. ## Further Resources @@ -116,7 +116,7 @@ Putting together all the terms introduces in this article: ### TypeScript Lint Rules and ASTs Interested in how these ASTs work with ESLint rules? -We collaborated with our friends at Sourcegraph on a [Tour de Source on TypeScript ESLint](https://sourcegraph.com/notebooks/Tm90ZWJvb2s6MTA2OA==). +We collaborated with our friends at Sourcegraph on a [Tour de Source on typescript-eslint](https://sourcegraph.com/notebooks/Tm90ZWJvb2s6MTA2OA==). Read on to learn how ESLint rules use ASTs to analyze code files and, thanks to `@typescript-eslint/parser`, call TypeScript's type checking APIs to analyze code. [astexplorer.net]: https://astexplorer.net diff --git a/packages/website/docusaurusConfig.ts b/packages/website/docusaurusConfig.ts index 7ad2d275be8a..bfa844fc2f0b 100644 --- a/packages/website/docusaurusConfig.ts +++ b/packages/website/docusaurusConfig.ts @@ -66,7 +66,7 @@ const themeConfig: ThemeCommonConfig & AlgoliaThemeConfig = { ], image: 'img/logo-twitter-card.png', navbar: { - title: 'TypeScript ESLint', + title: 'typescript-eslint', logo: { alt: '', height: '32px', @@ -142,7 +142,7 @@ const themeConfig: ThemeCommonConfig & AlgoliaThemeConfig = { ], }, ], - copyright: `Copyright © ${new Date().getFullYear()} TypeScript ESLint, Inc. Built with Docusaurus.`, + copyright: `Copyright © ${new Date().getFullYear()} typescript-eslint, Inc. Built with Docusaurus.`, }, prism: { theme: { @@ -232,8 +232,9 @@ const pluginPwaOptions: PluginPwaOptions = { }; const config: Config = { - title: 'TypeScript ESLint', - tagline: 'Tooling which enables ESLint to support TypeScript', + title: 'typescript-eslint', + tagline: + 'The tooling that enables ESLint and Prettier to support TypeScript.', url: 'https://typescript-eslint.io', baseUrl: '/', onBrokenLinks: 'throw', @@ -275,6 +276,11 @@ const config: Config = { rel: 'manifest', href: '/img/favicon/site.webmanifest', }, + { + color: '#2656c7', + href: '/img/favicon/safari-pinned-tab.svg', + rel: 'mask-icon', + }, ], }; diff --git a/packages/website/sidebars/sidebar.base.js b/packages/website/sidebars/sidebar.base.js index a949c9f2390a..fe84b9c1ae39 100644 --- a/packages/website/sidebars/sidebar.base.js +++ b/packages/website/sidebars/sidebar.base.js @@ -67,6 +67,7 @@ module.exports = { }, { items: [ + 'maintenance/branding', { collapsible: false, items: ['maintenance/issues/rule-deprecations'], diff --git a/packages/website/src/components/FinancialContributors/Sponsors/styles.module.css b/packages/website/src/components/FinancialContributors/Sponsors/styles.module.css index 08e99b16488d..b92051eddcba 100644 --- a/packages/website/src/components/FinancialContributors/Sponsors/styles.module.css +++ b/packages/website/src/components/FinancialContributors/Sponsors/styles.module.css @@ -7,7 +7,7 @@ display: flex; flex-wrap: wrap; justify-content: center; - align-items: flex-end; + align-items: stretch; max-width: 800px; padding: 0; } @@ -19,6 +19,7 @@ } .sponsorsTier img { + background: white; display: block; margin: auto; } diff --git a/packages/website/src/components/FinancialContributors/index.tsx b/packages/website/src/components/FinancialContributors/index.tsx index f952a5a42354..e0f83e34293b 100644 --- a/packages/website/src/components/FinancialContributors/index.tsx +++ b/packages/website/src/components/FinancialContributors/index.tsx @@ -10,8 +10,8 @@ export function FinancialContributors(): JSX.Element { return ( <>

- The TypeScript ESLint project would not be possible without the generous - support of our financial contributors. + The typescript-estlint project would not be possible without the + generous support of our financial contributors.

+ + + +Created by potrace 1.14, written by Peter Selinger 2001-2017 + + + + + + + diff --git a/packages/website/static/img/favicon/site.webmanifest b/packages/website/static/img/favicon/site.webmanifest index ba9eb3dcb7b9..938ae458ef30 100644 --- a/packages/website/static/img/favicon/site.webmanifest +++ b/packages/website/static/img/favicon/site.webmanifest @@ -1,14 +1,19 @@ { - "name": "TypeScript ESLint", - "short_name": "TypeScript ESLint", + "background_color": "#443fd4", + "display": "standalone", "icons": [ { "src": "/android-chrome-192x192.png", "sizes": "192x192", "type": "image/png" + }, + { + "src": "/android-chrome-512x512.png", + "sizes": "512x512", + "type": "image/png" } ], - "theme_color": "#443fd4", - "background_color": "#443fd4", - "display": "standalone" + "name": "typescript-eslint", + "short_name": "typescript-eslint", + "theme_color": "#443fd4" } diff --git a/packages/website/static/img/logo-twitter-card.png b/packages/website/static/img/logo-twitter-card.png index b63a38262991..7e276da9a382 100644 Binary files a/packages/website/static/img/logo-twitter-card.png and b/packages/website/static/img/logo-twitter-card.png differ diff --git a/packages/website/static/img/logo.png b/packages/website/static/img/logo.png index f6022cf5129e..0d7ce9aee1a2 100644 Binary files a/packages/website/static/img/logo.png and b/packages/website/static/img/logo.png differ diff --git a/packages/website/static/img/logo.svg b/packages/website/static/img/logo.svg index 557d2dbcac00..bfe61aecb7cd 100644 --- a/packages/website/static/img/logo.svg +++ b/packages/website/static/img/logo.svg @@ -1,5 +1,22 @@ - - - - + + + + + + diff --git a/packages/website/static/img/logo_maskable.png b/packages/website/static/img/logo_maskable.png index 8c32267e15cf..837410e605cc 100644 Binary files a/packages/website/static/img/logo_maskable.png and b/packages/website/static/img/logo_maskable.png differ diff --git a/packages/website/static/img/typescript.svg b/packages/website/static/img/typescript.svg index 557d2dbcac00..c6f06b4ead4f 100644 --- a/packages/website/static/img/typescript.svg +++ b/packages/website/static/img/typescript.svg @@ -1,5 +1,5 @@ - + diff --git a/packages/website/static/manifest.json b/packages/website/static/manifest.json index 1c10758b3a7a..3eccbd4b2369 100644 --- a/packages/website/static/manifest.json +++ b/packages/website/static/manifest.json @@ -1,6 +1,6 @@ { "background_color": "#443FD4", - "description": "Documentation for TypeScript ESLint: the tooling that enables ESLint to support TypeScript.", + "description": "Documentation for typescript-eslint: the tooling that enables ESLint to support TypeScript.", "display": "standalone", "icons": [ { @@ -16,9 +16,9 @@ } ], "id": "/?source=pwa", - "name": "TypeScript ESLint", + "name": "typescript-eslint", "scope": "/", - "short_name": "TypeScript ESLint", + "short_name": "typescript-eslint", "start_url": "/?source=pwa", "theme_color": "#443FD4" }