chore: upgarde (satellite-v1 + others) (#35)

e-krebs · web-flow · commit 8c3dfcc4af37 · 2024-03-01T14:41:25.000+01:00
- upgrade satellite to v1.0.0
  - handling `satellite.min.css` a bit differently
  - update linting
- fix: `stl-` classes being stripped
- upgrade other dependencies
- fix typing issues
- v0.0.10
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -2,16 +2,16 @@ const path = require('path');
 
 module.exports = {
   root: true,
-  extends: ['plugin:@algolia/satellite/recommended', 'prettier'],
-  plugins: ['@algolia/satellite', '@typescript-eslint', 'prettier'],
+  extends: ['plugin:@algolia/stl/recommended', 'prettier'],
+  plugins: ['@algolia/stl', '@typescript-eslint', 'prettier'],
   settings: {
     'import/resolver': {
       node: {
         extensions: ['.js', '.jsx', '.ts', '.tsx'],
       },
       typescript: {},
     },
-    satellite: {
+    stl: {
       tailwindConfigPath: path.resolve(__dirname, './tailwind.config.js'),
     },
     react: {
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "algolia-analyzer",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "author": "Emmanuel Krebs <e-krebs@users.noreply.github.com>",
   "license": "MIT",
   "scripts": {
@@ -21,47 +21,47 @@
     "webext-prod": {}
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.12.2",
+    "@tanstack/react-query": "^5.24.1",
+    "eslint-plugin-jsdoc": "^48.2.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "devDependencies": {
-    "@algolia/client-search": "^4.20.0",
-    "@algolia/eslint-plugin-satellite": "^4.4.0",
-    "@algolia/satellite": "1.0.0-beta.178",
-    "@parcel/config-webextension": "^2.10.3",
-    "@parcel/validator-typescript": "^2.10.3",
-    "@swc/core": "^1.3.100",
-    "@swc/jest": "^0.2.29",
-    "@types/chrome": "^0.0.253",
-    "@types/jest": "^29.5.10",
+    "@algolia/client-search": "^4.22.1",
+    "@algolia/eslint-plugin-stl": "^1.0.0",
+    "@algolia/satellite": "1.0.0",
+    "@parcel/config-webextension": "^2.12.0",
+    "@parcel/validator-typescript": "^2.12.0",
+    "@swc/core": "^1.4.2",
+    "@swc/jest": "^0.2.36",
+    "@types/chrome": "^0.0.262",
+    "@types/jest": "^29.5.12",
     "@types/lodash": "^4.14.202",
-    "@types/node": "^20.10.3",
-    "@types/react": "^18.2.41",
-    "@types/react-dom": "^18.2.17",
-    "@typescript-eslint/eslint-plugin": "^6.13.1",
-    "@typescript-eslint/parser": "^6.13.1",
-    "algoliasearch": "^4.20.0",
-    "autoprefixer": "^10.4.16",
+    "@types/node": "^20.11.24",
+    "@types/react": "^18.2.61",
+    "@types/react-dom": "^18.2.19",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "algoliasearch": "^4.22.1",
+    "autoprefixer": "^10.4.17",
     "bestzip": "^2.2.1",
-    "classnames": "^2.3.2",
-    "eslint": "^8.55.0",
+    "classnames": "^2.5.1",
+    "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-jsdoc": "^46.9.0",
-    "eslint-plugin-prettier": "^5.0.1",
+    "eslint-plugin-prettier": "^5.1.3",
     "jest": "^29.7.0",
     "lodash": "^4.17.21",
-    "parcel": "^2.10.3",
-    "postcss": "^8.4.33",
-    "prettier": "^3.1.0",
+    "parcel": "^2.12.0",
+    "postcss": "^8.4.35",
+    "prettier": "^3.2.5",
     "process": "^0.11.10",
     "react-feather": "^2.0.10",
     "react-json-view": "^1.21.3",
     "rimraf": "^5.0.5",
-    "tailwindcss": "^3.3.5",
-    "typescript": "^5.3.2",
+    "tailwindcss": "^3.4.1",
+    "typescript": "^5.3.3",
     "zod": "^3.22.4"
   },
   "alias": {
diff --git a/src/components/Tags.tsx b/src/components/Tags.tsx
@@ -18,7 +18,7 @@ export const StatusCodeTag: FC<CustomTagProps & { statusCode: number }> = ({
   reversed,
   ...props
 }) => (
-  <Tag {...props} variant={getStatusColor(statusCode)}>
+  <Tag {...props} variant={getStatusColor(statusCode)} title="status code" placeholder={undefined}>
     {reversed && '!'}
     {statusCode}
   </Tag>
@@ -29,7 +29,7 @@ export const MethodTag: FC<CustomTagProps & { method: string }> = ({
   reversed,
   ...props
 }) => (
-  <Tag {...props}>
+  <Tag {...props} title="method" placeholder={undefined}>
     {reversed && '!'}
     {method}
   </Tag>
@@ -40,7 +40,7 @@ export const ClusterTag: FC<CustomTagProps & { cluster: string }> = ({
   reversed,
   ...props
 }) => (
-  <Tag {...props} variant="blue" title="cluster">
+  <Tag {...props} variant="blue" title="cluster" placeholder={undefined}>
     {reversed && '!'}
     {cluster}
   </Tag>
@@ -51,7 +51,7 @@ export const IndexTag: FC<CustomTagProps & { index: string | null }> = ({
   reversed,
   ...props
 }) => (
-  <Tag {...props} variant="accent" title="index">
+  <Tag {...props} variant="accent" title="index" placeholder={undefined}>
     {reversed && '!'}
     {index || 'no index'}
   </Tag>
@@ -62,7 +62,7 @@ export const ApiSubPathTag: FC<CustomTagProps & { subPath: string | null }> = ({
   reversed,
   ...props
 }) => (
-  <Tag {...props} variant="pink" title="api path">
+  <Tag {...props} variant="pink" title="api path" placeholder={undefined}>
     {reversed && '!'}
     {subPath || 'no API path'}
   </Tag>
@@ -80,7 +80,7 @@ const apiString: Record<ApiType, string> = {
 };
 
 export const ApiTag: FC<CustomTagProps & { api: ApiType }> = ({ api, reversed, ...props }) => (
-  <Tag {...props} variant="orange" title="API">
+  <Tag {...props} variant="orange" title="API" placeholder={undefined}>
     {reversed && '!'}
     {apiString[api]}
   </Tag>
diff --git a/src/content/tailwind.css b/src/content/tailwind.css
@@ -1,3 +1,5 @@
+@import '../../node_modules/@algolia/satellite/dist/satellite.min.css';
+
 @tailwind base;
 @tailwind components;
 @tailwind utilities;
diff --git a/src/manifest.json b/src/manifest.json
@@ -2,7 +2,7 @@
   "manifest_version": 3,
   "name": "Algolia Analyzer",
   "description": "algolia-analyzer",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "minimum_chrome_version": "60",
   "icons": {
     "16": "./content/icons/icon-16.png",
diff --git a/src/pages/devtools/Page.tsx b/src/pages/devtools/Page.tsx
@@ -116,7 +116,7 @@ export const Page: FC = () => {
             variant="subtle"
             size="large"
             title="extension settings"
-            onClick={(): void => chrome.runtime.openOptionsPage()}
+            onClick={(): void => chrome.runtime.openOptionsPage(() => {})}
           />
         </header>
         <div className="h-[calc(100vh-3rem)] bg-grey-100 relative overflow-x-hidden">
diff --git a/src/pages/devtools/index.tsx b/src/pages/devtools/index.tsx
@@ -2,6 +2,5 @@ import ReactDOM from 'react-dom/client';
 
 import { App } from './App';
 import 'content/tailwind.css';
-import '@algolia/satellite/satellite.min.css';
 
 ReactDOM.createRoot(document.getElementById('root')!).render(<App />);
diff --git a/src/pages/options/index.tsx b/src/pages/options/index.tsx
@@ -2,6 +2,5 @@ import ReactDOM from 'react-dom/client';
 
 import { Page } from './Page';
 import 'content/tailwind.css';
-import '@algolia/satellite/satellite.min.css';
 
 ReactDOM.createRoot(document.getElementById('root')!).render(<Page />);
diff --git a/tailwind.config.js b/tailwind.config.js
@@ -1,11 +1,11 @@
-const sourceSatellite = require('@algolia/satellite/cjs/styles/tailwind.config.js');
+const sourceSatellite = require('@algolia/satellite/tailwind.config.js');
 
 const { prefix, ...satellite } = sourceSatellite;
 
 /** @type {import('tailwindcss').Config} */
 module.exports = {
   presets: [satellite],
-  content: ['./src/**/*.html', './src/**/*.ts', './src/**/*.tsx'],
+  content: ['./node_modules/@algolia/satellite/**/*.js', './src/**/*.{html,ts,tsx}'],
   theme: {
     ...satellite.theme,
     extends: {},
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+@import '../../node_modules/@algolia/satellite/dist/satellite.min.css';`
	`2`	`+`
`1`	`3`	`@tailwind base;`
`2`	`4`	`@tailwind components;`
`3`	`5`	`@tailwind utilities;`