From c6df1774cc7005e935f63caf06bd28a856be6596 Mon Sep 17 00:00:00 2001 From: Brendon Go Date: Wed, 22 Apr 2020 15:00:49 -0700 Subject: [PATCH] Rename sgrep to semgrep in other markdown files (#542) --- .bento/archive.json | 8 -------- .gitignore | 2 +- CODE_OF_CONDUCT.md | 2 +- CONTRIBUTING.md | 2 +- docs/development.md | 18 +++++++++--------- 5 files changed, 12 insertions(+), 20 deletions(-) diff --git a/.bento/archive.json b/.bento/archive.json index b9216b232dbc..37f6ad950917 100644 --- a/.bento/archive.json +++ b/.bento/archive.json @@ -8,14 +8,6 @@ "message": "Use of exec detected.", "severity": 1, "syntactic_context": "exec(f\"global output; output = {where_expression}\")" - }, - "bcbe9de4fcc164d88d24abeed3888c42": { - "tool_id": "bandit", - "check_id": "exec-used", - "path": "sgrep_lint/semgrep/evaluation.py", - "message": "Use of exec detected.", - "severity": 1, - "syntactic_context": "exec(f\"global output; output = {where_expression}\")" } } }, diff --git a/.gitignore b/.gitignore index fe4d21c54188..ad16f44722ef 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,7 @@ _build .merlin -sgrep/sgrep.install +semgrep_core/sgrep.install /project.el /skip_list.txt /top.ml diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index d200e34c0117..915bad49fad9 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -55,7 +55,7 @@ further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at sgrep@r2c.dev. All +reported by contacting the project team at semgrep@r2c.dev. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 694801352046..8f46b67abc5a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ ## Latest build [![CircleCI](https://circleci.com/gh/returntocorp/sgrep.svg?style=svg)](https://circleci.com/gh/returntocorp/sgrep) -`sgrep` is LGPL-licensed and we would love your contributions. See docs/development.md +`semgrep` is LGPL-licensed and we would love your contributions. See docs/development.md We have [Circle CI](https://circleci.com/gh/returntocorp/sgrep) builds running on this project and forks. diff --git a/docs/development.md b/docs/development.md index ec36daae4e96..12f2d41014bb 100644 --- a/docs/development.md +++ b/docs/development.md @@ -32,7 +32,7 @@ eval $(opam env) && opam install -y ./pfff Then you can compile the program with: ```bash -cd sgrep +cd semgrep_core make all ``` @@ -43,24 +43,24 @@ You can also use the Dockerfile in this directory to build semgrep inside a cont Then to test semgrep on a file, for example tests/GENERIC/test.py run: ```bash -cd sgrep +cd semgrep_core ./_build/default/bin/main_sgrep.exe -e foo tests/python ... ``` -If you want to test sgrep on a directory with a set of given rules, run: +If you want to test semgrep on a directory with a set of given rules, run: ```bash -cp ./sgrep/_build/default/bin/main_sgrep.exe /usr/local/bin/sgrep -cd sgrep_lint +cp ./semgrep_core/_build/default/bin/main_sgrep.exe /usr/local/bin/semgrep_core +cd semgrep make && make install -sgrep-lint --config +semgrep --config ``` -It is also possible to run sgrep\_lint from source: +It is also possible to run semgrep from source: ```text -cd sgrep_lint +cd semgrep python3 -m semgrep ``` @@ -70,7 +70,7 @@ You can use Visual Studio Code \(vscode\) to edit the code of semgrep. The [reas The OCaml and Reason IDE extension by David Morrison is another valid extension, but it seems not as actively maintained as reason-vscode. -The source of semgrep contains also a .vscode/ directory at its root containing a task file to automatically build sgrep from vscode. +The source of semgrep contains also a .vscode/ directory at its root containing a task file to automatically build semgrep from vscode. Note that dune and ocamlmerlin must be in your PATH for vscode to correctly build and provide cross-reference on the code. In case of problems, do: