Skip to content

A local-first personal finance app

lint: enable linter in docs and fix issues (#6400)

Matiss Janis Aboltinsfca4522a6532
diff --git a/.oxlintrc.json b/.oxlintrc.json
index 0dddd2bff6..cac1941947 100644
--- a/.oxlintrc.json
+++ b/.oxlintrc.json
@@ -233,7 +233,6 @@
{
"files": [
- "packages/docs/**/*", // TODO: fix these issues
"packages/api/migrations/*",
"packages/loot-core/migrations/*",
"packages/sync-server/src/app-gocardless/banks/*.js",
diff --git a/eslint.config.mjs b/eslint.config.mjs
index 06e3e0487c..ed88a34fb0 100644
--- a/eslint.config.mjs
+++ b/eslint.config.mjs
@@ -13,9 +13,6 @@ import pluginActual from './packages/eslint-plugin-actual/lib/index.js';
export default defineConfig(
{
ignores: [
- //temporary
- 'packages/docs',
-
'packages/api/app/bundle.api.js',
'packages/api/app/stats.json',
'packages/api/@types',
@@ -255,6 +252,7 @@ export default defineConfig(
'never',
{
json: 'always',
+ svg: 'always',
},
],
'import/order': [
@@ -492,6 +490,14 @@ export default defineConfig(
'actual/prefer-logger-over-console': 'off',
},
},
+ {
+ files: ['packages/docs/**/*'],
+ rules: {
+ 'actual/typography': 'off',
+ 'actual/no-untranslated-strings': 'off',
+ 'no-restricted-syntax': 'off',
+ },
+ },
{
files: [
'packages/desktop-client/**/*.{ts,tsx}',
diff --git a/packages/docs/.oxlintrc.json b/packages/docs/.oxlintrc.json
new file mode 100644
index 0000000000..a21a9aecee
--- /dev/null
+++ b/packages/docs/.oxlintrc.json
@@ -0,0 +1,6 @@
+{
+ "$schema": "./node_modules/oxlint/configuration_schema.json",
+ "rules": {
+ "import/no-default-export": "off"
+ }
+}
diff --git a/packages/docs/docs/api/APIList.jsx b/packages/docs/docs/api/APIList.jsx
index 66faebefab..87bb127d5e 100644
--- a/packages/docs/docs/api/APIList.jsx
+++ b/packages/docs/docs/api/APIList.jsx
@@ -7,7 +7,7 @@ export default function APIList({ title, sections }) {
<ul>
{sections.map(name => {
- let id = name.replace(/[ -]/g, '-').toLowerCase();
+ const id = name.replace(/[ -]/g, '-').toLowerCase();
return (
<li
key={id}
diff --git a/packages/docs/docs/api/types.jsx b/packages/docs/docs/api/types.jsx
index c34eef09d5..48fc183f2e 100644
--- a/packages/docs/docs/api/types.jsx
+++ b/packages/docs/docs/api/types.jsx
@@ -1,6 +1,6 @@
import React from 'react';
-export let types = {
+export const types = {
id: {
name: 'id',
type: 'string',
@@ -36,7 +36,7 @@ export let types = {
},
};
-export let objects = {
+export const objects = {
initConfig: [
{
name: 'serverURL',
diff --git a/packages/docs/src/components/Button.jsx b/packages/docs/src/components/Button.jsx
index 29a77b5805..4417a651b5 100644
--- a/packages/docs/src/components/Button.jsx
+++ b/packages/docs/src/components/Button.jsx
@@ -1,5 +1,7 @@
import React from 'react';
+
import Link from '@docusaurus/Link';
+
import classes from './Button.module.css';
export default function Button({ primary, to, className, ...props }) {
diff --git a/packages/docs/src/components/HomepageFeatures/index.jsx b/packages/docs/src/components/HomepageFeatures/index.jsx
index c1c1b45f8a..5ecefd031b 100644
--- a/packages/docs/src/components/HomepageFeatures/index.jsx
+++ b/packages/docs/src/components/HomepageFeatures/index.jsx
@@ -1,5 +1,7 @@
import React from 'react';
+
import clsx from 'clsx';
+
import styles from './styles.module.css';
const FeatureList = [
diff --git a/packages/docs/src/components/Image.jsx b/packages/docs/src/components/Image.jsx
index 0af899daaa..71968e8a99 100644
--- a/packages/docs/src/components/Image.jsx
+++ b/packages/docs/src/components/Image.jsx
@@ -1,4 +1,5 @@
import React from 'react';
+
import IdealImage from '@theme/IdealImage';
// https://github.com/endiliey/react-ideal-image/blob/de4e8f0388ac3645d3f32355c79c3b6a7cc61ff3/src/components/theme.js
diff --git a/packages/docs/src/components/Key.jsx b/packages/docs/src/components/Key.jsx
index ee4f012a62..b01cf56510 100644
--- a/packages/docs/src/components/Key.jsx
+++ b/packages/docs/src/components/Key.jsx
@@ -1,4 +1,5 @@
import React, { useEffect, useState } from 'react';
+
import classes from './Key.module.css';
function title(str) {
@@ -33,7 +34,7 @@ const arrows = {
};
export default function Key({ mod, fixed, mods = [], k, arrow }) {
- let [isMacLike, setMacLike] = useState(true);
+ const [isMacLike, setMacLike] = useState(true);
useEffect(() => {
setMacLike(detectMac());
@@ -49,7 +50,7 @@ export default function Key({ mod, fixed, mods = [], k, arrow }) {
mods = mods.map(mod => (fixed ? mod : transform(mod, isMacLike))).map(title);
- let keys = [...mods, title(k)];
+ const keys = [...mods, title(k)];
return (
<div style={{ display: 'inline-flex' }}>
diff --git a/packages/docs/src/pages/index.jsx b/packages/docs/src/pages/index.jsx
index f709f390c6..e3d3285c6f 100644
--- a/packages/docs/src/pages/index.jsx
+++ b/packages/docs/src/pages/index.jsx
@@ -1,6 +1,6 @@
+import Link from '@docusaurus/Link';
import Layout from '@theme/Layout';
import ThemedImage from '@theme/ThemedImage';
-import Link from '@docusaurus/Link';
import Button from '../components/Button';
diff --git a/packages/docs/src/remark/mentions.js b/packages/docs/src/remark/mentions.js
index 0093519f5a..7327259316 100644
--- a/packages/docs/src/remark/mentions.js
+++ b/packages/docs/src/remark/mentions.js
@@ -7,7 +7,7 @@ function githubMentionPlugin() {
const text = node.value;
let match;
let lastIndex = 0;
- let segments = [];
+ const segments = [];
while ((match = pattern.exec(text))) {
const { index } = match;
const username = match[1];
diff --git a/packages/docs/src/theme/MDXComponents.js b/packages/docs/src/theme/MDXComponents.js
index e753cc7b11..77a0cabdef 100644
--- a/packages/docs/src/theme/MDXComponents.js
+++ b/packages/docs/src/theme/MDXComponents.js
@@ -1,5 +1,6 @@
-import MDXComponents from '@theme-original/MDXComponents';
import Image from '@site/src/components/Image';
+import MDXComponents from '@theme-original/MDXComponents';
+
import Key from '../components/Key';
export default {
...MDXComponents,
diff --git a/upcoming-release-notes/6400.md b/upcoming-release-notes/6400.md
new file mode 100644
index 0000000000..dea4bef433
--- /dev/null
+++ b/upcoming-release-notes/6400.md
@@ -0,0 +1,6 @@
+---
+category: Maintenance
+authors: [MatissJanis]
+---
+
+lint: enable linter in docs and fix issues