chore: Build update

.appveyor.yml

@@ -1,24 +1,22 @@
 version: 1.0.{build}
 image: Visual Studio 2015
 init:
-- git config --global core.autocrlf true
+  - git config --global core.autocrlf true
 install:
-- ps: Install-Product node 10
-- npm install -g npm@6
+  - ps: Install-Product node 10
+  - npm install -g npm@6
 branches:
   only:
-  - master
+    - master
 environment:
   JAVA6_HOME: C:/Program Files/Java/jdk1.6.0/jre
 build_script:
-- npm install
-- npm run tslint
-- npm run pack-tool
-- npm run pack-runtime
+  - npm install
+  - npm run lint
 test_script:
-- npm test
+  - npm test
 artifacts:
-- path: 'antlr4ts-*.tgz'
+  - path: "antlr4ts-*.tgz"
 cache:
-- node_modules -> **\package.json
-- C:\Users\appveyor\.m2 -> **\pom.xml
+  - node_modules -> **\package.json # do we need child node_modules?
+  - C:\Users\appveyor\.m2 -> **\pom.xml

.eslintignore

@@ -0,0 +1,7 @@
+!.eslintrc.js
+node_modules/
+dist
+gen
+cross-target
+reference
+runtime/typescript/*.js

.eslintrc.json

@@ -0,0 +1,22 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "rules": {
+    "@typescript-eslint/camelcase": 0,
+    "@typescript-eslint/no-explicit-any": 0,
+    "@typescript-eslint/no-namespace": 0,
+    "@typescript-eslint/no-non-null-assertion": 0,
+    "@typescript-eslint/no-unused-vars": 0,
+    "@typescript-eslint/no-use-before-define": 0,
+    "@typescript-eslint/no-var-requires": 0,
+    "no-case-declarations": 0,
+    "no-constant-condition": 0,
+    "no-inner-declarations": 0
+  }
+}

.gitignore

@@ -42,7 +42,7 @@ jspm_packages/
 /src/tree/xpath/XPathLexer.ts
 gen/
 /target/
-/tool/target/
+tool/typescript/target
 doc/
 
 # Visual Studio build output and per-user files
@@ -60,3 +60,8 @@ bin/
 
 # NPM pack output
 *.tgz
+
+**/dist
+tsconfig.tsbuildinfo
+test/runtime/cross-target/
+.antlr/

.mocharc.yml

@@ -0,0 +1,8 @@
+# mocha.opts:
+#
+# --require source-map-support/register
+# --recursive
+# test/dist
+
+spec: test/dist/**/*.js
+require: source-map-support/register

.travis.yml

@@ -11,6 +11,4 @@ script:
   - nyc --reporter=none mocha --timeout=10000
   - nyc report --reporter=text-lcov > coverage.lcov
   - codecov
-  - npm run tslint
-  - npm run pack-tool
-  - npm run pack-runtime
+  - npm run lint

.vscode/extensions.json

@@ -0,0 +1,10 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "donjayamanne.githistory",
+    "eamodio.gitlens",
+    "editorconfig.editorconfig",
+    "esbenp.prettier-vscode",
+    "mike-lischke.vscode-antlr4"
+  ]
+}

.vscode/launch.json

