Merge pull request #6 from codiga/feat/analyze-command

analyze command

Author: dastrong-codiga

.gitignore

@@ -1,4 +1,5 @@
 node_modules
 coverage
 .vscode
-codiga-cli*.tgz
+codiga-cli*.tgz
+.DS_store

README.md

@@ -70,6 +70,62 @@ If you know what rulesets you want to add, you can pass their names into the com
 codiga ruleset-add my-public-ruleset my-private-ruleset
 ```
 
+### Analyze and report issues for a file or directory
+
+#### Single File
+
+To analyze a single file named `file.js` you can could run the following commands. The first command would analyze `file.js` for violations with the rules found in `foo-ruleset` and the second command would include the rules from `bar-ruleset` too.
+
+```bash
+codiga analyze file.js --ruleset foo-ruleset
+```
+
+```bash
+codiga analyze file.js --ruleset foo-ruleset --ruleset bar-ruleset
+```
+
+> When analyzing a single file, a valid ruleset must be set using the `--ruleset` option.
+
+#### Directory
+
+To analyze a directory and all the files within, you could run any of the following commands to target the directory `foo`.
+
+```bash
+codiga analyze foo
+```
+
+```bash
+codiga analyze ./foo
+```
+
+```bash
+codiga analyze /Users/cool-name/foo
+```
+
+When analyzing a directory it isn't necessary to specify a ruleset using `--ruleset`, **if** you have a `codiga.yml` file in the targeted directory. If there isn't a `codiga.yml` and you haven't specified rulesets in the command, the analyze will exit.
+
+> You can find rulesets to use on the [Codiga Hub](https://app.codiga.io/hub/rulesets) or you can use a command introduced above `codiga ruleset-add` to create a `codiga.yml` quickly.
+
+#### Options
+
+- `-r/--ruleset`
+  - Specify the rulesets you want your analysis done with
+    - **Required:** when analyzing a single file or when there isn't a `codiga.yml` in the root targeted directory
+    - **Default:** `codiga.yml`
+    - **Notes:** if set, will override a `codiga.yml`
+- `-f/--format`
+  - Specify the format you want your analysis reported in
+    - **Options:** `text`, `json`, `csv`
+    - **Default:** `text`
+- `-o/--output`
+  - Specify where you want your analysis reported to
+    - **Default:** `stdout`
+    - **Examples:** `results.csv`, `violations.json`, `analysis.text`
+    - **Notes:** If there are no violations, no file will be created.
+- `--follow-symlinks`
+  - Specify if you want to follow and analyze symbolic links
+    - **Default:** false
+
 ### Analysis and report issues between two commits
 
 Use the command below to detect any violations between your two commits.

codiga.yml

@@ -0,0 +1,5 @@
+rulesets:
+  - jestjs
+  - javascript-client-security
+  - javascript-inclusive
+  - javascript-best-practices

jest.config.js

@@ -4,6 +4,10 @@
  */
 
 module.exports = {
+  moduleNameMapper: {
+    "^csv-stringify/dist/esm/sync":
+      "<rootDir>/node_modules/csv-stringify/dist/cjs/sync",
+  },
   // All imported modules in your tests should be mocked automatically
   // automock: false,