Merge pull request #3 from ing-bank/clean-references

Clean old references and fix findings.

.dictionaries/README.md

@@ -0,0 +1,21 @@
+# Dictionaries
+
+This folder contains dictionaries to be used by spell checkers programs to
+validate the special words used in this project.
+
+## Available dictionaries
+
+### Words
+
+Contains words used in this project.
+
+File: [words.dic](words.dic)
+
+## File format
+
+Plain text files with the dic extension, containing words separated with a
+newline.
+
+## Adding words guidelines
+
+Please only add words that make sense, and in the appropriate dictionary.

.dictionaries/words.dic

@@ -0,0 +1,4 @@
+CLASSDEF
+ENDDOC
+PROPERTYDEF
+REVHIST

.github/workflows/build_test.yml

@@ -22,5 +22,5 @@ jobs:
         node-version: '16.x'
         cache: 'npm'  
     - run: npm install
-    - run: npm run compile
+    - run: npm run build
     - run: npm test

.gitignore

@@ -1,8 +1,9 @@
-*.jrnl
-*.log
-out
-node_modules
-*.vsix
-.project
-.settings
-.classpath
+# Dependency directory
+node_modules/
+
+# Editors
+.idea/
+
+# Project build
+lib/
+*.tgz

.npmignore

@@ -1,6 +1,13 @@
-*.ts
-!*.d.ts
-tsconfig.json
-*.tgz
-.npmrc*
+# Exclude all files
+*
+
+# Add lib/
+!lib/**
+# Exclude exceptions from lib/
 *.map
+*.tsbuildinfo
+
+# Add documentation
+!LICENSE
+!CHANGELOG.md
+!README.md

.npmrc

@@ -0,0 +1,4 @@
+always-auth=true
+registry=https://registry.npmjs.org
+//registry.npmjs.org/:_authToken=${PARSER_TOKEN}
+//registry.npmjs.org/:username=${PARSER_USER}

.vscode/settings.json

@@ -1,10 +1,9 @@
-// Place your settings in this file to overwrite default and user settings.
 {
     "files.exclude": {
-        "out": false // set this to true to hide the "out" folder with the compiled JS files
+        "lib": false
     },
     "search.exclude": {
-        "out": true // set this to false to include "out" folder in search results
+        "lib": true
     },
-    "editor.rulers": [120] // Recommended typescript ruler
-}
+    "editor.rulers": [120]
+}

package.json

@@ -9,23 +9,27 @@
     "scripting",
     "language"
   ],
-  "homepage": "https://github.com/ing-bank/vscode-psl#readme",
+  "homepage": "https://github.com/ing-bank/psl-parser#readme",
   "bugs": {
-    "url": "https://github.com/ing-bank/vscode-psl/issues"
+    "url": "https://github.com/ing-bank/psl-parser/issues"
   },
   "license": "MIT",
   "author": "atiplea",
   "contributors": [
     "SOliveira"
   ],
-  "main": "out/index.js",
+  "main": "lib/index.js",
+  "types": "lib/types/index.js",
   "repository": {
     "type": "git",
-    "url": "https://github.com/ing-bank/vscode-psl.git"
+    "url": "https://github.com/ing-bank/psl-parser.git"
   },
   "scripts": {
-    "compile": "tsc -p ./",
-    "watch": "npm run compile -- -watch",
+    "prebuild": "rimraf lib",
+    "build": "tsc --build src",
+    "lint": "tslint -c tslint.json --project .",
+    "watch": "npm run build -- -watch",
+    "pretest": "tsc --build src",
     "test": "jest"
   },
   "dependencies": {
@@ -39,6 +43,7 @@
     "ts-jest": "^29.0.3",
     "tslint": "^5.20.1",
     "typescript": "^4.8.4",
-    "jsonc-parser": "^3.2.0"
+    "jsonc-parser": "^3.2.0",
+    "rimraf": "^3.0.2"
   }
 }

src/parser/parser.ts → src/parser.ts

@@ -157,7 +157,7 @@ export interface ParsedDocument {
 	declarations: Declaration[];
 
 	/**
-	 * An array of PROPERTYDEFs
+	 * An array of PROPERTYDEF
 	 */
 	properties: Property[];
 
@@ -328,16 +328,17 @@ class Parser {
 					if (documentation) this.activeMethod.documentation = documentation;
 				}
 			}
