ts2famix 1.0.11 → 1.0.13

package/src/ts2famix-cli.ts

@@ -1,39 +1,39 @@
-#!/usr/bin/env node
-import * as fs from "fs";
-import yargs from "yargs";
-import { Importer } from './analyze';
-import { FamixRepository } from "./lib/famix/src/famix_repository";
-import { Project } from "ts-morph";
-
-const argv = yargs
-    .example(`ts2famix -i "path/to/project/**/*.ts" -o JSONModels/projectName.json`, 'Creates a JSON-format Famix model of typescript files.')
-    .example(`ts2famix -i path/to/tsconfig.json -o JSONModels/projectName.json`, 'Creates a JSON-format model of a typescript project.')
-    .alias('i', 'input')
-    .nargs('i', 1)
-    .alias('o', 'output')
-    .nargs('o', 1)
-    .demandOption('input').demandOption('output').parseSync();
-
-const importer = new Importer();
-let famixRep: FamixRepository;
-
-if ((argv.input as string).endsWith('tsconfig.json')) {
-    const tsConfigFilePath = argv.input as string;
-    const project = new Project({
-        tsConfigFilePath
-      }); 
-    famixRep = importer.famixRepFromProject(project);
-} else {
-    const paths = new Array<string>();
-    paths.push(argv.input as string);
-    famixRep = importer.famixRepFromPaths(paths);
-}
-
-const jsonOutput = famixRep.getJSON();
-const jsonFilePath = argv.output as string;
-
-fs.writeFile(jsonFilePath, jsonOutput, (err) => {
-    if (err) { throw err; }
-});
-
-console.info(`Created: ${jsonFilePath}`); 
+#!/usr/bin/env node
+import * as fs from "fs";
+import yargs from "yargs";
+import { Importer } from './analyze';
+import { FamixRepository } from "./lib/famix/src/famix_repository";
+import { Project } from "ts-morph";
+
+const argv = yargs
+    .example(`ts2famix -i "path/to/project/**/*.ts" -o JSONModels/projectName.json`, 'Creates a JSON-format Famix model of typescript files.')
+    .example(`ts2famix -i path/to/tsconfig.json -o JSONModels/projectName.json`, 'Creates a JSON-format model of a typescript project.')
+    .alias('i', 'input')
+    .nargs('i', 1)
+    .alias('o', 'output')
+    .nargs('o', 1)
+    .demandOption('input').demandOption('output').parseSync();
+
+const importer = new Importer();
+let famixRep: FamixRepository;
+
+if ((argv.input as string).endsWith('tsconfig.json')) {
+    const tsConfigFilePath = argv.input as string;
+    const project = new Project({
+        tsConfigFilePath
+      }); 
+    famixRep = importer.famixRepFromProject(project);
+} else {
+    const paths = new Array<string>();
+    paths.push(argv.input as string);
+    famixRep = importer.famixRepFromPaths(paths);
+}
+
+const jsonOutput = famixRep.getJSON();
+const jsonFilePath = argv.output as string;
+
+fs.writeFile(jsonFilePath, jsonOutput, (err) => {
+    if (err) { throw err; }
+});
+
+console.info(`Created: ${jsonFilePath}`); 

package/tsconfig.json