@@ -1,48 +1,49 @@
 {
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Debug Tests",
-            "type": "node",
-            "request": "launch",
-            "program": "${workspaceRoot}/node_modules/mocha/bin/_mocha",
-            "stopOnEntry": false,
-            "args": [
-                "--debug", "-R", "dot"
-            ],
-            "cwd": "${workspaceRoot}",
-            "preLaunchTask": "tsc",
-            "runtimeExecutable": null,
-            "runtimeArgs": [
-                "--nolazy"
-            ],
-            "env": {
-                "NODE_ENV": "development"
-            },
-            "console": "integratedTerminal",
-            "sourceMaps": true,
-            "outDir": "${workspaceRoot}/target"
-        },
-        {
-            "name": "Attach",
-            "type": "node",
-            "request": "attach",
-            "port": 5858,
-            "address": "localhost",
-            "restart": false,
-            "sourceMaps": true,
-            "outDir": null,
-            "localRoot": "${workspaceRoot}",
-            "remoteRoot": null
-        },
-        {
-            "name": "Attach to Process",
-            "type": "node",
-            "request": "attach",
-            "processId": "${command.PickProcess}",
-            "port": 5858,
-            "sourceMaps": true,
-            "outDir": "${workspaceRoot}/target"
-        }
-    ]
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug Tests",
+      "type": "node",
+      "request": "launch",
+      "program": "${workspaceRoot}/node_modules/mocha/bin/_mocha",
+      "stopOnEntry": false,
+      "args": [
+        "--debug",
+        "-R",
+        "dot"
+      ],
+      "cwd": "${workspaceRoot}",
+      "runtimeExecutable": null,
+      "runtimeArgs": [
+        "--nolazy"
+      ],
+      "env": {
+        "NODE_ENV": "development"
+      },
+      "console": "integratedTerminal",
+      "sourceMaps": true,
+      "outDir": "${workspaceRoot}/target"
+    },
+    {
+      "name": "Attach",
+      "type": "node",
+      "request": "attach",
+      "port": 5858,
+      "address": "localhost",
+      "restart": false,
+      "sourceMaps": true,
+      "outDir": null,
+      "localRoot": "${workspaceRoot}",
+      "remoteRoot": null
+    },
+    {
+      "name": "Attach to Process",
+      "type": "node",
+      "request": "attach",
+      "processId": "${command.PickProcess}",
+      "port": 5858,
+      "sourceMaps": true,
+      "outDir": "${workspaceRoot}/target"
+    }
+  ]
 }

.vscode/settings.json

@@ -1,7 +1,7 @@
-// Place your settings in this file to overwrite default and user settings.
 {
-    "typescript.tsdk": "./node_modules/typescript/lib",
     "editor.rulers": [
         120
-    ]
-}
+    ],
+    "typescript.tsdk": "./node_modules/typescript/lib",
+    "eslint.lintTask.enable": true
+}

.vscode/tasks.json

@@ -1,18 +1,32 @@
 {
-    // See https://go.microsoft.com/fwlink/?LinkId=733558
-    // for the documentation about the tasks.json format
-    "version": "2.0.0",
-    "command": "npm",
-    "type": "shell",
-    "args": ["run", "tsc-watch"],
-    "presentation": {
-        "echo": true,
-        "reveal": "silent",
-        "focus": false,
-        "panel": "shared",
-        "showReuseMessage": true,
-        "clear": false
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "npm",
+      "script": "tsc",
+      "problemMatcher": ["$tsc"],
+      "label": "npm: tsc",
+      "detail": "tsc --build"
     },
-    "isBackground": true,
-    "problemMatcher": "$tsc"
+    {
+      "type": "npm",
+      "script": "tsc-watch",
+      "problemMatcher": ["$tsc-watch"],
+      "label": "npm: tsc-watch",
+      "detail": "tsc --build --watch",
+      "isBackground": true,
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    },
+    {
+      "type": "npm",
+      "script": "lint",
+      "problemMatcher": ["$eslint-stylish"],
+      "label": "eslint: lint whole folder",
+      "group": "build",
+      "detail": "eslint . --ext .ts"
+    }
+  ]
 }

CONTRIBUTING.md

@@ -8,13 +8,21 @@ only be considered when sent from users who have signed the
 
 ## Building from Source
 
+### NPM vs YARN
+
+There are two significant package managers these days, NPM (which is included with Node.js), and YARN (which has been innovating.) Unfortunately the build process for antlr4ts currently does not support YARN.
+
+We'll try to change that in the future, but for now the desire to ship a stable version 1.0 release overcomes any short-term advantages YARN may offer. So use NPM for now.
+
+If you are deeply into YARN, the problem seems to be in that NPM creates symbolic links in the project root's node_module folder for antlr4ts and antlr4ts-cli, while YARN apparently copies the files instead. Unfortunately, the timing of the copy doesn't work, because under YARN, node_modules\antlr4ts-cli\target\antlr4-typescript-4.7.3-SNAPSHOT-complete.jar doesn't get included because it is copied before its build.
+
 ### Prerequisites
 
 Building this repository from source requires several tools:
 
-* Node.js 6.7.x
-* Maven 3.3.1+ (3.3.9+ recommended)
-* Java Development Kit 1.6+ (1.8+ recommended)
+- Node.js 6.7.x
+- Maven 3.3.1+ (3.3.9+ recommended)
+- Java Development Kit 1.6+ (1.8+ recommended)
 
 Users working in Visual Studio Code should update their workspace settings to specify the paths for the Java Development
 Kit and Apache Maven:
