Skip to content

chore(site): align ESLint config to typescript-eslint's recommended-requiring-type-checking #5797

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 26, 2023
Merged

chore(site): align ESLint config to typescript-eslint's recommended-requiring-type-checking #5797

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c1bf93a
chore(site): align ESLint config to typescript-eslint's recommended-r…
JoshuaKGoldberg Jan 19, 2023
5727a88
Fixed immediately fixable rules, and TODO-diabled the rest
JoshuaKGoldberg Jan 19, 2023
9efca7a
Merge branch 'main'
JoshuaKGoldberg Jan 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 21 additions & 11 deletions site/.eslintrc.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ env:
extends:
- eslint:recommended
- plugin:@typescript-eslint/recommended
- plugin:@typescript-eslint/recommended-requiring-type-checking
- plugin:eslint-comments/recommended
- plugin:import/recommended
- plugin:import/typescript
Expand Down Expand Up @@ -35,29 +36,38 @@ root: true
rules:
"@typescript-eslint/brace-style":
["error", "1tbs", { "allowSingleLine": false }]
"@typescript-eslint/camelcase": "off"
"@typescript-eslint/explicit-function-return-type": "off"
"@typescript-eslint/explicit-module-boundary-types": "error"
"@typescript-eslint/method-signature-style": ["error", "property"]
"@typescript-eslint/no-floating-promises": error
"@typescript-eslint/no-invalid-void-type": error
# TODO: Investigate whether to enable this rule & fix and/or disable all its complaints
"@typescript-eslint/no-misused-promises": "off"
# TODO: Investigate whether to enable this rule & fix and/or disable all its complaints
"@typescript-eslint/no-unsafe-argument": "off"
# TODO: Investigate whether to enable this rule & fix and/or disable all its complaints
"@typescript-eslint/no-unsafe-assignment": "off"
# TODO: Investigate whether to enable this rule & fix and/or disable all its complaints
"@typescript-eslint/no-unsafe-call": "off"
# TODO: Investigate whether to enable this rule & fix and/or disable all its complaints
"@typescript-eslint/no-unsafe-member-access": "off"
# TODO: Investigate whether to enable this rule & fix and/or disable all its complaints
"@typescript-eslint/no-unsafe-return": "off"
# TODO: Investigate whether to enable this rule & fix and/or disable all its complaints
"@typescript-eslint/require-await": "off"
# TODO: Investigate whether to enable this rule & fix and/or disable all its complaints
"@typescript-eslint/restrict-plus-operands": "off"
# TODO: Investigate whether to enable this rule & fix and/or disable all its complaints
"@typescript-eslint/restrict-template-expressions": "off"
# TODO: Investigate whether to enable this rule & fix and/or disable all its complaints
"@typescript-eslint/unbound-method": "off"
# We're disabling the `no-namespace` rule to use a pattern of defining an interface,
# and then defining functions that operate on that data via namespace. This is helpful for
# dealing with immutable objects. This is a common pattern that shows up in some other
# large TypeScript projects, like VSCode.
# More details: https://github.com/coder/m/pull/9720#discussion_r697609528
"@typescript-eslint/no-namespace": "off"
"@typescript-eslint/no-unnecessary-boolean-literal-compare": error
"@typescript-eslint/no-unnecessary-condition": warn
"@typescript-eslint/no-unnecessary-type-assertion": warn
"@typescript-eslint/no-unused-vars":
- error
- argsIgnorePattern: "^_"
varsIgnorePattern: "^_"
ignoreRestSiblings: true
"@typescript-eslint/no-use-before-define": "off"
"@typescript-eslint/object-curly-spacing": ["error", "always"]
"@typescript-eslint/triple-slash-reference": "off"
"brace-style": "off"
"curly": ["error", "all"]
"eslint-comments/require-description": "error"
Expand Down
6 changes: 2 additions & 4 deletions site/src/api/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@ export const hardCodedCSRFCookie = (): string => {
export const withDefaultFeatures = (
fs: Partial<TypesGen.Entitlements["features"]>,
): TypesGen.Entitlements["features"] => {
for (const k in TypesGen.FeatureNames) {
const feature = k as TypesGen.FeatureName
for (const feature of TypesGen.FeatureNames) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://typescript-eslint.io/rules/no-for-in-array

A for-in loop (for (var i in o)) iterates over the properties of an Object. While it is legal to use for-in loops with array types, it is not common. for-in will iterate over the indices of the array as strings, omitting any "holes" in the array.

// Skip fields that are already filled.
if (fs[feature] !== undefined) {
continue
Expand Down Expand Up @@ -152,8 +151,7 @@ export const getTokens = async (): Promise<TypesGen.APIKey[]> => {
}

export const deleteAPIKey = async (keyId: string): Promise<void> => {
const response = await axios.delete("/api/v2/users/me/keys/" + keyId)
return response.data
await axios.delete("/api/v2/users/me/keys/" + keyId)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This function indicates it returns Promise<void>, so any returned data is ignored. It's violating @typescript-eslint/no-unsafe-return anyway so I figured I'd clean it up. 🙂

}

export const getUsers = async (
Expand Down
4 changes: 2 additions & 2 deletions site/src/components/LicenseBanner/LicenseBanner.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ import { Language } from "./LicenseBannerView"
describe("LicenseBanner", () => {
it("does not show when there are no warnings", async () => {
render(<LicenseBanner />)
const bannerPillSingular = await screen.queryByText(Language.licenseIssue)
const bannerPillPlural = await screen.queryByText(Language.licenseIssues(2))
const bannerPillSingular = screen.queryByText(Language.licenseIssue)
const bannerPillPlural = screen.queryByText(Language.licenseIssues(2))
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

screen.queryByText, screen.getByRole, etc. don't return Promises. There's no need to await them.

@typescript-eslint/await-thenable

expect(bannerPillSingular).toBe(null)
expect(bannerPillPlural).toBe(null)
})
Expand Down
2 changes: 1 addition & 1 deletion site/src/pages/TemplateSettingsPage/TemplateSettingsPage.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ const fillAndSubmitForm = async ({
await userEvent.clear(maxTtlField)
await userEvent.type(maxTtlField, default_ttl_ms.toString())

const allowCancelJobsField = await screen.getByRole("checkbox")
const allowCancelJobsField = screen.getByRole("checkbox")
// checkbox is checked by default, so it must be clicked to get unchecked
if (!allow_user_cancel_workspace_jobs) {
await userEvent.click(allowCancelJobsField)
Expand Down
2 changes: 1 addition & 1 deletion site/src/pages/UsersPage/UsersPage.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ describe("UsersPage", () => {
expect(API.getUsers).toBeCalledWith({ offset: 0, limit: 25, q: "" }),
)

const pageButtons = await container.querySelectorAll(
const pageButtons = container.querySelectorAll(
`button[name="Page button"]`,
)
// count handler says there are 2 pages of results
Expand Down
2 changes: 1 addition & 1 deletion site/src/pages/WorkspacesPage/WorkspacesPage.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ describe("WorkspacesPage", () => {
name: "Previous page",
})
expect(prevPage).toBeDisabled()
const pageButtons = await container.querySelectorAll(
const pageButtons = container.querySelectorAll(
`button[name="Page button"]`,
)
expect(pageButtons.length).toBe(2)
Expand Down
4 changes: 1 addition & 3 deletions site/src/xServices/users/searchUserXService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,7 @@ export const searchUserMachine = createMachine(
{
services: {
searchUsers: async (_, { query }) =>
await (
await getUsers(queryToFilter(query))
).users,
(await getUsers(queryToFilter(query))).users,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This also is an await of something (.users) that is not async.

},
actions: {
assignSearchResults: assign({
Expand Down