@opensip-tools/checks-java 1.0.4 → 1.0.5

package/.turbo/turbo-build.log

@@ -0,0 +1,4 @@
+
+> @opensip-tools/checks-java@1.0.5 build /home/runner/work/opensip-tools/opensip-tools/packages/fitness/checks-java
+> tsc
+

package/.turbo/turbo-test.log

@@ -0,0 +1,15 @@
+
+> @opensip-tools/checks-java@1.0.5 test /home/runner/work/opensip-tools/opensip-tools/packages/fitness/checks-java
+> vitest run --passWithNoTests
+
+
+ RUN  v2.1.9 /home/runner/work/opensip-tools/opensip-tools/packages/fitness/checks-java
+
+ ✓ src/__tests__/analyze.test.ts (6 tests) 14ms
+ ✓ src/__tests__/no-printstacktrace.test.ts (6 tests) 30ms
+
+ Test Files  2 passed (2)
+      Tests  12 passed (12)
+   Start at  05:38:46
+   Duration  10.13s (transform 2.67s, setup 0ms, collect 16.26s, tests 44ms, environment 0ms, prepare 1.09s)
+

package/.turbo/turbo-typecheck.log

@@ -1,4 +1,4 @@
 
-> @opensip-tools/checks-java@1.0.4 typecheck /Users/sb/Documents/Code/opensip-ai/opensip-tools/packages/fitness/checks-java
+> @opensip-tools/checks-java@1.0.5 typecheck /home/runner/work/opensip-tools/opensip-tools/packages/fitness/checks-java
 > tsc --noEmit
 

package/dist/__tests__/analyze.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=analyze.test.d.ts.map

package/dist/__tests__/analyze.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"analyze.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/analyze.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/analyze.test.js

@@ -0,0 +1,27 @@
+import { describe, expect, it } from 'vitest';
+import { analyzePrintStackTrace } from '../checks/no-printstacktrace.js';
+describe('analyzePrintStackTrace', () => {
+    it('flags e.printStackTrace()', () => {
+        const out = analyzePrintStackTrace('try { foo(); } catch (Exception e) { e.printStackTrace(); }');
+        expect(out).toHaveLength(1);
+        expect(out[0]?.severity).toBe('warning');
+    });
+    it('flags printStackTrace() with whitespace', () => {
+        expect(analyzePrintStackTrace('e.printStackTrace ( )')).toHaveLength(1);
+    });
+    it('reports the correct line', () => {
+        const out = analyzePrintStackTrace('class X {\n  void f(Exception e) {\n    e.printStackTrace();\n  }\n}');
+        expect(out[0]?.line).toBe(3);
+    });
+    it('does not flag printStackTrace with arguments', () => {
+        expect(analyzePrintStackTrace('e.printStackTrace(System.err)')).toHaveLength(0);
+    });
+    it('flags multiple occurrences in one file', () => {
+        const src = 'a.printStackTrace();\nb.printStackTrace();';
+        expect(analyzePrintStackTrace(src)).toHaveLength(2);
+    });
+    it('returns an empty list when no .printStackTrace() is present', () => {
+        expect(analyzePrintStackTrace('class X {}')).toEqual([]);
+    });
+});
+//# sourceMappingURL=analyze.test.js.map