-			else if (this.activeToken.isNewLine()) continue;
-			else this.throwAwayTokensTil(Type.NewLine);
+			else if (!this.activeToken.isNewLine()) {
+				this.throwAwayTokensTil(Type.NewLine);
+			}
 		}
 		return {
 			comments: this.comments,
 			declarations: this.declarations,
 			extending: this.extending,
-			pslPackage: this.pslPackage,
 			methods: this.methods,
 			properties: this.properties,
+			pslPackage: this.pslPackage,
 			tokens: this.tokens,
 		};
 	}
@@ -580,7 +581,9 @@ class Parser {
 	}
 
 	private throwAwayTokensTil(type: Type) {
-		while (this.next() && this.activeToken.type !== type);
+		while (this.next()) {
+			if (this.activeToken.type === type) break;
+		}
 	}
 
 	private loadTokenBuffer() {

src/parser/statementParser.ts → src/statementParser.ts

@@ -1,4 +1,4 @@
-import { getTokens, Token, Type } from './tokenizer';
+import {getTokens, Token, Type} from './tokenizer';
 
 export enum SyntaxKind {
 	ASSIGNMENT,
@@ -402,7 +402,7 @@ export class StatementParser {
 		const spaceOrExpression = this.activeToken;
 		if (spaceOrExpression.isSpace()) {
 			this.next();
-			return forStatement; // argumentless for
+			return forStatement; // argument less for
 		}
 		const expression = this.parseExpression();
 		if (expression) forStatement.expressions.push(expression);
@@ -484,13 +484,12 @@ export class StatementParser {
 		while (this.activeToken && this.activeToken.isColon()) {
 			const colonToken = this.activeToken;
 			this.next(true);
-			const colon: BinaryOperator = {
+			rootNode = {
 				kind: SyntaxKind.BINARY_OPERATOR,
 				left: rootNode,
 				operator: [colonToken],
 				right: this.parseValue(),
 			};
-			rootNode = colon;
 		}
 		return rootNode;
 	}
@@ -747,6 +746,7 @@ export function forEachChild(node: Node, f: (n: Node) => boolean) {
 			const declaration = node as DeclarationStatement;
 			if (declaration.args) declaration.args.forEach(arg => forEachChild(arg, f));
 			f(declaration.type);
+			break;
 		case SyntaxKind.NUMERIC_LITERAL:
 		case SyntaxKind.STRING_LITERAL:
 			f(node);

src/tsconfig.json

@@ -0,0 +1,7 @@
+{
+    "extends": "../tsconfig-base.json",
+    "compilerOptions": {
+        "composite": true,
+    }
+}
+

test/parser.test.ts

@@ -1,5 +1,5 @@
-import * as parser from '../src/parser/parser';
-import * as tokenizer from '../src/parser/tokenizer';
+import * as parser from '../src/parser';
+import * as tokenizer from '../src/tokenizer';
 
 function getMethod(methodString: string): parser.Method | undefined {
 	const d = parser.parseText(methodString);
@@ -209,7 +209,7 @@ describe('Argument Names', () => {
 		expect(argNameValues).toEqual(['x1', 'x2']);
 	});
 
-	test('1 argument multitype', () => {
+	test('1 argument multi type', () => {
 		const methodString = 'public static void main(void x1(Integer, Record))';
 		const result = getMethod(methodString);
 		if (!result) {
@@ -220,7 +220,7 @@ describe('Argument Names', () => {
 		expect(argNameValues).toEqual(['x1']);
 	});
 
-	test('2 argument multitype', () => {
+	test('2 argument multi type', () => {
 		const methodString = 'public static void main(void x1(Integer, Record), void x2(void, String))';
 		const result = getMethod(methodString);
 		if (!result) {
@@ -231,7 +231,7 @@ describe('Argument Names', () => {
 		expect(argNameValues).toEqual(['x1', 'x2']);
 	});
 
-	test('2 argument multitype', () => {
+	test('2 argument multiline and multi type', () => {
 		const methodString = 'public static void main(void x1(Integer, Record)\n\t, void x2(void, String))';
 		const result = getMethod(methodString);
 		if (!result) {
@@ -299,7 +299,7 @@ describe('Argument Types', () => {
 		expect(argValues).toEqual([['String']]);
 	});
 
-	test('1 argument multitype', () => {
+	test('1 argument multi type', () => {
 		const methodString = 'public static void main(String x1(Number))';
 		const result = getMethod(methodString);
 		if (!result) {
@@ -681,15 +681,15 @@ describe('type declarations', () => {
 		expect(doc.declarations[0].types[0].value).toEqual('String');
 		expect(doc.declarations[0].id.value).toEqual('x');
 	});
-	test('mutliple type declaration', () => {
+	test('multiple type declaration', () => {
 		const declarationString = '\ttype public literal String x,y';
 		const doc = getParsedDoc(declarationString);
 		expect(doc.declarations[0].types[0].value).toEqual('String');
 		expect(doc.declarations[0].id.value).toEqual('x');
 		expect(doc.declarations[1].types[0].value).toEqual('String');
 		expect(doc.declarations[1].id.value).toEqual('y');
 	});
-	test('mutliple multitype type declaration', () => {
+	test('multiple multi type type declaration', () => {
 		const declarationString = '\ttype public literal String x(Number,Boolean),y';
 		const doc = getParsedDoc(declarationString);
 		expect(doc.declarations[0].types[0].value).toEqual('String');
@@ -699,7 +699,7 @@ describe('type declarations', () => {
 		expect(doc.declarations[1].types[0].value).toEqual('String');
 		expect(doc.declarations[1].id.value).toEqual('y');
 	});
-	test('mutliple type declaration equal sign', () => {
+	test('multiple type declaration equal sign', () => {
 		const declarationString = '\ttype String x = "hi", y = "hi"';
 		const doc = getParsedDoc(declarationString);
 		expect(doc.declarations[0].types[0].value).toEqual('String');

test/statementParser.test.ts

@@ -1,8 +1,8 @@
 import {
 	BinaryOperator, DeclarationStatement, Expression, Identifier, MultiSet, NumericLiteral,
 	PostCondition, Statement, StatementParser, StringLiteral, SyntaxKind, TypeIdentifier, Value,
-} from '../src/parser/statementParser';
-import { getTokens, Token } from '../src/parser/tokenizer';
+} from '../src';
+import { getTokens, Token } from '../src/tokenizer';
 
 function parse(text: string) {
 	return new StatementParser(getTokens(text));
@@ -126,18 +126,18 @@ describe('recursive tests', () => {
 		expect(start.id).toBe(parser.tokens[2]);
 	});
 	test('Runtime start', () => {
-		const parser = parse('Runtime.start("BA",varlist)');
+		const parser = parse('Runtime.start("BA",varList)');
 		const dotNode = parser.parseExpression() as BinaryOperator;
 		const runtime = dotNode.left as Identifier;
 		const start = dotNode.right as Identifier;
 		const args = start.args as Value[];
 		const ba = args[0];
-		const varlist = args[1];
+		const varList = args[1];
 		expect(dotNode.kind === SyntaxKind.BINARY_OPERATOR);
 		expect(runtime.id).toBe(parser.tokens[0]);
 		expect((start).id).toBe(parser.tokens[2]);
 		expect(ba.id).toBe(parser.tokens[5]);
-		expect(varlist.id).toBe(parser.tokens[8]);
+		expect(varList.id).toBe(parser.tokens[8]);
 	});
 	test('grandchild', () => {
 		const parser = parse('a.b.c');
@@ -545,7 +545,7 @@ describe('recursive tests', () => {
 		expect(i.id.value).toBe('i');
 		expect(initial.id.value).toBe('1');
 	});
-	test('argumentless for loop', () => {
+	test('argument less for loop', () => {
 		const parser = parse('for  set x = 1');
 		const statements = parser.parseLine();
 		const forStatement = statements[0];
@@ -563,7 +563,7 @@ describe('recursive tests', () => {
 		expect(args.length).toBe(3);
 	});
 	test('for order', () => {
-		const parser = parse('for  set seq=tras(seq).order() quit:seq.isNull()  do set(tras(seq))');
+		const parser = parse('for  set seq=array(seq).order() quit:seq.isNull()  do set(array(seq))');
 		const statements = parser.parseLine();
 		const setStatement = statements[1];
 		const equal = setStatement.expressions[0] as BinaryOperator;