@profile-psl/psl-parser 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,58 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0]
+
+### Changed
+
+- Project split from original source [ing-bank/vscode-psl](https://github.com/ing-bank/vscode-psl.git)
+  to new dedicated source [ing-bank/psl-parser](https://github.com/ing-bank/psl-parser.git).
+  This deprecates all previous released versions. Previous revisions from the
+  original CHANGELOG are kept, even though the change log does not contain a
+  lot of information.
+- Update this changelog to follow the latest format from *Keep a Changelog*.
+- Let functions return `null` instead of `undefined` for those functions where
+  not all paths had a return value.
+- Switched linter from `tslint` to `eslint`.
+- Update all the dependencies to the latest version
+- Change the module type to ES module.
+- Moved from jest to node test framework.
+
+## [0.0.3] - 2019-04-19
+
+### Changed
+
+- Minor changes.
+
+## [0.0.2] - 2019-04-19
+
+### Changed
+
+- Minor changes.
+
+## [0.0.1] - 2019-04-19
+
+### Added
+
+- Initial publication.
+
+[Unreleased]: https://github.com/ing-bank/psl-parser/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/ing-bank/psl-parser/compare/4814107ce1840d92c2ab0de99e31887014453d4c...v0.1.0
+
+<!--
+The links to 0.0.3 and earlier go to the commit where the package.json
+for the psl-parser was changed. The diffs are not usable as this project
+contains a lot more than just the psl-parser.
+
+The links for 0.0.1 and 0.0.2 point to the same commit, as the first occurrence
+of the package.json already had the version set to 0.0.2
+-->
+[0.0.3]: https://github.com/ing-bank/vscode-psl/commit/4a89048f6c2c45218986284f00e8898d8500d9f3
+[0.0.2]: https://github.com/ing-bank/vscode-psl/commit/4bed075d2087d7fa714370df71acc5d43a0ef9fe
+[0.0.1]: https://github.com/ing-bank/vscode-psl/commit/4bed075d2087d7fa714370df71acc5d43a0ef9fe

package/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 ING Bank NV
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,34 @@
+# psl-parser
+
+Implementation of a Profile Scripting Language Parser in TypeScript.
+
+## Usage
+
+```javascript
+import { parseText } from 'psl-parser';
+
+const parsedPsl = parseText(/* PSL source text */);
+
+parsedPsl.methods.forEach(method => {
+    console.log(method.id.value);
+})
+```
+
+## Development
+
+If you would like to join the development of this project, you will need to
+install [node.js] (with npm) in order to install the dependencies.
+
+Once you clone the project, from the command line in the root of this project,
+run `npm install`.
+
+## History
+
+This project was originally developed under [ing-bank/vscode-psl] repository,
+in order to preserve that history this project was cloned from
+[ing-bank/vscode-psl] and only code relevant to the psl-parser was retained.
+Please refer to the [split commit] for details.
+
+[split commit]: https://github.com/ing-bank/psl-parser/commit/4814107ce1840d92c2ab0de99e31887014453d4c
+[ing-bank/vscode-psl]: https://github.com/ing-bank/vscode-psl.git
+[node.js]: https://nodejs.org/en

package/config.d.ts

@@ -0,0 +1,29 @@
+export declare function setConfig(configPath: string, workspaces: Map<string, string>): void;
+export declare function removeConfig(configPath: string): void;
+/**
+ * Absolute paths.
+ */
+export interface FinderPaths {
+    /**
+     * Absolute path to the active routine, if the active component is a routine.
+     */
+    activeRoutine?: string;
+    /**
+     * Absolute path to the active table, if the active component is a table.
+     */
+    activeTable?: string;
+    /**
+     * Absolute paths to all possible sources for PSL classes, across all projects.
+     * Ordered by priority.
+     */
+    projectPsl: string[];
+    /**
+     * Absolute path to the location of PSL core class definitions.
+     */
+    corePsl: string;
+    /**
+     * Absolute path to the directory that contains file definitions.
+     */
+    tables: string[];
+}
+export declare function getFinderPaths(currentDir: string, activeRoutine?: string): FinderPaths;

package/config.js

@@ -0,0 +1,51 @@
+import * as fs from "fs-extra";
+import * as path from "path";
+const activeConfigs = new Map();
+export function setConfig(configPath, workspaces) {
+    const configBaseDir = path.dirname(configPath);
+    // TODO: (Mischa Reitsma) Loading from a file and not validating that it follows the ProjectConfig interface, worth writing a config parser or use a lib to check against a json schema.
+    const config = JSON.parse(fs.readFileSync(configPath).toString());
+    config.parentProjects = config.parentProjects.map(p => workspaces.get(p)).filter(x => x);
+    activeConfigs.set(configBaseDir, config);
+}
+export function removeConfig(configPath) {
+    const configBaseDir = path.dirname(configPath);
+    activeConfigs.delete(configBaseDir);
+}
+export function getFinderPaths(currentDir, activeRoutine) {
+    const defaultPslSources = ["dataqwik/procedure/", "psl/"];
+    const defaultFileDefinitionSources = ["dataqwik/table/"];
+    const config = activeConfigs.get(currentDir);
+    const projectPsl = [];
+    const tables = [];
+    const loadPsl = (base, source) => {
+        projectPsl.push(path.join(base, source));
+    };
+    const loadFileDefinition = (base, source) => {
+        tables.push(path.join(base, source));
+    };
+    const relativePslSources = (config && config.pslSources)
+        ? config.pslSources : defaultPslSources;
+    const relativeFileDefinitionSource = config && config.fileDefinitionSources
+        ? config.fileDefinitionSources : defaultFileDefinitionSources;
+    const corePsl = path.join(currentDir, ".vscode/pslcls/");
+    // load core first
+    projectPsl.push(corePsl);
+    // load base sources
+    relativePslSources.forEach(source => loadPsl(currentDir, source));
+    relativeFileDefinitionSource.forEach(source => loadFileDefinition(currentDir, source));
+    // load parent sources
+    if (config && config.parentProjects) {
+        for (const parent of config.parentProjects) {
+            relativePslSources.forEach(source => loadPsl(parent, source));
+            relativeFileDefinitionSource.forEach(source => loadFileDefinition(parent, source));
+        }
+    }
+    return {
+        activeRoutine,
+        corePsl,
+        projectPsl,
+        tables,
+    };
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NvbmZpZy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssRUFBRSxNQUFNLFVBQVUsQ0FBQztBQUMvQixPQUFPLEtBQUssSUFBSSxNQUFNLE1BQU0sQ0FBQztBQUk3QixNQUFNLGFBQWEsR0FBc0MsSUFBSSxHQUFHLEVBQUUsQ0FBQztBQVFuRSxNQUFNLFVBQVUsU0FBUyxDQUFDLFVBQWtCLEVBQUUsVUFBK0I7SUFDNUUsTUFBTSxhQUFhLEdBQWtCLElBQUksQ0FBQyxPQUFPLENBQUMsVUFBVSxDQUFDLENBQUM7SUFFOUQsd0xBQXdMO0lBQ3hMLE1BQU0sTUFBTSxHQUNYLElBQUksQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDLFlBQVksQ0FBQyxVQUFVLENBQUMsQ0FBQyxRQUFRLEVBQUUsQ0FBa0IsQ0FBQztJQUVyRSxNQUFNLENBQUMsY0FBYyxHQUFHLE1BQU0sQ0FBQyxjQUFjLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ3pGLGFBQWEsQ0FBQyxHQUFHLENBQUMsYUFBYSxFQUFFLE1BQU0sQ0FBQyxDQUFDO0FBQzFDLENBQUM7QUFFRCxNQUFNLFVBQVUsWUFBWSxDQUFDLFVBQWtCO0lBQzlDLE1BQU0sYUFBYSxHQUFrQixJQUFJLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxDQUFDO0lBQzlELGFBQWEsQ0FBQyxNQUFNLENBQUMsYUFBYSxDQUFDLENBQUM7QUFDckMsQ0FBQztBQWlDRCxNQUFNLFVBQVUsY0FBYyxDQUFDLFVBQWtCLEVBQUUsYUFBc0I7SUFFeEUsTUFBTSxpQkFBaUIsR0FBRyxDQUFDLHFCQUFxQixFQUFFLE1BQU0sQ0FBQyxDQUFDO0lBQzFELE1BQU0sNEJBQTRCLEdBQUcsQ0FBQyxpQkFBaUIsQ0FBQyxDQUFDO0lBRXpELE1BQU0sTUFBTSxHQUE4QixhQUFhLENBQUMsR0FBRyxDQUFDLFVBQVUsQ0FBQyxDQUFDO0lBRXhFLE1BQU0sVUFBVSxHQUFHLEVBQUUsQ0FBQztJQUN0QixNQUFNLE1BQU0sR0FBYSxFQUFFLENBQUM7SUFFNUIsTUFBTSxPQUFPLEdBQUcsQ0FBQyxJQUFZLEVBQUUsTUFBYyxFQUFFLEVBQUU7UUFDaEQsVUFBVSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksRUFBRSxNQUFNLENBQUMsQ0FBQyxDQUFDO0lBQzFDLENBQUMsQ0FBQztJQUVGLE1BQU0sa0JBQWtCLEdBQUcsQ0FBQyxJQUFZLEVBQUUsTUFBYyxFQUFFLEVBQUU7UUFDM0QsTUFBTSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksRUFBRSxNQUFNLENBQUMsQ0FBQyxDQUFDO0lBQ3RDLENBQUMsQ0FBQztJQUVGLE1BQU0sa0JBQWtCLEdBQUcsQ0FBQyxNQUFNLElBQUksTUFBTSxDQUFDLFVBQVUsQ0FBQztRQUN2RCxDQUFDLENBQUMsTUFBTSxDQUFDLFVBQVUsQ0FBQyxDQUFDLENBQUMsaUJBQWlCLENBQUM7SUFFekMsTUFBTSw0QkFBNEIsR0FBRyxNQUFNLElBQUksTUFBTSxDQUFDLHFCQUFxQjtRQUMxRSxDQUFDLENBQUMsTUFBTSxDQUFDLHFCQUFxQixDQUFDLENBQUMsQ0FBQyw0QkFBNEIsQ0FBQztJQUUvRCxNQUFNLE9BQU8sR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLFVBQVUsRUFBRSxpQkFBaUIsQ0FBQyxDQUFDO0lBQ3pELGtCQUFrQjtJQUNsQixVQUFVLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBRXpCLG9CQUFvQjtJQUNwQixrQkFBa0IsQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQyxPQUFPLENBQUMsVUFBVSxFQUFFLE1BQU0sQ0FBQyxDQUFDLENBQUM7SUFDbEUsNEJBQTRCLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsa0JBQWtCLENBQUMsVUFBVSxFQUFFLE1BQU0sQ0FBQyxDQUFDLENBQUM7SUFFdkYsc0JBQXNCO0lBQ3RCLElBQUksTUFBTSxJQUFJLE1BQU0sQ0FBQyxjQUFjLEVBQUUsQ0FBQztRQUNyQyxLQUFLLE1BQU0sTUFBTSxJQUFJLE1BQU0sQ0FBQyxjQUFjLEVBQUUsQ0FBQztZQUM1QyxrQkFBa0IsQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQyxPQUFPLENBQUMsTUFBTSxFQUFFLE1BQU0sQ0FBQyxDQUFDLENBQUM7WUFDOUQsNEJBQTRCLENBQUMsT0FBTyxDQUNuQyxNQUFNLENBQUMsRUFBRSxDQUFDLGtCQUFrQixDQUFDLE1BQU0sRUFBRSxNQUFNLENBQUMsQ0FDNUMsQ0FBQztRQUNILENBQUM7SUFDRixDQUFDO0lBRUQsT0FBTztRQUNOLGFBQWE7UUFDYixPQUFPO1FBQ1AsVUFBVTtRQUNWLE1BQU07S0FDTixDQUFDO0FBQ0gsQ0FBQyJ9

package/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./parser";
+export * from "./statementParser";
+import * as _tokenizer from "./tokenizer";
+export { _tokenizer as tokenizer };
+import * as _utilities from "./utilities";
+export { _utilities as utilities };

package/index.js

@@ -0,0 +1,7 @@
+export * from "./parser";
+export * from "./statementParser";
+import * as _tokenizer from "./tokenizer";
+export { _tokenizer as tokenizer };
+import * as _utilities from "./utilities";
+export { _utilities as utilities };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxVQUFVLENBQUM7QUFFekIsY0FBYyxtQkFBbUIsQ0FBQztBQUVsQyxPQUFPLEtBQUssVUFBVSxNQUFNLGFBQWEsQ0FBQztBQUMxQyxPQUFPLEVBQUUsVUFBVSxJQUFJLFNBQVMsRUFBRSxDQUFDO0FBRW5DLE9BQU8sS0FBSyxVQUFVLE1BQU0sYUFBYSxDQUFDO0FBQzFDLE9BQU8sRUFBRSxVQUFVLElBQUksU0FBUyxFQUFFLENBQUMifQ==

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@profile-psl/psl-parser",
+  "version": "0.1.0",
+  "description": "Profile Scripting Language Parser",
+  "type": "module",
+  "keywords": [
+    "PSL",
+    "parser",
+    "Profile"
+  ],
+  "homepage": "https://github.com/ing-bank/psl-parser#readme",
+  "bugs": {
+    "url": "https://github.com/ing-bank/psl-parser/issues"
+  },
+  "license": "MIT",
+  "author": "atiplea",
+  "contributors": [
+    "SOliveira",
+    {
+      "name": "Mischa Reitsma",
+      "email": "dev@mreitmsa.com",
+      "url": "https://github.com/mischareitsma"
+    }
+  ],
+  "main": "index.js",
+  "types": "index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://git@github.com/ing-bank/psl-parser.git"
+  },
+  "dependencies": {
+    "fs-extra": "^11.2.0",
+    "jsonc-parser": "^3.2.0"
+  }
+}

package/parser.d.ts

@@ -0,0 +1,155 @@
+import { Statement } from "./statementParser";
+import { Token } from "./tokenizer";
+/**
+ * Used for checking the type of Member at runtime
+ */
+export declare enum MemberClass {
+    method = 1,
+    parameter = 2,
+    property = 3,
+    declaration = 4,
+    column = 5,
+    table = 6,
+    proc = 7
+}
+/**
+ * A generic type that abstracts Method, Parameter, Declaration, etc
+ */
+export interface Member {
+    /**
+     * The Token representing the name of the member.
+     */
+    id: Token;
+    /**
+     * An array of types. The 0 index represents the 0 node type.
+     * For trees the type of the nth node will be found at index n.
+     */
+    types: Token[];
+    modifiers: Token[];
+    /**
+     * The member class to determine the type at runtime
+     */
+    memberClass: MemberClass;
+    documentation?: string;
+}
+/**
+ * Contains information about a Method
+ */
+export interface Method extends Member {
+    /**
+     * The Token of the closing parenthesis after the declaration of all the Method's
+     * parameters.
+     */
+    closeParen: Token;
+    /**
+     * Currently unused for Methods.
+     */
+    types: Token[];
+    /**
+     * All the modifiers before the Method id, like "public", "static", "void", "String", etc.
+     */
+    modifiers: Token[];
+    /**
+     * The parameters of the Method, each with their own typing and comment information.
+     */
+    parameters: Parameter[];
+    /**
+     * The "type" declarations found within the body of the method.
+     * Only the location where they are declared is referenced.
+     */
+    declarations: Declaration[];
+    /**
+     * The zero-based line where the Method begins
+     */
+    line: number;
+    /**
+     * The last line of the Method, right before the start of a new Method
+     */
+    endLine: number;
+    /**
+     * Whether the Method (label) is a batch label, such as "OPEN" or "EXEC"
+     */
+    batch: boolean;
+    statements: Statement[];
+}
+/**
+ * A PROPERTYDEF declaration
+ */
+export interface Property extends Member {
+    /**
+     * The other Tokens in the declaration, currently unparsed.
+     */
+    modifiers: Token[];
+}
+/**
+ * Represents a parameter, always belonging to a Method
+ */
+export interface Parameter extends Member {
+    /**
+     * If the req keyword is used
+     */
+    req: boolean;
+    /**
+     * If the ret keyword is used
+     */
+    ret: boolean;
+    /**
+     * If the literal keyword is used.
+     */
+    literal: boolean;
+    /**
+     * The contents of the comment for the parameter, i.e.
+     * ```
+     * public String name(
+     * 		String p1 // a comment
+     * 		)
+     * ```
+     */
+    comment: Token;
+}
+/**
+ * A type declaration, typically found within a method.
+ */
+export interface Declaration extends Member {
+    /**
+     * The other Tokens in the declaration, currently unparsed.
+     */
+    modifiers: Token[];
+}
+/**
+ * An abstract syntax tree of a PSL document
+ */
+export interface ParsedDocument {
+    /**
+     * An array of Declarations that are not contained within a method.
+     * This will be empty for valid Profile 7.6 code but is maintained for compatibility.
+     */
+    declarations: Declaration[];
+    /**
+     * An array of PROPERTYDEF
+     */
+    properties: Property[];
+    /**
+     * An array of the methods in the document
+     */
+    methods: Method[];
+    /**
+     * All the tokens in the document, for reference.
+     */
+    tokens: Token[];
+    /**
+     * The Token that represents the parent class.
+     */
+    extending: Token;
+    /**
+     * The Token that represents the PSL package.
+     */
+    pslPackage: string;
+    /**
+     * The tokens corresponding to line and block comments.
+     */
+    comments: Token[];
+}
+export declare const NON_TYPE_MODIFIERS: string[];
+export declare function parseText(sourceText: string): ParsedDocument;
+export declare function parseFile(sourcePath: string): Promise<ParsedDocument>;