package/dist/__tests__/analyze.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"analyze.test.js","sourceRoot":"","sources":["../../src/__tests__/analyze.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAEzE,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;IACtC,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACnC,MAAM,GAAG,GAAG,sBAAsB,CAAC,6DAA6D,CAAC,CAAC;QAClG,MAAM,CAAC,GAAG,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC5B,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACjD,MAAM,CAAC,sBAAsB,CAAC,uBAAuB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;QAClC,MAAM,GAAG,GAAG,sBAAsB,CAAC,sEAAsE,CAAC,CAAC;QAC3G,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,CAAC,sBAAsB,CAAC,+BAA+B,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAClF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,MAAM,GAAG,GAAG,4CAA4C,CAAC;QACzD,MAAM,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;QACrE,MAAM,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/__tests__/no-printstacktrace.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=no-printstacktrace.test.d.ts.map

package/dist/__tests__/no-printstacktrace.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-printstacktrace.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/no-printstacktrace.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/no-printstacktrace.test.js

@@ -0,0 +1,51 @@
+import { stripComments, stripStrings } from '@opensip-tools/lang-java/strip';
+import { describe, expect, it } from 'vitest';
+import { analyzePrintStackTrace } from '../checks/no-printstacktrace.js';
+describe('analyzePrintStackTrace', () => {
+    it('flags e.printStackTrace()', () => {
+        const violations = analyzePrintStackTrace('e.printStackTrace();');
+        expect(violations.length).toBe(1);
+        expect(violations[0]?.line).toBe(1);
+        expect(violations[0]?.message).toContain('logging framework');
+    });
+    it('does not flag the same literal text inside a string after stripping', () => {
+        // The content filter (strip-strings-and-comments) is applied by the
+        // framework before calling analyze. Simulate that here.
+        const src = 'String s = "e.printStackTrace()";';
+        const filtered = stripStrings(src);
+        const violations = analyzePrintStackTrace(filtered);
+        expect(violations.length).toBe(0);
+    });
+    it('does not flag occurrences inside comments after stripping', () => {
+        const src = '// see e.printStackTrace() for example\nint x = 1;';
+        const filtered = stripComments(src);
+        const violations = analyzePrintStackTrace(filtered);
+        expect(violations.length).toBe(0);
+    });
+    it('reports correct line numbers for multiple matches', () => {
+        const src = [
+            'class A {',
+            '  void m(Throwable e) {',
+            '    e.printStackTrace();',
+            '    int x = 1;',
+            '    e.printStackTrace();',
+            '  }',
+            '}',
+        ].join('\n');
+        const violations = analyzePrintStackTrace(src);
+        expect(violations.length).toBe(2);
+        expect(violations[0]?.line).toBe(3);
+        expect(violations[1]?.line).toBe(5);
+    });
+    it('flags calls with whitespace inside the parens', () => {
+        const violations = analyzePrintStackTrace('e.printStackTrace( );');
+        expect(violations.length).toBe(1);
+    });
+    it('does not flag printStackTrace with arguments (different signature)', () => {
+        // printStackTrace(PrintStream) is a legitimate call — only the
+        // no-arg variant goes to System.err implicitly.
+        const violations = analyzePrintStackTrace('e.printStackTrace(System.out);');
+        expect(violations.length).toBe(0);
+    });
+});
+//# sourceMappingURL=no-printstacktrace.test.js.map

package/dist/__tests__/no-printstacktrace.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-printstacktrace.test.js","sourceRoot":"","sources":["../../src/__tests__/no-printstacktrace.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAA;AAC5E,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AAE7C,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAA;AAExE,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;IACtC,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACnC,MAAM,UAAU,GAAG,sBAAsB,CAAC,sBAAsB,CAAC,CAAA;QACjE,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACnC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAA;IAC/D,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,qEAAqE,EAAE,GAAG,EAAE;QAC7E,oEAAoE;QACpE,wDAAwD;QACxD,MAAM,GAAG,GAAG,mCAAmC,CAAA;QAC/C,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,CAAA;QAClC,MAAM,UAAU,GAAG,sBAAsB,CAAC,QAAQ,CAAC,CAAA;QACnD,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACnC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,GAAG,GAAG,oDAAoD,CAAA;QAChE,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,CAAA;QACnC,MAAM,UAAU,GAAG,sBAAsB,CAAC,QAAQ,CAAC,CAAA;QACnD,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACnC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,MAAM,GAAG,GAAG;YACV,WAAW;YACX,yBAAyB;YACzB,0BAA0B;YAC1B,gBAAgB;YAChB,0BAA0B;YAC1B,KAAK;YACL,GAAG;SACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACZ,MAAM,UAAU,GAAG,sBAAsB,CAAC,GAAG,CAAC,CAAA;QAC9C,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACnC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACrC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,UAAU,GAAG,sBAAsB,CAAC,uBAAuB,CAAC,CAAA;QAClE,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACnC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,oEAAoE,EAAE,GAAG,EAAE;QAC5E,+DAA+D;QAC/D,gDAAgD;QAChD,MAAM,UAAU,GAAG,sBAAsB,CACvC,gCAAgC,CACjC,CAAA;QACD,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACnC,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/checks/no-printstacktrace.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @fileoverview Flag uses of `Throwable.printStackTrace()`.
+ *
+ * `e.printStackTrace()` writes to stderr, bypassing the application's
+ * logging framework. Stack traces emitted that way miss correlation
+ * IDs, log levels, and structured fields, and they typically don't
+ * land in centralized log aggregation. Always log via the configured
+ * logger (SLF4J/Log4j/etc.) and pass the throwable as the cause.
+ *
+ * The check uses the `strip-strings-and-comments` content filter so
+ * the literal token "printStackTrace()" inside a string literal or
+ * comment isn't reported.
+ */
+import { type CheckViolation } from '@opensip-tools/fitness';
+/**
+ * Pure analysis function. Exported so unit tests can exercise the
+ * detection logic without standing up the full Check framework
+ * (defineCheck wraps `analyze` into an `execute` closure that
+ * requires an ExecutionContext to invoke).
+ */
+export declare function analyzePrintStackTrace(content: string): CheckViolation[];
+export declare const noPrintStackTrace: import("@opensip-tools/fitness").Check;
+//# sourceMappingURL=no-printstacktrace.d.ts.map

package/dist/checks/no-printstacktrace.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-printstacktrace.d.ts","sourceRoot":"","sources":["../../src/checks/no-printstacktrace.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,EAAe,KAAK,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAIzE;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG,cAAc,EAAE,CAkBxE;AAED,eAAO,MAAM,iBAAiB,wCAW5B,CAAA"}

package/dist/checks/no-printstacktrace.js

@@ -0,0 +1,50 @@
+/**
+ * @fileoverview Flag uses of `Throwable.printStackTrace()`.
+ *
+ * `e.printStackTrace()` writes to stderr, bypassing the application's
+ * logging framework. Stack traces emitted that way miss correlation
+ * IDs, log levels, and structured fields, and they typically don't
+ * land in centralized log aggregation. Always log via the configured
+ * logger (SLF4J/Log4j/etc.) and pass the throwable as the cause.
+ *
+ * The check uses the `strip-strings-and-comments` content filter so
+ * the literal token "printStackTrace()" inside a string literal or
+ * comment isn't reported.
+ */
+import { defineCheck } from '@opensip-tools/fitness';
+const PRINT_STACK_TRACE_PATTERN = /\.printStackTrace\s*\(\s*\)/g;
+/**
+ * Pure analysis function. Exported so unit tests can exercise the
+ * detection logic without standing up the full Check framework
+ * (defineCheck wraps `analyze` into an `execute` closure that
+ * requires an ExecutionContext to invoke).
+ */
+export function analyzePrintStackTrace(content) {
+    const violations = [];
+    const lines = content.split('\n');
+    for (const [i, line_] of lines.entries()) {
+        const line = line_;
+        PRINT_STACK_TRACE_PATTERN.lastIndex = 0;
+        while (PRINT_STACK_TRACE_PATTERN.exec(line) !== null) {
+            violations.push({
+                message: 'e.printStackTrace() bypasses the logging framework — use a logger instead',
+                severity: 'warning',
+                line: i + 1,
+                suggestion: 'Replace with logger.error("...", e) so the trace lands in centralized logs',
+            });
+        }
+    }
+    return violations;
+}
+export const noPrintStackTrace = defineCheck({
+    id: 'c1d2e3f4-9876-4321-cccc-300000000001',
+    slug: 'java-no-print-stack-trace',
+    description: 'e.printStackTrace() bypasses the logging framework — use a logger instead',
+    scope: { languages: ['java'], concerns: [] },
+    tags: ['quality', 'observability', 'java'],
+    // Strip strings AND comments so the literal token inside a docstring
+    // or example comment isn't false-flagged.
+    contentFilter: 'strip-strings-and-comments',
+    analyze: (content) => analyzePrintStackTrace(content),
+});
+//# sourceMappingURL=no-printstacktrace.js.map

package/dist/checks/no-printstacktrace.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-printstacktrace.js","sourceRoot":"","sources":["../../src/checks/no-printstacktrace.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,EAAE,WAAW,EAAuB,MAAM,wBAAwB,CAAA;AAEzE,MAAM,yBAAyB,GAAG,8BAA8B,CAAA;AAEhE;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CAAC,OAAe;IACpD,MAAM,UAAU,GAAqB,EAAE,CAAA;IACvC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IACjC,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;QACzC,MAAM,IAAI,GAAG,KAAK,CAAA;QAClB,yBAAyB,CAAC,SAAS,GAAG,CAAC,CAAA;QACvC,OAAO,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YACrD,UAAU,CAAC,IAAI,CAAC;gBACd,OAAO,EACL,2EAA2E;gBAC7E,QAAQ,EAAE,SAAS;gBACnB,IAAI,EAAE,CAAC,GAAG,CAAC;gBACX,UAAU,EACR,4EAA4E;aAC/E,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IACD,OAAO,UAAU,CAAA;AACnB,CAAC;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG,WAAW,CAAC;IAC3C,EAAE,EAAE,sCAAsC;IAC1C,IAAI,EAAE,2BAA2B;IACjC,WAAW,EACT,2EAA2E;IAC7E,KAAK,EAAE,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;IAC5C,IAAI,EAAE,CAAC,SAAS,EAAE,eAAe,EAAE,MAAM,CAAC;IAC1C,qEAAqE;IACrE,0CAA0C;IAC1C,aAAa,EAAE,4BAA4B;IAC3C,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,sBAAsB,CAAC,OAAO,CAAC;CACtD,CAAC,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export declare const checks: readonly [import("@opensip-tools/fitness").Check];
+export declare const metadata: {
+    name: string;
+    version: string;
+    description: string;
+};
+export { noPrintStackTrace } from './checks/no-printstacktrace.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,MAAM,mDAA+B,CAAA;AAGlD,eAAO,MAAM,QAAQ;;;;CAIpB,CAAA;AAED,OAAO,EAAC,iBAAiB,EAAC,MAAM,gCAAgC,CAAA"}

package/dist/index.js

@@ -0,0 +1,9 @@
+import { noPrintStackTrace } from './checks/no-printstacktrace.js';
+export const checks = [noPrintStackTrace];
+export const metadata = {
+    name: '@opensip-tools/checks-java',
+    version: '0.6.1',
+    description: 'Java fitness checks',
+};
+export { noPrintStackTrace } from './checks/no-printstacktrace.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAElE,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,iBAAiB,CAAU,CAAA;AAGlD,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,IAAI,EAAE,4BAA4B;IAClC,OAAO,EAAE,OAAO;IAChB,WAAW,EAAE,qBAAqB;CACnC,CAAA;AAED,OAAO,EAAC,iBAAiB,EAAC,MAAM,gCAAgC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opensip-tools/checks-java",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "license": "MIT",
   "description": "Java fitness checks for opensip-tools",
   "repository": {
@@ -19,8 +19,8 @@
     ".": "./dist/index.js"
   },
   "dependencies": {
-    "@opensip-tools/fitness": "1.0.4",
-    "@opensip-tools/lang-java": "1.0.4"
+    "@opensip-tools/fitness": "1.0.5",
+    "@opensip-tools/lang-java": "1.0.5"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",