forked from jasder/antlr
adapted antlr4 js to use webpack for browser publishing
lib/require.js custom require removed in favour of webpack bundle documentation updated package-lock.json added
This commit is contained in:
Camilo Roca
parent
7fc2180166
commit
c2180d2d5c
|
|
@ -57,7 +57,7 @@ Edit the repository looking for 4.5 or whatever and update it. Bump version in t
|
|||
* runtime/Python3/src/antlr4/Recognizer.py
|
||||
* runtime/CSharp/runtime/CSharp/Antlr4.Runtime/Properties/AssemblyInfo.cs
|
||||
* runtime/CSharp/runtime/CSharp/Antlr4.Runtime/Antlr4.Runtime.dotnet.csproj
|
||||
* runtime/JavaScript/src/antlr4/package.json
|
||||
* runtime/JavaScript/package.json
|
||||
* runtime/JavaScript/src/antlr4/Recognizer.js
|
||||
* runtime/Cpp/VERSION
|
||||
* runtime/Cpp/runtime/src/RuntimeMetaData.cpp
|
||||
|
|
@ -277,16 +277,14 @@ git push origin gh-pages
|
|||
### JavaScript
|
||||
|
||||
```bash
|
||||
cd runtime/JavaScript/src
|
||||
zip -r /tmp/antlr-javascript-runtime-4.8.zip antlr4
|
||||
cp /tmp/antlr-javascript-runtime-4.8.zip ~/antlr/sites/website-antlr4/download
|
||||
cd runtime/JavaScript
|
||||
# git add, commit, push
|
||||
```
|
||||
|
||||
**Push to npm**
|
||||
|
||||
```bash
|
||||
cd runtime/JavaScript/src
|
||||
cd runtime/JavaScript
|
||||
npm login
|
||||
npm publish antlr4
|
||||
```
|
||||
|
|
@ -294,11 +292,8 @@ npm publish antlr4
|
|||
Move target to website
|
||||
|
||||
```bash
|
||||
pushd ~/antlr/sites/website-antlr4/download
|
||||
git add antlr-javascript-runtime-4.8.zip
|
||||
git commit -a -m 'update JS runtime'
|
||||
git push origin gh-pages
|
||||
popd
|
||||
npm build
|
||||
cp /dist/antlr4.js ~/antlr/sites/website-antlr4/download
|
||||
```
|
||||
|
||||
### CSharp
|
||||
|
|
|
|||
|
|
@ -0,0 +1,2 @@
|
|||
/dist/
|
||||
/node_modules
|
||||
|
|
@ -8,6 +8,28 @@ This runtime has been tested in Node.js, Safari, Firefox, Chrome and IE.
|
|||
|
||||
See www.antlr.org for more information on ANTLR
|
||||
|
||||
See https://github.com/antlr/antlr4/blob/master/doc/javascript-target.md for more information on using ANTLR in JavaScript
|
||||
See [Javascript Target](https://github.com/antlr/antlr4/blob/master/doc/javascript-target.md)
|
||||
for more information on using ANTLR in JavaScript
|
||||
|
||||
|
||||
## publishing
|
||||
|
||||
The JavaScript itself is tested using npm, so assumption is npm is already installed.
|
||||
The current npm version used is 3.10.9.
|
||||
|
||||
### to npm
|
||||
|
||||
The publishing itself relies on the information in package.json.
|
||||
To publish run `npm login` from Terminal, then `npm publish antlr4`
|
||||
|
||||
That's it!
|
||||
|
||||
### to browser
|
||||
|
||||
To publish antlr4 for browser usage you need to bundle it into a single
|
||||
file with `npm build`. This will create `dist/antlr4.js` file. Upload it
|
||||
to your favourite server.
|
||||
|
||||
That's it!
|
||||
|
||||
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -2,7 +2,7 @@
|
|||
"name": "antlr4",
|
||||
"version": "4.8.0",
|
||||
"description": "JavaScript runtime for ANTLR4",
|
||||
"main": "index.js",
|
||||
"main": "src/antlr4/index.js",
|
||||
"repository": "antlr/antlr4.git",
|
||||
"keywords": [
|
||||
"lexer",
|
||||
|
|
@ -15,5 +15,15 @@
|
|||
"bugs": {
|
||||
"url": "https://github.com/antlr/antlr4/issues"
|
||||
},
|
||||
"homepage": "https://github.com/antlr/antlr4"
|
||||
"homepage": "https://github.com/antlr/antlr4",
|
||||
"devDependencies": {
|
||||
"webpack": "^4.41.5",
|
||||
"webpack-cli": "^3.3.10"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "webpack"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=10"
|
||||
}
|
||||
}
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
# JavaScript target for ANTLR 4
|
||||
|
||||
JavaScript runtime libraries for ANTLR 4
|
||||
|
||||
This runtime is available through npm. The package name is 'antlr4'.
|
||||
|
||||
This runtime has been tested in Node.js, Safari, Firefox, Chrome and IE.
|
||||
|
||||
See www.antlr.org for more information on ANTLR
|
||||
|
||||
See https://github.com/antlr/antlr4/blob/master/doc/javascript-target.md for more information on using ANTLR in JavaScript
|
||||
|
||||
|
||||
|
|
@ -1,267 +0,0 @@
|
|||
//
|
||||
// This file is part of Honey Require
|
||||
//
|
||||
// Copyright (c) 2015 Torben Haase
|
||||
//
|
||||
// Honey Require is free software: you can redistribute it and/or modify it
|
||||
// under the terms of the MIT License (MIT).
|
||||
//
|
||||
// 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.
|
||||
//
|
||||
// You should have received a copy of the MIT License along with Honey Require.
|
||||
// If not, see <https://opensource.org/licenses/MIT>.
|
||||
//
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// NOTE The load parameter points to the function, which prepares the
|
||||
// environment for each module and runs its code. Scroll down to the end of
|
||||
// the file to see the function definition.
|
||||
(function(load) { 'use strict';
|
||||
|
||||
// NOTE Mozilla still sets the wrong fileName property for errors that occur
|
||||
// inside an eval call (even with sourceURL). However, the stack
|
||||
// contains the correct source, so it can be used to re-threw the error
|
||||
// with the correct fileName property.
|
||||
// WARN Re-throwing an error object will mess up the stack trace and the
|
||||
// column number.
|
||||
if (typeof (new Error()).fileName == "string") {
|
||||
self.addEventListener("error", function(evt) {
|
||||
if (evt.error instanceof Error) {
|
||||
if (pwd[0]) {
|
||||
evt.preventDefault();
|
||||
throw new evt.error.constructor(evt.error.message, pwd[0].uri, evt.error.lineNumber);
|
||||
}
|
||||
else {
|
||||
var m = evt.error.stack.match(/^[^\n@]*@([^\n]+):\d+:\d+/);
|
||||
if (m === null) {
|
||||
console.warn("Honey: unable to read file name from stack");
|
||||
}
|
||||
else if (evt.error.fileName != m[1]) {
|
||||
evt.preventDefault();
|
||||
throw new evt.error.constructor(evt.error.message, m[1], evt.error.lineNumber);
|
||||
}
|
||||
}
|
||||
}
|
||||
}, false);
|
||||
}
|
||||
|
||||
// INFO Current module descriptors
|
||||
// pwd[0] contains the descriptor of the currently loaded module,
|
||||
// pwd[1] contains the descriptor its parent module and so on.
|
||||
|
||||
var pwd = Array();
|
||||
|
||||
// INFO Path parser
|
||||
// Older browsers don't support the URL interface, therefore we use an
|
||||
// anchor element as parser in that case. Thes breaks web worker support,
|
||||
// but we don't care since these browsers also don't support web workers.
|
||||
|
||||
var parser = (function() {
|
||||
try {
|
||||
return new URL(location.href);
|
||||
} catch(e) {
|
||||
var p = Object.create(location);
|
||||
// need to set writable, because WorkerLocation is read-only
|
||||
Object.defineProperty(p, "href", {writable:true});
|
||||
return p;
|
||||
}
|
||||
})();
|
||||
|
||||
// INFO Module cache
|
||||
// Contains getter functions for the exports objects of all the loaded
|
||||
// modules. The getter for the module 'mymod' is name '$name' to prevent
|
||||
// collisions with predefined object properties (see note below).
|
||||
// As long as a module has not been loaded the getter is either undefined
|
||||
// or contains the module code as a function (in case the module has been
|
||||
// pre-loaded in a bundle).
|
||||
// WARN IE8 supports defineProperty only for DOM objects, therfore we use a
|
||||
// HTMLDivElement as cache in that case. This breaks web worker support,
|
||||
// but we don't care since IE8 has no web workers at all.
|
||||
|
||||
try {
|
||||
var cache = new Object();
|
||||
Object.defineProperty(cache, "foo", {'value':"bar",'configurable':true});
|
||||
delete cache.foo;
|
||||
}
|
||||
catch (e) {
|
||||
console.warn("Honey: falling back to DOM workaround for cache object ("+e+")");
|
||||
cache = document.createElement('DIV');
|
||||
}
|
||||
|
||||
// INFO Send lock
|
||||
// Sending the request causes the event loop to continue. Therefore
|
||||
// pending AJAX load events for the same url might be executed before
|
||||
// the synchronous onLoad is called. This should be no problem, but in
|
||||
// Chrome the responseText of the sneaked in load events will be empty.
|
||||
// Therefore we have to lock the loading while executing send().
|
||||
|
||||
var lock = new Object();
|
||||
|
||||
// INFO Honey options
|
||||
// The values can be set by defining a object called Honey. The
|
||||
// Honey object has to be defined before this script here is loaded
|
||||
// and changing the values in the Honey object will have no effect
|
||||
// afterwards!
|
||||
|
||||
var requirePath = self.Honey&&self.Honey.requirePath!==undefined ? self.Honey.requirePath.slice(0) : ['./'];
|
||||
var requireCompiler = self.Honey&&self.Honey.requireCompiler!==undefined ? self.Honey.requireCompiler : null;
|
||||
|
||||
// NOTE Parse module root paths
|
||||
var base = [location.origin, location.href.substr(0, location.href.lastIndexOf("/")+1)];
|
||||
for (var i=0; i<requirePath.length; i++) {
|
||||
parser.href = (requirePath[i][0]=="."?base[1]:base[0])+requirePath[i];
|
||||
requirePath[i] = parser.href;
|
||||
}
|
||||
|
||||
// NOTE Add preloaded modules to cache
|
||||
for (var id in (self.Honey && self.Honey.requirePreloaded))
|
||||
cache['$'+resolve(id).id] = self.Honey.requirePreloaded[id].toString();
|
||||
|
||||
// NOTE Add module overrides to cache
|
||||
for (var id in (self.Honey && self.Honey.requireOverrides))
|
||||
cache['$'+resolve(id).id] = self.Honey.requireOverrides[id];
|
||||
|
||||
// INFO Module getter
|
||||
// Takes a module identifier, resolves it and gets the module code via an
|
||||
// AJAX request from the module URI. If this was successful the code and
|
||||
// some environment variables are passed to the load function. The return
|
||||
// value is the module's `exports` object. If the cache already
|
||||
// contains an object for the module id, this object is returned directly.
|
||||
// NOTE If a callback function has been passed, the AJAX request is asynchronous
|
||||
// and the mpdule exports are passed to the callback function after the
|
||||
// module has been loaded.
|
||||
|
||||
function require(identifier, callback, compiler) {
|
||||
if (identifier instanceof Array) {
|
||||
var modules = new Array();
|
||||
var modcount = identifier.length;
|
||||
for (var index = 0; index < identifier.length; index++) {
|
||||
(function(id, i) {
|
||||
modules.push(require(id, callback&&function(mod) {
|
||||
modules[i] = mod;
|
||||
(--modcount==0) && callback(modules);
|
||||
}, compiler));
|
||||
})(identifier[index], index);
|
||||
}
|
||||
return modules;
|
||||
}
|
||||
|
||||
compiler = compiler!==undefined ? compiler : requireCompiler;
|
||||
var descriptor = resolve(identifier);
|
||||
var cacheid = '$'+descriptor.id;
|
||||
|
||||
if (cache[cacheid]) {
|
||||
if (typeof cache[cacheid] === 'string')
|
||||
load(descriptor, cache, pwd, cache[cacheid]);
|
||||
// NOTE The callback should always be called asynchronously to ensure
|
||||
// that a cached call won't differ from an uncached one.
|
||||
callback && setTimeout(function(){callback(cache[cacheid])}, 0);
|
||||
return cache[cacheid];
|
||||
}
|
||||
|
||||
var request = new XMLHttpRequest();
|
||||
|
||||
// NOTE IE8 doesn't support the onload event, therefore we use
|
||||
// onreadystatechange as a fallback here. However, onreadystatechange
|
||||
// shouldn't be used for all browsers, since at least mobile Safari
|
||||
// seems to have an issue where onreadystatechange is called twice for
|
||||
// readyState 4.
|
||||
callback && (request[request.onload===null?'onload':'onreadystatechange'] = onLoad);
|
||||
request.open('GET', descriptor.uri, !!callback);
|
||||
lock[cacheid] = lock[cacheid]++||1;
|
||||
request.send();
|
||||
lock[cacheid]--;
|
||||
!callback && onLoad();
|
||||
return cache[cacheid];
|
||||
|
||||
function onLoad() {
|
||||
if (request.readyState != 4)
|
||||
return;
|
||||
if (request.status != 200)
|
||||
throw new Error("Honey: unable to load "+descriptor.id+" ("+request.status+" "+request.statusText+")");
|
||||
if (lock[cacheid]) {
|
||||
console.warn("Honey: module locked: "+descriptor.id);
|
||||
callback && setTimeout(onLoad, 0);
|
||||
return;
|
||||
}
|
||||
if (!cache[cacheid]) {
|
||||
var source = compiler ? compiler(request.responseText) : request.responseText;
|
||||
load(descriptor, cache, pwd, 'function(){\n'+source+'\n}');
|
||||
}
|
||||
callback && callback(cache[cacheid]);
|
||||
}
|
||||
}
|
||||
|
||||
// INFO Module resolver
|
||||
// Takes a module identifier and resolves it to a module id and URI. Both
|
||||
// values are returned as a module descriptor, which can be passed to
|
||||
// `fetch` to load a module.
|
||||
|
||||
function resolve(identifier) {
|
||||
// NOTE Matches [1]:[..]/[path/to/][file][.js]
|
||||
var m = identifier.match(/^(?:([^:\/]+):)?(\.\.?)?\/?((?:.*\/)?)([^\.]+)?(\..*)?$/);
|
||||
// NOTE Matches [1]:[/path/to/]file.js
|
||||
var p = (pwd[0]?pwd[0].id:"").match(/^(?:([^:\/]+):)?(.*\/|)[^\/]*$/);
|
||||
var root = m[2] ? requirePath[p[1]?parseInt(p[1]):0] : requirePath[m[1]?parseInt(m[1]):0];
|
||||
parser.href = (m[2]?root+p[2]+m[2]+'/':root)+m[3]+(m[4]?m[4]:'index');
|
||||
var uri = parser.href+(m[5]?m[5]:'.js');
|
||||
if (uri.substr(0,root.length) != root)
|
||||
throw new Error("Honey: relative identifier outside of module root");
|
||||
var id = (m[1]?m[1]+":":"0:")+parser.href.substr(root.length);
|
||||
return {'id':id,'uri':uri};
|
||||
}
|
||||
|
||||
// INFO Exporting require to global scope
|
||||
|
||||
if (self.require !== undefined)
|
||||
throw new Error("Honey: '\'require\' already defined in global scope");
|
||||
|
||||
try {
|
||||
Object.defineProperty(self, 'require', {'value':require});
|
||||
Object.defineProperty(self.require, 'resolve', {'value':resolve});
|
||||
Object.defineProperty(self.require, 'path', {'get':function(){return requirePath.slice(0);}});
|
||||
}
|
||||
catch (e) {
|
||||
// NOTE IE8 can't use defineProperty on non-DOM objects, so we have to fall
|
||||
// back to unsave property assignments in this case.
|
||||
self.require = require;
|
||||
self.require.resolve = resolve;
|
||||
self.require.path = requirePath.slice(0);
|
||||
}
|
||||
|
||||
})(
|
||||
|
||||
// INFO Module loader
|
||||
// Takes the module descriptor, the global variables and the module code,
|
||||
// sets up the module envirinment, defines the module getter in the cache
|
||||
// and evaluates the module code. If module is a bundle the code of the
|
||||
// pre-loaded modules will be stored in the cache afterwards.
|
||||
// NOTE This functions is defined as an anonymous function, which is passed as
|
||||
// a parameter to the closure above to provide a clean environment (only
|
||||
// global variables, module and exports) for the loaded module. This is
|
||||
// also the reason why `source`, `pwd` & `cache` are not named parameters.
|
||||
// NOTE If we would strict use mode here, the evaluated code would be forced to be
|
||||
// in strict mode, too.
|
||||
|
||||
function /*load*/(module/*, cache, pwd, source*/) {
|
||||
var global = self;
|
||||
var exports = new Object();
|
||||
Object.defineProperty(module, 'exports', {'get':function(){return exports;},'set':function(e){exports=e;}});
|
||||
arguments[2].unshift(module);
|
||||
Object.defineProperty(arguments[1], '$'+module.id, {'get':function(){return exports;}});
|
||||
arguments[3] = '('+arguments[3]+')();\n//# sourceURL='+module.uri;
|
||||
eval(arguments[3]);
|
||||
// NOTE Store module code in the cache if the loaded file is a bundle
|
||||
if (typeof module.id !== 'string')
|
||||
for (id in module)
|
||||
arguments[1]['$'+require.resolve(id).id] = module[id].toString();
|
||||
arguments[2].shift();
|
||||
}
|
||||
|
||||
);
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
publishing to npm
|
||||
=================
|
||||
The JavaScript runtime is published on npm.
|
||||
There is nothing to build since JavaScript is based on source code only.
|
||||
The JavaScript itself is tested using npm, so assumption is npm is already installed.
|
||||
The current npm version used is 3.10.9.
|
||||
The publishing itself relies on the information in src/antlr4/package.json.
|
||||
To publish, from Terminal, you need to navigate to the src/ directory.
|
||||
Once there, login: npm login
|
||||
Then npm publish antlr4
|
||||
That's it!
|
||||
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
const path = require('path')
|
||||
|
||||
module.exports = {
|
||||
mode: "production",
|
||||
entry: './src/antlr4/index.js',
|
||||
output: {
|
||||
filename: 'antlr4.js',
|
||||
path: path.resolve(__dirname, 'dist'),
|
||||
// the name of the exported antlr4
|
||||
library: "antlr4",
|
||||
libraryTarget: 'window'
|
||||
},
|
||||
node: {
|
||||
module: "empty",
|
||||
net: "empty",
|
||||
fs: "empty"
|
||||
},
|
||||
target: "web"
|
||||
}
|
||||
Loading…
Reference in New Issue