@dxworks/insider 0.0.1-test

package/README.md

@@ -0,0 +1,89 @@
+# Insider
+
+Insider is a belt of tools built on the idea of searching regular expressions in code. Insider is able to detect code
+smells, the usage of external libraries and the topics that a software project approaches by only using Regex. This
+means that Insider does not use any type of parsing and is therefore language independent.
+
+## Installation
+
+### From Github
+
+To install Insider from Github, please download from the [latest release](https://github.com/dxworks/insider/releases)
+from Github, the `insider.zip` archive and unzip it to a specific location. The contents of this archive are:
+
+* `insider-*.jar` - the executable jar file
+* `insider.bat` - a batch script for executing Insider on Windows
+* `insider.sh` - a shell script for executing insider on Windows
+* `config` - a folder for configuration files, described more in the [Configuration Section](#Configuration)
+* `results` - a folder where Insider will output the results.
+
+### From Docker
+
+...
+
+### From Code
+
+Clone the repository from [here](https://github.com/dxworks/insider).
+
+Run `gradle clean build` to obtain an executable jar.
+
+## Configuration
+
+Edit the configuration file (*config/insider-conf.properties*), to **specify the root folder** of the project's sources.
+
+## Commands
+
+### Find Command
+
+* In order to find the occurrences of the libraries in the analyzed project. Use the following command (run Insider
+  using the **insider.bat** or **insider.sh** script):
+
+```
+insider.sh find config/libraries.json
+```
+
+* Detect Simple Code Smells. Use the following command (run Insider using the **insider.bat** or **insider.sh** script):
+
+```
+insider.sh find config/code_smells.json
+```
+
+* You can also run the *find* command with both files at once:
+
+```
+insider.sh find config/libraries.json config/code_smells.json
+```
+
+The commands will generate two *.json* files (**_PROJECT_ID-libraries.json_** and **_PROJECT_ID-code_smells.json_**) in
+the **results** folder.
+
+## Voyager Integration
+
+Insider is also a Voyager Instrument. To configure Insider from Voyager you can add the following fields in the `mission.yml` file:
+
+```yaml
+# A map of instrument names to commands and parameters.
+# When 'runsAll' is false the mission will run only the instruments
+# with the commands declared here, in this order.
+instruments:
+  insider:
+    # A map of parameter name to value
+    # Only add the parameters you want to override (the default values are written here)
+    parameters:
+      max-heap: 4g # will configure the maximum heap space the jvm process will get. For large process may be needed to be set to 16g or higher
+      findConfig: 'config/fingerprints/code_smells.json config/fingerprints/libraries.json' # a space separated list of insider fingerprints
+      inspectConfig: 'config/rules' # a space separated list of folders or Application Inspector specific rules, like the ones here: https://github.com/microsoft/ApplicationInspector/tree/main/AppInspector/rules/default
+
+# A map of environment variables, name to value, for voyager missions
+# overwrites the variables from global config, instrument and command
+# Only set the environment variables you need.
+environment:
+  INSIDER_LANGUAGES: 'java,c++,c#' # a comma separated list of the languages to analyse (just a sample example)
+  INSIDER_LINGUIST_FILE: "${instrument}/languages.yml" # a file containing languages to extension mappings according to [GitHub Linguist](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml)
+  INSIDER_DEPEXT_MAX_NAMESPACE_LENGTH: 200 # the maximum length of a namespace for DepExt analysis
+```
+
+## Acknowledgements
+
+The `inspect` command is inspired by the [Application Inspector](https://github.com/microsoft/ApplicationInspector)
+project created by Microsoft. Insider even uses the same input files as Application Inspector.

package/TODO.txt

@@ -0,0 +1,7 @@
+vezi sa nu existe un slash la inceputul fqn-urilor fisierelor
+
+la techFinder sa spui pe ce fisier lucreaza (poate fa-le in paralel)
+
+loguie ce comanda face tot timpul
+
+loguie la final ce output gaseste si unde.

package/dxworks-site.json

@@ -0,0 +1,13 @@
+{
+  "displayName": "Insider",
+  "description": "A tool that uses regular expressions to scan code smells, find dependencies between code entities, and detect topics used in a system",
+  "relevance": 1,
+  "categories": ["tool"],
+  "codeOwners": [
+    {
+      "name": "Mario Rivis"
+    }
+  ],
+  "technologies": ["java", "gradle"],
+  "docs": "https://dxworks.github.io/insider"
+}

package/lib/index.js

@@ -0,0 +1,13 @@
+const {insider} = require("./lib");
+const {Command} = require("commander");
+
+exports.insiderCommand = new Command()
+  .name('insider')
+  .description('Running Insider commands')
+  .option('-wd --working-directory', 'Selects the directory where Insider will store the results folder.' +
+    ` Defaults to the location where Insider is installed: ${__dirname}. If set to true it will use the current working directory process.cwd()`,
+    false)
+  .allowUnknownOption()
+  .action(insider)
+
+

package/lib/insider.js

@@ -0,0 +1,7 @@
+#! /usr/bin/env node
+'use strict'
+const {insider} = require("./lib");
+
+(async () => {
+  await insider();
+})();

package/lib/lib.js

@@ -0,0 +1,21 @@
+const {JavaCaller} = require('java-caller');
+
+async function insider(options) {
+  const java = new JavaCaller({
+    jar: 'insider.jar', // CLASSPATH referencing the package embedded jar files
+    mainClass: 'org.dxworks.insider.Insider',// Main class to call, must be available from CLASSPATH,
+    rootPath: __dirname,
+    minimumJavaVersion: 11,
+    output: 'console'
+  });
+
+  const args = [...process.argv];
+  let index = args.indexOf('insider'); //if it is called from dxw cli
+  if(index === -1)
+    index = 1
+  args.splice(0,  index + 1);
+  const {status} = await java.run(args, {cwd: options?.workingDirectory? process.cwd(): __dirname});
+  process.exitCode = status;
+}
+
+module.exports = {insider}

package/lombok.config

@@ -0,0 +1,2 @@
+# This file is generated by the 'io.freefair.lombok' Gradle plugin
+config.stopBubbling = true

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@dxworks/insider",
+  "version": "0.0.1-test",
+  "description": "Insider is a belt of tools built on the idea of searching regular expressions in code",
+  "keywords": [
+    "insider",
+    "java",
+    "regex"
+  ],
+  "homepage": "https://github.com/dxworks/insider#readme",
+  "bugs": {
+    "url": "https://github.com/dxworks/insider/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dxworks/insider.git"
+  },
+  "license": "Apache-2.0",
+  "author": "Mario Rivis",
+  "main": "dist/index.js",
+  "bin": {
+    "insider": "dist/insider.js"
+  },
+  "scripts": {
+    "build": "npm run clean && mkdir dist && cp lib/*.js dist && cp build/libs/insider*.jar dist/insider.jar && npm run copy-assets",
+    "copy-assets": "cp -R config dist/config",
+    "clean": "rimraf dist/",
+    "local": "npm run build && npm i"
+  },
+  "dependencies": {
+    "commander": "11.1.0",
+    "java-caller": "^2.7.0"
+  },
+  "overrides": {
+    "tar": "^7.5.11"
+  },
+  "devDependencies": {
+    "json": "^11.0.0",
+    "rimraf": "^3.0.2",
+    "sort-package-json": "^1.52.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dxw": {
+    "commands": [
+      {
+        "file": "dist/index.js",
+        "command": "insiderCommand"
+      }
+    ]
+  }
+}