Skip to content

Commit b52287d

Browse files
Philip Reesprees1
authored andcommitted
Add code analysis overview guide
1 parent 397e09f commit b52287d

File tree

2 files changed

+53
-2
lines changed

2 files changed

+53
-2
lines changed

pages/tidal tools/sourcecode.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ If the machine running code analysis can not access the internet; you can perfor
7979
tidal analyze code [/path/to/source-code-A] [/path/to/source-code-B] --offline
8080
```
8181

82-
The `--offline` flag indicates that the results are outputted to a local file, instead of being uploaded.
82+
The `--offline` flag indicates that the results are saved to a local file, instead of being uploaded.
8383

8484
After the analysis is completed, you will find the results in a file called `code-analysis-<DATE>-<TYPE>.json`.
8585

@@ -104,4 +104,4 @@ By using Docker, the analysis can use those libraries without requiring you to i
104104
105105
### What about security?
106106
107-
**The entire code analysis process takes place locally on your machine.** It will scan your files locally looking for common patterns and information when modernizing. The only data that is captured and sent from the analysis are the results of the analysis and the associated metadata. You can view all of the raw analysis results that are sent to Tidal Accelerator before they are sent, by viewing the contents of the results file locally.
107+
**The entire code analysis process takes place locally on your machine.** It will scan your files locally looking for common patterns and information when modernizing. The only data that is captured and sent from the analysis are the results of the analysis and the associated metadata. You can view all raw analysis results sent to Tidal Accelerator before they are sent, by performing an offline analysis and viewing the results file locally.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
toc: false
3+
title: Code Analysis Overview
4+
keywords: code, analyze, source code
5+
last_updated: Novemvber, 2023
6+
summary: "What code analysis does and its compatibility"
7+
sidebar: main_sidebar
8+
folder: userguides
9+
permalink: code-analysis-overview.html
10+
---
11+
12+
# Tidal Code Analysis Overview
13+
Analyzes code bases for various patterns that are useful in assessing applications for transformation and continual modernization.
14+
15+
## Language support
16+
17+
| Language | Statistics | Package Currency | IP Address Detection | Filesystem Detection | Subprocess Detection |
18+
|---------------------------------|-------------|-------------------|-----------------------|-----------------------|-----------------------|
19+
| C# ||||||
20+
| Java ||||||
21+
| JavaScript ||||||
22+
| Python ||||||
23+
| COBOL ||||||
24+
| PHP ||||||
25+
| C++ ||||||
26+
| C ||||||
27+
| sh/bash/ksh/zsh ||||||
28+
| JSP ||||||
29+
| Perl ||||||
30+
| Visual Basic, VB.NET, VBScript ||||||
31+
32+
It is also able to determine statistics and IP address detection for almost any source code files including but not limited to:
33+
34+
Ada, ASP, ASP.NET, Assembly, AWK, Basic, Batch, C Header, C Shell, C++ Header, Clojure, ClojureScript, CMake, CoffeeScript, CSS, Cython, Coldfusion, D, Dart, Dockerfile, Elixir, Elm, Emacs Lisp, Erlang, F#, Fish, modern and legacy Fortran, Groovy, Go, Handlebars, Haskell, HTML, INI, Jupyter, Kotlin, LaTeX, Less, Lisp, Lua, Makefile, Matlab, Nushell, Objective-C, Objective C++, OCaml, Pascal, PL/SQL, Powershell, R, Rexx, Ruby, Rust, Sass, Scala, Scheme, sed, Swift, Terraform, and TypeScript.
35+
36+
## What does it do
37+
38+
It measures and determines several important aspects of an application code base including;
39+
40+
- Statistics - Overall code base statistics, including statistics regarding the total number of files, lines of code, comments and blank lines, types of languages used, as well as these statistics per source file.
41+
- Package Currency - Library and package detection, including the names and versions of all packages used.
42+
- Filesystem Detection - Filesystem usage, reading, writing, or manipulation of files stored on the OS filesystem.
43+
- Subprocess Detection - Usage of executing subprocesses outside of the execution environment of the language.
44+
- IP Address Detection - Identification of references to IP addresses, private addresses, and addresses used as listeners.
45+
46+
## How to use it
47+
For step-by-step instructions to perform an analysis refer to [the usage guide](/analyze-source-code.html).
48+
49+
## Security
50+
The entire code analysis process takes place locally on your machine. It will scan your files locally looking for common patterns and information when modernizing. The only data that is captured and sent from the analysis are the results of the analysis and the associated metadata. You can view all of the raw analysis results that are sent to Tidal Accelerator before they are sent, by viewing the contents of the results file locally.
51+

0 commit comments

Comments
 (0)