Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
codecharta-analysis
Advanced tools
codecharta-analysis - npm Package Compare versions
Comparing version 1.123.0 to 1.125.0
@@ -1,2 +0,2 @@ | ||
| Copyright (c) 2020, MaibornWolff GmbH | ||
| Copyright (c) 2024, MaibornWolff GmbH | ||
| All rights reserved. | ||
@@ -3,0 +3,0 @@ |
@@ -13,3 +13,3 @@ { | ||
| "name": "codecharta-analysis", | ||
| "version": "1.123.0", | ||
| "version": "1.125.0", | ||
| "description": "MaibornWolff CodeCharta Analysis Tools", | ||
@@ -16,0 +16,0 @@ "scripts": { |
@@ -1,2 +0,2 @@ | ||
| Copyright (c) 2018, MaibornWolff GmbH | ||
| Copyright (c) 2024, MaibornWolff GmbH | ||
| All rights reserved. | ||
@@ -3,0 +3,0 @@ |
@@ -65,3 +65,5 @@ # CodeCharta analysis | ||
| - Use our [Docker Image](#installation-via-docker) to run the analysis in a container | ||
| - Use [docker-compose](https://maibornwolff.github.io/codecharta/docs/docker-containers/) to run the analysis in a complete environment with other needed tools like Sonar and a running CodeCharta Visualization instance to view your city map. | ||
| - Use [docker-compose](https://maibornwolff.github.io/codecharta/docs/docker-containers/) to run the analysis in a | ||
| complete environment with other needed tools like Sonar and a running CodeCharta Visualization instance to view your | ||
| city map. | ||
| - Download the SourceCode from the asset section of a release and [extract it](#extract-tar-or-zip-archive) | ||
@@ -80,3 +82,5 @@ - Clone the repository and [build it yourself](#build-it-yourself) (Development) | ||
| You can use Codecharta analysis in multiple ways. This section will deal with how to use the analysis as a standalone container. For information on how to use with docker compose, please check out our [docker compose documentation](https://maibornwolff.github.io/codecharta/docs/docker-containers/). | ||
| You can use Codecharta analysis in multiple ways. This section will deal with how to use the analysis as a standalone | ||
| container. For information on how to use with docker compose, please check out | ||
| our [docker compose documentation](https://maibornwolff.github.io/codecharta/docs/docker-containers/). | ||
| We assume that you already installed docker, if not, you have to do that before! | ||
@@ -87,7 +91,22 @@ | ||
| - Navigate into the directory you want to analyse with CodeCharta. There are multiple ways to use the docker image: | ||
| 1. Start the docker container and a bash shell in it with `docker run --name codecharta-analysis -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis bash`. This runs the image, names the container `codecharta-analysis`, mounts the current directory and sets it as the working directory of your container. You can now use the codecharta shell or any other of the tools installed in the container via the command line. | ||
| 2. Start the docker container and directly use some command (like the ccsh): `docker run --name codecharta-analysis -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis ccsh`. This starts the Ccsh without any commands, which will open an interactive codecharta shell that will guide you through the parsing/analyzing process. The working directory of your Terminal will be used as the working directory of the container. | ||
| 3. Start the docker container and directly use a specific parser: `docker run --name codecharta-analysis -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis ccsh rawtextparser .`. This starts the RawTextParser in the current working directory in a container. | ||
| - After executing the run command once, you can repeat the same docker configuration with `docker start codecharta-analysis` or you have to change the name or delete the old container if you want to `docker run` a different configuration. | ||
| - After analysing, you can copy any results with `docker cp codecharta-analysis:/your/path/fileName.cc.json fileName.cc.json` to your current working directory (replace `/your/path/` with correct path in container). If this does not work, make sure you assigned the name `codecharta-analysis` to your container, if not use the correct name or container id. | ||
| 1. Start the docker container and a bash shell in it | ||
| with `docker run --name codecharta-analysis -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis bash`. | ||
| This runs the image, names the container `codecharta-analysis`, mounts the current directory and sets it as the | ||
| working directory of your container. You can now use the codecharta shell or any other of the tools installed in | ||
| the container via the command line. | ||
| 2. Start the docker container and directly use some command (like the | ||
| ccsh): `docker run --name codecharta-analysis -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis ccsh`. | ||
| This starts the Ccsh without any commands, which will open an interactive codecharta shell that will guide you | ||
| through the parsing/analyzing process. The working directory of your Terminal will be used as the working | ||
| directory of the container. | ||
| 3. Start the docker container and directly use a specific | ||
| parser: `docker run --name codecharta-analysis -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis ccsh rawtextparser .`. | ||
| This starts the RawTextParser in the current working directory in a container. | ||
| - After executing the run command once, you can repeat the same docker configuration | ||
| with `docker start codecharta-analysis` or you have to change the name or delete the old container if you want | ||
| to `docker run` a different configuration. | ||
| - After analysing, you can copy any results | ||
| with `docker cp codecharta-analysis:/your/path/fileName.cc.json fileName.cc.json` to your current working directory ( | ||
| replace `/your/path/` with correct path in container). If this does not work, make sure you assigned the | ||
| name `codecharta-analysis` to your container, if not use the correct name or container id. | ||
@@ -132,8 +151,11 @@ ## Extract tar or zip archive | ||
| In order to keep the code style consistent, an XML-file containing the settings used for this project can be found in `intellij-resources`. | ||
| In order to keep the code style consistent, an XML-file containing the settings used for this project can be found | ||
| in `intellij-resources`. | ||
| Please import these settings in `File > Settings > Editor > Code Style`, and make sure you have ticked the box to reformat code before committing. | ||
| Please import these settings in `File > Settings > Editor > Code Style`, and make sure you have ticked the box to | ||
| reformat code before committing. | ||
| ## License | ||
| Some parts of CodeCharta use the [SonarJava library](https://github.com/SonarSource/sonar-java/), which is licensed under the GNU Lesser General Public Library, version 3. | ||
| Some parts of CodeCharta use the [SonarJava library](https://github.com/SonarSource/sonar-java/), which is licensed | ||
| under the GNU Lesser General Public Library, version 3. |
@@ -15,2 +15,3 @@ # CodeCharta | ||
| Please visit [our github page](https://github.com/MaibornWolff/codecharta/tree/master/analysis) to learn more about CodeCharta | ||
| Please visit [our github page](https://github.com/MaibornWolff/codecharta/tree/master/analysis) to learn more about | ||
| CodeCharta |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by8.18%
56809865
- Number of lines in readme file
- increased by6.25%
17
No dependency changes