[add] getDocLinks

CHANGELOG.md

@@ -1,3 +1,9 @@
+## [0.2.3] 2023-05-15
+* [mod] update npm dependancies
+* [fix] handling of default function namespace #24 
+* [fix] module level xqdoc comments #25
+* [add] documentLink support
+
 ## [0.2.2] 2023-04-22
 * [xqdoc] vars and functions have .comments created from xqdoc style comments
 

lib/compiler/handlers.js

@@ -25,7 +25,8 @@ exports.ModuleDecl = function(translator, rootSctx, node){
     };
 };
 
-exports.ModuleImport = function(translator, rootSctx, node) {
+
+exports.ModuleImport = function(translator, rootSctx, node,ats) {
     var prefix = '';
     var moduleURI;
     //location hints
@@ -35,18 +36,13 @@ exports.ModuleImport = function(translator, rootSctx, node) {
             prefix = TreeOps.flatten(ncname);
         },
 
-        URILiteral: function(uri) {
-            uri = TreeOps.flatten(uri);
+        URILiteral: function(node) {
+            let uri = TreeOps.flatten(node);
             uri = uri.substring(1, uri.length - 1);
-            if(moduleURI !== undefined) {
-                //location hints
-                console.log("AT: ",uri);
-                return;
-            }
-
+            if(moduleURI !== undefined) return ;  //location hints          
             moduleURI = uri;
             translator.apply(function(){
-                rootSctx.importModule(uri, prefix, node.pos);
+                rootSctx.importModule(uri, prefix, node.pos,ats);
             });
         }
     };

lib/compiler/static_context.js

@@ -221,14 +221,16 @@ exports.StaticContext = function (parent, pos, processor) {
         defaultElementNamespace: '',
         namespaces: namespaces,
         availableModuleNamespaces: [],
-        importModule: function (uri, prefix, pos) {
+        locations: {},  // ns:{location:..,pos:..}
+        importModule: function (uri, prefix, pos,ats) {
             if (this !== this.root) {
                 throw new Error('Function not invoked from the root static context.');
             }
-            this.addNamespace(uri, prefix, pos, 'module');
+            this.addNamespace(uri, prefix, pos, 'module',ats);
+           // if(ats && ats.length>0 ) console.log("$$$"+ats[0]);
             if (this.moduleResolver) {
                 try {
-                    var mod = this.moduleResolver(uri, []);
+                    var mod = this.moduleResolver(uri, ats);
                     if (mod.variables) {
                         TreeOps.concat(this.variables, mod.variables);
                     }
@@ -241,7 +243,9 @@ exports.StaticContext = function (parent, pos, processor) {
             }
             return this;
         },
-
+        getDocLinks: function () {
+            return this.locations;
+        },
         getAvailableModuleNamespaces: function () {
             return this.root.availableModuleNamespaces;
         },
@@ -250,7 +254,7 @@ exports.StaticContext = function (parent, pos, processor) {
             return this.root.namespaces[uri].prefixes;
         },
 
-        addNamespace: function (uri, prefix, pos, type) {
+        addNamespace: function (uri, prefix, pos, type,ats) {
             if (prefix === '' && type === 'module') {
                 throw new StaticWarning('W01', 'Avoid this type of import. Use import module namespace instead', pos);
             }
@@ -281,7 +285,7 @@ exports.StaticContext = function (parent, pos, processor) {
                 pos: pos,
                 type: type
             };
-
+            if(ats && ats.length) this.locations[uri]=ats;
             if (namespace && !namespace.override && !(namespace.uri = uri)) {
                 throw new StaticWarning('W02', '"' + uri + '" already bound to the "' + namespace.prefixes.join(', ') + '" prefix', pos);
             }

lib/compiler/translator.js

@@ -161,7 +161,18 @@ exports.Translator = function(rootStcx, ast){
     };
 
     this.ModuleImport = function (node) {
-        this.visitChildren(node, Handlers.ModuleImport(translator, rootStcx, node));
+        let ats=[],seenAt=false;
+        this.visitChildren(node,{
+            TOKEN: function(token){
+                seenAt="at"===token.value;
+            },
+            URILiteral: function(node) {
+                if(!seenAt) return;
+                var uri = TreeOps.flatten(node);
+                uri = uri.substring(1, uri.length - 1);
+                ats.push({location:uri,pos: node.pos});
+        }}); 
+        this.visitChildren(node, Handlers.ModuleImport(translator, rootStcx, node,ats));
         return true;
     };
 

lib/xqlint.js

@@ -42,7 +42,7 @@ exports.XQLint = function (source, opts) {
     //ACE editor worker hack
     opts = { ...defaults, ...opts }
 
-    var ast, xqdoc;
+    var ast;
     var sctx = opts.staticContext ? opts.staticContext : createStaticContext(opts.processor);
 
     this.getAST = function (pos) {
@@ -59,6 +59,11 @@ exports.XQLint = function (source, opts) {
         return xqdoc.getXQDoc(withPos);
     };
 
+    this.getDocLinks = function () {
+        const dl=sctx.getDocLinks();
+        return dl;
+    };
+
     var markers = [];
     this.getMarkers = function () {
         return markers;

package.json

@@ -2,7 +2,7 @@
   "author": "Andy Bunce <bunce.andy@gmail.com> (https://github.com/apb2006)",
   "name": "@quodatum/xqlint",
   "description": "XQuery Quality Checker",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "keywords": [
     "xquery",
     "dev",

scripts/modules.js

@@ -1,5 +1,5 @@
 'use strict';
-// generate index.json file from xqm files in dir
+// generate module-library.json file from xqm files in dir
 var dir='specs/libs/basex-9.7';
 var fn='specs/libs/w3c/xpath3.1-fn.xqm';
 var out='lib/compiler/module-library.json';

test/features/doclinks.js

@@ -0,0 +1,9 @@
+// generate xqdoc
+var fs = require('fs');
+
+var XQLint = require('../../lib/xqlint').XQLint;
+var baseUri="C:/Users/andy/git/quodatum/xqlint/";
+
+var linter = new XQLint(fs.readFileSync(baseUri+'cases/override.xq', 'utf-8'), { styleCheck: false });
+var links = linter.getDocLinks();
+console.log(links);

test/features/linter.js

@@ -2,9 +2,8 @@
 var fs = require('fs');
 
 var XQLint = require('../../lib/xqlint').XQLint;
+var baseUri="C:/Users/andy/git/quodatum/xqlint/";
 
-var src="C:/Users/andy/git/quodatum/xqlint/test/queries/update/fun.xq";
-//src="cases/history.xqm";
-var linter = new XQLint(fs.readFileSync(src, 'utf-8'),{fileName: src});
-var markers = linter.getMarkers()
+var linter = new XQLint(fs.readFileSync(baseUri+'test/xqlint_queries/namespaces/1.xq', 'utf-8'), { styleCheck: false });
+var markers = linter.getMarkers();
 console.log(markers);

test/namespace_test.js

@@ -15,7 +15,7 @@ vows.describe('Test Namespace declarations').addBatch({
         var error = markers[0];
         assert.equal(error.type, 'error', 'Type of marker');
         assert.equal(error.message.indexOf('[XQST0047]'), 0, 'Is Error [XQST0047]');
-        assert.deepEqual(error.pos, { sl: 1, sc: 0, el: 1, ec: 50 }, 'Marker Position');
+        assert.deepEqual(error.pos, { sl: 1, sc: 30, el: 1, ec: 50 }, 'Marker Position');
         var warning = markers[1];
         assert.equal(warning.type, 'warning', 'Type of marker');
     },