@codacy/tools-opengrep-1 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Codacy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,102 @@
+# @codacy/tools-opengrep-1
+
+## Table of Contents
+- [Overview](#overview)
+- [Rule bundling](#rule-bundling)
+- [Updating patterns](#updating-patterns)
+- [Updating rules](#updating-rules)
+- [Updating the Opengrep version](#updating-the-opengrep-version)
+- [Development](#development)
+- [Notes for maintainers](#notes-for-maintainers)
+
+---
+
+## Overview
+
+Multi-language SAST (Static Application Security Testing) scanner using the [Opengrep](https://opengrep.dev/) binary. Supports 30+ languages via YAML rule files. Uses the CLI execution strategy.
+
+| Property | Value |
+|----------|-------|
+| Tool ID | `Semgrep` (legacy, for Codacy platform compatibility) |
+| Display name | `Opengrep` |
+| Codacy UUID | `6792c561-236d-41b7-ba5e-9d6bee0d548b` |
+| Strategy | CLI |
+| Languages | 30+ (Python, JavaScript, TypeScript, Java, Go, Ruby, C, C++, etc.) |
+| Binary | `opengrep` |
+| File patterns | `*` (auto-detects by language) |
+| Pattern count | ~2500 |
+| Extra dependency | `yaml` (for YAML rule config parsing/generation) |
+
+## Rule bundling
+
+Opengrep uses YAML rule files for detection. The adapter bundles ~2200 rules into `src/rules.yaml`, sourced from:
+
+1. **semgrep/semgrep-rules** — community rules (pinned at commit `4ccd3b9`)
+2. **GitLab SAST rules** — MIT-licensed rules from `gitlab.com/gitlab-org/security-products/sast-rules`
+3. **Codacy custom rules** — from `codacy/codacy-opengrep` wrapper repo
+
+The bundled `src/rules.yaml` is **committed to the repository** for consistency and reproducibility.
+
+## Updating patterns
+
+```bash
+# Re-fetch pattern metadata from the Codacy API
+pnpm prefetch
+
+# Commit the result
+git add src/patterns.json
+```
+
+Pattern IDs follow the format `Semgrep_python.lang.security.audit.exec-detected.exec-detected` (dot-separated rule paths).
+
+## Updating rules
+
+```bash
+# Re-fetch and bundle rules from all three sources
+pnpm fetch-rules
+
+# This clones the rule repos, extracts matching rules, and writes src/rules.yaml
+# Only rules whose IDs match src/patterns.json are included
+
+# Commit the result
+git add src/rules.yaml
+```
+
+The `fetch-rules` script (`scripts/fetch-rules.mjs`):
+- Clones `semgrep/semgrep-rules` at the pinned commit
+- Clones GitLab SAST rules (latest)
+- Clones `codacy/codacy-opengrep` for custom rules
+- Extracts rules, assigns path-based IDs
+- Filters to only rules matching `src/patterns.json`
+- Writes concatenated YAML to `src/rules.yaml`
+
+To update the pinned semgrep-rules commit, edit `SEMGREP_RULES_COMMIT` in `scripts/fetch-rules.mjs`.
+
+## Updating the Opengrep version
+
+1. Update `preferredVersion` in `src/adapter.ts`
+2. Run `pnpm test` to verify compatibility
+3. Consider re-running `pnpm fetch-rules` if the new version supports new rule syntax
+
+## Development
+
+```bash
+pnpm build        # Build with tsup
+pnpm test         # Run tests (requires opengrep in PATH)
+pnpm fetch-rules  # Re-bundle rules from upstream sources
+pnpm prefetch     # Re-fetch pattern metadata from Codacy API
+```
+
+**Opengrep must be installed manually:**
+```bash
+curl -fsSL https://raw.githubusercontent.com/opengrep/opengrep/main/install.sh | bash
+```
+
+## Notes for maintainers
+
+- **Tool ID is `Semgrep`** for legacy compatibility with the Codacy platform. The `displayName` is set to `Opengrep` for CLI display. Never change the tool ID without coordinating with the Codacy platform team.
+- **Config materialization**: When Codacy patterns are specified, the adapter loads `src/rules.yaml`, filters to enabled rules, and writes a filtered config to `.codacy/generated/opengrep-rules.yaml`.
+- **check_id prefix stripping**: Opengrep prepends a path-based namespace to check_ids derived from the config file path relative to cwd. The adapter computes and strips this prefix (e.g. `codacy.generated.`) plus any `tmp.` legacy prefix.
+- **Config file search**: `.semgrep.yaml`, `.opengrep.yaml`, `.semgrep.yml`, `.opengrep.yml` (in that order).
+- **Opengrep errors**: Parse errors (syntax errors, partial parsing) from Opengrep's JSON `errors` array are converted to structured `AnalysisError` objects with `filePath`. Stderr (scan status table) is logged at debug level only.
+- **Rule ID format**: Semgrep-rules use `{dir}.{filename}.{ruleId}` (dots), GitLab rules use `{dir}_{filename}` (underscores), Codacy custom rules keep their original IDs.

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import * as _codacy_tooling from '@codacy/tooling';
+
+declare const _default: Readonly<_codacy_tooling.ToolAdapter>;
+
+export { _default as default };