feat: support typescript linting and type checking (#475)

* feat: support typescript linting and type checking (#474) * feat: support typescript eslint * feat: run tsc --noEmit on typescript projects * chore: remove unused babel-eslint package * chore(release): cut 10.8.0-alpha.1 [skip release] # [10.8.0-alpha.1](v10.7.4...v10.8.0-alpha.1) (2024-10-22) ### Features * support typescript linting and type checking ([#474](#474)) ([b68f69a](b68f69a)) --------- Co-authored-by: @dhis2-bot <apps@dhis2.org>
dhis2 · Oct 24, 2024 · 296dd60 · 296dd60
1 parent f36c1e1
commit 296dd60
Show file tree

Hide file tree

Showing 8 changed files with 1,027 additions and 265 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+# [10.8.0-alpha.1](https://github.com/dhis2/cli-style/compare/v10.7.4...v10.8.0-alpha.1) (2024-10-22)
+
+
+### Features
+
+* support typescript linting and type checking ([#474](https://github.com/dhis2/cli-style/issues/474)) ([b68f69a](https://github.com/dhis2/cli-style/commit/b68f69a428ab9867f96099c29953e9dd62977a3b))
+
 ## [10.7.4](https://github.com/dhis2/cli-style/compare/v10.7.3...v10.7.4) (2024-09-18)
 
 

diff --git a/config/eslint-react.config.js b/config/eslint-react.config.js
@@ -1,5 +1,5 @@
 module.exports = {
-    parser: 'babel-eslint',
+    parser: '@typescript-eslint/parser',
 
     plugins: ['react-hooks'],
 

diff --git a/config/eslint.config.js b/config/eslint.config.js
@@ -24,6 +24,19 @@ module.exports = {
         },
         sourceType: 'module',
     },
+    // Limit TypeScript linting to TS/TSX
+    overrides: [
+        {
+            files: ['**/*.{ts,tsx}'],
+            extends: [
+                'plugin:@typescript-eslint/recommended',
+                'plugin:import/typescript',
+            ],
+            rules: {
+                'import/extensions': 'off',
+            },
+        },
+    ],
 
     rules: {
         'max-params': [

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@dhis2/cli-style",
-    "version": "10.7.4",
+    "version": "10.8.0-alpha.1",
     "description": "The code and commit style for DHIS2.",
     "repository": {
         "type": "git",
@@ -30,12 +30,13 @@
         "@commitlint/config-conventional": "^13.1.0",
         "@dhis2/cli-helpers-engine": "^3.0.0",
         "@ls-lint/ls-lint": "^1.10.0",
-        "babel-eslint": "^10.1.0",
-        "eslint": "^7.32.0",
-        "eslint-config-prettier": "^8.3.0",
+        "@typescript-eslint/eslint-plugin": "^8.9.0",
+        "@typescript-eslint/parser": "^8.9.0",
+        "eslint": "^8",
+        "eslint-config-prettier": "^9.1.0",
         "eslint-plugin-import": "^2.22.1",
-        "eslint-plugin-react": "^7.31.10",
-        "eslint-plugin-react-hooks": "^4.6.2",
+        "eslint-plugin-react": "^7.37.1",
+        "eslint-plugin-react-hooks": "^5.0.0",
         "fast-glob": "^3.2.5",
         "find-up": "^5.0.0",
         "fs-extra": "^10.0.0",
@@ -49,6 +50,7 @@
         "semver": "^7.3.5",
         "stylelint": "^16.3.1",
         "stylelint-use-logical": "^2.1.2",
+        "typescript": "^5.6.3",
         "yargs": "^16.2.0"
     },
     "publishConfig": {

diff --git a/src/commands/types/javascript.js b/src/commands/types/javascript.js
@@ -4,6 +4,7 @@ const { exit } = require('@dhis2/cli-helpers-engine')
 const { eslint } = require('../../tools/eslint.js')
 const { prettier } = require('../../tools/prettier.js')
 const { stylelint } = require('../../tools/stylelint.js')
+const { typescriptCheck } = require('../../tools/typescript-check.js')
 const { configured } = require('../../utils/config.js')
 const { selectFiles } = require('../../utils/files.js')
 const {
@@ -52,8 +53,22 @@ exports.handler = (argv, callback) => {
         return
     }
 
+    const isTypescriptProject = configured('typescript')
+
+    if (isTypescriptProject) {
+        log.info('typescript > tsc --noEmit')
+        typescriptCheck({ callback: finalStatus })
+
+        if (finalStatus() === 0) {
+            log.print('Typescript check completed successfully.')
+            log.print('')
+        }
+    }
+
     if (configured('eslint')) {
-        log.info('javascript > eslint')
+        log.info(
+            `${isTypescriptProject ? 'typescript' : 'javascript'} > eslint`
+        )
         eslint({
             apply,
             files: jsFiles,

diff --git a/src/tools/typescript-check.js b/src/tools/typescript-check.js
@@ -0,0 +1,8 @@
+const { bin } = require('@dhis2/cli-helpers-engine').exec
+const { PROJECT_ROOT } = require('../utils/paths.js')
+
+exports.typescriptCheck = ({ callback }) => {
+    const cmd = 'tsc'
+
+    bin(cmd, { args: ['--noEmit'], PROJECT_ROOT }, callback)
+}
diff --git a/src/utils/config.js b/src/utils/config.js
@@ -32,6 +32,7 @@ const packageConfigs = {
  * project.
  */
 const projectConfigs = {
+    typescript: path.join(PROJECT_ROOT, 'tsconfig.json'),
     editorconfig: path.join(PROJECT_ROOT, '.editorconfig'),
     eslint: path.join(PROJECT_ROOT, '.eslintrc.js'),
     prettier: path.join(PROJECT_ROOT, '.prettierrc.js'),