@eagleoutice/flowr 1.5.1 → 2.0.0

package/dataflow/processor.d.ts

@@ -1,9 +1,12 @@
 /**
  * Based on a two-way fold, this processor will automatically supply scope information
  */
-import type { NormalizedAst, ParentInformation, RNode, RNodeWithParent, RParseRequest } from '../r-bridge';
-import type { DataflowInformation } from './internal/info';
-import type { DataflowScopeName, REnvironmentInformation } from './environments';
+import type { DataflowInformation } from './info';
+import type { NormalizedAst, ParentInformation, RNodeWithParent } from '../r-bridge/lang-4.x/ast/model/processing/decorate';
+import type { REnvironmentInformation } from './environments/environment';
+import type { RParseRequest } from '../r-bridge/retriever';
+import type { NodeId } from '../r-bridge/lang-4.x/ast/model/processing/node-id';
+import type { RNode } from '../r-bridge/lang-4.x/ast/model/model';
 export interface DataflowProcessorInformation<OtherInfo> {
     /**
    * Initial and frozen ast-information
@@ -11,13 +14,9 @@ export interface DataflowProcessorInformation<OtherInfo> {
     readonly completeAst: NormalizedAst<OtherInfo>;
     /**
    * Correctly contains pushed local scopes introduced by `function` scopes.
-   * Will by default *not* contain any symbol-bindings introduces along the way, they have to be decorated when moving up the tree.
+   * Will by default *not* contain any symbol-bindings introduced along the way; they have to be decorated when moving up the tree.
    */
-    readonly environments: REnvironmentInformation;
-    /**
-   * Name of the currently active scope, (hopefully) always {@link LocalScope | Local}
-   */
-    readonly activeScope: DataflowScopeName;
+    readonly environment: REnvironmentInformation;
     /**
    * Other processors to be called by the given functions
    */
@@ -31,14 +30,20 @@ export interface DataflowProcessorInformation<OtherInfo> {
      * The most recent (last) entry is expected to always be the {@link currentRequest}.
      */
     readonly referenceChain: string[];
+    /**
+     * The chain of control-flow {@link NodeId}s that lead to the current node (e.g. of known ifs).
+     */
+    readonly controlDependencies: NodeId[] | undefined;
 }
 export type DataflowProcessor<OtherInfo, NodeType extends RNodeWithParent<OtherInfo>> = (node: NodeType, data: DataflowProcessorInformation<OtherInfo>) => DataflowInformation;
-type NodeWithKey<OtherInfo, Node extends RNode<OtherInfo & ParentInformation>, TypeKey> = Node['type'] extends TypeKey ? Node : never;
+type NodeWithKey<OtherInfo, Key> = RNode<OtherInfo & ParentInformation> & {
+    type: Key;
+};
 /**
  * This way, a processor mapped to a {@link RType#Symbol} require a {@link RSymbol} as first parameter and so on.
  */
 export type DataflowProcessors<OtherInfo> = {
-    [key in RNode['type']]: DataflowProcessor<OtherInfo, NodeWithKey<OtherInfo, RNodeWithParent<OtherInfo>, key>>;
+    [key in RNode['type']]: DataflowProcessor<OtherInfo, NodeWithKey<OtherInfo, key>>;
 };
 /**
  * Originally, dataflow processor was written as a two-way fold, but this produced problems when trying to resolve function calls
@@ -50,7 +55,7 @@ export type DataflowProcessors<OtherInfo> = {
  * Now this method can be called recursively within the other processors to parse the dataflow for nodes that you can not narrow down.
  *
  * @param current - The current node to start processing from
- * @param data    - The initial information to be passed down
+ * @param data    - The initial (/current) information to be passed down
  */
-export declare function processDataflowFor<OtherInfo>(current: RNodeWithParent<OtherInfo>, data: DataflowProcessorInformation<OtherInfo & ParentInformation>): DataflowInformation;
+export declare function processDataflowFor<OtherInfo>(current: RNode<OtherInfo & ParentInformation>, data: DataflowProcessorInformation<OtherInfo & ParentInformation>): DataflowInformation;
 export {};

package/dataflow/processor.js

@@ -11,7 +11,7 @@ exports.processDataflowFor = void 0;
  * Now this method can be called recursively within the other processors to parse the dataflow for nodes that you can not narrow down.
  *
  * @param current - The current node to start processing from
- * @param data    - The initial information to be passed down
+ * @param data    - The initial (/current) information to be passed down
  */
 function processDataflowFor(current, data) {
     return data.processors[current.type](current, data);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eagleoutice/flowr",
-  "version": "1.5.1",
+  "version": "2.0.0",
   "description": "Static Dataflow Analyzer and Program Slicer for the R Programming Language",
   "types": "dist/src/index.d.ts",
   "repository": {
@@ -12,12 +12,21 @@
     "url": "https://github.com/Code-Inspect/flowr/issues"
   },
   "scripts": {
+    "main": "npm run build && node dist/src/cli/flowr.js",
     "publish-library": "cp .npmignore package.json README.md LICENSE dist/src/ && cd dist/src && npm publish --access public",
-    "release": "release-it --ci",
+    "release": "npx release-it --ci",
+    "stats": "ts-node src/cli/statistics-app.ts",
+    "stats-helper": "ts-node src/cli/statistics-helper-app.ts",
+    "slicer": "ts-node src/cli/slicer-app.ts",
+    "benchmark-helper": "ts-node src/cli/benchmark-helper-app.ts",
+    "benchmark": "npm run build && node dist/src/cli/benchmark-app.js",
+    "summarizer": "ts-node src/cli/summarizer-app.ts",
+    "export-quads": "ts-node src/cli/export-quads-app.ts",
+    "capabilities-markdown": "ts-node src/r-bridge/data/print.ts",
     "build": "tsc --project .",
-    "lint-local": "eslint src/ test/ --rule \"no-warning-comments: off\"",
-    "lint": "npm run license-compat -- --summary && eslint src/ test/",
-    "license-compat": "license-checker --onlyAllow 'MIT;MIT OR X11;GPLv2;LGPL;GNUGPL;ISC;Apache-2.0;FreeBSD;BSD-2-Clause;clearbsd;ModifiedBSD;BSD-3-Clause;Python-2.0;Unlicense;WTFPL;CC-BY-4.0;CC-BY-3.0;CC0-1.0;0BSD'",
+    "lint-local": "npx eslint --version && npx eslint src/ test/ --rule \"no-warning-comments: off\"",
+    "lint": "npm run license-compat -- --summary && npx eslint --version && npx eslint src/ test/",
+    "license-compat": "license-checker --onlyAllow 'MIT;MIT OR X11;GPLv2;LGPL;GNUGPL;ISC;Apache-2.0;FreeBSD;BSD-2-Clause;clearbsd;ModifiedBSD;BSD-3-Clause;Python-2.0;Unlicense;WTFPL;BlueOak-1.0.0;CC-BY-4.0;CC-BY-3.0;CC0-1.0;0BSD'",
     "doc": "typedoc",
     "test": "nyc --no-clean mocha",
     "performance-test": "func() { cd test/performance/ && bash run-all-suites.sh $1 $2 $3; cd ../../; }; func",
@@ -36,20 +45,25 @@
   "mocha": {
     "require": "ts-node/register",
     "timeout": 60000,
-    "spec": "test/**/*.spec.ts"
+    "spec": "test/**/*.spec.ts",
+    "source-map": true,
+    "recursive": true,
+    "exit": true,
+    "produce-source-map": true
   },
   "nyc": {
     "all": true,
     "per-file": true,
     "check-coverage": false,
-    "skip-full": false,
+    "skip-full": true,
     "lines": 70,
     "extension": [
       ".ts"
     ],
-    "include": "src/**/*.ts",
+    "include": [
+      "src/**/*.ts"
+    ],
     "reporter": [
-      "html",
       "text",
       "lcov",
       "cobertura"
@@ -68,55 +82,7 @@
     "extends": [
       "@eagleoutice/eslint-config-flowr"
     ],
-    "rules": {
-      "import/no-restricted-paths": [
-        "error",
-        {
-          "zones": [
-            {
-              "target": "modules/benchmark",
-              "from": [
-                "modules/cli",
-                "src",
-                "modules/statistics"
-              ]
-            },
-            {
-              "target": "modules/cli",
-              "from": [
-                "modules/benchmark",
-                "src",
-                "modules/statistics"
-              ]
-            },
-            {
-              "target": "modules/statistics",
-              "from": [
-                "modules/benchmark",
-                "modules/cli",
-                "src"
-              ]
-            },
-            {
-              "target": "src",
-              "from": [
-                "modules/benchmark",
-                "modules/cli",
-                "modules/statistics"
-              ]
-            },
-            {
-              "target": "test",
-              "from": [
-                "modules/benchmark",
-                "modules/cli",
-                "modules/statistics"
-              ]
-            }
-          ]
-        }
-      ]
-    }
+    "rules": {}
   },
   "typedocOptions": {
     "includeVersion": true,
@@ -213,13 +179,14 @@
     }
   },
   "devDependencies": {
-    "@commitlint/cli": "^18.4.3",
-    "@commitlint/config-angular": "^18.4.3",
-    "@eagleoutice/eslint-config-flowr": "^1.0.2",
-    "@stylistic/eslint-plugin": "^1.6.2",
-    "@stylistic/eslint-plugin-plus": "^1.6.2",
-    "@stylistic/eslint-plugin-ts": "^1.6.2",
-    "@types/chai": "^4.3.11",
+    "@commitlint/cli": "^19.3.0",
+    "@commitlint/config-angular": "^19.3.0",
+    "@eagleoutice/eslint-config-flowr": "^1.0.8",
+    "@j-ulrich/release-it-regex-bumper": "^5.1.0",
+    "@stylistic/eslint-plugin": "^2.1.0",
+    "@stylistic/eslint-plugin-plus": "^2.1.0",
+    "@stylistic/eslint-plugin-ts": "^2.1.0",
+    "@types/chai": "^4.3.16",
     "@types/chai-as-promised": "^7.1.8",
     "@types/command-line-args": "^5.2.3",
     "@types/command-line-usage": "^5.0.4",
@@ -227,15 +194,16 @@
     "@types/n-readlines": "^1.0.6",
     "@types/n3": "^1.16.4",
     "@types/object-hash": "^3.0.6",
+    "@types/semver": "^7.5.6",
     "@types/tmp": "^0.2.6",
-    "@typescript-eslint/eslint-plugin": "^6.13.2",
-    "chai": "^4.3.10",
+    "@types/ws": "^8.5.10",
+    "@typescript-eslint/eslint-plugin": "^7.8.0",
+    "chai": "^4.3.16",
     "chai-as-promised": "^7.1.1",
-    "eslint": "^8.55.0",
-    "eslint-config-standard-with-typescript": "^42.0.0",
-    "eslint-plugin-check-file": "^2.6.2",
-    "eslint-plugin-import": "^2.29.0",
-    "eslint-plugin-n": "^16.3.1",
+    "eslint": "^8.57.0",
+    "eslint-plugin-check-file": "^2.8.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-n": "^17.6.0",
     "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-tsdoc": "^0.2.17",
     "license-checker": "^25.0.1",
@@ -244,32 +212,27 @@
     "nyc": "^15.1.0",
     "release-it": "^17.0.1",
     "ts-node": "^10.9.2",
-    "typedoc": "^0.25.4",
-    "typedoc-plugin-missing-exports": "^2.1.0",
+    "typedoc": "^0.25.13",
+    "typedoc-plugin-missing-exports": "^2.2.0",
     "typedoc-theme-hierarchy": "^4.1.2",
-    "typedoc-umlclass": "^0.8.0",
-    "typescript": "^5.3.3",
-    "@j-ulrich/release-it-regex-bumper": "^5.1.0"
+    "typedoc-umlclass": "^0.9.0",
+    "typescript": "^5.3.3"
   },
   "dependencies": {
-    "@types/semver": "^7.5.6",
-    "@types/tar": "^6.1.10",
-    "@types/ws": "^8.5.10",
     "@xmldom/xmldom": "^0.8.10",
     "command-line-args": "^5.2.1",
     "command-line-usage": "^7.0.1",
-    "csv-parse": "^5.5.3",
-    "joi": "^17.11.0",
+    "joi": "^17.13.1",
     "n-readlines": "^1.0.1",
     "n3": "^1.17.2",
     "object-hash": "^3.0.0",
     "rotating-file-stream": "^3.1.1",
     "semver": "^7.5.4",
-    "tar": "^6.2.0",
-    "tmp": "^0.2.1",
+    "tar": "^7.1.0",
+    "tmp": "^0.2.3",
     "ts-essentials": "^9.4.1",
     "tslog": "^4.9.2",
-    "ws": "^8.16.0",
+    "ws": "^8.17.0",
     "xpath-ts2": "^1.4.2"
   }
 }