mirror of
https://github.com/hanzoai/studio-desktop.git
synced 2026-10-30 18:21:16 +00:00
filteredandGitHub
881f1fd638
Replaces Electron's `any`-typed IPC with compile-time type safety. ### Type Contract - Central `IpcChannels` interface defines all channels with param/return types - Compile-time tests ensure complete coverage of `IPC_CHANNELS` - `strictIpcMain`/`strictIpcRenderer` wrappers enforce type contract ### Migration - All IPC usage migrated to type-safe wrappers - ESLint prevents import of untyped `ipcMain`/`ipcRenderer` - Fixed pre-existing type mismatches discovered during migration ### API Fixes - Terminal write: Returns `void` instead of `string` - Download pause/resume/cancel: Return `void` instead of `boolean` - Validation complete: Marked as returning incorrect type - Validate installation: Marked as returning incorrect type - Terminal restore: Marked as potentially `undefined` - Get base path: Correctly typed as `string | undefined` - Get GPU: Needs API fix to send `GpuType` instead of `TorchDeviceType` ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-1366-Type-safe-IPC-system-2866d73d365081ffb02ac1d2dce7ce62) by [Unito](https://www.unito.io)
120 lines
3.3 KiB
JavaScript
120 lines
3.3 KiB
JavaScript
import eslint from '@eslint/js';
|
|
import eslintPluginUnicorn from 'eslint-plugin-unicorn';
|
|
import globals from 'globals';
|
|
import tseslint from 'typescript-eslint';
|
|
|
|
export default tseslint.config(
|
|
// Baseline include / exclude
|
|
{ files: ['**/*.{js,cjs,mjs,ts,mts}'] },
|
|
{ ignores: ['dist/**/*', 'jest.config.cjs', 'scripts/shims/**/*'] },
|
|
|
|
// Baseline
|
|
eslint.configs.recommended,
|
|
...tseslint.configs.recommendedTypeChecked,
|
|
{
|
|
languageOptions: {
|
|
parserOptions: {
|
|
projectService: true,
|
|
tsconfigRootDir: import.meta.dirname,
|
|
},
|
|
},
|
|
rules: {
|
|
'no-empty-pattern': ['error', { allowObjectPatternsAsParameters: true }],
|
|
'no-control-regex': 'off',
|
|
|
|
'@typescript-eslint/restrict-template-expressions': 'off',
|
|
'@typescript-eslint/prefer-readonly': 'warn',
|
|
},
|
|
},
|
|
|
|
// Baseline (except preload)
|
|
{
|
|
ignores: ['./src/preload.ts'],
|
|
languageOptions: { globals: { ...globals.node } },
|
|
},
|
|
|
|
// Preload
|
|
{
|
|
files: ['./src/preload.ts'],
|
|
languageOptions: { globals: { ...globals.browser } },
|
|
},
|
|
|
|
// Unicorn
|
|
eslintPluginUnicorn.configs['flat/recommended'],
|
|
{
|
|
rules: {
|
|
// Enable
|
|
'unicorn/better-regex': 'warn',
|
|
// Disable
|
|
'unicorn/prefer-string-slice': 'off',
|
|
'unicorn/no-negated-condition': 'off',
|
|
'unicorn/filename-case': 'off',
|
|
'unicorn/no-null': 'off',
|
|
'unicorn/prevent-abbreviations': 'off',
|
|
'unicorn/switch-case-braces': 'off',
|
|
'unicorn/explicit-length-check': 'off',
|
|
'unicorn/consistent-function-scoping': 'off',
|
|
'unicorn/prefer-event-target': 'off',
|
|
'unicorn/prefer-ternary': ['error', 'only-single-line'],
|
|
'unicorn/no-nested-ternary': 'off',
|
|
},
|
|
},
|
|
|
|
// Scripts
|
|
{
|
|
files: ['scripts/**/*'],
|
|
rules: {
|
|
'unicorn/no-process-exit': 'off',
|
|
},
|
|
},
|
|
|
|
// Tests
|
|
{
|
|
files: ['tests/**/*'],
|
|
rules: {
|
|
'unicorn/prefer-module': 'off',
|
|
'unicorn/no-useless-undefined': 'off',
|
|
'@typescript-eslint/unbound-method': 'off',
|
|
'@typescript-eslint/no-unsafe-assignment': 'off',
|
|
'@typescript-eslint/no-unsafe-member-access': 'off',
|
|
'@typescript-eslint/no-unsafe-argument': 'off',
|
|
'@typescript-eslint/no-unsafe-call': 'off',
|
|
'@typescript-eslint/no-unsafe-return': 'off',
|
|
'@typescript-eslint/no-explicit-any': 'off',
|
|
},
|
|
},
|
|
|
|
// Forbid import of Electron's any-typed ipcMain / ipcRenderer.
|
|
{
|
|
rules: {
|
|
'no-restricted-imports': [
|
|
'error',
|
|
{
|
|
paths: [
|
|
{
|
|
name: 'electron',
|
|
importNames: ['ipcMain', 'ipcRenderer'],
|
|
message: "Import strictIpcMain/strictIpcRenderer from '@/ipc/strictIpc' instead of Electron's IPC.",
|
|
},
|
|
{
|
|
name: 'electron/main',
|
|
importNames: ['ipcMain'],
|
|
message: "Import strictIpcMain from '@/ipc/strictIpc' instead of Electron's IPC.",
|
|
},
|
|
{
|
|
name: 'electron/renderer',
|
|
importNames: ['ipcRenderer'],
|
|
message: "Import strictIpcRenderer from '@/ipc/strictIpc' instead of Electron's IPC.",
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
},
|
|
// Override restricted imports for strictIpc.ts.
|
|
{
|
|
files: ['src/infrastructure/ipcChannels.ts', 'tests/**/*.ts'],
|
|
rules: { 'no-restricted-imports': 'off' },
|
|
}
|
|
);
|