SonarQube : TypeScript baseUrl ve göreli yollar yapılandırması => sorun “Dependencies should be explicit” (typescript:S4328)

Bağlam

  • Kullanılan ALM: Azure DevOps
  • Kullanılan CI sistemi: Azure DevOps
  • Gerekli olduğunda kullanılan tarayıcı komutu (özel bilgiler gizlendi) :
  - task: SonarCloudPrepare@1
    inputs:
      SonarCloud: 'SonarCloud-Clement'
      organization: 'assoconnect'
      scannerMode: 'CLI'
      configMode: 'manual'
      cliProjectKey: 'assoconnect_frontend'
      cliProjectName: 'frontend'
      cliProjectVersion: '$(Build.BuildNumber)'
      cliSources: 'src'
      extraProperties: |
        sonar.tests=src
        sonar.test.inclusions=**/__tests__/**
        sonar.coverage.exclusions=src/pages/**
        sonar.junit.reportPaths=junit.xml
        sonar.typescript.lcov.reportPaths=coverage/lcov.info
        sonar.typescript.tsconfigPath=tsconfig.json
    displayName: 'Prepare SonarQube analysis'

  - task: SonarCloudAnalyze@1
    displayName: 'Run SonarQube analysis'

  - task: SonarCloudPublish@1
    inputs:
      pollingTimeoutSec: '300'
    displayName: 'Publish SonarQube analysis result'
  • Depodaki diller: TypeScript

Gözlemlenen problem

.tsx dosyalarımızdaki tüm imports için, “Bağımlılıklar açık olmalı (typescript:S4328)” sorunu örneklerimiz var.

tsconfig.json dosyamızda göreli yollarla uğraşmak zorunda kalmamak için bir baseUrl (https://www.typescriptlang.org/docs/handbook/module-resolution.html#base-url) yapılandırdık. WebStorm bu yapılandırmayla uyumlu görünüyor ve linter herhangi bir mesaj göstermiyor. Ama Sonar'da bir modül ithal ettiğimizde, başında ./ olmadığı için bunun harici bir modül olduğunu düşünüyor ve bağımlılıkların içinde arıyor.

Örnek

  • bizim düzenimiz şudur :
src/
|___pages/
|   |___Index/
|       |___index.tsx
|       |___type.tsx
|___App.tsx
package.json
tsconfig.json
  • dosya içerikleri
// package.json
// nothing path-related, only external dependencies
...

// tsconfig.json
{
  "compilerOptions": {
    "baseUrl": "./src/",
...

// src/App.tsx
...
import Index from 'pages/Index' // => ISSUE : Dependencies should be explicit (typescript:S4328)
...

// src/pages/Index/index.tsx
...
import * as Type from './type' // => OK, NO ISSUES
...
import { StoreContext } from 'store' // => ISSUE : Dependencies should be explicit (typescript:S4328)
...
export default () => (
...

Cevap #1

şunu gibi sonar.sources içinde belirli bir yol eklemeyi deneyebilirsiniz:

// in my tsconfig
"paths": {
      "src": [
        "./src/*"
      ],
    },

// in my sonar-project.properties
sonar.sources=src/components,src/navigation,src/screens,src/store,src/types,src/utils

Benim için çalışıyor, sonar tarama raporunda 'bağımlılık açık olmalı' sorunları kaldırıldı

İlgili makaleler