feat: migrate plugins to TypeScript and update package configurations

Author: clicktodev

plugins/remark-codeblock-language-as-title/package.json

@@ -3,7 +3,7 @@
   "version": "0.0.1",
   "private": true,
   "description": "Remark plugin for using codeblock language as title",
-  "main": "src/index.js",
+  "main": "src/index.ts",
   "type": "module",
   "keywords": [
     "remark",
@@ -20,6 +20,7 @@
     "unist-util-visit": "^5.0.0"
   },
   "devDependencies": {
+    "@types/mdast": "^4.0.4",
     "remark": "^15.0.1"
   }
 }

…codeblock-language-as-title/src/index.js …codeblock-language-as-title/src/index.tsplugins/remark-codeblock-language-as-title/src/index.js renamed to plugins/remark-codeblock-language-as-title/src/index.ts plugins/remark-codeblock-language-as-title/src/index.js renamed to plugins/remark-codeblock-language-as-title/src/index.ts

@@ -5,12 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+import { Root } from 'mdast';
+
 export default function codeblockLanguageAsTitleRemarkPlugin() {
-  /**
-   * @param {import('mdast').Root} root - The root node of the Markdown AST
-   * @returns {Promise<void>}
-   */
-  return async root => {
+  return async (root: Root) => {
     const {visit} = await import('unist-util-visit');
     visit(root, 'code', node => {
       if (node.lang) {

plugins/remark-lint-no-dead-urls/package.json

@@ -3,7 +3,7 @@
   "version": "0.0.1",
   "private": true,
   "description": "Remark linter rule to check for dead urls",
-  "main": "src/index.js",
+  "main": "src/index.ts",
   "type": "module",
   "keywords": [
     "remark",

…ns/remark-lint-no-dead-urls/src/index.js …ns/remark-lint-no-dead-urls/src/index.tsplugins/remark-lint-no-dead-urls/src/index.js renamed to plugins/remark-lint-no-dead-urls/src/index.ts plugins/remark-lint-no-dead-urls/src/index.js renamed to plugins/remark-lint-no-dead-urls/src/index.ts

@@ -12,6 +12,10 @@ import {lintRule} from 'unified-lint-rule';
 import {visit} from 'unist-util-visit';
 
 import {fetch} from './lib.js';
+import { Node, Data } from 'unist';
+import { Root } from 'mdast';
+
+import { Method } from 'got';
 
 const linkCache = new Map();
 
@@ -23,12 +27,12 @@ const HTTP = {
 };
 
 const uri = {
-  isLocalhost: url => /^(https?:\/\/)(localhost|127\.0\.0\.1)(:\d+)?/.test(url),
-  isExternal: url => /(https?:\/\/)/.test(url),
-  isPath: url => /^\/.*/.test(url),
+  isLocalhost: (url: string) => /^(https?:\/\/)(localhost|127\.0\.0\.1)(:\d+)?/.test(url),
+  isExternal: (url: string) => /(https?:\/\/)/.test(url),
+  isPath: (url: string) => /^\/.*/.test(url),
 };
 
-async function cacheFetch(urlOrPath, method, options) {
+async function cacheFetch(urlOrPath: string, method: Method, options: { [x: string]: any; baseUrl: any; }) {
   if (linkCache.has(urlOrPath)) {
     return [urlOrPath, linkCache.get(urlOrPath)];
   }
@@ -42,9 +46,9 @@ async function cacheFetch(urlOrPath, method, options) {
   return [urlOrPath, code];
 }
 
-async function naiveLinkCheck(urls, options) {
+async function naiveLinkCheck(urls: string[] , options : { [x: string]: any; baseUrl: any; }) {
   return Promise.allSettled(
-    urls.map(async url => {
+    urls.map(async (url) => {
       try {
         return await cacheFetch(url, 'HEAD', options);
       } catch {
@@ -64,7 +68,15 @@ async function naiveLinkCheck(urls, options) {
   );
 }
 
-async function noDeadUrls(ast, file, options = {}) {
+async function noDeadUrls(
+  ast: Root,
+  file: any,
+  options: {
+    skipUrlPatterns?: string[];
+    baseUrl?: string;
+    [key: string]: any;
+  } = {}
+) {
   const urlToNodes = new Map();
 
   const {skipUrlPatterns, ...clientOptions} = options;

…gins/remark-lint-no-dead-urls/src/lib.js …gins/remark-lint-no-dead-urls/src/lib.tsplugins/remark-lint-no-dead-urls/src/lib.js renamed to plugins/remark-lint-no-dead-urls/src/lib.ts plugins/remark-lint-no-dead-urls/src/lib.js renamed to plugins/remark-lint-no-dead-urls/src/lib.ts

@@ -5,9 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import got from 'got';
+import got, { Method } from 'got';
 
-export async function fetch(url, method, options = {}) {
+export async function fetch(url: string, method: Method, options = {}) {
   const {statusCode} = await got(url, {
     ...options,
     method,

plugins/remark-snackplayer/package.json

@@ -3,7 +3,7 @@
   "version": "0.1.0",
   "private": true,
   "description": "Remark Expo Snack Plugin",
-  "main": "src/index.js",
+  "main": "src/index.ts",
   "type": "module",
   "keywords": [
     "remark",
@@ -17,14 +17,16 @@
   ],
   "scripts": {
     "lint": "eslint .",
-    "test": "yarn tape tests/index.js"
+    "test": "yarn tape tests/index.ts"
   },
   "dependencies": {
     "dedent": "^1.5.3",
     "object.fromentries": "^2.0.3",
     "unist-util-visit-parents": "^3.1.1"
   },
   "devDependencies": {
+    "@types/object.fromentries": "^2.0.4",
+    "@types/tape": "^5.8.1",
     "remark": "^15.0.1",
     "remark-mdx": "^3.1.0",
     "tape": "^5.7.0"

plugins/remark-snackplayer/src/index.js plugins/remark-snackplayer/src/index.tsplugins/remark-snackplayer/src/index.js renamed to plugins/remark-snackplayer/src/index.ts

@@ -9,6 +9,8 @@
 
 import visit from 'unist-util-visit-parents';
 import fromEntries from 'object.fromentries';
+import { Node, Data } from 'unist';
+import { Root } from 'mdast';
 
 const parseParams = (paramString = '') => {
   const params = fromEntries(new URLSearchParams(paramString));
@@ -20,15 +22,15 @@ const parseParams = (paramString = '') => {
   return params;
 };
 
-function attr(name, value) {
+function attr(name: string, value: string) {
   return {
     type: 'mdxJsxAttribute',
     name,
     value,
   };
 }
 
-async function toJsxNode(node) {
+async function toJsxNode(node: Node<Data>) {
   const params = parseParams(node.meta);
 
   // Gather necessary Params
@@ -85,7 +87,7 @@ async function toJsxNode(node) {
 }
 
 export default function SnackPlayer() {
-  return async tree => {
+  return async (tree: Node<Data>) => {
     const nodesToProcess = [];
     visit(tree, 'code', (node, parent) => {
       if (node.lang === 'SnackPlayer') {

plugins/remark-snackplayer/tests/index.js plugins/remark-snackplayer/tests/index.tsplugins/remark-snackplayer/tests/index.js renamed to plugins/remark-snackplayer/tests/index.ts

@@ -11,9 +11,9 @@ import {remark} from 'remark';
 import remarkMdx from 'remark-mdx';
 import test from 'tape';
 
-import SnackPlayer from '../src/index.js';
+import SnackPlayer from '../src/index';
 
-function read(name) {
+function read(name: string) {
   return fs.readFileSync(path.join(import.meta.dirname, name), 'utf8');
 }
 

scripts/generate-llms-txt.js scripts/generate-llms-txt.tsscripts/generate-llms-txt.js renamed to scripts/generate-llms-txt.ts

@@ -39,7 +39,7 @@ const SLUG_TO_URL = {
 };
 
 // Function to convert the TypeScript sidebar config to JSON
-async function convertSidebarConfigToJson(fileName) {
+async function convertSidebarConfigToJson(fileName: string) {
   const inputFileContent = fs.readFileSync(
     path.join(import.meta.dirname, '../website', fileName),
     'utf8'
@@ -70,8 +70,8 @@ async function convertSidebarConfigToJson(fileName) {
 }
 
 // Function to extract URLs from sidebar config
-function extractUrlsFromSidebar(sidebarConfig, prefix) {
-  const urls = [];
+function extractUrlsFromSidebar(sidebarConfig: SidebarConfig, prefix: string) {
+  const urls: string[] = [];
 
   // Process each section (docs, api, components)
   Object.entries(sidebarConfig).forEach(([, categories]) => {
@@ -93,15 +93,19 @@ function extractUrlsFromSidebar(sidebarConfig, prefix) {
   return urls;
 }
 
+type SidebarItem = string | {type: string; id?: string; items?: SidebarItem[]; label?: string};
+type Items = SidebarItem[] | {items: SidebarItem[]};
+
+interface SidebarConfig {
+  [section: string]: {
+    [category: string]: Items;
+  };
+}
 // Recursive function to process items and extract URLs
-function processItemsForUrls(items, urls, prefix) {
-  if (typeof items === 'object' && Array.isArray(items.items)) {
-    processItemsForUrls(items.items, urls, prefix);
-    return;
-  }
+function processItemsForUrls(items: Items, urls: string[], prefix: string) {
+  const itemsArray = getItemsArray(items);
 
-  if (Array.isArray(items)) {
-    items.forEach(item => {
+  itemsArray.forEach(item => {
       if (typeof item === 'string') {
         urls.push(`${URL_PREFIX}${prefix}/${item}`);
       } else if (typeof item === 'object') {
@@ -112,11 +116,16 @@ function processItemsForUrls(items, urls, prefix) {
         }
       }
     });
-  }
+}
+
+interface UrlCheckResult {
+  url: string;
+  status: number | string;
+  error?: string;
 }
 
 // Function to check URL status
-function checkUrl(urlString) {
+function checkUrl(urlString: string): Promise<UrlCheckResult> {
   return new Promise(resolve => {
     const parsedUrl = url.parse(urlString);
 
@@ -130,7 +139,7 @@ function checkUrl(urlString) {
     const req = https.request(options, res => {
       resolve({
         url: urlString,
-        status: res.statusCode,
+        status: res.statusCode || 0,
       });
     });
 
@@ -155,8 +164,8 @@ function checkUrl(urlString) {
 }
 
 // Process each URL
-async function processUrls(urls) {
-  const unavailableUrls = [];
+async function processUrls(urls: string[]) {
+  const unavailableUrls: UnavailableUrl[] = [];
 
   for (const urlToCheck of urls) {
     const result = await checkUrl(urlToCheck);
@@ -176,7 +185,7 @@ async function processUrls(urls) {
 }
 
 // Function to extract title from markdown frontmatter
-function extractMetadataFromMarkdown(filePath) {
+function extractMetadataFromMarkdown(filePath: string) {
   try {
     const content = fs.readFileSync(filePath, 'utf8');
     const frontmatterMatch = content.match(/---\n([\s\S]*?)\n---/);
@@ -188,7 +197,7 @@ function extractMetadataFromMarkdown(filePath) {
       return {
         title: titleMatch
           ? titleMatch[1].trim()
-          : filePath.split('/').pop().replace('.md', ''),
+          : filePath.split('/').pop()?.replace('.md', ''),
         slug: slugMatch ? slugMatch[1].trim().replace(/^\//, '') : null,
       };
     }
@@ -197,14 +206,18 @@ function extractMetadataFromMarkdown(filePath) {
   }
   // If no frontmatter found, on an error occurred use the filename
   return {
-    title: filePath.split('/').pop().replace('.md', ''),
+    title: filePath.split('/').pop()?.replace('.md', ''),
     slug: null,
   };
 }
 
 // Function to map special cases for file names that don't match the sidebar
-function mapDocPath(item, prefix) {
-  const specialCases = {
+interface SpecialCases {
+  [key: string]: string;
+}
+
+function mapDocPath(item: string | SidebarItem, prefix: string): string {
+  const specialCases: SpecialCases = {
     'environment-setup': 'getting-started.md',
     'native-platform': 'native-platforms.md',
     'turbo-native-modules-introduction': 'turbo-native-modules.md',
@@ -223,8 +236,19 @@ function mapDocPath(item, prefix) {
   return `${item}.md`;
 }
 
+type UnavailableUrl = {url: string; status: number | string; error: string | null;};
+
+// Helper function to extract items array from Items type
+function getItemsArray(items: Items): SidebarItem[] {
+  if (Array.isArray(items)) {
+    return items;
+  } else {
+    return items.items;
+  }
+}
+
 // Function to generate output for each sidebar
-function generateMarkdown(sidebarConfig, docPath, prefix, unavailableUrls) {
+function generateMarkdown(sidebarConfig: SidebarConfig, docPath: string, prefix: string, unavailableUrls: UnavailableUrl[]) {
   let markdown = '';
 
   // Process each section (docs, api, components)
@@ -235,12 +259,10 @@ function generateMarkdown(sidebarConfig, docPath, prefix, unavailableUrls) {
     Object.entries(categories).forEach(([categoryName, items]) => {
       markdown += `### ${categoryName === '0' ? 'General' : categoryName}\n\n`;
 
-      if (typeof items === 'object' && Array.isArray(items.items)) {
-        items = items.items;
-      }
-      const reorderedArray = items.every(item => typeof item === 'string')
-        ? items
-        : [...items].sort((a, b) =>
+      const itemsArray = getItemsArray(items);
+      const reorderedArray = itemsArray.every(item => typeof item === 'string')
+        ? itemsArray
+        : [...itemsArray].sort((a, b) =>
             typeof a === 'string' && typeof b !== 'string'
               ? -1
               : typeof a !== 'string' && typeof b === 'string'
@@ -268,7 +290,7 @@ function generateMarkdown(sidebarConfig, docPath, prefix, unavailableUrls) {
           } else if (item.type === 'category' && Array.isArray(item.items)) {
             // This is a category with nested items
             markdown += `#### ${item.label}\n\n`;
-            item.items.forEach(nestedItem => {
+            item.items.forEach((nestedItem: SidebarItem) => {
               if (typeof nestedItem === 'string') {
                 const fullDocPath = `${docPath}${mapDocPath(nestedItem, prefix)}`;
                 if (!isEntryUnavailable(unavailableUrls, fullDocPath)) {
@@ -296,7 +318,7 @@ function generateMarkdown(sidebarConfig, docPath, prefix, unavailableUrls) {
 }
 
 async function generateOutput() {
-  const results = [];
+  const results: { markdown: string; prefix: string; }[] = [];
   const promises = [];
 
   let output = `# ${TITLE}\n\n`;
@@ -365,7 +387,7 @@ async function generateOutput() {
     });
 }
 
-function isEntryUnavailable(unavailableUrls, docPath) {
+function isEntryUnavailable(unavailableUrls: UnavailableUrl[], docPath: string) {
   return !!unavailableUrls.find(entry =>
     entry.url.endsWith(docPath.substring(1))
   );

scripts/image-check.js scripts/image-check.tsscripts/image-check.js renamed to scripts/image-check.ts

@@ -12,7 +12,7 @@ import path from 'node:path';
 const imageReferenceRegExp = new RegExp(/!\[.*?\]\((.*)\)/g);
 
 async function main() {
-  const assets = [];
+  const assets: { imagePath: string; markdownPath: string; }[] = [];
   const missingAssets = [];
   const queue = [];