Merge pull request #210 from docsbydoxdox/hotfix/api-scope-tag-support

[hotfix] Added api scope tag support.

Author: neogeek

packages/doxdox-parser-custom/src/__snapshots__/index.test.ts.snap

@@ -1182,3 +1182,47 @@ exports[`custom parser parse parse example jsdoc headers (function methods) 1`]
   "path": "./test/mocks/function.js",
 }
 `;
+
+exports[`custom parser tag tests public/private scope 1`] = `
+{
+  "methods": [
+    {
+      "description": "",
+      "fullName": "privateMethod()",
+      "name": "privateMethod",
+      "params": [],
+      "private": true,
+      "returns": [],
+      "slug": "test-mocks-scope-js-privatemethod",
+    },
+    {
+      "description": "",
+      "fullName": "privateMethod()",
+      "name": "privateMethod",
+      "params": [],
+      "private": true,
+      "returns": [],
+      "slug": "test-mocks-scope-js-privatemethod",
+    },
+    {
+      "description": "",
+      "fullName": "publicMethod()",
+      "name": "publicMethod",
+      "params": [],
+      "private": false,
+      "returns": [],
+      "slug": "test-mocks-scope-js-publicmethod",
+    },
+    {
+      "description": "",
+      "fullName": "publicMethod()",
+      "name": "publicMethod",
+      "params": [],
+      "private": false,
+      "returns": [],
+      "slug": "test-mocks-scope-js-publicmethod",
+    },
+  ],
+  "path": "./test/mocks/scope.js",
+}
+`;

packages/doxdox-parser-custom/src/index.test.ts

@@ -27,6 +27,14 @@ describe('custom parser', () => {
         });
     });
 
+    describe('tag tests', () => {
+        it('public/private scope', async () => {
+            await expect(
+                parse(process.cwd(), './test/mocks/scope.js')
+            ).resolves.toMatchSnapshot();
+        });
+    });
+
     describe('parse example from JSDoc documentation https://jsdoc.app/', () => {
         // JSDoc Example from https://jsdoc.app/
         it('parse amd-module', async () => {

packages/doxdox-parser-custom/src/index.ts

@@ -100,8 +100,11 @@ export const parseString = async (
                 const returnTags = method.comment.tags.filter(({ tag }) =>
                     /return$/.test(tag)
                 );
-                const privateScopeTags = method.comment.tags.filter(({ tag }) =>
-                    /private$/.test(tag)
+
+                const privateScopeTags = method.comment.tags.filter(
+                    ({ tag, name }) =>
+                        /private$/.test(tag) ||
+                        (tag === 'api' && /private$/.test(name))
                 );
 
                 const params = paramTags.map(({ name, description, type }) => ({

packages/doxdox-parser-custom/test/mocks/scope.js

@@ -0,0 +1,19 @@
+/**
+ * @public
+ */
+function publicMethod() {}
+
+/**
+ * @api public
+ */
+function publicMethod() {}
+
+/**
+ * @private
+ */
+function privateMethod() {}
+
+/**
+ * @api private
+ */
+function privateMethod() {}