add jsdoc types in js files

Author: chaance

package.json

@@ -22,10 +22,12 @@
     "@babel/preset-typescript": "^7.7.4",
     "@rollup/plugin-replace": "^2.2.1",
     "@types/jest": "26.x",
+    "@types/jsonfile": "^6.0.1",
     "@types/react": "16.x",
     "@types/react-dom": "16.x",
     "@types/react-native": "*",
     "@types/react-test-renderer": "16.x",
+    "@types/semver": "^7.3.8",
     "@typescript-eslint/eslint-plugin": "^4.28.3",
     "@typescript-eslint/parser": "^4.28.3",
     "babel-eslint": "^10.1.0",

scripts/publish.js

@@ -17,11 +17,18 @@ function invariant(cond, message) {
   if (!cond) throw new Error(message);
 }
 
+/**
+ * @returns {string}
+ */
 function getTaggedVersion() {
   let output = execSync("git tag --list --points-at HEAD").toString();
   return output.replace(/^v|\n+$/g, "");
 }
 
+/**
+ * @param {string} packageName
+ * @param {string|number} version
+ */
 async function ensureBuildVersion(packageName, version) {
   let file = path.join(rootDir, "build", packageName, "package.json");
   let json = await jsonfile.readFile(file);
@@ -31,6 +38,10 @@ async function ensureBuildVersion(packageName, version) {
   );
 }
 
+/**
+ * @param {string} packageName
+ * @param {string} tag
+ */
 function publishBuild(packageName, tag) {
   let buildDir = path.join(rootDir, "build", packageName);
   console.log();
@@ -39,6 +50,9 @@ function publishBuild(packageName, tag) {
   execSync(`npm publish ${buildDir} --tag ${tag}`, { stdio: "inherit" });
 }
 
+/**
+ * @returns {Promise<1 | 0>}
+ */
 async function run() {
   try {
     // 0. Ensure we are in CI. We don't do this manually

scripts/version.js

@@ -1,7 +1,6 @@
 import path from "path";
 import { fileURLToPath } from "url";
 import { execSync } from "child_process";
-
 import chalk from "chalk";
 import Confirm from "prompt-confirm";
 import jsonfile from "jsonfile";
@@ -10,10 +9,19 @@ import semver from "semver";
 const dirname = path.dirname(fileURLToPath(import.meta.url));
 const rootDir = path.resolve(dirname, "..");
 
+/**
+ * @param {string} packageName
+ * @returns {string}
+ */
 function packageJson(packageName) {
   return path.join(rootDir, "packages", packageName, "package.json");
 }
 
+/**
+ * @param {*} cond
+ * @param {string} message
+ * @returns {asserts cond}
+ */
 function invariant(cond, message) {
   if (!cond) throw new Error(message);
 }
@@ -27,6 +35,12 @@ function ensureCleanWorkingDirectory() {
   );
 }
 
+/**
+ * @param {string} currentVersion
+ * @param {string} givenVersion
+ * @param {string} [prereleaseId]
+ * @returns {string}
+ */
 function getNextVersion(currentVersion, givenVersion, prereleaseId) {
   invariant(
     givenVersion != null,
@@ -47,18 +61,29 @@ function getNextVersion(currentVersion, givenVersion, prereleaseId) {
   return nextVersion;
 }
 
+/**
+ * @param {string} question
+ * @returns {Promise<string>}
+ */
 async function prompt(question) {
   let confirm = new Confirm(question);
   let answer = await confirm.run();
   return answer;
 }
 
+/**
+ * @param {string} packageName
+ */
 async function getPackageVersion(packageName) {
   let file = packageJson(packageName);
   let json = await jsonfile.readFile(file);
   return json.version;
 }
 
+/**
+ * @param {string} packageName
+ * @param {(json: string) => any} transform
+ */
 async function updatePackageConfig(packageName, transform) {
   let file = packageJson(packageName);
   let json = await jsonfile.readFile(file);

tsconfig.json

@@ -17,11 +17,6 @@
     "stripInternal": true,
     "jsx": "react"
   },
-  "files": [
-    "packages/react-router/index.tsx",
-    "packages/react-router-dom/index.tsx",
-    "packages/react-router-dom/server.tsx",
-    "packages/react-router-native/index.tsx"
-  ],
-  "include": ["types/global.d.ts"]
+  "include": ["packages/**/*", "types/*"],
+  "exclude": ["**/*.*.snap"]
 }

yarn.lock

@@ -1681,6 +1681,13 @@
   resolved "https://registry.yarnpkg.com/@types/json5/-/json5-0.0.29.tgz#ee28707ae94e11d2b827bcbe5270bcea7f3e71ee"
   integrity sha1-7ihweulOEdK4J7y+UnC86n8+ce4=
 
+"@types/jsonfile@^6.0.1":
+  version "6.0.1"
+  resolved "https://registry.yarnpkg.com/@types/jsonfile/-/jsonfile-6.0.1.tgz#639eff0748d60dfbc9d5f743ca7178bd93f53c71"
+  integrity sha512-SSCc8i9yl6vjgXSyZb0uEodk3UjXuWd55t1D+Ie1zuTx7ml+2AEj0Xyomi3NBz1gCBsZVyWWnXOLXowS1ufhEw==
+  dependencies:
+    "@types/node" "*"
+
 "@types/minimatch@*":
   version "3.0.4"
   resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-3.0.4.tgz#f0ec25dbf2f0e4b18647313ac031134ca5b24b21"
@@ -1750,6 +1757,11 @@
   resolved "https://registry.yarnpkg.com/@types/scheduler/-/scheduler-0.16.1.tgz#18845205e86ff0038517aab7a18a62a6b9f71275"
   integrity sha512-EaCxbanVeyxDRTQBkdLb3Bvl/HK7PBK6UJjsSixB0iHKoWxE5uu2Q/DgtpOhPIojN0Zl1whvOd7PoHs2P0s5eA==
 
+"@types/semver@^7.3.8":
+  version "7.3.8"
+  resolved "https://registry.yarnpkg.com/@types/semver/-/semver-7.3.8.tgz#508a27995498d7586dcecd77c25e289bfaf90c59"
+  integrity sha512-D/2EJvAlCEtYFEYmmlGwbGXuK886HzyCc3nZX/tkFTQdEU8jZDAgiv08P162yB17y4ZXZoq7yFAnW4GDBb9Now==
+
 "@types/stack-utils@^1.0.1":
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/@types/stack-utils/-/stack-utils-1.0.1.tgz#0a851d3bd96498fa25c33ab7278ed3bd65f06c3e"