@@ -67,7 +75,7 @@ the actual file name produced by the profiler.
 node --prof-process isolate-000001C4B0FF38A0-v8.log >profile.txt
 ```
 
-The resulting file, `profile.txt` will contain a summary of the results from running a sampling profiler. 
+The resulting file, `profile.txt` will contain a summary of the results from running a sampling profiler.
 
 ## Versioning
 
@@ -116,38 +124,54 @@ ability to provide meaningful release notes.
 >
 > In addition to the above, building the design-time tool requires:
 >
->       - A Java development kit, 1.8x or greater (see above.)  
->       - The [Maven](https://maven.apache.org/download.cgi) project system after downloading, [set it up according to these instructions](https://maven.apache.org/install.html). 
+>       - A Java development kit, 1.8x or greater (see above.)
+>       - The [Maven](https://maven.apache.org/download.cgi) project system after downloading, [set it up according to these instructions](https://maven.apache.org/install.html).
 >
-> After you clone the project, run `npm install` from the root directory, this will install other runtime- and development-time dependencies.  
+> After you clone the project, run `npm install` from the root directory, this will install other runtime- and development-time dependencies.
 >
-> The first time you run `npm install`, it will build and install the current version of the **antlr4ts** tool locally.   After that, if you update the tool, you will need to execute the command `npm install tool`.   This includes if you pull any updates that change the tool. 
+> The first time you run `npm install`, it will build and install the current version of the **antlr4ts** tool locally. After that, if you update the tool, you will need to execute the command `npm install tool`. This includes if you pull any updates that change the tool.
 >
 > ## Dev setup with Visual Studio
+>
 > Any edition of [Visual Studio 2015](https://www.visualstudio.com/vs/) (or greater) should work, including Communitity Edition.
 > You'll want to be sure you have the following VS extensions installed:
+>
 > - [Node Tools for Visual Studio 1.2](https://www.visualstudio.com/vs/node-js/) (or greater)
 > - [TypeScript for Visual Studio 2015](https://www.microsoft.com/en-us/download/details.aspx?id=48593) 2.03 or greater.
 >
-> You ***should*** be able to run tests from the Test Explorer, etc... but there seems to be an unresolved problem making this work, for now use the command-line method below to be sure you run them all.
+> You **_should_** be able to run tests from the Test Explorer, etc... but there seems to be an unresolved problem making this work, for now use the command-line method below to be sure you run them all.
 >
 > ### Running basic tests should be as simple as...
+>
 > ```
 > npm test
 > ```
+>
 > How we integrate with runtime-testsuite is TBD.
 >
 > ### Generating test code coverage report
+>
 > ```
-> npm run cover 
+> npm run cover
 > ```
+>
 > This executes a code-coverage test run, then generates an interactive HTML report in `coverage/lcov-report/index.html`.
 >
 > ### Java Reference code
-> To view the Java code this project was derived from, use the following commands in the project root directory.   This *isn't* strictly needed for building the project, and the reference implementation is expected to be fairly stable.
+>
+> To view the Java code this project was derived from, use the following commands in the project root directory. This _isn't_ strictly needed for building the project, and the reference implementation is expected to be fairly stable.
 >
 > ```
 > git submodule init
 > git submodule update
 > ```
-> The later (update) command may need to be repeated occasionally after another contributor updates the version of reference code.
+>
+> The later (update) command may need to be repeated occasionally after another contributor updates the version of reference code.
+
+# A note on the build process
+
+The build process for this project has grown organically based on npm scripts. One part of those scripts used the
+**npm link** command, and with further experience, this seems to have caused a fragile build situation. As stands the
+build can leave npm **global** symlinks pointing into this build directory. They can effect what version of ANTLR4TS
+is used by other projects, outside this repository. For this reason, I'm removing them from package.json, but leaving
+in place a **npm run unlink** script which can help the cleanup process.

antlr4ts.njsproj

@@ -27,7 +27,7 @@
     <TypeScriptOutFile />
     <TypeScriptOutDir>$(MSBuildProjectDirectory)\target</TypeScriptOutDir>
     <TypeScriptGeneratesDeclarations>False</TypeScriptGeneratesDeclarations>
-    <TypeScriptNoEmitOnError>True</TypeScriptNoEmitOnError>
+    <TypeScriptNoEmitOnError>False</TypeScriptNoEmitOnError>
     <TypeScriptMapRoot>$(MSBuildProjectDirectory)\target</TypeScriptMapRoot>
     <TypeScriptSourceRoot />
   </PropertyGroup>