Added tseslint style checks (#31)

Author: nebrius

packages/config/eslint/base.mjs

@@ -39,6 +39,7 @@ export const getBaseESLintConfig = ({
         ]
       : undefined),
     ...tseslint.configs.recommendedTypeChecked,
+    ...tseslint.configs.stylisticTypeChecked,
     {
       files: ["**/*.{ts,tsx,mts}"],
       languageOptions: {
@@ -78,6 +79,7 @@ export const getBaseESLintConfig = ({
         "no-return-assign": "error",
         "@typescript-eslint/consistent-type-imports": "error",
         "@typescript-eslint/no-non-null-assertion": "error",
+        "@typescript-eslint/consistent-type-definitions": ["error", "type"],
 
         // TODO: Currently this crashes and so we have to turn it off. It was fixed previously at
         // https://github.com/typescript-eslint/typescript-eslint/issues/10338, but seems to have regressed

packages/docs-md/src/cli/cli.ts

@@ -115,9 +115,7 @@ async function getSettings(): Promise<ParsedSettings> {
     );
   }
 
-  if (!configFileImport.output) {
-    configFileImport.output = {};
-  }
+  configFileImport.output ??= {};
 
   // Parse the settings using Zod to ensure accuracy
   const configFileContents = settingsSchema.safeParse(configFileImport);

packages/docs-md/src/components/TryItNow/hooks/useCodeDependencies.ts

@@ -20,7 +20,7 @@ export function useTranspileDependencyMatches(transpiledCode: string) {
     const dependencies = transpiledCode.matchAll(re);
     const dependenciesArray = Array.from(dependencies).reduce(
       (prev, match) => {
-        const dependency = match.groups?.dependency || "";
+        const dependency = match.groups?.dependency ?? "";
         // filter out local dependencies
         if (localImportRegex.test(dependency)) {
           return prev;

packages/docs-md/src/components/TryItNow/state/index.ts

@@ -8,7 +8,7 @@ export const lastEditorValueAtom = atom<string | null>(null);
 export const setDependenciesAtom = atom(
   null,
   (get, set, dependencies: Record<string, string>, code: string) => {
-    const previousDependencies = get(dependenciesAtom) || {};
+    const previousDependencies = get(dependenciesAtom) ?? {};
     if (
       Object.keys(dependencies).join("-") !==
       Object.keys(previousDependencies).join("-")

packages/docs-md/src/pages/codeSnippets/generateCodeSnippets.ts

@@ -9,7 +9,7 @@ import type {
 import { getSettings } from "../../util/settings.ts";
 
 const CODE_SNIPPETS_API_URL =
-  process.env.SPEAKEASY_CODE_SNIPPETS_API_URL || "https://api.speakeasy.com";
+  process.env.SPEAKEASY_CODE_SNIPPETS_API_URL ?? "https://api.speakeasy.com";
 
 export type DocsCodeSnippets = Record<OperationChunk["id"], CodeSnippet>;
 

packages/docs-md/src/pages/content/chunks/schema.ts

@@ -33,7 +33,7 @@ type TypeLabel = {
 
 type DisplayType = {
   typeLabel: TypeLabel;
-  breakoutSubTypes: Array<{ label: string; schema: SchemaValue }>;
+  breakoutSubTypes: { label: string; schema: SchemaValue }[];
 };
 
 function getDisplayType(
@@ -208,9 +208,7 @@ function computeMultilineTypeLabel(
       }
 
       let contents = `${typeLabel.label}<\n`;
-      for (let i = 0; i < children.length; i++) {
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        const child = children[i]!;
+      for (const child of children) {
         contents += `${" ".repeat(indentation + 1)}${child.contents}\n`;
       }
       contents += `${" ".repeat(indentation)}>\n`;
@@ -241,9 +239,7 @@ function computeMultilineTypeLabel(
       }
 
       let contents = "\n";
-      for (let i = 0; i < children.length; i++) {
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        const child = children[i]!;
+      for (const child of children) {
         contents += `${" ".repeat(indentation)}| ${child.contents}\n`;
       }
       return {

packages/docs-md/src/pages/data/getDocsData.ts

@@ -9,7 +9,7 @@ import { unzipSync } from "node:zlib";
 import type { Chunk } from "../../types/chunk.ts";
 declare class Go {
   argv: string[];
-  env: { [envKey: string]: string };
+  env: Record<string, string>;
   exit: (code: number) => void;
   importObject: WebAssembly.Imports;
   exited: boolean;

packages/docs-md/src/types/renderer.ts

@@ -4,7 +4,7 @@ export type AppendOptions = {
   escape?: Escape;
 };
 
-export interface Renderer {
+export type Renderer = {
   escapeText(text: string, options: { escape: Escape }): string;
 
   insertFrontMatter(options: {
@@ -67,4 +67,4 @@ export interface Renderer {
   }): void;
 
   render(): string;
-}
+};

packages/docs-md/src/types/site.ts

@@ -1,8 +1,8 @@
 import type { Renderer } from "./renderer.ts";
 
-export interface Site {
+export type Site = {
   createPage(path: string): Renderer;
   render(): Record<string, string>;
   buildPagePath(slug: string, options?: { appendIndex?: boolean }): string;
   hasPage(path: string): boolean;
-}
+};

scaffold-templates/docusaurus/src/components/PropertiesModal.tsx

@@ -1,9 +1,9 @@
 import * as Dialog from "@radix-ui/react-dialog";
 import "./styles.css";
 
-interface PropertiesModalProps {
+type PropertiesModalProps = {
   children: React.ReactNode;
-}
+};
 
 export const PropertiesModal = ({ children }: PropertiesModalProps) => (
   <Dialog.Root>