switch scripts package to pure typescript (#4106)

Author: JasonVMo

.yarnrc.yml

@@ -239,7 +239,7 @@ catalogs:
     react-native-windows: ^0.81.0
     react-test-renderer: 19.1.4
 
-dynamicPackageExtensions: ./scripts/dynamic.extensions.mjs
+dynamicPackageExtensions: ./scripts/dynamic.extensions.mts
 
 enableGlobalCache: false
 

package.json

@@ -16,17 +16,17 @@
   ],
   "scripts": {
     "build": "lage build-all",
-    "clean-all": "node ./scripts/src/preinstall/clean-all.js",
+    "clean-all": "node ./scripts/src/preinstall/clean-all.ts",
     "docs": "yarn workspace fluent-rn-website start",
     "bundle:repo": "lage bundle",
     "clean": "lage clean",
     "change": "node .github/scripts/change.mts",
     "changeset:version": "node .github/scripts/changeset-version-with-postbump.mts",
     "change:check": "node .github/scripts/change.mts --check",
-    "check-publishing": "node ./scripts/src/cli.mjs check-publishing",
+    "check-publishing": "node ./scripts/src/cli.ts check-publishing",
     "lint-fix": "cross-env FURN_FIX_MODE=true lage lint",
     "lint-package-fix": "cross-env FURN_FIX_MODE=true lage lint-package",
-    "preinstall": "node ./scripts/src/preinstall/use-yarn-please.js",
+    "preinstall": "node ./scripts/src/preinstall/use-yarn-please.ts",
     "format": "oxfmt",
     "format:check": "oxfmt --check",
     "lint-lockfile": "lint-lockfile",

scripts/dynamic.extensions.mjs scripts/dynamic.extensions.mtsscripts/dynamic.extensions.mjs renamed to scripts/dynamic.extensions.mts

@@ -1,23 +1,19 @@
-// @ts-check
-
 import fs from 'node:fs';
 import path from 'node:path';
-import { getToolVersion, hasJestConfig } from './src/preinstall/tool-versions.js';
+import { getToolVersion, hasJestConfig } from './src/preinstall/tool-versions.ts';
+import type { PackageManifest } from './src/utils/projectRoot.ts';
 
-/**
- * @typedef {() => boolean} ConditionalCheck
- */
+type ConditionalCheck = () => boolean;
 
 /**
  * Conditionally add a dependency to the given dependencies object if it is not already present
- * @param {string[]} depsToAdd
- * @param {import('./src/utils/projectRoot.ts').PackageManifest} manifest
- * @param {ConditionalCheck | boolean | undefined} condition
- * @returns {Record<string, string>}
  */
-function conditionallyAdd(depsToAdd, manifest, condition) {
-  /** @type {Record<string, string>} */
-  const newDeps = {};
+function conditionallyAdd(
+  depsToAdd: string[],
+  manifest: PackageManifest,
+  condition: ConditionalCheck | boolean | undefined,
+): Record<string, string> {
+  const newDeps: Record<string, string> = {};
   if (!condition || (typeof condition === 'function' ? condition() : condition)) {
     for (const dep of depsToAdd) {
       if (!manifest.dependencies?.[dep] && !manifest.devDependencies?.[dep]) {
@@ -36,29 +32,23 @@ function conditionallyAdd(depsToAdd, manifest, condition) {
 }
 
 /**
- * @param {import('./src/utils/projectRoot.ts').PackageManifest} manifest - The package manifest.
- * @returns {boolean} true if oxfmt should be added based on the manifest's prettier scripts
+ * Returns true if oxfmt should be added based on the manifest's prettier scripts.
  */
-function addOxfmt(manifest) {
+function addOxfmt(manifest: PackageManifest): boolean {
   return Boolean(manifest && manifest.scripts && (manifest.scripts.format || manifest.scripts['format:fix']));
 }
 
 /**
  * Check if Jest is already in the manifest or if a Jest script is defined.
- * @param {string} cwd - The current working directory.
- * @param {import('./src/utils/projectRoot.ts').PackageManifest} manifest - The package manifest.
- * @returns {boolean} - True if Jest should be added, false otherwise.
  */
-function addJest(cwd, manifest) {
+function addJest(cwd: string, manifest: PackageManifest): boolean {
   return Boolean(manifest.scripts?.test && hasJestConfig(cwd));
 }
 
 /**
  * Get the dynamic dependencies for the given package given the package root directory and its manifest.
- * @param {{cwd: string, manifest: import('./src/utils/projectRoot.ts').PackageManifest}} param0
- * @returns { { dependencies: Record<string, string> } }
  */
-export default function ({ cwd, manifest }) {
+export default function ({ cwd, manifest }: { cwd: string; manifest: PackageManifest }): { dependencies: Record<string, string> } {
   const enableLinting = Boolean(manifest.scripts && manifest.scripts.lint);
 
   return {

scripts/package.json

@@ -9,14 +9,14 @@
     "directory": "scripts"
   },
   "bin": {
-    "fluentui-scripts": "./src/cli.mjs"
+    "fluentui-scripts": "./src/cli.ts"
   },
   "type": "module",
-  "main": "./src/index.js",
+  "main": "./src/index.ts",
   "exports": {
     ".": {
-      "require": "./src/index.js",
-      "default": "./src/index.js"
+      "require": "./src/index.ts",
+      "default": "./src/index.ts"
     },
     "./babel-config": "./configs/jest/babel.config.cjs",
     "./jest-config": "./configs/jest/jest.config.cjs",
@@ -29,10 +29,10 @@
     "build": "tsgo",
     "build-core": "tsgo",
     "bundlesize": "bundlesize --debug",
-    "depcheck": "node ./src/cli.mjs depcheck",
-    "format": "node ./src/cli.mjs format",
-    "lint": "node ./src/cli.mjs lint",
-    "lint-package": "node ./src/cli.mjs lint-package"
+    "depcheck": "node ./src/cli.ts depcheck",
+    "format": "node ./src/cli.ts format",
+    "lint": "node ./src/cli.ts lint",
+    "lint-package": "node ./src/cli.ts lint-package"
   },
   "dependencies": {
     "@babel/core": "catalog:",

scripts/src/cli.mjs scripts/src/cli.tsscripts/src/cli.mjs renamed to scripts/src/cli.ts

@@ -1,14 +1,13 @@
 #!/usr/bin/env node
-// @ts-check
 
 import { Builtins, Cli } from 'clipanion';
 import { BuildCommand } from './tasks/build.ts';
-import { CleanCommand } from './tasks/clean.js';
-import { FormatCommand } from './tasks/format.js';
-import { LintCommand } from './tasks/lint.js';
+import { CleanCommand } from './tasks/clean.ts';
+import { FormatCommand } from './tasks/format.ts';
+import { LintCommand } from './tasks/lint.ts';
 import { LintPackageCommand } from './tasks/lintPackage.ts';
-import { JestCommand } from './tasks/jest.js';
-import { CheckPublishingCommand } from './tasks/checkPublishingTask.js';
+import { JestCommand } from './tasks/jest.ts';
+import { CheckPublishingCommand } from './tasks/checkPublishingTask.ts';
 import { DepcheckCommand } from './tasks/depcheck.ts';
 
 const cli = new Cli({

scripts/src/index.js scripts/src/index.tsscripts/src/index.js renamed to scripts/src/index.ts

@@ -1,2 +1 @@
-// @ts-check
 export { isPnpmMode } from './utils/ispnpm.ts';

scripts/src/preinstall/clean-all.js scripts/src/preinstall/clean-all.tsscripts/src/preinstall/clean-all.js renamed to scripts/src/preinstall/clean-all.ts

@@ -1,16 +1,10 @@
-// @ts-check
-
-const child_process = require('child_process');
-const fs = require('fs');
-const path = require('path');
-const os = require('os');
+import child_process from 'node:child_process';
+import fs from 'node:fs';
+import path from 'node:path';
+import os from 'node:os';
 // This script MUST NOT have any deps aside from Node built-ins, because it deletes all node_modules!
 
-/**
- * @param {string} question - The question to prompt the user with
- * @returns {Promise<string>}
- * */
-function prompt(question) {
+function prompt(question: string): Promise<string> {
   return new Promise((resolve) => {
     process.stdin.resume();
     process.stdout.write(question);
@@ -22,10 +16,7 @@ function prompt(question) {
   });
 }
 
-/**
- * @param {string} itemPath - The path to the item to check
- */
-function deleteIfSymlink(itemPath) {
+function deleteIfSymlink(itemPath: string): void {
   itemPath = path.resolve(itemPath);
   try {
     // Compare realpath since fs.statSync(itemPath).isSymbolicLink() doesn't work on Windows
@@ -40,10 +31,8 @@ function deleteIfSymlink(itemPath) {
 
 /**
  * Deletes symlinks in the specified node_modules directory.
- * @param {string} nodeModulesPath - The path to the node_modules directory
- * @returns {void}
  */
-function deleteNodeModulesSymlinks(nodeModulesPath) {
+function deleteNodeModulesSymlinks(nodeModulesPath: string): void {
   if (!fs.existsSync(nodeModulesPath)) {
     return;
   }
@@ -62,10 +51,8 @@ function deleteNodeModulesSymlinks(nodeModulesPath) {
 
 /**
  * Deletes symlinks in the specified parent folder.
- * @param {string} parentFolder - The path to the parent folder
- * @returns {void}
  */
-function deleteSymlinks(parentFolder) {
+function deleteSymlinks(parentFolder: string): void {
   const parentPath = path.join(process.cwd(), parentFolder);
   if (!fs.existsSync(parentPath)) {
     return;

scripts/src/preinstall/tool-versions.js scripts/src/preinstall/tool-versions.tsscripts/src/preinstall/tool-versions.js renamed to scripts/src/preinstall/tool-versions.ts

@@ -2,12 +2,12 @@ import fs from 'node:fs';
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 
+import type { PackageManifest } from '../utils/projectRoot.ts';
+
 /**
  * Get the package.json manifest for a given folder.
- * @param {string} folder
- * @returns {import('../utils/projectRoot.ts').PackageManifest}
  */
-function getPackageManifest(folder) {
+function getPackageManifest(folder: string): PackageManifest {
   const manifestPath = path.join(folder, 'package.json');
   return JSON.parse(fs.readFileSync(manifestPath, 'utf-8'));
 }
@@ -17,8 +17,7 @@ const scriptFolder = path.join(path.dirname(fileURLToPath(import.meta.url)), '..
 const scriptManifest = getPackageManifest(scriptFolder);
 const rootManifest = getPackageManifest(path.dirname(scriptFolder));
 
-/** @type {Record<string, string>} */
-const devToolVersions = {
+const devToolVersions: Record<string, string> = {
   '@eslint/js': '^9.0.0',
   '@microsoft/eslint-plugin-sdl': '^1.1.0',
   '@react-native-community/cli': '^13.6.4',
@@ -58,27 +57,21 @@ const devToolVersions = {
   ...rootManifest.devDependencies,
 };
 
-/** @type {Record<string, string>} */
-const workspaceToolVersions = {
+const workspaceToolVersions: Record<string, string> = {
   '@fluentui-react-native/scripts': 'workspace:*',
 };
 
-/**
- *
- * @param {string} packageName
- * @returns {string | null}
- */
-export function getToolVersion(packageName) {
+export function getToolVersion(packageName: string): string | null {
   return devToolVersions[packageName] ?? workspaceToolVersions[packageName] ?? null;
 }
 
 const CONFIG_EXTENSIONS = ['.js', '.cjs', '.mjs', '.ts', '.cts', '.mts'];
 
 /**
- * @param {string} cwd - The current working directory.
- * @returns {boolean} - True if a Jest config file exists in the cwd, false otherwise.
+ * @param cwd the current working directory.
+ * @returns true if a Jest config file exists in the cwd, false otherwise.
  */
-export function hasJestConfig(cwd) {
+export function hasJestConfig(cwd: string): boolean {
   for (const ext of CONFIG_EXTENSIONS) {
     if (fs.existsSync(path.join(cwd, `jest.config${ext}`))) {
       return true;

scripts/src/preinstall/use-yarn-please.js scripts/src/preinstall/use-yarn-please.tsscripts/src/preinstall/use-yarn-please.js renamed to scripts/src/preinstall/use-yarn-please.ts

@@ -1,7 +1,5 @@
-// @ts-check
-
 import { Command } from 'clipanion';
-import { runYarn } from '../utils/runScript.js';
+import { runYarn } from '../utils/runScript.ts';
 import { getProjectRoot } from '../utils/projectRoot.ts';
 import { getResolvedConfig } from '../utils/buildConfig.ts';