@@ -1,70 +1,70 @@
-{
-  "compilerOptions": {
-    /* Basic Options */
-    "target": "ES2017",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "CommonJS",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
-    // "lib": [],                             /* Specify library files to be included in the compilation. */
-    // "allowJs": true,                       /* Allow javascript files to be compiled. */
-    // "checkJs": true,                       /* Report errors in .js files. */
-    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
-    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
-    // "outFile": "./",                       /* Concatenate and emit output to single file. */
-    "outDir": "./dist",                        /* Redirect output structure to the directory. */
-    "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "composite": true,                     /* Enable project compilation */
-    // "incremental": true,                   /* Enable incremental compilation */
-    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
-    // "removeComments": true,                /* Do not emit comments to output. */
-    // "noEmit": true,                        /* Do not emit outputs. */
-    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
-    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-
-    /* Strict Type-Checking Options */
-    "strict": false,                           /* Enable all strict type-checking options. */
-    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,              /* Enable strict null checks. */
-    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
-    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
-    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
-    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
-    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
-
-    /* Additional Checks */
-    // "noUnusedLocals": true,                /* Report errors on unused locals. */
-    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
-    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
-    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
-
-    /* Module Resolution Options */
-    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-    "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
-    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                       /* List of folders to include type definitions from. */
-    // "types": [],                           /* Type declaration files to be included in compilation. */
-    "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
-
-    /* Source Map Options */
-    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
-    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
-
-    /* Experimental Options */
-    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
-  },
-  "include": ["src"],
-  "exclude": ["node_modules", "**/*.spec.ts"],
-  "typedocOptions": {
-    "entryPoints": ["src/*"],
-    "entryPointStrategy": "expand",
-    "out": "docs",
-    "githubPages": false
-  }
+{
+  "compilerOptions": {
+    /* Basic Options */
+    "target": "ES2017",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
+    "module": "CommonJS",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "outDir": "./dist",                        /* Redirect output structure to the directory. */
+    "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "incremental": true,                   /* Enable incremental compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": false,                           /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "**/*.spec.ts"],
+  "typedocOptions": {
+    "entryPoints": ["src/*"],
+    "entryPointStrategy": "expand",
+    "out": "docs",
+    "githubPages": false
+  }
 }

package/dist/analyze.js

@@ -1,102 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Importer = void 0;
-const ts_morph_1 = require("ts-morph");
-const fs = __importStar(require("fs"));
-const famix_functions_1 = require("./famix_functions/famix_functions");
-const processFiles_1 = require("./analyze_functions/processFiles");
-const processAccesses_1 = require("./analyze_functions/processAccesses");
-const processInvocations_1 = require("./analyze_functions/processInvocations");
-const processInheritances_1 = require("./analyze_functions/processInheritances");
-const processImportClauses_1 = require("./analyze_functions/processImportClauses");
-/**
- * This class is used to build a Famix model from a TypeScript source code
- */
-class Importer {
-    constructor() {
-        this.project = new ts_morph_1.Project(); // The project containing the source files to analyze
-        this.famixFunctions = new famix_functions_1.FamixFunctions(); // FamixFunctions object, it contains all the functions needed to create Famix entities
-        this.processFiles = new processFiles_1.ProcessFiles(this.famixFunctions); // ProcessFiles object, it contains all the functions needed to process the source files
-        this.processAccesses = new processAccesses_1.ProcessAccesses(this.famixFunctions); // ProcessAccesses object, it contains all the functions needed to process the accesses
-        this.processInvocations = new processInvocations_1.ProcessInvocations(this.famixFunctions); // ProcessInvocations object, it contains all the functions needed to process the invocations
-        this.processInheritances = new processInheritances_1.ProcessInheritances(this.famixFunctions); // ProcessInheritances object, it contains all the functions needed to process the inheritances
-        this.processImportClauses = new processImportClauses_1.ProcessImportClauses(this.famixFunctions); // ProcessImportClauses object, it contains all the functions needed to process the import clauses
-    }
-    /**
-     * Main method
-     * @param paths An array of paths to the source files to analyze
-     * @returns The Famix repository containing the Famix model
-     */
-    famixRepFromPaths(paths) {
-        let famixRep;
-        try {
-            console.info(`famixRepFromPaths: paths: ${paths}`);
-            const sourceFiles = this.project.addSourceFilesAtPaths(paths);
-            this.processFiles.processFiles(sourceFiles);
-            const accesses = this.processFiles.getAccesses();
-            const methodsAndFunctionsWithId = this.processFiles.getMethodsAndFunctionsWithId();
-            const classes = this.processFiles.getClasses();
-            const interfaces = this.processFiles.getInterfaces();
-            const modules = this.processFiles.getModules();
-            const exports = this.processFiles.getExports();
-            this.processImportClauses.processImportClauses(modules, exports);
-            this.processAccesses.processAccesses(accesses);
-            this.processInvocations.processInvocations(methodsAndFunctionsWithId);
-            this.processInheritances.processInheritances(classes, interfaces);
-            famixRep = this.famixFunctions.getFamixRepository();
-        }
-        catch (error) {
-            console.error(`> ERROR: got exception ${error}. Exiting...`);
-            console.error(error.message);
-            console.error(error.stack);
-            process.exit(1);
-        }
-        return famixRep;
-    }
-    /**
-     * Main method for tests
-     * @param filename The name of the file to analyze
-     * @param source A TypeScript source code
-     * @returns The Famix repository containing the Famix model
-     */
-    famixRepFromSource(filename, source) {
-        const filePath = `./test_src/${filename}.ts`;
-        fs.writeFileSync(filePath, source, 'utf-8');
-        const famixRep = this.famixRepFromPaths([filePath]);
-        return famixRep;
-    }
-    /**
-     * Main method for a ts-morph project
-     * @param project A ts-morph project
-     * @returns The Famix repository containing the Famix model
-     */
-    famixRepFromProject(project) {
-        const sourceFileNames = project.getSourceFiles().map(f => f.getFilePath());
-        const famixRep = this.famixRepFromPaths(sourceFileNames);
-        return famixRep;
-    }
-}
-exports.Importer = Importer;

package/dist/analyze_functions/processAccesses.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProcessAccesses = void 0;
-/**
- * This class is used to build a Famix model for the accesses
- */
-class ProcessAccesses {
-    /**
-     * Initializes the ProcessAccesses object
-     * @param famixFunctions FamixFunctions object, it contains all the functions needed to create Famix entities
-     */
-    constructor(famixFunctions) {
-        this.famixFunctions = famixFunctions;
-    }
-    /**
-     * Builds a Famix model for the accesses on the parameters, variables, properties and enum members of the source files
-     * @param accesses A map of parameters, variables, properties and enum members with their id
-     */
-    processAccesses(accesses) {
-        console.info(`processAccesses: Creating accesses:`);
-        accesses.forEach((v, id) => {
-            console.info(`processAccesses: Accesses to ${v.getName()}`);
-            try {
-                const temp_nodes = v.findReferencesAsNodes();
-                temp_nodes.forEach(node => this.processNodeForAccesses(node, id));
-            }
-            catch (error) {
-                console.error(`> WARNING: got exception ${error}. Continuing...`);
-            }
-        });
-    }
-    /**
-     * Builds a Famix model for an access on a parameter, variable, property or enum member
-     * @param n A node
-     * @param id An id of a parameter, a variable, a property or an enum member
-     */
-    processNodeForAccesses(n, id) {
-        try {
-            this.famixFunctions.createFamixAccess(n, id);
-            console.info(`processNodeForAccesses: node: node, (${n.getType().getText()})`);
-        }
-        catch (error) {
-            console.error(`> WARNING: got exception ${error}. ScopeDeclaration invalid for ${n.getSymbol().getFullyQualifiedName()}. Continuing...`);
-        }
-    }
-}
-exports.ProcessAccesses = ProcessAccesses;