Check types with tsc in CI (withastro#2535)

.github/workflows/ci.yml

@@ -29,6 +29,18 @@ jobs:
 
       - name: Run Check
         run: pnpm run check
+  tsc:
+    name: Check for type issues with tsc
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install Tools & Dependencies
+        uses: ./.github/actions/install
+
+      - name: Run Check
+        run: pnpm run tsc
   eslint:
     name: Check for code issues with ESLint
     runs-on: ubuntu-latest

integrations/astro-asides.ts

@@ -37,8 +37,9 @@ function remarkAsides(): unified.Plugin<[], mdast.Root> {
 	const variants = new Set(['note', 'tip', 'caution', 'danger']);
 
 	const transformer: unified.Transformer<mdast.Root> = (tree, file) => {
+		// @ts-expect-error Possibly infinite type instantiation we can’t do anything about.
 		visit(tree, (node, index, parent) => {
-			if (node.type !== 'containerDirective') return;
+			if (!parent || index === null || node.type !== 'containerDirective') return;
 			const type = node.name;
 			if (!variants.has(type)) return;
 

integrations/utils/isMDX.ts

@@ -1,4 +1,4 @@
-import { VFile } from 'vfile';
+import type { VFile } from 'vfile';
 
 export function isMDXFile(file: VFile) {
 	return file.history[0].endsWith('.mdx');

package.json

@@ -9,6 +9,7 @@
     "test": "vitest",
     "preview": "astro preview",
     "check": "astro check",
+    "tsc": "tsc",
     "format": "pnpm run format:code",
     "format:ci": "pnpm run format:imports && pnpm run format:code",
     "format:code": "prettier -w . --cache --plugin-search-dir=.",
@@ -37,6 +38,7 @@
     "@docsearch/css": "^3.2.2",
     "@docsearch/react": "^3.2.0",
     "@types/chroma-js": "^2.1.4",
+    "@types/hast": "^2.3.4",
     "@types/html-escaper": "^3.0.0",
     "@types/mdast": "^3.0.10",
     "@types/node": "^18.6.4",
@@ -64,6 +66,7 @@
     "kleur": "^4.1.5",
     "mdast-util-from-markdown": "^1.2.0",
     "mdast-util-to-hast": "^12.2.4",
+    "mdast-util-to-string": "^3.1.1",
     "micromark-util-character": "^1.1.0",
     "micromark-util-symbol": "^1.0.1",
     "node-fetch": "^3.2.10",

scripts/generate-integration-pages.ts

@@ -1,5 +1,16 @@
 import kleur from 'kleur';
-import type { Definition, HTML, Link, Root, Text } from 'mdast';
+import type {
+	Blockquote,
+	Definition,
+	HTML,
+	Link,
+	ListContent,
+	Paragraph,
+	PhrasingContent,
+	Root,
+	Text,
+} from 'mdast';
+import { toString } from 'mdast-util-to-string';
 import fetch from 'node-fetch';
 import fs from 'node:fs';
 import { remark } from 'remark';
@@ -193,35 +204,38 @@ function closeUnclosedLinebreaks() {
 /** Remark plugin to replace GitHub note/warning syntax with docs-style asides. */
 function replaceAsides() {
 	return function transform(tree: Root) {
-		visit(tree, 'blockquote', (node) => {
+		visit(tree, 'blockquote', (node: Blockquote | Paragraph) => {
 			const openingParagraph = node.children[0];
-			const [firstChild, trailingText] = openingParagraph.children;
+
+			if (!('children' in openingParagraph)) return;
+			const [firstChild, trailingText, ...children] = openingParagraph.children;
 
 			// check for **Note:** or **Warning:** at the beginning of the first paragraph
-			if (firstChild.type !== 'strong' || !/Note|Warning/.test(firstChild.children[0].value)) {
-				return;
-			}
+			if (firstChild.type !== 'strong') return;
+			const firstChildText = toString(firstChild);
+			if (!/Note|Warning/.test(firstChildText)) return;
 
 			// assign aside type
-			const AsideType =
-				firstChild.children[0].value.toLowerCase() === 'warning' ? 'caution' : 'note';
+			const AsideType = firstChildText.toLowerCase() === 'warning' ? 'caution' : 'note';
 
 			// remove blockquotes `>`
 			node.type = 'paragraph';
 
-			// replace **strong** for :::aside
-			firstChild.type = 'text';
-			firstChild.value = `:::${AsideType}`;
-
 			// if trailingText starts with `: ` replace it with a newline
-			trailingText.value = trailingText.value.replace(/^: /, '\n');
+			if ('value' in trailingText) {
+				trailingText.value = trailingText.value.replace(/^: /, '\n');
+			}
+
+			// Opening and closing ::: text to wrap blockquote.
+			const openAside: Text = { type: 'text', value: `:::${AsideType}` };
+			const closeAside: Text = { type: 'text', value: '\n:::' };
 
-			// append ::: at end of the paragraph
-			const lastChild = {
-				type: 'text',
-				value: '\n:::',
-			};
-			openingParagraph.children.push(lastChild);
+			openingParagraph.children = [
+				openAside,
+				trailingText,
+				...children,
+				closeAside,
+			] as ListContent[];
 		});
 	};
 }
@@ -263,7 +277,7 @@ function removeTOC() {
 			const firstItemContent = node.children[0].children[0];
 			if (firstItemContent.type !== 'paragraph') return;
 			return firstItemContent.children.some(
-				(child) =>
+				(child: PhrasingContent) =>
 					child.type === 'link' &&
 					(child.url.startsWith('#why') || child.url.startsWith('#installation'))
 			);

scripts/lib/linkcheck/base/base.ts

@@ -1,4 +1,4 @@
-import { CheckBase } from './check';
+import type { CheckBase } from './check';
 
 export interface LinkCheckerOptions {
 	baseUrl: string;

scripts/lib/linkcheck/base/check.ts

@@ -1,5 +1,5 @@
-import { LinkIssue } from './issue';
-import { AllPagesByPathname, HtmlPage } from './page';
+import type { LinkIssue } from './issue';
+import type { AllPagesByPathname, HtmlPage } from './page';
 
 export interface CheckHtmlPageContext {
 	allPages: AllPagesByPathname;

scripts/lib/linkcheck/base/issue.ts

@@ -1,7 +1,7 @@
-import { AnnotationProperties } from '@actions/core';
+import type { AnnotationProperties } from '@actions/core';
 import { formatCount } from '../../output.mjs';
-import { CheckBase } from './check';
-import { HtmlPage } from './page';
+import type { CheckBase } from './check';
+import type { HtmlPage } from './page';
 
 export interface LinkIssue {
 	type: IssueType;

scripts/lib/linkcheck/base/page.ts

@@ -1,4 +1,4 @@
-import { Document, Element } from 'domhandler';
+import type { Document, Element } from 'domhandler';
 import htmlparser2 from 'htmlparser2';
 
 export interface AllPagesByPathname {

scripts/lib/linkcheck/steps/build-index.ts

@@ -1,7 +1,7 @@
 import fs from 'fs';
 import path from 'path';
 import { dedentMd } from '../../output.mjs';
-import { LinkCheckerOptions } from '../base/base';
+import type { LinkCheckerOptions } from '../base/base';
 import { AllPagesByPathname, HtmlPage } from '../base/page';
 
 /**
@@ -13,7 +13,7 @@ export function getPagePathnamesFromSitemap(options: LinkCheckerOptions) {
 	const sitemaps = distContents.filter((path) => /^sitemap-\d+\.xml$/.test(path));
 
 	const sitemapRegex = new RegExp(`<loc>${options.baseUrl}(/.*?)</loc>`, 'ig');
-	const uniquePagePaths = new Set();
+	const uniquePagePaths = new Set<string>();
 
 	for (const filename of sitemaps) {
 		const sitemapFilePath = path.join(options.buildOutputDir, filename);

scripts/lib/linkcheck/steps/find-issues.ts

@@ -2,8 +2,8 @@ import fs from 'fs';
 import path from 'path';
 import { dedentMd } from '../../output.mjs';
 import { indexOfHref, LinkCheckerOptions, LinkCheckerState } from '../base/base';
-import { LinkIssue } from '../base/issue';
-import { AllPagesByPathname, HtmlPage } from '../base/page';
+import type { LinkIssue } from '../base/issue';
+import type { AllPagesByPathname, HtmlPage } from '../base/page';
 
 /**
  * Goes through all pre-parsed and indexed pages, runs all configured checks,

scripts/lib/linkcheck/steps/optional-autofix.ts

@@ -2,7 +2,7 @@ import fs from 'fs';
 import kleur from 'kleur';
 import { dedentMd, formatCount } from '../../output.mjs';
 import { LinkCheckerOptions, LinkCheckerState, replaceHrefs } from '../base/base';
-import { LinkIssue } from '../base/issue';
+import type { LinkIssue } from '../base/issue';
 
 /**
  * Handle all autofix-related tasks:

scripts/lib/linkcheck/steps/output-issues.ts

@@ -1,9 +1,9 @@
 import core from '@actions/core';
 import kleur from 'kleur';
 import { dedentMd, formatCount } from '../../output.mjs';
-import { LinkCheckerState } from '../base/base';
-import { IssueType, LinkIssue } from '../base/issue';
-import { HtmlPage } from '../base/page';
+import type { LinkCheckerState } from '../base/base';
+import type { IssueType, LinkIssue } from '../base/issue';
+import type { HtmlPage } from '../base/page';
 
 /**
  * Outputs the result of the link check to the console.

src/components/tabs/useTabState.ts

@@ -14,7 +14,7 @@ export function useTabState(
 	if (!storeKey) return localState;
 
 	const curr = $tabStore[storeKey]?.curr ?? initialCurr;
-	function setCurr(newCurr) {
+	function setCurr(newCurr: string) {
 		if (storeKey) {
 			tabStore.setKey(storeKey, { curr: newCurr });
 		} else {

src/i18n/ar/ui.ts

@@ -21,7 +21,6 @@ export default UIDictionary({
 		'astro logo on a starry expanse of space, with a purple saturn-like planet floating in the right foreground',
 	// Left Sidebar
 	'leftSidebar.a11yTitle': 'الأساسي',
-	'leftSidebar.noTranslations': 'لم يتم العثور على أي ترجمة',
 	'leftSidebar.viewInEnglish': 'أعرض الإنجليزية',
 	// Right Sidebar
 	'rightSidebar.a11yTitle': 'ثانوي',

src/i18n/de/nav.ts

@@ -6,9 +6,6 @@ export default NavDictionary({
 	'getting-started': 'Erste Schritte',
 	install: 'Installation',
 	'editor-setup': 'Editor-Einrichtung',
-	migrate: 'Migrations-Anleitung',
-	'integrations/integrations': 'Mit Astro gebaut',
-	'comparing-astro-vs-other-tools': 'Astro vs. X',
 
 	// Core Concepts
 	coreConcepts: 'Kernkonzepte',

src/i18n/es/nav.ts

@@ -5,7 +5,6 @@ export default NavDictionary({
 	'getting-started': 'Empezando',
 	install: 'Instalación',
 	'editor-setup': 'Configuración del editor de código',
-	migrate: 'Guía de migración',
 	coreConcepts: 'Conceptos básicos',
 	'concepts/why-astro': '¿Por qué usar Astro?',
 	'concepts/mpa-vs-spa': 'MPA vs. SPA',

src/i18n/fr/nav.ts

@@ -10,9 +10,6 @@ export default NavDictionary({
 	'getting-started': 'Bien démarrer',
 	install: 'Installation',
 	'editor-setup': "Configuration de l'éditeur de code",
-	migrate: 'Guide de Migration',
-	'integrations/integrations': 'Construit avec Astro',
-	'comparing-astro-vs-other-tools': 'Astro vs. X',
 
 	// Core Concepts
 	coreConcepts: 'Concepts Fondamentaux',

src/i18n/ja/nav.ts

@@ -6,7 +6,6 @@ export default NavDictionary({
 	'getting-started': 'はじめに',
 	install: 'インストール',
 	'editor-setup': 'エディタのセットアップ',
-	migrate: 'アップグレードガイド',
 
 	// Tutorials
 	tutorials: 'チュートリアル',

src/i18n/pt-br/nav.ts

@@ -6,7 +6,6 @@ export default NavDictionary({
 	install: 'Instalação',
 	'editor-setup': 'Configuração do Editor',
 	'guides/migrate-to-astro': 'Migre para o Astro',
-	migrate: 'Guia de Migração',
 	coreConcepts: 'Principais Conceitos',
 	'concepts/why-astro': 'Por que Astro?',
 	'concepts/islands': 'Ilhas Astro',

src/i18n/zh-tw/nav.ts

@@ -5,7 +5,6 @@ export default NavDictionary({
 	'getting-started': '新手上路',
 	install: '安裝',
 	'editor-setup': '編輯器設定',
-	migrate: '轉移指南',
 
 	// Core Concepts
 	coreConcepts: '主要概念',

src/util-server.ts

@@ -3,6 +3,7 @@
 	Do not import this file from a hydrated client-side component.
 */
 
+// @ts-expect-error Package without types we can’t do anything about.
 import EleventyFetch from '@11ty/eleventy-fetch';
 
 export type CachedFetchOptions = {
@@ -26,7 +27,8 @@ export async function cachedFetch(
 			type: 'buffer',
 			fetchOptions,
 		});
-	} catch (error) {
+	} catch (e: unknown) {
+		const error = e as Error;
 		const msg: string = error?.message || error.toString();
 		const matches = msg.match(/^Bad response for (.*) \(.*?\): (.*)$/);
 		status = parseInt(matches?.[2] || '') || 404;

src/util/getGithubEditUrl.ts

@@ -1,4 +1,4 @@
-import { AstroGlobal } from 'astro';
+import type { AstroGlobal } from 'astro';
 import { getLanguageFromURL } from '../util';
 
 /** Gets the URL to edit the page on GitHub */

src/util/groupPagesByLang.ts

@@ -2,6 +2,9 @@ import type { MarkdownInstance } from 'astro';
 
 export const groupPagesByLang = <T extends MarkdownInstance<Record<string, unknown>>>(pages: T[]) =>
 	pages.reduce((pages, page) => {
+		if (!page.url) {
+			throw new Error('No `url` for page: ' + page.file);
+		}
 		const lang = page.url.split('/')[1];
 		if (!pages[lang]) pages[lang] = [];
 		pages[lang].push(page);