TypeScript proof-of-concept

.distignore

@@ -1,5 +1,6 @@
 .git
 .github
+.husky
 .idea
 .storybook
 .wordpress-org
@@ -65,6 +66,7 @@ README.md
 rollup.config.js
 scoper.inc.php
 SECURITY.md
+tsconfig.json
+tsconfig.shared.json
 webpack.config.cjs
 webpack.config.test.cjs
-.husky

.eslintrc

@@ -247,7 +247,8 @@
           "^@googleforcreators\\/(.*)\\/(.*)": "./packages/$1/src/$2",
           "^@googleforcreators\\/(.*)": "./packages/$1/src/",
           "^@web-stories-wp\\/(.*)": "./packages/$1/src/"
-        }
+        },
+        "extensions": [ ".js", ".jsx", ".ts", ".tsx" ]
       }
     },
     "jsdoc": {
@@ -281,6 +282,31 @@
     ]
   },
   "overrides": [
+    {
+      "files": [
+        "**/*.ts",
+        "**/*.tsx"
+      ],
+      "excludedFiles": [
+        "**/*.d.ts"
+      ],
+      "extends": [
+        "plugin:@typescript-eslint/eslint-recommended"
+      ],
+      "plugins": [
+        "@typescript-eslint"
+      ],
+      "parser": "@typescript-eslint/parser",
+      "rules": {
+        "no-duplicate-imports": "off",
+        "@typescript-eslint/no-duplicate-imports": "error",
+        "jsdoc/require-param-type": "off",
+        "jsdoc/require-returns-type": "off",
+        "no-unused-vars": "off",
+        "no-shadow": "off",
+        "@typescript-eslint/no-shadow": "error"
+      }
+    },
     {
       "files": [
         "__mocks__/**/*.js",

.github/workflows/codeql-analysis.yml

@@ -6,6 +6,7 @@ on:
     paths:
       - '**.js'
       - '**.cjs'
+      - '**.ts'
     branches:
       - main
       - release/*
@@ -14,6 +15,7 @@ on:
     paths:
       - '**.js'
       - '**.cjs'
+      - '**.ts'
     # The branches below must be a subset of the branches above
     branches:
       - main

.github/workflows/lint-css-js-md.yml

@@ -6,6 +6,7 @@ on:
     paths:
       - '**.js'
       - '**.cjs'
+      - '**.ts'
       - '**.css'
       - 'packages/**/*.md'
       - '.eslint*'
@@ -24,6 +25,7 @@ on:
     paths:
       - '**.js'
       - '**.cjs'
+      - '**.ts'
       - '**.css'
       - 'packages/**/*.md'
       - '.eslint*'

.github/workflows/lint-i18n.yml

@@ -4,6 +4,8 @@ on:
   push:
     paths:
       - '**.js'
+      - '**.cjs'
+      - '**.ts'
       - '**/package.json'
       - 'package-lock.json'
       - 'web-stories.php'
@@ -14,6 +16,8 @@ on:
   pull_request:
     paths:
       - '**.js'
+      - '**.cjs'
+      - '**.ts'
       - '**/package.json'
       - 'package-lock.json'
       - 'web-stories.php'

.github/workflows/tests-karma-dashboard.yml

@@ -9,6 +9,7 @@ on:
       - 'webpack.config.cjs'
       - 'webpack.config.test.cjs'
       - 'packages/**/*.js'
+      - 'packages/**/*.ts'
       - '**/package.json'
       - 'package-lock.json'
       - '__static__/**'
@@ -23,6 +24,7 @@ on:
       - 'webpack.config.cjs'
       - 'webpack.config.test.cjs'
       - 'packages/**/*.js'
+      - 'packages/**/*.ts'
       - '**/package.json'
       - 'package-lock.json'
       - '__static__/**'

.github/workflows/tests-karma-editor.yml

@@ -10,6 +10,7 @@ on:
       - 'webpack.config.test.cjs'
       - 'packages/**/*.js'
       - 'packages/**/*.cjs'
+      - 'packages/**/*.ts'
       - '**/package.json'
       - 'package-lock.json'
       - '__static__/**'
@@ -26,6 +27,7 @@ on:
       - 'webpack.config.test.cjs'
       - 'packages/**/*.js'
       - 'packages/**/*.cjs'
+      - 'packages/**/*.ts'
       - '**/package.json'
       - 'package-lock.json'
       - '__static__/**'

.github/workflows/tests-unit-js.yml

@@ -5,6 +5,8 @@ on:
     # Only run if JS-related files changed.
     paths:
       - '**.js'
+      - '**.cjs'
+      - '**.ts'
       - '**/package.json'
       - 'package-lock.json'
       - 'packages/templates/src/raw/**'
@@ -17,6 +19,8 @@ on:
     # Only run if JS-related files changed.
     paths:
       - '**.js'
+      - '**.cjs'
+      - '**.ts'
       - '**/package.json'
       - 'package-lock.json'
       - 'packages/templates/src/raw/**'

.gitignore

@@ -7,6 +7,7 @@ node_modules
 /packages/migration/scripts/module.js
 /packages/*/dist
 /packages/*/dist-module
+/packages/*/dist-types
 /build
 /bin/build
 /bin/local-env/data
@@ -21,3 +22,4 @@ phpcs.xml
 phpunit.xml
 .phpunit.result.cache
 /packages/*/package-lock.json
+tsconfig.tsbuildinfo

.npmpackagejsonlintrc.json

@@ -57,6 +57,7 @@
         "exports",
         "main",
         "module",
+        "types",
         "source",
         "publishConfig",
         "sideEffects",

babel.config.cjs

@@ -43,6 +43,7 @@ module.exports = function (api) {
           development: !isProduction,
         },
       ],
+      '@babel/preset-typescript',
     ],
     plugins: [
       '@wordpress/babel-plugin-import-jsx-pragma',