Skip to content
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.

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

chore: Stricter ESLint config #383

Merged
merged 2 commits into from
Dec 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 16 additions & 7 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ module.exports = {
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/eslint-recommended',
'plugin:@typescript-eslint/recommended',
'plugin:@typescript-eslint/recommended-type-checked',
'plugin:import/recommended',
'plugin:import/electron',
'plugin:import/typescript',
Expand All @@ -18,7 +18,11 @@ module.exports = {
'prettier',
],
parser: '@typescript-eslint/parser',
ignorePatterns: ['resources/group_snippet.js', 'install-k6.js'],
ignorePatterns: [
'resources/group_snippet.js',
'install-k6.js',
'.eslintrc.cjs',
],
plugins: [
'import',
'unused-imports',
Expand All @@ -43,11 +47,16 @@ module.exports = {
argsIgnorePattern: '^_',
},
],
// TODO: remove warnings when plugin:@typescript-eslint/recommended-type-checked is enabled
'@typescript-eslint/no-unsafe-assignment': 'warn',
'@typescript-eslint/no-unsafe-return': 'warn',
'@typescript-eslint/no-unsafe-argument': 'warn',
'@typescript-eslint/no-unsafe-member-access': 'warn',
'@typescript-eslint/no-floating-promises': [
'error',
{
ignoreIIFE: true,
},
],
'@typescript-eslint/no-misused-promises': [
'error',
{ checksVoidReturn: false },
],
},

