Skip to content

Commit

Permalink
Rename sgrep to semgrep in other markdown files (#542)
Browse files Browse the repository at this point in the history
  • Loading branch information
brendongo committed Apr 22, 2020
1 parent c6df9d8 commit c6df177
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 20 deletions.
8 changes: 0 additions & 8 deletions .bento/archive.json
Expand Up @@ -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}\")"
}
}
},
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
@@ -1,7 +1,7 @@
_build
.merlin

sgrep/sgrep.install
semgrep_core/sgrep.install
/project.el
/skip_list.txt
/top.ml
Expand Down
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -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.

Expand Down
18 changes: 9 additions & 9 deletions docs/development.md
Expand Up @@ -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
```

Expand 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 <YAML_FILE_OR_DIRECTORY> <code to check>
semgrep --config <YAML_FILE_OR_DIRECTORY> <code to check>
```

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
```

Expand All @@ -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:

Expand Down

0 comments on commit c6df177

Please sign in to comment.