Files
rowy/src/components/CodeEditor/useMonacoCustomizations.ts

322 lines
9.4 KiB
TypeScript
Raw Normal View History

2021-10-29 18:09:37 +11:00
import { useEffect } from "react";
2022-06-09 13:27:59 +10:00
// import {
// quicktype,
// InputData,
// jsonInputForTargetLanguage,
// } from "quicktype-core";
2022-06-08 12:32:17 +10:00
import { useAtom } from "jotai";
2021-10-29 18:09:37 +11:00
2022-06-08 12:32:17 +10:00
import {
tableScope,
tableRowsAtom,
tableColumnsOrderedAtom,
} from "@src/atoms/tableScope";
2021-10-29 18:09:37 +11:00
import { useMonaco } from "@monaco-editor/react";
import type { languages } from "monaco-editor/esm/vs/editor/editor.api";
import githubLightTheme from "./github-light-default.json";
import githubDarkTheme from "./github-dark-default.json";
import { useTheme } from "@mui/material";
2021-11-30 12:27:28 +11:00
import type { SystemStyleObject, Theme } from "@mui/system";
2021-10-29 18:09:37 +11:00
// TODO:
2022-05-24 20:34:28 +10:00
// import { getFieldType, getFieldProp } from "@src/components/fields";
2021-10-29 18:09:37 +11:00
/* eslint-disable import/no-webpack-loader-syntax */
import firestoreDefs from "!!raw-loader!./firestore.d.ts";
import firebaseAuthDefs from "!!raw-loader!./firebaseAuth.d.ts";
import firebaseStorageDefs from "!!raw-loader!./firebaseStorage.d.ts";
import utilsDefs from "!!raw-loader!./utils.d.ts";
2021-12-02 20:24:37 +07:00
import rowyUtilsDefs from "!!raw-loader!./rowy.d.ts";
2021-10-29 18:09:37 +11:00
import extensionsDefs from "!!raw-loader!./extensions.d.ts";
2022-03-04 09:54:37 +08:00
import { runRoutes } from "@src/constants/runRoutes";
2022-07-18 14:40:46 +10:00
import { rowyRunAtom, projectScope } from "@src/atoms/projectScope";
2022-06-08 12:32:17 +10:00
import { getFieldProp } from "@src/components/fields";
2021-10-29 18:09:37 +11:00
export interface IUseMonacoCustomizationsProps {
minHeight?: number;
disabled?: boolean;
error?: boolean;
extraLibs?: string[];
diagnosticsOptions?: languages.typescript.DiagnosticsOptions;
onUnmount?: () => void;
2021-11-02 12:36:12 +11:00
// Internal only
fullScreen?: boolean;
2021-10-29 18:09:37 +11:00
}
export default function useMonacoCustomizations({
minHeight,
disabled,
error,
extraLibs,
diagnosticsOptions = {
noSemanticValidation: true,
noSyntaxValidation: false,
},
2021-10-29 18:09:37 +11:00
onUnmount,
2021-11-02 12:36:12 +11:00
fullScreen,
2021-10-29 18:09:37 +11:00
}: IUseMonacoCustomizationsProps) {
const theme = useTheme();
const monaco = useMonaco();
2022-06-08 12:32:17 +10:00
const [tableRows] = useAtom(tableRowsAtom, tableScope);
2022-07-18 14:40:46 +10:00
const [rowyRun] = useAtom(rowyRunAtom, projectScope);
2022-06-08 12:32:17 +10:00
const [tableColumnsOrdered] = useAtom(tableColumnsOrderedAtom, tableScope);
2021-10-29 18:09:37 +11:00
useEffect(() => {
return () => {
onUnmount?.();
};
}, []);
// Initialize external libs & TypeScript compiler options
2021-10-29 18:09:37 +11:00
useEffect(() => {
if (!monaco) return;
2021-10-29 18:09:37 +11:00
try {
monaco.languages.typescript.javascriptDefaults.setCompilerOptions({
target: monaco.languages.typescript.ScriptTarget.ES2020,
allowNonTsExtensions: true,
});
2021-10-29 18:09:37 +11:00
monaco.languages.typescript.javascriptDefaults.addExtraLib(firestoreDefs);
monaco.languages.typescript.javascriptDefaults.addExtraLib(
firebaseAuthDefs
);
monaco.languages.typescript.javascriptDefaults.addExtraLib(
firebaseStorageDefs
);
monaco.languages.typescript.javascriptDefaults.addExtraLib(
utilsDefs,
"ts:filename/utils.d.ts"
);
2021-12-02 20:24:37 +07:00
monaco.languages.typescript.javascriptDefaults.addExtraLib(rowyUtilsDefs);
} catch (error) {
console.error(
"An error occurred during initialization of Monaco: ",
error
);
}
}, [monaco]);
// Initialize extraLibs from props
useEffect(() => {
if (!monaco) return;
if (!extraLibs) return;
try {
monaco.languages.typescript.javascriptDefaults.addExtraLib(
extraLibs.join("\n"),
"ts:filename/extraLibs.d.ts"
);
} catch (error) {
console.error("Could not add extraLibs from props: ", error);
}
}, [monaco, extraLibs]);
// Set diagnostics options
const stringifiedDiagnosticsOptions = JSON.stringify(diagnosticsOptions);
useEffect(() => {
if (!monaco) return;
2021-10-29 18:09:37 +11:00
try {
monaco.languages.typescript.javascriptDefaults.setDiagnosticsOptions({
...JSON.parse(stringifiedDiagnosticsOptions),
diagnosticCodesToIgnore: [
1323, // remove dynamic import error
],
});
} catch (error) {
console.error("Could not set diagnostics options: ", error);
}
}, [monaco, stringifiedDiagnosticsOptions]);
2022-06-08 12:32:17 +10:00
const addJsonFieldDefinition = async (
columnKey: string,
interfaceName: string
) => {
const samples = tableRows
.map((row) => row[columnKey])
.filter((entry) => entry !== undefined)
.map((entry) => JSON.stringify(entry));
2022-06-09 13:27:59 +10:00
monaco?.languages.typescript.javascriptDefaults.addExtraLib(
`type ${interfaceName} = any;`
);
// if (!samples || samples.length === 0) {
// monaco?.languages.typescript.javascriptDefaults.addExtraLib(
// `type ${interfaceName} = any;`
// );
// return;
// } else {
// const jsonInput = jsonInputForTargetLanguage("typescript");
// await jsonInput.addSource({
// name: interfaceName,
// samples,
// });
// const inputData = new InputData();
// inputData.addInput(jsonInput);
// const result = await quicktype({
// inputData,
// lang: "typescript",
// rendererOptions: { "just-types": "true" },
// });
// const newLib = result.lines.join("\n").replaceAll("export ", "");
// monaco?.languages.typescript.javascriptDefaults.addExtraLib(newLib);
//}
2022-06-08 12:32:17 +10:00
};
2022-06-08 12:32:17 +10:00
const setSecrets = async () => {
// set secret options
try {
const listSecrets = await rowyRun({
route: runRoutes.listSecrets,
});
const secretsDef = `type SecretNames = ${listSecrets
.map((secret: string) => `"${secret}"`)
.join(" | ")}
enum secrets {
${listSecrets
.map((secret: string) => `${secret} = "${secret}"`)
.join("\n")}
}
`;
monaco?.languages.typescript.javascriptDefaults.addExtraLib(secretsDef);
} catch (error) {
console.error("Could not set secret definitions: ", error);
}
};
//TODO: types
const setBaseDefinitions = () => {
const rowDefinition =
tableColumnsOrdered
.map((column) => {
const { type, key } = column;
if (type === "JSON") {
const interfaceName = key[0].toUpperCase() + key.slice(1);
addJsonFieldDefinition(key, interfaceName);
const def = `static "${key}": ${interfaceName}`;
return def;
}
return `static "${key}": ${getFieldProp("dataType", type)}`;
})
.join(";\n") + ";";
const availableFields = tableColumnsOrdered
.map((key) => `"${key}"`)
.join("|\n");
2022-06-08 12:32:17 +10:00
monaco?.languages.typescript.javascriptDefaults.addExtraLib(
["/**", " * extensions type configuration", " */", extensionsDefs].join(
"\n"
),
"ts:filename/extensions.d.ts"
);
monaco?.languages.typescript.javascriptDefaults.addExtraLib(
[
"// basic types that are used in all places",
"declare var require: any;",
"declare var Buffer: any;",
"const ref: FirebaseFirestore.DocumentReference;",
"const storage: firebasestorage.Storage;",
"const db: FirebaseFirestore.Firestore;",
"const auth: firebaseauth.BaseAuth;",
`type Row = {${rowDefinition}};`,
`type Field = ${availableFields} | string | object;`,
`type Fields = Field[];`,
].join("\n"),
"ts:filename/rowFields.d.ts"
);
};
//TODO: Set row definitions
useEffect(() => {
if (!monaco) return;
try {
setBaseDefinitions();
} catch (error) {
console.error("Could not set basic", error);
}
// set available secrets from secretManager
try {
setSecrets();
} catch (error) {
console.error("Could not set secrets: ", error);
}
}, [monaco, tableColumnsOrdered]);
2021-10-29 18:09:37 +11:00
2021-11-30 12:27:28 +11:00
let boxSx: SystemStyleObject<Theme> = {
2021-10-29 18:09:37 +11:00
minWidth: 400,
minHeight,
height: minHeight,
borderRadius: 1,
resize: "vertical",
overflow: "hidden",
position: "relative",
backgroundColor: disabled ? "transparent" : theme.palette.action.input,
"&::after": {
content: '""',
position: "absolute",
top: 0,
left: 0,
bottom: 0,
right: 0,
pointerEvents: "none",
borderRadius: "inherit",
boxShadow: `0 -1px 0 0 ${theme.palette.text.disabled} inset,
0 0 0 1px ${theme.palette.action.inputOutline} inset`,
transition: theme.transitions.create("box-shadow", {
duration: theme.transitions.duration.short,
}),
},
"&:hover::after": {
boxShadow: `0 -1px 0 0 ${theme.palette.text.primary} inset,
0 0 0 1px ${theme.palette.action.inputOutline} inset`,
},
"&:focus-within::after": {
boxShadow: `0 -2px 0 0 ${theme.palette.primary.main} inset,
0 0 0 1px ${theme.palette.action.inputOutline} inset`,
},
...(error
? {
"&::after, &:hover::after, &:focus-within::after": {
boxShadow: `0 -2px 0 0 ${theme.palette.error.main} inset,
0 0 0 1px ${theme.palette.action.inputOutline} inset`,
},
}
: {}),
"& .editor": {
// Overwrite user-select: none that causes editor
// to not be focusable in Safari
userSelect: "auto",
height: "100%",
},
"& .monaco-editor, & .monaco-editor .margin, & .monaco-editor-background": {
backgroundColor: "transparent",
},
};
2021-11-02 12:36:12 +11:00
if (fullScreen)
boxSx = {
...boxSx,
position: "fixed",
top: 0,
left: 0,
right: 0,
bottom: 0,
2022-06-06 12:21:38 +10:00
zIndex: theme.zIndex.tooltip * 2,
2021-11-02 12:36:12 +11:00
m: "0 !important",
resize: "none",
backgroundColor: theme.palette.background.paper,
borderRadius: 0,
"&::after": { display: "none" },
};
2021-10-29 18:09:37 +11:00
return { boxSx };
}