Modify S4328: Use new package.json shared methods (#4377)

package.json

@@ -164,7 +164,6 @@
     "@sonar/css": "lib/css/src",
     "@sonar/html": "lib/html/src",
     "@sonar/jsts": "lib/jsts/src",
-    "@sonar/jsts/embedded": "lib/jsts/src/embedded",
     "@sonar/shared": "lib/shared/src",
     "@sonar/yaml": "lib/yaml/src"
   }

packages/bridge/src/errors/middleware.ts

@@ -18,9 +18,8 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 import express from 'express';
-import { ErrorCode } from '@sonar/shared/errors';
+import { ErrorCode, error } from '@sonar/shared';
 import { JsTsAnalysisOutput } from '@sonar/jsts';
-import { error } from '@sonar/shared/helpers';
 
 /**
  * Express.js middleware for handling error while serving requests.

packages/bridge/src/memory.ts

@@ -22,7 +22,7 @@ import * as v8 from 'v8';
 import * as os from 'os';
 import fs from 'fs';
 import { constants, NodeGCPerformanceDetail, PerformanceObserver } from 'perf_hooks';
-import { debug, error, getContext, info, warn } from '@sonar/shared/helpers';
+import { debug, error, getContext, info, warn } from '@sonar/shared';
 
 const MB = 1024 * 1024;
 

packages/bridge/src/server.ts

@@ -28,7 +28,7 @@ import http from 'http';
 import path from 'path';
 import router from './router';
 import { errorMiddleware } from './errors';
-import { debug, getContext } from '@sonar/shared/helpers';
+import { debug, getContext } from '@sonar/shared';
 import { timeoutMiddleware } from './timeout';
 import { AddressInfo } from 'net';
 import { Worker, SHARE_ENV } from 'worker_threads';

packages/bridge/tests/errors/middleware.test.ts

@@ -17,7 +17,7 @@
  * along with this program; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
-import { ErrorCode, APIError } from '@sonar/shared/errors';
+import { ErrorCode, APIError } from '@sonar/shared';
 import * as express from 'express';
 import { EMPTY_JSTS_ANALYSIS_OUTPUT, errorMiddleware } from '../../src/errors';
 

packages/bridge/tests/router.test.ts

@@ -17,7 +17,7 @@
  * along with this program; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
-import { setContext, toUnixPath } from '@sonar/shared/helpers';
+import { setContext, toUnixPath } from '@sonar/shared';
 import http from 'http';
 import { createAndSaveProgram, RuleConfig } from '@sonar/jsts';
 import path from 'path';

packages/bridge/tests/server.test.ts

@@ -20,7 +20,7 @@
 import { start } from '../src/server';
 import { promisify } from 'util';
 import path from 'path';
-import { setContext } from '@sonar/shared/helpers';
+import { setContext } from '@sonar/shared';
 import { AddressInfo } from 'net';
 import { request } from './tools';
 import http from 'http';

packages/bridge/tests/worker.test.ts

@@ -20,7 +20,7 @@
 
 import path from 'path';
 import { Worker } from 'worker_threads';
-import { ErrorCode } from '@sonar/shared/errors';
+import { ErrorCode } from '@sonar/shared';
 
 describe('worker', () => {
   let worker: Worker;

packages/css/src/analysis/analysis.ts

@@ -18,7 +18,7 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 import { Issue, RuleConfig } from '../linter';
-import { AnalysisInput, AnalysisOutput } from '@sonar/shared/types';
+import { AnalysisInput, AnalysisOutput } from '@sonar/shared';
 
 /**
  * A CSS analysis input

packages/css/src/linter/issues/transform.ts

@@ -18,7 +18,7 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 import * as stylelint from 'stylelint';
-import { debug } from '@sonar/shared/helpers';
+import { debug } from '@sonar/shared';
 import { Issue } from './issue';
 
 /**

packages/css/tests/analysis/analyzer.test.ts

@@ -20,7 +20,7 @@
 import { analyzeCSS, CssAnalysisInput } from '../../src/analysis';
 import { RuleConfig } from '../../src/linter';
 import path from 'path';
-import { readFile } from '@sonar/shared/helpers';
+import { readFile } from '@sonar/shared';
 
 const rules = [{ key: 'block-no-empty', configurations: [] }];
 

packages/css/tests/linter/wrapper.test.ts

@@ -19,7 +19,7 @@
  */
 import path from 'path';
 import * as stylelint from 'stylelint';
