@diplodoc/lint 1.12.0 → 1.13.0

package/README.md

@@ -85,6 +85,7 @@ Initializes linting in a package:
 Updates configuration files to the latest versions:
 
 - Updates `.eslintrc.js`, `.prettierrc.js`, `.stylelintrc.js`
+- Updates/copies GitHub Actions workflows (including `sonarcloud.yml`, `coverage.yml`) and `sonar-project.properties` (with `{{PACKAGE_NAME}}` substitution)
 - Updates ignore files with new patterns
 - **Does not** re-initialize Husky
 - **Does not** modify existing scripts in `package.json`
@@ -224,6 +225,20 @@ build({
 - **Import**: Use `@diplodoc/lint/esbuild` — it re-exports the full esbuild API (ESM and CJS).
 - **Why**: Aligns esbuild version and avoids duplicate native bindings; add `@diplodoc/lint` as a devDependency and use this export instead of installing `esbuild` directly in the package.
 
+### SonarCloud
+
+Scaffolding provides optional SonarCloud integration for code quality and coverage:
+
+- **`sonar-project.properties`** — copied to the package root; the placeholder `{{PACKAGE_NAME}}` is replaced with the package name **without scope** (e.g. `@diplodoc/foo` → `foo`) so each repo has a unique SonarCloud project key.
+- **`.github/workflows/sonarcloud.yml`** — runs SonarCloud analysis on push/PR to `master`/`main`. The scan runs only when the package has a `test:coverage` script and coverage was generated; otherwise the job skips the scan.
+- **`.github/workflows/coverage.yml`** — optional workflow that runs `test:coverage` when the script exists (see above); does not block merging.
+
+To enable SonarCloud for a repository:
+
+1. Add the repository in [SonarCloud](https://sonarcloud.io) (organization `diplodoc-platform`).
+2. Add the **SONAR_TOKEN** secret in the GitHub repo settings.
+3. Optionally add a `test:coverage` script (e.g. `vitest run --coverage`) so the SonarCloud workflow can upload coverage.
+
 ## Metapackage vs Standalone Usage
 
 The package works in two modes:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@diplodoc/lint",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "Diplodoc platform internal utility set for linting",
   "bin": {
     "lint": "./bin/lint.js",

package/scaffolding/.github/workflows/coverage.yml

@@ -0,0 +1,63 @@
+# ⚠️ IMPORTANT: This workflow is a template from diplodoc/lint/scaffolding
+# Do not edit this file in other packages - it is automatically copied from here.
+# To modify this workflow, edit it in diplodoc/devops/lint/scaffolding/.github/workflows/
+# and then run the scaffolding update process.
+#
+# This workflow is optional: it does not block merging even if it fails (continue-on-error).
+
+name: Coverage
+
+on:
+  push:
+    branches:
+      - master
+      - main
+  pull_request:
+    branches:
+      - master
+      - main
+  workflow_dispatch:
+
+jobs:
+  coverage:
+    name: Test coverage
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: 'npm'
+
+      - name: Install latest npm (>= 11.5.1)
+        run: |
+          [ "$(printf '%s\n' "11.5.1" "$(npm -v)" | sort -V | head -n1)" = "11.5.1" ] || npm install -g npm@latest
+        shell: bash
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests with coverage
+        id: coverage-run
+        run: |
+          if node -e "const s=require('./package.json').scripts; process.exit(s && s['test:coverage'] ? 0 : 1)"; then
+            npm run test:coverage
+            echo "ran=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "test:coverage script not found, skipping."
+            echo "ran=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Upload coverage artifact
+        if: success() && steps.coverage-run.outputs.ran == 'true'
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage
+          path: coverage/
+          retention-days: 7

package/scaffolding/.github/workflows/sonarcloud.yml

@@ -0,0 +1,45 @@
+name: SonarCloud Analysis
+
+on:
+  push:
+    branches: [master, main]
+  pull_request:
+    branches: [master, main]
+    types: [opened, synchronize, reopened]
+
+jobs:
+  sonarcloud:
+    name: SonarCloud Analysis
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Shallow clones should be disabled for better analysis
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests with coverage
+        id: coverage-run
+        run: |
+          if node -e "const s=require('./package.json').scripts; process.exit(s && s['test:coverage'] ? 0 : 1)"; then
+            npm run test:coverage
+            echo "ran=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "test:coverage script not found, skipping."
+            echo "ran=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: SonarCloud Scan
+        if: success() && steps.coverage-run.outputs.ran == 'true'
+        uses: SonarSource/sonarqube-scan-action@v7.0.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

package/scaffolding/sonar-project.properties

@@ -0,0 +1,27 @@
+# SonarCloud project configuration
+# This file will be generated/updated by SonarCloud when you connect your repository
+
+# Project identification
+# Note: sonar.organization can also be set via environment variable SONAR_ORGANIZATION
+# or via GitHub Actions workflow. If not set here, it must be provided in the workflow.
+sonar.organization=diplodoc-platform
+sonar.projectKey=diplodoc-platform_{{package}}
+sonar.projectName={{package}}
+
+# Source code location
+sonar.sources=src
+sonar.exclusions=**/*.spec.ts,**/*.test.ts,**/__tests__/**
+
+# Test code location
+sonar.tests=src
+sonar.test.inclusions=**/*.spec.ts,**/*.test.ts,**/__tests__/**
+
+# Coverage reports
+sonar.javascript.lcov.reportPaths=coverage/lcov.info
+sonar.typescript.lcov.reportPaths=coverage/lcov.info
+
+# TypeScript configuration
+sonar.typescript.tsconfigPath=tsconfig.json
+
+# Encoding
+sonar.sourceEncoding=UTF-8

package/scripts/copy-scaffolding.js

@@ -1,5 +1,5 @@
 const {join, relative, dirname} = require('node:path');
-const {readdirSync, copyFileSync, mkdirSync, existsSync, realpathSync} = require('node:fs');
+const {readdirSync, readFileSync, writeFileSync, copyFileSync, mkdirSync, existsSync, realpathSync} = require('node:fs');
 
 // Determine package root directory
 // Try multiple strategies to find the package root
@@ -32,6 +32,41 @@ if (!existsSync(srcDir)) {
 
 const targetDir = process.cwd();
 
+/** @type {{ PACKAGE_NAME: string }} Variables for scaffolding template substitution */
+let scaffoldVars = {PACKAGE_NAME: 'package'};
+const packageJsonPath = join(targetDir, 'package.json');
+if (existsSync(packageJsonPath)) {
+    try {
+        const pkg = JSON.parse(readFileSync(packageJsonPath, 'utf8'));
+        const name = pkg.name && typeof pkg.name === 'string' ? pkg.name : '';
+        scaffoldVars.PACKAGE_NAME = name.replace(/^@[^/]+\//, '') || 'package';
+    } catch {
+        // leave default
+    }
+}
+
+function applyTemplate(content) {
+    if (typeof content !== 'string' || !content.includes('{{')) {
+        return content;
+    }
+    return content.replace(/\{\{PACKAGE_NAME\}\}/g, scaffoldVars.PACKAGE_NAME);
+}
+
+function copyFileWithSubstitution(srcPath, targetPath) {
+    let content;
+    try {
+        content = readFileSync(srcPath, 'utf8');
+    } catch {
+        copyFileSync(srcPath, targetPath);
+        return;
+    }
+    if (content.includes('{{PACKAGE_NAME}}')) {
+        writeFileSync(targetPath, applyTemplate(content), 'utf8');
+    } else {
+        writeFileSync(targetPath, content, 'utf8');
+    }
+}
+
 // Verify scaffolding directory exists
 if (!existsSync(srcDir)) {
     console.error(`[@diplodoc/lint] Error: scaffolding directory not found at ${srcDir}`);
@@ -74,9 +109,9 @@ function copyScaffoldingFiles(excludePatterns = []) {
                 if (!existsSync(targetParent)) {
                     mkdirSync(targetParent, {recursive: true});
                 }
-                // Force overwrite existing files
+                // Force overwrite existing files (with optional {{PACKAGE_NAME}} substitution)
                 try {
-                    copyFileSync(srcPath, targetPath);
+                    copyFileWithSubstitution(srcPath, targetPath);
                 } catch (error) {
                     console.error(`[@diplodoc/lint] Error copying ${srcPath} to ${targetPath}:`, error.message);
                     throw error;
@@ -105,7 +140,7 @@ function copyWorkflows() {
         if (entry.isFile()) {
             const srcPath = join(workflowsSrc, entry.name);
             const targetPath = join(workflowsTarget, entry.name);
-            copyFileSync(srcPath, targetPath);
+            copyFileWithSubstitution(srcPath, targetPath);
         }
     }
 }