fix: Assorted Typing Fixes (#3348)

With all the commits below, we resolve all outstanding typing issues in the repo, and CI jobs run green. * fix: Convert DashboardPage and DashboardWidget to TypeScript * fix: fix type errors in package manager ext * fix: Convert Post component to TypeScript * fix: avatar typings should accept null user * fix: convert Notification component to TypeScript * fix: properly use `typeof` in ForumApplication * feat: make Notification content attr generic * chore: format Notification component * fix: Convert DiscussionRenamedNotification to TypeScript * fix(pusher) move shims to a location where they get applied * fix(pusher): fix some typing errors * fix(akismet): fix some typing issues * chore: update core dist typings * chore(pusher): format * fix: anchorScroll should accept string selectors * fix: more accurately represent ApiQueryParamsPlural * fix: convert PostStreamState to TypeScript * chore(core): rebuild typings * feat: allow extending app.routes * fix: more flexible typings for highlight.ts * fix: use primitive `number` type for Discussion typings * fix: convert DiscussionListItem to TypeScript * chore: rebuild core typings * fix: final pusher type fixes * feat: start tags TypeScript conversion * fix: require-dev tags in pusher for CI TypeScript purposes. * chore(core): format * chore(tags): build dist typings * feat(pusher): use dist types from tags. * feat: convert flags to TypeScript * chore(flags): generate dist typings * fix(akismet): last type errors * chore: update .yarn-integrity * chore: partially run flarum-cli audit infra --fix The tsconfig changes from that command are ignored, since we don't yet support "replacable sections" that would let us add custom config. * chore: use type imports * fix: broader gitattributes * chore: run flarum-cli audit infra --monorepo --fix * feat: make `app.data` typings extensible * chore(core): format * chore: boost tags TypeScript coverage * fix(tags): further increase type coverage.
flarum · Mar 23, 2022 · a595665 · a595665
1 parent 4ecd9a9
commit a595665
Show file tree

Hide file tree

Showing 255 changed files with 1,574 additions and 1,214 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,20 @@
+**/.gitattributes export-ignore
+**/.gitignore export-ignore
+**/.gitmodules export-ignore
+**/.github export-ignore
+**/.travis export-ignore
+**/.travis.yml export-ignore
+**/.editorconfig export-ignore
+**/.styleci.yml export-ignore
+
+**/phpunit.xml export-ignore
+**/tests export-ignore
+
+**/js/dist/**/* -diff
+**/js/dist/**/* linguist-generated
+**/js/dist-typings/**/* -diff
+**/js/dist-typings/**/* linguist-generated
+**/js/yarn.lock -diff
+**/js/package-lock.json -diff
+
+* text=auto eol=lf
diff --git a/.github/workflows/flarum-akismet-frontend.yml b/.github/workflows/flarum-akismet-frontend.yml
@@ -18,5 +18,6 @@ jobs:
       backend_directory: ./extensions/akismet
       js_package_manager: yarn
       main_git_branch: main
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
diff --git a/.github/workflows/flarum-approval-frontend.yml b/.github/workflows/flarum-approval-frontend.yml
@@ -18,5 +18,6 @@ jobs:
       backend_directory: ./extensions/approval
       js_package_manager: yarn
       main_git_branch: main
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
diff --git a/.github/workflows/flarum-core-frontend.yml b/.github/workflows/flarum-core-frontend.yml
@@ -18,5 +18,6 @@ jobs:
       backend_directory: ./framework/core
       js_package_manager: yarn
       main_git_branch: main
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
diff --git a/.github/workflows/flarum-embed-frontend.yml b/.github/workflows/flarum-embed-frontend.yml
@@ -18,5 +18,6 @@ jobs:
       backend_directory: ./extensions/embed
       js_package_manager: yarn
       main_git_branch: main
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
diff --git a/.github/workflows/flarum-emoji-frontend.yml b/.github/workflows/flarum-emoji-frontend.yml
@@ -18,5 +18,6 @@ jobs:
       backend_directory: ./extensions/emoji
       js_package_manager: yarn
       main_git_branch: main
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
diff --git a/.github/workflows/flarum-flags-frontend.yml b/.github/workflows/flarum-flags-frontend.yml
@@ -12,11 +12,12 @@ jobs:
     with:
       enable_bundlewatch: false
       enable_prettier: true
-      enable_typescript: false
+      enable_typescript: true
 
       frontend_directory: ./extensions/flags/js
       backend_directory: ./extensions/flags
       js_package_manager: yarn
       main_git_branch: main
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
diff --git a/.github/workflows/flarum-likes-frontend.yml b/.github/workflows/flarum-likes-frontend.yml
@@ -18,5 +18,6 @@ jobs:
       backend_directory: ./extensions/likes
       js_package_manager: yarn
       main_git_branch: main
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
diff --git a/.github/workflows/flarum-lock-frontend.yml b/.github/workflows/flarum-lock-frontend.yml
@@ -18,5 +18,6 @@ jobs:
       backend_directory: ./extensions/lock
       js_package_manager: yarn
       main_git_branch: main
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
diff --git a/.github/workflows/flarum-markdown-frontend.yml b/.github/workflows/flarum-markdown-frontend.yml
@@ -18,5 +18,6 @@ jobs:
       backend_directory: ./extensions/markdown
       js_package_manager: yarn
       main_git_branch: main
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
diff --git a/.github/workflows/flarum-mentions-frontend.yml b/.github/workflows/flarum-mentions-frontend.yml
@@ -18,5 +18,6 @@ jobs:
       backend_directory: ./extensions/mentions
       js_package_manager: yarn
       main_git_branch: main
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
diff --git a/.github/workflows/flarum-nicknames-frontend.yml b/.github/workflows/flarum-nicknames-frontend.yml
@@ -18,5 +18,6 @@ jobs:
       backend_directory: ./extensions/nicknames
       js_package_manager: yarn
       main_git_branch: main
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
diff --git a/.github/workflows/flarum-package-manager-frontend.yml b/.github/workflows/flarum-package-manager-frontend.yml
@@ -18,5 +18,6 @@ jobs:
       backend_directory: ./extensions/package-manager
       js_package_manager: yarn
       main_git_branch: main
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
diff --git a/.github/workflows/flarum-pusher-frontend.yml b/.github/workflows/flarum-pusher-frontend.yml
@@ -18,5 +18,6 @@ jobs:
       backend_directory: ./extensions/pusher
       js_package_manager: yarn
       main_git_branch: main
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
diff --git a/.github/workflows/flarum-statistics-frontend.yml b/.github/workflows/flarum-statistics-frontend.yml
@@ -18,5 +18,6 @@ jobs:
       backend_directory: ./extensions/statistics
       js_package_manager: yarn
       main_git_branch: main
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
diff --git a/.github/workflows/flarum-sticky-frontend.yml b/.github/workflows/flarum-sticky-frontend.yml
@@ -18,5 +18,6 @@ jobs:
       backend_directory: ./extensions/sticky
       js_package_manager: yarn
       main_git_branch: main
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
diff --git a/.github/workflows/flarum-subscriptions-frontend.yml b/.github/workflows/flarum-subscriptions-frontend.yml
@@ -18,5 +18,6 @@ jobs:
       backend_directory: ./extensions/subscriptions
       js_package_manager: yarn
       main_git_branch: main
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
diff --git a/.github/workflows/flarum-suspend-frontend.yml b/.github/workflows/flarum-suspend-frontend.yml
@@ -18,5 +18,6 @@ jobs:
       backend_directory: ./extensions/suspend
       js_package_manager: yarn
       main_git_branch: main
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
diff --git a/.github/workflows/flarum-tags-frontend.yml b/.github/workflows/flarum-tags-frontend.yml
@@ -12,7 +12,7 @@ jobs:
     with:
       enable_bundlewatch: false
       enable_prettier: false
-      enable_typescript: false
+      enable_typescript: true
 
       frontend_directory: ./extensions/tags/js
       backend_directory: ./extensions/tags

diff --git a/extensions/akismet/.gitattributes b/extensions/akismet/.gitattributes
diff --git a/extensions/akismet/js/package.json b/extensions/akismet/js/package.json
@@ -12,7 +12,7 @@
         "check-typings": "tsc --noEmit --emitDeclarationOnly false",
         "check-typings-coverage": "typescript-coverage-report",
         "clean-typings": "npx rimraf dist-typings && mkdir dist-typings",
-        "build-typings": "yarn run clean-typings && [ -e src/@types ] && cp -r src/@types dist-typings/@types && tsc && yarn run post-build-typings",
+        "build-typings": "yarn run clean-typings && ([ -e src/@types ] && cp -r src/@types dist-typings/@types || true) && tsc && yarn run post-build-typings",
         "post-build-typings": "find dist-typings -type f -name '*.d.ts' -print0 | xargs -0 sed -i 's,../src/@types,@types,g'"
     },
     "devDependencies": {

diff --git a/extensions/akismet/js/src/forum/index.ts b/extensions/akismet/js/src/forum/index.ts
@@ -1,18 +1,22 @@
 import { extend, override } from 'flarum/common/extend';
 import app from 'flarum/forum/app';
+import type Post from 'flarum/common/models/Post';
+import type ItemList from 'flarum/common/utils/ItemList';
 
 import PostControls from 'flarum/forum/utils/PostControls';
 import CommentPost from 'flarum/forum/components/CommentPost';
-import ItemList from 'flarum/common/utils/ItemList';
-import Post from 'flarum/common/models/Post';
+import type Mithril from 'mithril';
 
 app.initializers.add('flarum-akismet', () => {
-  extend(PostControls, 'destructiveControls', function (items: ItemList, post: Post) {
+  extend(PostControls, 'destructiveControls', function (items: ItemList<Mithril.Children>, post: Post) {
     if (items.has('approve')) {
       const flags = post.flags();
 
-      if (flags && flags.some((flag) => flag.type() === 'akismet')) {
-        items.get('approve').children = app.translator.trans('flarum-akismet.forum.post.not_spam_button');
+      if (flags && flags.some((flag) => flag?.type() === 'akismet')) {
+        const approveItem = items.get('approve');
+        if (approveItem && typeof approveItem === 'object' && 'children' in approveItem) {
+          approveItem.children = app.translator.trans('flarum-akismet.forum.post.not_spam_button');
+        }
       }
     }
   });

diff --git a/extensions/akismet/js/tsconfig.json b/extensions/akismet/js/tsconfig.json
@@ -4,13 +4,14 @@
   // This will match all .ts, .tsx, .d.ts, .js, .jsx files in your `src` folder
   // and also tells your Typescript server to read core's global typings for
   // access to `dayjs` and `$` in the global namespace.
-  "include": ["src/**/*", "../vendor/flarum/core/js/dist-typings/@types/**/*", "@types/**/*"],
+  "include": ["src/**/*", "../vendor/*/*/js/dist-typings/@types/**/*", "@types/**/*"],
   "compilerOptions": {
     // This will output typings to `dist-typings`
     "declarationDir": "./dist-typings",
     "baseUrl": ".",
     "paths": {
-      "flarum/*": ["../vendor/flarum/core/js/dist-typings/*"]
+      "flarum/*": ["../vendor/flarum/core/js/dist-typings/*"],
+      "flarum/flags/*": ["../vendor/flarum/flags/js/dist-typings/*"]
     }
   }
 }
diff --git a/extensions/approval/.gitattributes b/extensions/approval/.gitattributes
diff --git a/extensions/bbcode/.gitattributes b/extensions/bbcode/.gitattributes
diff --git a/extensions/embed/.gitattributes b/extensions/embed/.gitattributes
diff --git a/extensions/emoji/.gitattributes b/extensions/emoji/.gitattributes
diff --git a/extensions/flags/.gitattributes b/extensions/flags/.gitattributes
diff --git a/extensions/flags/composer.json b/extensions/flags/composer.json
@@ -49,7 +49,7 @@
                 "gitConf": true,
                 "githubActions": true,
                 "prettier": true,
-                "typescript": false,
+                "typescript": true,
                 "bundlewatch": false,
                 "backendTesting": true,
                 "editorConfig": true,

diff --git a/extensions/flags/js/admin.js → extensions/flags/js/admin.ts b/extensions/flags/js/admin.js → extensions/flags/js/admin.ts
diff --git a/extensions/flags/js/dist-typings/@types/shims.d.ts b/extensions/flags/js/dist-typings/@types/shims.d.ts
diff --git a/extensions/flags/js/dist-typings/admin/index.d.ts b/extensions/flags/js/dist-typings/admin/index.d.ts
diff --git a/extensions/flags/js/dist-typings/forum/addFlagControl.d.ts b/extensions/flags/js/dist-typings/forum/addFlagControl.d.ts
diff --git a/extensions/flags/js/dist-typings/forum/addFlagsDropdown.d.ts b/extensions/flags/js/dist-typings/forum/addFlagsDropdown.d.ts
diff --git a/extensions/flags/js/dist-typings/forum/addFlagsToPosts.d.ts b/extensions/flags/js/dist-typings/forum/addFlagsToPosts.d.ts
diff --git a/extensions/flags/js/dist-typings/forum/compat.d.ts b/extensions/flags/js/dist-typings/forum/compat.d.ts
diff --git a/extensions/flags/js/dist-typings/forum/components/FlagList.d.ts b/extensions/flags/js/dist-typings/forum/components/FlagList.d.ts