hazemKrimi/touch-programming
1
0
Fork 0
mirror of https://github.com/hazemKrimi/touch-programming.git synced 2026-05-01 18:20:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Migrate to TS with ESLint and Prettier

Browse Source
This commit is contained in:
Hazem Krimi
2025-01-28 22:54:38 +01:00
parent 40954e1f52
commit c17f0f484a
18 changed files with 1274 additions and 586 deletions
Download Patch File Download Diff File Expand all files Collapse all files
client/eslint.config.js
+29 -32
View File
@@ -1,38 +1,35 @@
import js from '@eslint/js'
import globals from 'globals'
import react from 'eslint-plugin-react'
import reactHooks from 'eslint-plugin-react-hooks'
import reactRefresh from 'eslint-plugin-react-refresh'
import globals from 'globals';
import pluginJs from '@eslint/js';
import tseslint from 'typescript-eslint';
import pluginReact from 'eslint-plugin-react';
import hooksPlugin from 'eslint-plugin-react-hooks';
import prettier from 'eslint-plugin-prettier';
// TODO: Better understand and improve this config along with tsconfig.
/** @type {import('eslint').Linter.Config[]} */
export default [
{ ignores: ['dist'] },
{ files: ['**/*.{js,mjs,cjs,ts,jsx,tsx}'] },
{ languageOptions: { globals: globals.browser } },
pluginJs.configs.recommended,
...tseslint.configs.recommended,
pluginReact.configs.flat.recommended,
{
files: ['**/*.{js,jsx}'],
languageOptions: {
ecmaVersion: 2020,
globals: globals.browser,
parserOptions: {
ecmaVersion: 'latest',
ecmaFeatures: { jsx: true },
sourceType: 'module',
},
},
settings: { react: { version: '18.3' } },
plugins: {
react,
'react-hooks': reactHooks,
'react-refresh': reactRefresh,
},
rules: {
...js.configs.recommended.rules,
...react.configs.recommended.rules,
...react.configs['jsx-runtime'].rules,
...reactHooks.configs.recommended.rules,
'react/jsx-no-target-blank': 'off',
'react-refresh/only-export-components': [
'warn',
{ allowConstantExport: true },
],
prettier,
},
rules: {
'react/react-in-jsx-scope': 'off'
},
settings: {
react: {
version: 'detect'
}
}
},
]
{
plugins: {
'react-hooks': hooksPlugin,
},
rules: hooksPlugin.configs.recommended.rules,
}
];
client/index.html
+1 -1
View File
@@ -8,6 +8,6 @@
</head>
<body>
<div id="root"></div>
<script type="module" src="/src/main.jsx"></script>
<script type="module" src="/src/main.tsx"></script>
</body>
</html>
client/package-lock.json
Generated
+971 -342
View File
File diff suppressed because it is too large Load Diff
client/package.json
+15 -8
View File
@@ -6,25 +6,32 @@
"scripts": {
"dev": "vite",
"build": "vite build",
"lint": "eslint .",
"lint": "eslint src",
"preview": "vite preview",
"format": "prettier -w src"
},
"dependencies": {
"eslint-plugin-prettier": "^5.2.3",
"react": "^18.3.1",
"react-dom": "^18.3.1"
},
"devDependencies": {
"@eslint/js": "^9.15.0",
"@types/react": "^18.3.12",
"@types/react-dom": "^18.3.1",
"@eslint/js": "^9.19.0",
"@types/react": "^18.3.18",
"@types/react-dom": "^18.3.5",
"@typescript-eslint/eslint-plugin": "^8.22.0",
"@typescript-eslint/parser": "^8.22.0",
"@vitejs/plugin-react-swc": "^3.5.0",
"eslint": "^9.15.0",
"eslint-plugin-react": "^7.37.2",
"eslint": "^9.19.0",
"eslint-config-prettier": "^10.0.1",
"eslint-plugin-react": "^7.37.4",
"eslint-plugin-react-hooks": "^5.0.0",
"eslint-plugin-react-refresh": "^0.4.14",
"globals": "^15.12.0",
"globals": "^15.14.0",
"prettier": "^3.4.2",
"vite": "^6.0.1"
"typescript": "^5.7.3",
"typescript-eslint": "^8.22.0",
"vite": "^6.0.1",
"vite-tsconfig-paths": "^5.1.4"
}
}
client/src/App.css
-36
View File
@@ -1,36 +0,0 @@
.container {
margin: auto;
padding: 1rem;
letter-spacing: 0.12rem;
}
.pending {
color: gray;
}
.highlight {
color: gray;
animation: blink 0.75s infinite ease-in-out;
}
.correct {
color: green;
}
.incorrect {
color: red;
}
@keyframes blink {
0% {
border-left: 1px solid white;
}
50% {
border-left: 1px solid transparent;
}
100% {
border-left: 1px solid white;
}
}
client/src/App.jsx
-108
View File
@@ -1,108 +0,0 @@
import { useEffect, useState } from 'react';
import './App.css';
const KEYS_TO_DISABLE = ['Backspace', 'Shift', 'Alt', 'Control', 'F1', 'F2', 'F3', 'F4', 'F5', 'F6', 'F7', 'F8', 'F9', 'F10', 'F11', 'F12', 'Escape', 'Delete', 'PageDown', 'PageUp', 'Home', 'End', 'Insert', 'WakeUp', 'Pause', 'ScrollLock', 'ContextMenu', 'BrowserForward', 'BrowserBack', 'CapsLock', 'ArrowUp', 'ArrowDown', 'ArrowLeft', 'ArrowRight'];
function App() {
// TODO: Cleanup the file and create utils for trimming the code properly.
// TODO: Create a function that combines a sequence of spaces into tabs.
const [code, setCode] = useState('');
const [loaded, setLoaded] = useState(false);
const [characters, setCharacters] = useState([]);
useEffect(() => {
(async function() {
setCode('');
const response = await fetch(`${import.meta.env.VITE_API_URL}/generate?lang=lua`);
const reader = response.body.getReader();
const decoder = new TextDecoder();
while(true) {
const {value, done} = await reader.read();
setCode(prev => prev + decoder.decode(value));
if (done) {
break;
}
}
setCode(prev => prev.trim());
setLoaded(true);
})();
}, []);
useEffect(() => {
function handleKeyPress(event) {
event.preventDefault();
if (!loaded) return;
if (characters.length === code.length) return;
if (KEYS_TO_DISABLE.includes(event.key)) return;
const char = code[characters.length];
if (/^\n$/.test(char))
return setCharacters(
characters.concat(event.key === 'Enter')
);
if (/^(\s|\t)$/.test(char))
return setCharacters(
characters.concat(['Space', 'Tab'].includes(event.key))
);
setCharacters(
characters.concat(event.key === char)
);
}
window.addEventListener('keydown', handleKeyPress);
return () => window.removeEventListener('keydown', handleKeyPress);
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [loaded, characters]);
function renderCharacterClassName(index) {
const typed = characters[index];
if (loaded && index === characters.length) return 'highlight';
if (typeof typed === 'undefined') return 'pending';
if (!typed) return 'incorrect';
return 'correct';
}
function renderSpacingCharacter(char) {
if (/^\n$/.test(char)) return '\n';
if (/^(\s|\t)$/.test(char)) return '\u00A0'
return char;
}
function renderClassName(index) {
return `${renderCharacterClassName(index)}`.trim();
}
function renderCharacter(char, index) {
const rendered = renderSpacingCharacter(char);
if (/^\n$/.test(rendered)) {
return <span className={renderClassName(index)} key={char + index}><br /></span>
}
return (
<span className={renderClassName(index)} key={char + index}>
{rendered}
</span>
);
}
return (
<div className='container'>
{code.split('').map((char, index) => renderCharacter(char, index))}
</div>
);
}
export default App;
client/src/App.tsx
+7
View File
@@ -0,0 +1,7 @@
import Code from './components/Code';
function App() {
return <Code />;
}
export default App;
client/src/assets/react.svg
-1
View File
@@ -1 +0,0 @@
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="35.93" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 228"><path fill="#00D8FF" d="M210.483 73.824a171.49 171.49 0 0 0-8.24-2.597c.465-1.9.893-3.777 1.273-5.621c6.238-30.281 2.16-54.676-11.769-62.708c-13.355-7.7-35.196.329-57.254 19.526a171.23 171.23 0 0 0-6.375 5.848a155.866 155.866 0 0 0-4.241-3.917C100.759 3.829 77.587-4.822 63.673 3.233C50.33 10.957 46.379 33.89 51.995 62.588a170.974 170.974 0 0 0 1.892 8.48c-3.28.932-6.445 1.924-9.474 2.98C17.309 83.498 0 98.307 0 113.668c0 15.865 18.582 31.778 46.812 41.427a145.52 145.52 0 0 0 6.921 2.165a167.467 167.467 0 0 0-2.01 9.138c-5.354 28.2-1.173 50.591 12.134 58.266c13.744 7.926 36.812-.22 59.273-19.855a145.567 145.567 0 0 0 5.342-4.923a168.064 168.064 0 0 0 6.92 6.314c21.758 18.722 43.246 26.282 56.54 18.586c13.731-7.949 18.194-32.003 12.4-61.268a145.016 145.016 0 0 0-1.535-6.842c1.62-.48 3.21-.974 4.76-1.488c29.348-9.723 48.443-25.443 48.443-41.52c0-15.417-17.868-30.326-45.517-39.844Zm-6.365 70.984c-1.4.463-2.836.91-4.3 1.345c-3.24-10.257-7.612-21.163-12.963-32.432c5.106-11 9.31-21.767 12.459-31.957c2.619.758 5.16 1.557 7.61 2.4c23.69 8.156 38.14 20.213 38.14 29.504c0 9.896-15.606 22.743-40.946 31.14Zm-10.514 20.834c2.562 12.94 2.927 24.64 1.23 33.787c-1.524 8.219-4.59 13.698-8.382 15.893c-8.067 4.67-25.32-1.4-43.927-17.412a156.726 156.726 0 0 1-6.437-5.87c7.214-7.889 14.423-17.06 21.459-27.246c12.376-1.098 24.068-2.894 34.671-5.345a134.17 134.17 0 0 1 1.386 6.193ZM87.276 214.515c-7.882 2.783-14.16 2.863-17.955.675c-8.075-4.657-11.432-22.636-6.853-46.752a156.923 156.923 0 0 1 1.869-8.499c10.486 2.32 22.093 3.988 34.498 4.994c7.084 9.967 14.501 19.128 21.976 27.15a134.668 134.668 0 0 1-4.877 4.492c-9.933 8.682-19.886 14.842-28.658 17.94ZM50.35 144.747c-12.483-4.267-22.792-9.812-29.858-15.863c-6.35-5.437-9.555-10.836-9.555-15.216c0-9.322 13.897-21.212 37.076-29.293c2.813-.98 5.757-1.905 8.812-2.773c3.204 10.42 7.406 21.315 12.477 32.332c-5.137 11.18-9.399 22.249-12.634 32.792a134.718 134.718 0 0 1-6.318-1.979Zm12.378-84.26c-4.811-24.587-1.616-43.134 6.425-47.789c8.564-4.958 27.502 2.111 47.463 19.835a144.318 144.318 0 0 1 3.841 3.545c-7.438 7.987-14.787 17.08-21.808 26.988c-12.04 1.116-23.565 2.908-34.161 5.309a160.342 160.342 0 0 1-1.76-7.887Zm110.427 27.268a347.8 347.8 0 0 0-7.785-12.803c8.168 1.033 15.994 2.404 23.343 4.08c-2.206 7.072-4.956 14.465-8.193 22.045a381.151 381.151 0 0 0-7.365-13.322Zm-45.032-43.861c5.044 5.465 10.096 11.566 15.065 18.186a322.04 322.04 0 0 0-30.257-.006c4.974-6.559 10.069-12.652 15.192-18.18ZM82.802 87.83a323.167 323.167 0 0 0-7.227 13.238c-3.184-7.553-5.909-14.98-8.134-22.152c7.304-1.634 15.093-2.97 23.209-3.984a321.524 321.524 0 0 0-7.848 12.897Zm8.081 65.352c-8.385-.936-16.291-2.203-23.593-3.793c2.26-7.3 5.045-14.885 8.298-22.6a321.187 321.187 0 0 0 7.257 13.246c2.594 4.48 5.28 8.868 8.038 13.147Zm37.542 31.03c-5.184-5.592-10.354-11.779-15.403-18.433c4.902.192 9.899.29 14.978.29c5.218 0 10.376-.117 15.453-.343c-4.985 6.774-10.018 12.97-15.028 18.486Zm52.198-57.817c3.422 7.8 6.306 15.345 8.596 22.52c-7.422 1.694-15.436 3.058-23.88 4.071a382.417 382.417 0 0 0 7.859-13.026a347.403 347.403 0 0 0 7.425-13.565Zm-16.898 8.101a358.557 358.557 0 0 1-12.281 19.815a329.4 329.4 0 0 1-23.444.823c-7.967 0-15.716-.248-23.178-.732a310.202 310.202 0 0 1-12.513-19.846h.001a307.41 307.41 0 0 1-10.923-20.627a310.278 310.278 0 0 1 10.89-20.637l-.001.001a307.318 307.318 0 0 1 12.413-19.761c7.613-.576 15.42-.876 23.31-.876H128c7.926 0 15.743.303 23.354.883a329.357 329.357 0 0 1 12.335 19.695a358.489 358.489 0 0 1 11.036 20.54a329.472 329.472 0 0 1-11 20.722Zm22.56-122.124c8.572 4.944 11.906 24.881 6.52 51.026c-.344 1.668-.73 3.367-1.15 5.09c-10.622-2.452-22.155-4.275-34.23-5.408c-7.034-10.017-14.323-19.124-21.64-27.008a160.789 160.789 0 0 1 5.888-5.4c18.9-16.447 36.564-22.941 44.612-18.3ZM128 90.808c12.625 0 22.86 10.235 22.86 22.86s-10.235 22.86-22.86 22.86s-22.86-10.235-22.86-22.86s10.235-22.86 22.86-22.86Z"></path></svg>
Side by Side

Before

Width:  |  Height:  |  Size: 4.0 KiB

client/src/components/Code/index.css
+36
View File
@@ -0,0 +1,36 @@
.container {
margin: auto;
padding: 1rem;
letter-spacing: 0.12rem;
}
.pending {
color: gray;
}
.highlight {
color: gray;
animation: blink 0.75s infinite ease-in-out;
}
.correct {
color: green;
}
.incorrect {
color: red;
}
@keyframes blink {
0% {
border-left: 1px solid white;
}
50% {
border-left: 1px solid transparent;
}
100% {
border-left: 1px solid white;
}
}
client/src/components/Code/index.tsx
+112
View File
@@ -0,0 +1,112 @@
import { useEffect, useState } from 'react';
import { KEYS_TO_DISABLE } from 'constants/default';
import './index.css';
function Code() {
// TODO: Cleanup the file and create utils for trimming the code properly.
// TODO: Create a function that combines a sequence of spaces into tabs.
const [code, setCode] = useState<string>('');
const [loaded, setLoaded] = useState<boolean>(false);
const [characters, setCharacters] = useState<Array<boolean>>([]);
useEffect(() => {
(async function () {
setCode('');
const response = await fetch(
`${import.meta.env.VITE_API_URL}/generate?lang=lisp`,
);
if (!response.ok || !response.body) return;
const reader = response.body.getReader();
const decoder = new TextDecoder();
while (true) {
const { value, done } = await reader.read();
setCode((prev) => prev + decoder.decode(value));
if (done) {
break;
}
}
setCode((prev) => prev.trim());
setLoaded(true);
})();
}, []);
useEffect(() => {
function handleKeyPress(event: KeyboardEvent) {
event.preventDefault();
if (!loaded) return;
if (characters.length === code.length) return;
if (KEYS_TO_DISABLE.includes(event.key)) return;
const char = code[characters.length];
if (/^\n$/.test(char))
return setCharacters(characters.concat(event.key === 'Enter'));
if (/^(\s|\t)$/.test(char))
return setCharacters(
characters.concat(['Space', 'Tab'].includes(event.key)),
);
setCharacters(characters.concat(event.key === char));
}
window.addEventListener('keydown', handleKeyPress);
return () => window.removeEventListener('keydown', handleKeyPress);
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [loaded, characters]);
function renderCharacterClassName(index: number) {
const typed = characters[index];
if (loaded && index === characters.length) return 'highlight';
if (typeof typed === 'undefined') return 'pending';
if (!typed) return 'incorrect';
return 'correct';
}
function renderSpacingCharacter(char: string) {
if (/^\n$/.test(char)) return '\n';
if (/^(\s|\t)$/.test(char)) return '\u00A0';
return char;
}
function renderClassName(index: number) {
return `${renderCharacterClassName(index)}`.trim();
}
function renderCharacter(char: string, index: number) {
const rendered = renderSpacingCharacter(char);
if (/^\n$/.test(rendered)) {
return (
<span className={renderClassName(index)} key={char + index}>
<br />
</span>
);
}
return (
<span className={renderClassName(index)} key={char + index}>
{rendered}
</span>
);
}
return (
<div className='container'>
{code.split('').map((char, index) => renderCharacter(char, index))}
</div>
);
}
export default Code;
client/src/constants/default.ts
+36
View File
@@ -0,0 +1,36 @@
export const KEYS_TO_DISABLE = [
'Backspace',
'Shift',
'Alt',
'Control',
'F1',
'F2',
'F3',
'F4',
'F5',
'F6',
'F7',
'F8',
'F9',
'F10',
'F11',
'F12',
'Escape',
'Delete',
'PageDown',
'PageUp',
'Home',
'End',
'Insert',
'WakeUp',
'Pause',
'ScrollLock',
'ContextMenu',
'BrowserForward',
'BrowserBack',
'CapsLock',
'ArrowUp',
'ArrowDown',
'ArrowLeft',
'ArrowRight',
];
client/src/index.css
-47
View File
@@ -3,7 +3,6 @@
line-height: 1.5;
font-weight: 400;
color-scheme: light dark;
color: rgba(255, 255, 255, 0.87);
background-color: #242424;
@@ -13,15 +12,6 @@
-moz-osx-font-smoothing: grayscale;
}
a {
font-weight: 500;
color: #646cff;
text-decoration: inherit;
}
a:hover {
color: #535bf2;
}
body {
margin: 0;
display: flex;
@@ -29,40 +19,3 @@ body {
min-width: 320px;
min-height: 100vh;
}
h1 {
font-size: 3.2em;
line-height: 1.1;
}
button {
border-radius: 8px;
border: 1px solid transparent;
padding: 0.6em 1.2em;
font-size: 1em;
font-weight: 500;
font-family: inherit;
background-color: #1a1a1a;
cursor: pointer;
transition: border-color 0.25s;
}
button:hover {
border-color: #646cff;
}
button:focus,
button:focus-visible {
outline: 4px auto -webkit-focus-ring-color;
}
@media (prefers-color-scheme: light) {
:root {
color: #213547;
background-color: #ffffff;
}
a:hover {
color: #747bff;
}
button {
background-color: #f9f9f9;
}
}
client/src/main.jsx → client/src/main.tsx
+2 -4
View File
@@ -1,8 +1,6 @@
import { createRoot } from 'react-dom/client';
import './index.css';
import App from './App.jsx';
import './index.css';
// TODO: Bring back string mode when building and deploying
createRoot(document.getElementById('root')).render(
<App />
);
createRoot(document.getElementById('root')).render(<App />);
client/src/vite-env.d.ts
Vendored
+9
View File
@@ -0,0 +1,9 @@
/// <reference types="vite/client" />
interface ImportMetaEnv {
readonly VITE_API_URL: string;
}
interface ImportMeta {
readonly env: ImportMetaEnv;
}
client/tsconfig.json
+27
View File
@@ -0,0 +1,27 @@
{
"compilerOptions": {
"target": "ES2020",
"useDefineForClassFields": true,
"lib": ["ES2020", "DOM", "DOM.Iterable"],
"module": "ESNext",
"skipLibCheck": true,
/* Bundler mode */
"baseUrl": "src",
"moduleResolution": "bundler",
"allowImportingTsExtensions": true,
"resolveJsonModule": true,
"isolatedModules": true,
"noEmit": true,
"allowJs": true,
"jsx": "react-jsx",
/* Linting */
"strict": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"noFallthroughCasesInSwitch": true
},
"include": ["src"],
"references": [{ "path": "./tsconfig.node.json" }]
}
client/tsconfig.node.json
+10
View File
@@ -0,0 +1,10 @@
{
"compilerOptions": {
"composite": true,
"skipLibCheck": true,
"module": "ESNext",
"moduleResolution": "bundler",
"allowSyntheticDefaultImports": true
},
"include": ["vite.config.ts"]
}
client/vite.config.js
-7
View File
@@ -1,7 +0,0 @@
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react-swc'
// https://vite.dev/config/
export default defineConfig({
plugins: [react()],
})
client/vite.config.ts
+19
View File
@@ -0,0 +1,19 @@
import { defineConfig } from 'vite';
import react from '@vitejs/plugin-react-swc';
import vitesTSConfigPaths from 'vite-tsconfig-paths';
// https://vite.dev/config/
export default defineConfig({
plugins: [react(), vitesTSConfigPaths()],
server: {
port: 3000,
},
build: {
outDir: 'build',
},
resolve: {
alias: {
src: '/src',
},
},
});