parserOptions: {
Expand Down
3 changes: 1 addition & 2 deletions src/ErrorElement.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,10 @@ import { css } from '@emotion/react'
import GrotCrashed from '@/assets/grot-crashed.svg'
import { ArrowLeftIcon } from '@radix-ui/react-icons'

const handleCreateIssue = () => {
const handleCreateIssue = () =>
window.studio.browser.openExternalLink(
'https://github.com/grafana/k6-studio/issues'
)
}

const handleOpenLogs = () => {
window.studio.log.openLogFolder()
Expand Down
2 changes: 2 additions & 0 deletions src/codegen/codegen.utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ export function stringify(value: unknown): string {
return `{${properties}}`
}

// TODO: https://github.com/grafana/k6-studio/issues/277
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Marked ignore comments with a link to the issue (I'll update the issue description once this PR is merged).
While it does look annoying, the pros of enabling stricter rules for everything else outweigh the cons

// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
return `${value}`
}

Expand Down
3 changes: 1 addition & 2 deletions src/components/ExperimentalBanner.tsx
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
import { ExclamationTriangleIcon } from '@radix-ui/react-icons'
import { Flex, Text, Link } from '@radix-ui/themes'

const handleLinkClick = () => {
const handleLinkClick = () =>
window.studio.browser.openExternalLink(
'https://github.com/grafana/k6-studio/issues'
)
}

export function ExperimentalBanner() {
return (
Expand Down
2 changes: 2 additions & 0 deletions src/components/Form/FileUploadInput.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ export const FileUploadInput = ({
disabled={disabled}
onChange={field.onChange}
name={field.name}
// TODO: https://github.com/grafana/k6-studio/issues/277
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
value={field.value}
/>
</FieldGroup>
Expand Down
6 changes: 2 additions & 4 deletions src/components/Layout/ActivityBar/HelpButton.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,15 @@ import { QuestionMarkCircledIcon } from '@radix-ui/react-icons'
import { DropdownMenu, IconButton, Tooltip } from '@radix-ui/themes'

export function HelpButton() {
const handleOpenDocs = () => {
const handleOpenDocs = () =>
window.studio.browser.openExternalLink(
'https://grafana.com/docs/k6-studio/'
)
}

const handleReportIssue = () => {
const handleReportIssue = () =>
window.studio.browser.openExternalLink(
'https://github.com/grafana/k6-studio/issues'
)
}

const handleOpenApplicationLogs = () => {
window.studio.log.openLogFolder()
Expand Down
5 changes: 2 additions & 3 deletions src/components/Layout/ActivityBar/ProxyStatusIndicator.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,10 @@ export function ProxyStatusIndicator() {
const setProxyStatus = useStudioUIStore((state) => state.setProxyStatus)

useEffect(() => {
async function fetchProxyStatus() {
;(async function fetchProxyStatus() {
const status = await window.studio.proxy.getProxyStatus()
setProxyStatus(status)
}
fetchProxyStatus()
})()

return window.studio.proxy.onProxyStatusChange((status) =>
setProxyStatus(status)
Expand Down
5 changes: 3 additions & 2 deletions src/components/Layout/Sidebar/Sidebar.hooks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,14 @@ function useFolderContent() {
const setFolderContent = useStudioUIStore((s) => s.setFolderContent)

useEffect(() => {
window.studio.ui.getFiles().then((files) => {
;(async () => {
const files = await window.studio.ui.getFiles()
setFolderContent({
recordings: toFileMap(files.recordings),
generators: toFileMap(files.generators),
scripts: toFileMap(files.scripts),
})
})
})()
}, [setFolderContent])

useEffect(
Expand Down
6 changes: 2 additions & 4 deletions src/components/Settings/LogsSettings.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,11 @@ export function LogsSettings() {

// retrieve the current content of the log file
useEffect(() => {
async function fetchLogContent() {
;(async function fetchLogContent() {
const content = await window.studio.log.getLogContent()
setLogContent(content)
scrollToLastLine()
}

fetchLogContent()
})()
}, [scrollToLastLine])

// subscribe to log changes
Expand Down
5 changes: 2 additions & 3 deletions src/components/Settings/SettingsDialog.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,10 @@ export const SettingsDialog = ({ open, onOpenChange }: SettingsDialogProps) => {
const [selectedTab, setSelectedTab] = useState('proxy')

useEffect(() => {
async function fetchSettings() {
;(async function fetchSettings() {
const data = await window.studio.settings.getSettings()
setSettings(data)
}
fetchSettings()
})()
}, [])

const formMethods = useForm<AppSettings>({
Expand Down
3 changes: 1 addition & 2 deletions src/components/Settings/UsageReportSettings.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,10 @@ import { AppSettings } from '@/types/settings'
export const UsageReportSettings = () => {
const { control, register } = useFormContext<AppSettings>()

const handleLinkClick = () => {
const handleLinkClick = () =>
window.studio.browser.openExternalLink(
'https://grafana.com/docs/k6-studio/set-up/usage-collection/'
)
}

return (
<SettingsSection>
Expand Down
2 changes: 1 addition & 1 deletion src/components/WebLogView/Group.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ export function Group({
useClickAway(headerRef, () => {
if (!group.isEditing) return

handleSubmit(submit)()
return handleSubmit(submit)()
})

const isValidName = (value: string) => {
Expand Down
2 changes: 2 additions & 0 deletions src/components/WebLogView/RequestDetails/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ export function parseParams(data: ProxyData) {
}

return stringify(
// TODO: https://github.com/grafana/k6-studio/issues/277
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
JSON.parse(jsonrepair(parsePythonByteString(contentDecoded)))
)
} catch (e) {
Expand Down
22 changes: 10 additions & 12 deletions src/components/WebLogView/ResponseDetails/Font.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,17 @@ export function Font({ url }: { url: string }) {
const [isReady, setIsReady] = useState(false)
const [name, setName] = useState('')

async function addFontFace(url: string) {
const name = uniqueId('font-')
const font = new FontFace(name, `url(${url})`)

await font.load()
document.fonts.add(font)
setIsReady(true)
setName(name)
}

useEffect(() => {
setIsReady(false)
addFontFace(url)
;(async function addFontFace(url: string) {
setIsReady(false)
const name = uniqueId('font-')
const font = new FontFace(name, `url(${url})`)

await font.load()
document.fonts.add(font)
setIsReady(true)
setName(name)
})(url)
}, [url])

if (!isReady) {
Expand Down
2 changes: 2 additions & 0 deletions src/components/WebLogView/ResponseDetails/Preview.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ export function Preview({ content, contentType, format }: PreviewProps) {
return (
<ReactJson
shouldCollapse={(field) => field.name !== 'root'}
// TODO: https://github.com/grafana/k6-studio/issues/277
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
src={JSON.parse(content)}
theme={theme === 'dark' ? 'monokai' : 'rjv-default'}
style={theme === 'dark' ? reactJsonDarkStyles : reactJsonLightStyles}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,12 @@ export function parseContent(format: string | undefined, data: ProxyData) {
try {
switch (format) {
case 'json':
// TODO: https://github.com/grafana/k6-studio/issues/277
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
return stringify(JSON.parse(safeAtob(content)))
case 'json-raw':
// TODO: https://github.com/grafana/k6-studio/issues/277
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
return stringify(JSON.parse(safeAtob(content)), 0)
case 'css':
case 'html':
Expand Down
2 changes: 1 addition & 1 deletion src/hooks/useRunChecks.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ describe('useRunChecks', () => {
createK6Check({ id: '1', name: 'Check 1' }),
createK6Check({ id: '2', name: 'Check 2' }),
]
onScriptCheck.mockImplementation((callback) => {
onScriptCheck.mockImplementation((callback: (data: K6Check[]) => void) => {
callback(mockChecks)
return () => {}
})
Expand Down
3 changes: 2 additions & 1 deletion src/hooks/useRunLogs.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { useRunLogs } from './useRunLogs'
import { renderHook } from '@testing-library/react'
import { act } from 'react'
import { beforeAll, beforeEach, describe, expect, it, vi } from 'vitest'
import { K6Log } from '@/types'

const onScriptLog = vi.fn()

Expand Down Expand Up @@ -37,7 +38,7 @@ describe('useRunLogs', () => {

it('should update logs when onScriptLog is called', () => {
const mockLog = createK6Log()
onScriptLog.mockImplementation((callback) => {
onScriptLog.mockImplementation((callback: (log: K6Log) => void) => {
callback(mockLog)
return () => {}
})
Expand Down
2 changes: 1 addition & 1 deletion src/hooks/useScriptPreview.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import {
} from '@/test/factories/generator'

vi.mock('lodash-es', () => ({
debounce: vi.fn((fn) => fn),
debounce: vi.fn((fn: () => void) => fn),
}))
vi.mock('@/store/generator', () => ({
useGeneratorStore: {
Expand Down
2 changes: 2 additions & 0 deletions src/hooks/useScriptPreview.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ export function useScriptPreview() {
}, 100)

// Initial preview generation
// TODO: https://github.com/grafana/k6-studio/issues/277
// eslint-disable-next-line @typescript-eslint/no-floating-promises
updatePreview(useGeneratorStore.getState())

const unsubscribe = useGeneratorStore.subscribe((state) =>
Expand Down
Loading
Loading