Add Typecheck Prerequisites (godaddy#734)

Author: kbader-godaddy

package-lock.json

@@ -57,7 +57,8 @@
     "nx": "^15.0.13",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "rimraf": "^3.0.2"
+    "rimraf": "^3.0.2",
+    "typescript": "^5.4.5"
   },
   "eslintConfig": {
     "extends": [

package.json

@@ -36,7 +36,7 @@
   "devDependencies": {
     "cross-env": "^7.0.3",
     "eslint": "^8.56.0",
-    "eslint-config-godaddy": "^7.0.2",
+    "eslint-config-godaddy": "^7.1.0",
     "eslint-plugin-jest": "^27.6.3",
     "eslint-plugin-json": "^3.1.0",
     "eslint-plugin-unicorn": "^44.0.0",

packages/create-gasket-app/package.json

@@ -45,7 +45,7 @@
     "@svgr/core": "^6.2.0",
     "babel-plugin-add-module-exports": "^1.0.4",
     "eslint": "^8.56.0",
-    "eslint-config-godaddy": "^7.0.2",
+    "eslint-config-godaddy": "^7.1.0",
     "eslint-plugin-json": "^3.1.0",
     "eslint-plugin-unicorn": "^44.0.0",
     "mkdirp": "^1.0.4",

packages/gasket-assets/package.json

@@ -86,7 +86,7 @@
     "cross-env": "^7.0.3",
     "diagnostics": "^2.0.2",
     "eslint": "^8.56.0",
-    "eslint-config-godaddy": "^7.0.2",
+    "eslint-config-godaddy": "^7.1.0",
     "eslint-plugin-jest": "^27.6.3",
     "eslint-plugin-json": "^3.1.0",
     "eslint-plugin-unicorn": "^44.0.0",

packages/gasket-cli/package.json

@@ -46,7 +46,7 @@
     "eslint-plugin-json": "^3.1.0",
     "eslint-plugin-unicorn": "^44.0.0",
     "jest": "^29.7.0",
-    "typescript": "^5.4.2"
+    "typescript": "^5.4.5"
   },
   "eslintConfig": {
     "extends": [

packages/gasket-data/package.json

@@ -45,7 +45,7 @@
   "devDependencies": {
     "cross-env": "^7.0.3",
     "eslint": "^8.56.0",
-    "eslint-config-godaddy": "^7.0.2",
+    "eslint-config-godaddy": "^7.1.0",
     "eslint-plugin-jest": "^27.6.3",
     "eslint-plugin-json": "^3.1.0",
     "eslint-plugin-unicorn": "^44.0.0",

packages/gasket-engine/package.json

@@ -1,8 +1,12 @@
-// Wrapper to access window.fetch in case of polyfill or monkey patch
-function fetchWrapper(...args) {
-  return window.fetch(...args);
+/**
+ * Wrapper to access window.fetch in case of polyfill or monkey patch
+ * @type {import('./index').fetch}
+ */
+function fetchWrapper(input, init) {
+  return window.fetch(input, init);
 }
 
+// @ts-ignore - TS doesn't like adding properties to a function
 exports = fetchWrapper; // To import fetch from @gasket/fetch
 exports.default = fetchWrapper; // For TypeScript consumers without esModuleInterop.
 exports.Headers = window.Headers;

packages/gasket-fetch/lib/browser.js

@@ -1,2 +1,6 @@
-export function fetch(input: RequestInfo, init?: RequestInit): Promise<Response>;
+export function fetch(
+  input: RequestInfo,
+  init?: RequestInit
+): Promise<Response>;
+
 export default fetch;

packages/gasket-fetch/lib/index.d.ts

@@ -1,3 +1,5 @@
 const fetch = require('node-fetch');
+
 fetch.AbortController = require('abort-controller');
+
 module.exports = fetch;

packages/gasket-fetch/lib/node.js

@@ -15,7 +15,9 @@
     "test:runner": "npm run test:server && npm run test:browser",
     "test:browser": "jest --detectOpenHandles --env=jsdom test/browser.spec.js",
     "test:server": "jest --env=node test/server.spec.js",
-    "posttest": "npm run lint"
+    "posttest": "npm run lint && npm run typecheck",
+    "typecheck": "tsc",
+    "typecheck:watch": "tsc --watch"
   },
   "repository": {
     "type": "git",
@@ -49,22 +51,25 @@
     "core-js": "^3.35.0",
     "cross-env": "^7.0.3",
     "eslint": "^8.56.0",
-    "eslint-config-godaddy": "^7.0.2",
+    "eslint-config-godaddy": "^7.1.0",
     "eslint-plugin-jest": "^27.6.3",
     "eslint-plugin-json": "^3.1.0",
     "eslint-plugin-unicorn": "^44.0.0",
     "jest": "^29.7.0",
     "jsdom": "^20.0.0",
     "regenerator-runtime": "^0.14.1",
+    "typescript": "^5.4.5",
     "whatwg-fetch": "3.6.20"
   },
   "eslintConfig": {
     "extends": [
       "godaddy",
-      "plugin:jest/recommended"
+      "plugin:jest/recommended",
+      "plugin:jsdoc/recommended-typescript-flavor"
     ],
     "plugins": [
-      "unicorn"
+      "unicorn",
+      "jsdoc"
     ],
     "rules": {
       "unicorn/filename-case": "error"

packages/gasket-fetch/package.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": true,
+    "noEmit": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "lib": [
+      "esnext",
+      "dom"
+    ],
+    "types": [
+      "@types/jest"
+    ]
+  },
+  "exclude": [
+    "test",
+    "coverage"
+  ]
+}

packages/gasket-fetch/tsconfig.json

@@ -17,7 +17,9 @@
     "test:coverage": "jest --coverage",
     "posttest": "npm run lint",
     "prepack": "npm run docs",
-    "docs": "jsdoc2md --plugin @godaddy/dmd --files lib/index.js > docs/api.md"
+    "docs": "jsdoc2md --plugin @godaddy/dmd --files lib/index.js > docs/api.md",
+    "typecheck:skip": "tsc",
+    "typecheck:watch": "tsc --watch"
   },
   "repository": {
     "type": "git",
@@ -47,20 +49,23 @@
     "@godaddy/dmd": "^1.0.4",
     "cross-env": "^7.0.3",
     "eslint": "^8.56.0",
-    "eslint-config-godaddy": "^7.0.2",
+    "eslint-config-godaddy": "^7.1.0",
     "eslint-plugin-jest": "^27.6.3",
     "eslint-plugin-json": "^3.1.0",
     "eslint-plugin-unicorn": "^44.0.0",
     "jest": "^29.7.0",
-    "jsdoc-to-markdown": "^7.1.0"
+    "jsdoc-to-markdown": "^7.1.0",
+    "typescript": "^5.4.5"
   },
   "eslintConfig": {
     "extends": [
       "godaddy",
-      "plugin:jest/recommended"
+      "plugin:jest/recommended",
+      "plugin:jsdoc/recommended-typescript-flavor"
     ],
     "plugins": [
-      "unicorn"
+      "unicorn",
+      "jsdoc"
     ],
     "rules": {
       "unicorn/filename-case": "error"

packages/gasket-helper-intl/package.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": true,
+    "noEmit": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "lib": [
+      "esnext",
+      "dom"
+    ],
+    "types": [
+      "@types/jest"
+    ]
+  },
+  "exclude": [
+    "test",
+    "coverage"
+  ]
+}

packages/gasket-helper-intl/tsconfig.json

@@ -59,7 +59,7 @@
     "babel-eslint": "^10.1.0",
     "cross-env": "^7.0.3",
     "eslint": "^8.56.0",
-    "eslint-config-godaddy": "^7.0.2",
+    "eslint-config-godaddy": "^7.1.0",
     "eslint-plugin-babel": "^5.3.1",
     "eslint-plugin-jest": "^27.6.3",
     "eslint-plugin-json": "^3.1.0",

packages/gasket-log/package.json

@@ -18,7 +18,9 @@
     "test:coverage": "jest --coverage",
     "posttest": "npm run lint",
     "build": "babel src -d lib --delete-dir-on-start",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "typecheck:skip": "tsc",
+    "typecheck:watch": "tsc --watch"
   },
   "repository": {
     "type": "git",
@@ -63,7 +65,8 @@
     "next": "13.1.1",
     "prop-types": "^15.8.1",
     "react": "^18.2.0",
-    "react-dom": "^18.2.0"
+    "react-dom": "^18.2.0",
+    "typescript": "^5.4.5"
   },
   "peerDependencies": {
     "next": ">=10.2.0 <= 13.1.1",
@@ -73,10 +76,12 @@
   "eslintConfig": {
     "extends": [
       "godaddy-react",
-      "plugin:jest/recommended"
+      "plugin:jest/recommended",
+      "plugin:jsdoc/recommended-typescript-flavor"
     ],
     "plugins": [
-      "unicorn"
+      "unicorn",
+      "jsdoc"
     ],
     "rules": {
       "unicorn/filename-case": "error"

packages/gasket-nextjs/package.json

@@ -5,7 +5,6 @@ export const GasketDataContext = React.createContext({});
 
 /**
  * Provider for the GasketData, adds context to child elements.
- *
  * @param {object} props - Props
  * @param {GasketData} props.gasketData - Object of GasketData
  * @param {JSX.Element} props.children - Element to add GasketData context too
@@ -23,4 +22,3 @@ GasketDataProvider.propTypes = {
   gasketData: PropTypes.object,
   children: PropTypes.node
 };
-

packages/gasket-nextjs/src/gasket-data-provider.js

@@ -45,4 +45,4 @@ export const GasketDataProvider: ComponentType<PropsWithChildren<{ gasketData: G
  *
  * @returns {function} wrapper
  */
-export function withGasketDataProvider(): SubstitutableHOC;
+export function withGasketDataProvider(): SubstitutableHOC;

packages/gasket-nextjs/src/index.d.ts

@@ -5,7 +5,6 @@ import htmlescape from 'htmlescape';
 
 /**
  * Renders a script tag with JSON gasketData
- *
  * @param {object} props - Props
  * @param {GasketData} props.data - Gasket data from response
  * @returns {JSX.Element} script
@@ -28,7 +27,6 @@ GasketDataScript.propTypes = {
 /**
  * Make a wrapper to extend the Next.js Document, injecting a script with the
  * `gasketData` from the response object.
- *
  * @param {object} [options] - Configuration for wrapper
  * @param {number} [options.index] - Force script injection at particular index
  * @returns {function(Document)} wrapper
@@ -40,7 +38,6 @@ export function withGasketData(options = {}) {
    * To avoid polluting <head/>, we want to render our JSON in the <body/>
    * but before our other scripts so that it is available to query.
    * In a basic Next.js app, this is between the Main and NextScript tags.*
-   *
    * @param {Array} bodyChildren - Children of body element
    * @returns {number} index
    * @private
@@ -59,7 +56,6 @@ export function withGasketData(options = {}) {
 
   /**
    * Extend the Document
-   *
    * @param {Document} Document - Next Document class to wrap
    * @returns {Document} extended Document
    */

packages/gasket-nextjs/src/index.js

@@ -3,7 +3,6 @@ import { GasketDataContext } from './gasket-data-provider';
 
 /**
  * React that fetches GasketData in elements context and returns it
- *
  * @returns {object} GasketData
  */
 export const useGasketData = () => {

packages/gasket-nextjs/src/use-gasket-data.js

@@ -7,8 +7,7 @@ const clientGasketData = typeof window === 'object' ? require('@gasket/data') :
 /**
  * Make an HOC that adds a provider for the GasketData.
  * This can be used to wrap a top level React, Next.js custom App component or Next.js custom Document component.
- *
- * @returns {function} wrapper
+ * @returns {Function} wrapper
  */
 export const withGasketDataProvider = () => (WrappedComponent) => {
 

packages/gasket-nextjs/src/with-gasket-data-provider.js

@@ -1,4 +1,4 @@
-import React from 'react';;
+import React from 'react';
 import { render, queryByAttribute } from '@testing-library/react';
 
 import { GasketDataScript } from '../src';

packages/gasket-nextjs/test/gasket-data-script.test.js

@@ -1,4 +1,4 @@
-import React from 'react';;
+import React from 'react';
 import { render } from '@testing-library/react';
 
 describe('withGasketDataProvider', function () {

packages/gasket-nextjs/test/with-gasket-data-provider.test.js

@@ -27,7 +27,6 @@ class MyDocument extends Document {
 /**
  * Recursively searches through the rendered element tree for the first element
  * that matches the search type
- *
  * @param {object} renderedElement - The element that was rendered by the
  * component.
  * @param {string} searchType - The type of the element you're looking for.

packages/gasket-nextjs/test/with-gasket-data.test.js

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "jsx": "react",
+    "allowJs": true,
+    "checkJs": true,
+    "noEmit": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "lib": [
+      "esnext",
+      "dom"
+    ],
+    "types": [
+      "@types/jest"
+    ]
+  },
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "test",
+    "coverage",
+    "lib"
+  ]
+}

packages/gasket-nextjs/tsconfig.json

@@ -52,7 +52,7 @@
     "eslint-plugin-json": "^3.1.0",
     "eslint-plugin-unicorn": "^44.0.0",
     "jest": "^29.7.0",
-    "typescript": "^5.4.2"
+    "typescript": "^5.4.5"
   },
   "eslintConfig": {
     "extends": [

packages/gasket-plugin-analyze/package.json

@@ -51,7 +51,7 @@
     "@oclif/errors": "^1.3.5",
     "cross-env": "^7.0.3",
     "eslint": "^8.56.0",
-    "eslint-config-godaddy": "^7.0.2",
+    "eslint-config-godaddy": "^7.1.0",
     "eslint-plugin-jest": "^27.6.3",
     "eslint-plugin-json": "^3.1.0",
     "eslint-plugin-unicorn": "^44.0.0",

packages/gasket-plugin-command/package.json

@@ -45,7 +45,7 @@
     "@gasket/engine": "^6.46.2",
     "cross-env": "^7.0.3",
     "eslint": "^8.56.0",
-    "eslint-config-godaddy": "^7.0.2",
+    "eslint-config-godaddy": "^7.1.0",
     "eslint-plugin-jest": "^27.6.3",
     "eslint-plugin-json": "^3.1.0",
     "eslint-plugin-unicorn": "^44.0.0",