Feedback to include declarations

mapbox · Jun 30, 2022 · 4cef2cf · 4cef2cf
1 parent aa961ea
commit 4cef2cf
Show file tree

Hide file tree

Showing 9 changed files with 23,847 additions and 11 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1,12 +1,8 @@
 *.log
 coverage
 .DS_Store
-_batfish*
 src/docs/data
 src/docs/_site
-pkg
 src/test-cases-app/component-index.js
-dist
 **/*underreact.config.js
 **/*babel.config.js
-html.js
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,5 @@ src/docs/data
 pkg
 src/test-cases-app/component-index.js
 dist
+tsconfig.tsbuildinfo
+.vscode/launch.json
diff --git a/index.d.ts b/index.d.ts
diff --git a/package.json b/package.json
@@ -3,6 +3,7 @@
   "version": "3.0.0-alpha.1",
   "description": "UI components for Mapbox projects",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
     "build-component-index": "rtk-index ./src/components ./src/test-cases-app/component-index.js",
     "prestart": "npm run build-component-index",
@@ -15,7 +16,8 @@
     "jest-watch": "jest --watch --verbose=false",
     "format": "prettier --write '**/*.js'",
     "lint": "eslint .",
-    "pretest": "npm run lint",
+    "tsc": "tsc",
+    "pretest": "npm run lint && npm run jest && npm run tsc",
     "test": "jest",
     "build": "scripts/build-module-indexes.js && scripts/build-package.js"
   },

diff --git a/scripts/build-package.js b/scripts/build-package.js
@@ -35,9 +35,13 @@ function compileComponents() {
 
 // Copy non-src files that we want in the package.
 function copyFiles() {
-  return cpy(['LICENSE_Mapbox', 'CHANGELOG.md', 'README.md'], outputDir, {
-    cwd: rootDir
-  });
+  return cpy(
+    ['LICENSE_Mapbox', 'CHANGELOG.md', 'README.md', 'index.d.ts'],
+    outputDir,
+    {
+      cwd: rootDir
+    }
+  );
 }
 
 // Create a package.json that is ready to be published.

diff --git a/src/components/form/validators/validate-password.js b/src/components/form/validators/validate-password.js
@@ -32,8 +32,10 @@ export default function validatePassword(value) {
     ''
   ) : (
     <ul className="list-group">
-      {validations.map((listitem) => (
-        <li className="list-group-item">{listitem}</li>
+      {validations.map((listitem, i) => (
+        <li key={i} className="list-group-item">
+          {listitem}
+        </li>
       ))}
     </ul>
   );

diff --git a/src/docs/html.js b/src/docs/html.js
@@ -1,3 +1,4 @@
+/* eslint-disable no-undef */
 module.exports = `
   <!DOCTYPE html>
   <html lang="en">

diff --git a/src/test-cases-app/html.js b/src/test-cases-app/html.js
@@ -1,3 +1,4 @@
+/* eslint-disable no-undef */
 module.exports = `
   <!DOCTYPE html>
   <html lang='en'>

diff --git a/tsconfig.json b/tsconfig.json
@@ -6,6 +6,9 @@
       "dom.iterable",
       "esnext"
     ],
+    "emitDeclarationOnly": true,
+    "outFile": "index.d.ts",
+    "declaration": true,
     "allowJs": true,
     "skipLibCheck": true,
     "esModuleInterop": true,
@@ -16,7 +19,7 @@
     "module": "esnext",
     "moduleResolution": "node",
     "resolveJsonModule": true,
-    "isolatedModules": true,
+    "isolatedModules": false,
     "jsx": "react-jsx"
   },
   "include": [