-import { readFile } from '@sonar/shared/helpers';
+import { readFile } from '@sonar/shared';
 import { createStylelintConfig, LinterWrapper, RuleConfig } from '../../src/linter';
 
 describe('LinterWrapper', () => {

packages/html/src/index.ts

@@ -22,7 +22,7 @@ import {
   analyzeEmbedded,
   EmbeddedAnalysisInput as HtmlAnalysisInput,
   EmbeddedAnalysisOutput as HtmlAnalysisOutput,
-} from '@sonar/jsts/embedded';
+} from '@sonar/jsts';
 
 import { parseHTML } from './parser';
 

packages/html/src/parser/parse.ts

@@ -18,7 +18,7 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 import * as htmlparser from 'htmlparser2';
-import { EmbeddedJS } from '@sonar/jsts/embedded';
+import { EmbeddedJS } from '@sonar/jsts';
 
 /**
  * References:

packages/html/tests/analysis/analyzer.test.ts

@@ -20,9 +20,8 @@
 import { join } from 'path';
 import { embeddedInput } from '../../../jsts/tests/tools';
 import { parseHTML } from '../../src/parser';
-import { setContext } from '@sonar/shared/helpers';
-import { analyzeEmbedded } from '@sonar/jsts/embedded';
-import { initializeLinter } from '@sonar/jsts';
+import { setContext } from '@sonar/shared';
+import { analyzeEmbedded, initializeLinter } from '@sonar/jsts';
 
 describe('analyzeHTML', () => {
   const fixturesPath = join(__dirname, 'fixtures');

packages/html/tests/builder/build.test.ts

@@ -20,7 +20,7 @@
 import { join } from 'path';
 import { parseHTML } from '../../src/parser';
 import { embeddedInput } from '../../../jsts/tests/tools';
-import { buildSourceCodes } from '@sonar/jsts/embedded';
+import { buildSourceCodes } from '@sonar/jsts';
 
 describe('buildSourceCodes()', () => {
   const fixturesPath = join(__dirname, 'fixtures');

packages/html/tests/parser/parse.test.ts

@@ -19,7 +19,7 @@
  */
 import path from 'path';
 import { parseHTML } from '../../src/parser';
-import { readFile } from '@sonar/shared/helpers';
+import { readFile } from '@sonar/shared';
 
 describe('parseHtml', () => {
   it('should return embedded JavaScript', async () => {

packages/jsts/src/analysis/analysis.ts

@@ -17,9 +17,8 @@
  * along with this program; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
-import { FileType, JsTsLanguage } from '@sonar/shared/helpers';
+import { FileType, JsTsLanguage, AnalysisInput, AnalysisOutput } from '@sonar/shared';
 import { CpdToken, Issue, Metrics, SymbolHighlight, SyntaxHighlight } from '../linter';
-import { AnalysisInput, AnalysisOutput } from '@sonar/shared/types';
 import { Perf } from '../monitoring';
 
 /**

packages/jsts/src/analysis/analyzer.ts

@@ -17,9 +17,8 @@
  * along with this program; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
-import { APIError } from '@sonar/shared/errors';
+import { APIError, debug, getContext, JsTsLanguage } from '@sonar/shared';
 import { SourceCode } from 'eslint';
-import { debug, getContext, JsTsLanguage } from '@sonar/shared/helpers';
 import {
   computeMetrics,
   findNoSonarLines,

packages/jsts/src/builders/build.ts

@@ -17,7 +17,7 @@
  * along with this program; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
-import { debug, getContext, JsTsLanguage } from '@sonar/shared/helpers';
+import { debug, getContext, JsTsLanguage } from '@sonar/shared';
 import { JsTsAnalysisInput } from '../analysis';
 import { buildParserOptions, parseForESLint, parsers } from '../parsers';
 import { getProgramById } from '../program';

packages/jsts/src/dependencies/package-json/project-package-json.ts

@@ -19,7 +19,7 @@
  */
 import fs from 'fs';
 import path from 'path';
-import { toUnixPath, debug, error, readFileSync } from '@sonar/shared/helpers';
+import { toUnixPath, debug, error, readFileSync } from '@sonar/shared';
 import { PackageJson as PJ } from 'type-fest';
 import { Minimatch } from 'minimatch';
 

packages/jsts/src/embedded/analysis/analysis.ts

@@ -19,7 +19,7 @@
  */
 import { Perf } from 'jsts/src/monitoring';
 import { Issue } from '../../linter';
-import { AnalysisInput, AnalysisOutput } from '@sonar/shared/types';
+import { AnalysisInput, AnalysisOutput } from '@sonar/shared';
 
 /**
  * An analysis input of embedded code

packages/jsts/src/embedded/analysis/analyzer.ts

@@ -22,7 +22,7 @@ import { Position } from 'estree';
 import { getLinter, Issue, LinterWrapper } from '../../linter';
 import { buildSourceCodes, ExtendedSourceCode, LanguageParser } from '../builder';
 import { EmbeddedAnalysisInput, EmbeddedAnalysisOutput } from './analysis';
-import { debug } from '@sonar/shared/helpers';
+import { debug } from '@sonar/shared';
 import { measureDuration } from '../../monitoring';
 import { findNcloc } from '../../linter/visitors/metrics/ncloc';
 

packages/jsts/src/embedded/builder/patch.ts

@@ -21,7 +21,7 @@ import { AST, SourceCode } from 'eslint';
 import { Comment, Node } from 'estree';
 import { visit } from '../../linter';
 import { EmbeddedJS } from '../analysis';
-import { APIError } from '@sonar/shared/errors';
+import { APIError } from '@sonar/shared';
 
 /**
  * Patches the ESLint SourceCode instance parsed with an ESLint-based parser

packages/jsts/src/index.ts

@@ -24,3 +24,4 @@ export * from './linter';
 export * from './parsers';
 export * from './program';
 export * from './rules';
+export * from './embedded';

packages/jsts/src/linter/bundle-loader.ts

@@ -25,7 +25,7 @@ import { rules as reactESLintRules } from 'eslint-plugin-react';
 import { rules as reactA11yRules } from 'eslint-plugin-jsx-a11y';
 import { rules as internalRules } from '../rules';
 import { customRules as internalCustomRules, CustomRule } from './custom-rules';
-import { debug, getContext } from '@sonar/shared/helpers';
+import { debug, getContext } from '@sonar/shared';
 
 export function loadCustomRules(linter: Linter, rules: CustomRule[] = []) {
   for (const rule of rules) {

packages/jsts/src/linter/config/linter-config.ts

@@ -18,7 +18,7 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 import { Linter, Rule } from 'eslint';
-import { getContext } from '@sonar/shared/helpers';
+import { getContext } from '@sonar/shared';
 import { customRules as internalCustomRules } from '../custom-rules';
 import { extendRuleConfig, RuleConfig } from './rule-config';
 

packages/jsts/src/linter/config/rule-config.ts

@@ -18,7 +18,7 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 import { Rule } from 'eslint';
-import { FileType, getContext, JsTsLanguage } from '@sonar/shared/helpers';
+import { FileType, getContext, JsTsLanguage } from '@sonar/shared';
 import { hasSonarContextOption, hasSonarRuntimeOption, SONAR_RUNTIME } from '../parameters';
 
 /**

packages/jsts/src/linter/issues/message.ts

@@ -20,7 +20,7 @@
 import { Linter, SourceCode } from 'eslint';
 import { transformFixes } from '../quickfixes';
 import { Issue } from './issue';
-import { error } from '@sonar/shared/helpers';
+import { error } from '@sonar/shared';
 
 /**
  * Converts an ESLint message into a SonarQube issue

packages/jsts/src/linter/linters.ts

@@ -17,8 +17,7 @@
  * along with this program; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
-import { APIError } from '@sonar/shared/errors';
-import { debug } from '@sonar/shared/helpers';
+import { APIError, debug } from '@sonar/shared';
 import { LinterWrapper } from './wrapper';
 import { RuleConfig } from './config';
 

packages/jsts/src/linter/parameters/helpers/schema.ts

@@ -18,7 +18,7 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 import { Rule } from 'eslint';
-import { debug } from '@sonar/shared/helpers';
+import { debug } from '@sonar/shared';
 
 /**
  * Extracts the schema of a rule

packages/jsts/src/linter/wrapper.ts

@@ -20,7 +20,7 @@
 import { Linter, SourceCode } from 'eslint';
 import { loadBundles, loadCustomRules } from './bundle-loader';
 import { createLinterConfig, RuleConfig } from './config';
-import { debug, FileType, JsTsLanguage } from '@sonar/shared/helpers';
+import { debug, FileType, JsTsLanguage } from '@sonar/shared';
 import { LintingResult, transformMessages } from './issues';
 import { CustomRule } from './custom-rules';
 

packages/jsts/src/parsers/parse.ts

@@ -17,7 +17,7 @@
  * along with this program; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
-import { APIError } from '@sonar/shared/errors';
+import { APIError } from '@sonar/shared';
 import { SourceCode } from 'eslint';
 import { ParseFunction } from './eslint';
 

packages/jsts/src/program/program.ts

@@ -37,7 +37,7 @@ import {
   readFileSync,
   toUnixPath,
   warn,
-} from '@sonar/shared/helpers';
+} from '@sonar/shared';
 import tmp from 'tmp';
 import { promisify } from 'util';
 import fs from 'fs/promises';

packages/jsts/src/rules/S4328/rule.ts

@@ -26,7 +26,9 @@ import * as path from 'path';
 import * as fs from 'fs';
 import * as ts from 'typescript';
 import { RequiredParserServices } from '../helpers';
-import { stripBOM } from '@sonar/shared/helpers';
+import { toUnixPath } from '@sonar/shared';
+import { getNearestPackageJsons } from '@sonar/jsts';
+import { PackageJson } from 'type-fest';
 
 const DefinitelyTyped = '@types/';
 
@@ -156,7 +158,7 @@ function getPackageName(name: string) {
 }
 
 function getDependencies(fileName: string) {
-  let dirname = path.dirname(fileName);
+  let dirname = path.posix.dirname(toUnixPath(fileName));
   const cached = cache.get(dirname);
   if (cached) {
     return cached;
@@ -165,34 +167,24 @@ function getDependencies(fileName: string) {
   const result = new Set<string>();
   cache.set(dirname, result);
 
-  while (true) {
+  for (const packageJson of getNearestPackageJsons(fileName)) {
+    dirname = path.posix.dirname(packageJson.filename);
     const dirCached = dirCache.get(dirname);
     if (dirCached) {
       dirCached.forEach(d => result.add(d));
     } else {
-      const packageJsonPath = path.join(path.resolve(dirname), 'package.json');
-      const dep = fs.existsSync(packageJsonPath)
-        ? getDependenciesFromPackageJson(packageJsonPath)
-        : new Set<string>();
+      const dep = getDependenciesFromPackageJson(packageJson.contents);
       dep.forEach(d => result.add(d));
       dirCache.set(dirname, dep);
     }
-
-    const upperDir = path.dirname(dirname);
-    if (upperDir === dirname) {
-      break;
-    } else {
-      dirname = upperDir;
-    }
   }
 
   return result;
 }
 
-function getDependenciesFromPackageJson(packageJsonPath: string) {
+function getDependenciesFromPackageJson(content: PackageJson) {
   const result = new Set<string>();
   try {
-    const content = JSON.parse(readFile(packageJsonPath));
     if (content.dependencies !== undefined) {
       addDependencies(result, content.dependencies);
     }
@@ -268,8 +260,3 @@ function extractPathMappingPatterns(
 function getBaseUrl(parserServices: RequiredParserServices): string | undefined {
   return parserServices.program?.getCompilerOptions().baseUrl;
 }
-
-function readFile(filePath: string) {
-  const fileContent = fs.readFileSync(filePath, { encoding: 'utf8' });
-  return stripBOM(fileContent);
-}

packages/jsts/src/rules/S4328/unit.test.ts

@@ -20,9 +20,13 @@
 import { RuleTester } from 'eslint';
 import { rule } from './';
 import path from 'path';
+import { getAllPackageJsons, searchPackageJsonFiles } from '@sonar/jsts';
 
-const fixtures = path.join(__dirname, 'fixtures');
+//reset and search package.json files in rule dir
+getAllPackageJsons().clear();
+searchPackageJsonFiles(__dirname, []);
 
+const fixtures = path.join(__dirname, 'fixtures');
 const filename = path.join(fixtures, 'package-json-project/file.js');
 const options = [];
 const tsParserPath = require.resolve('@typescript-eslint/parser');