@progress/kendo-typescript-api-tasks 3.0.2-dev.4 → 3.0.2-dev.40

package/index.js

@@ -8,6 +8,7 @@ const typedoc = require('typedoc');
 const glob = require('glob');
 const generator = require('./lib/generator.js');
 const typeLinks = require('./type-links.json');
+const listMembers = require('./lib/list-api-members.js');
 
 const defaultConfig = {
     outPath: 'docs/api',
@@ -66,6 +67,18 @@ module.exports.addAPITasks = (gulp, userConfig) => {
         done();
     });
 
+    gulp.task('api-members', series('api-json', (done) => {
+        const data = JSON.parse(fs.readFileSync(config.jsonPath, 'utf8'));
+        const members = listMembers(data);
+        const output = members.map(({ name }) => `${name}`).join("\n");
+        const absoluteOutput = path.resolve(path.join(path.dirname(config.jsonPath), 'api-members.txt'));
+        fs.writeFileSync(absoluteOutput, output, "utf8");
+
+        console.log(`API members list written to ${absoluteOutput}`);
+
+        done();
+    }));
+
     gulp.task('api', series('api-json', 'api-clean', (done) => {
         const packageJson = path.join(process.cwd(), 'package.json');
         const packageInfo = require(packageJson);

package/lib/comment.js

@@ -13,7 +13,7 @@ const commentTags = (comment, member) =>
 
             if (tag.tag === '@example') {
                 text = text.replace(/_@/g, '@');
-            } else if (tag.tag === '@see') {
+            } else if (tag.tag === '@see' && member.packageName) {
                 const linkSlug = slug(member.packageName, text);
                 text = `\n\nSee [${text}]({% slug ${linkSlug} %})`;
             } else {

package/lib/generator.js

@@ -212,9 +212,35 @@ const writeFile = (name, content) => {
     fs.writeFileSync(name, content);
 };
 
+const stripPlatformContent = (input, platform) => {
+    if (typeof platform !== 'string') {
+        return input;
+    }
+
+    const extractContent = (_, platformMatch, platformContent) => (
+        platform.toLowerCase() === platformMatch.trim().toLowerCase() ? `${platformContent}` : ""
+    );
+
+    // Replace platform_content blocks on newlines
+    let content = input.replace(
+        /^[ \t]*{%\s*platform_content\s+([a-zA-Z0-9_-]+)\s*%}\r?\n?([\s\S]*?)^[ \t]*{%\s*endplatform_content\s*%}\r?\n?/gm,
+        extractContent
+    );
+
+    // Replace platform_content blocks without newlines (e.g. in comments)
+    content = content.replace(
+        /{%\s*platform_content\s+([a-zA-Z0-9_-]+)\s*%}([\s\S]*?){%\s*endplatform_content\s*%}/g,
+        extractContent
+    );
+
+    return content;
+};
+
 const writeMember = (path, member, info) => {
-    let sub = member.module ? member.module + '/' : '';
-    writeFile(`${path}/${sub}${member.url}.md`, memberPage(member, info));
+    const sub = member.module ? member.module + '/' : '';
+    const content = stripPlatformContent(memberPage(member, info), info.platform);
+
+    writeFile(`${path}/${sub}${member.url}.md`, content);
 };
 
 const groupMembers = (members) => {
@@ -266,7 +292,7 @@ const generate = (done, config, packageInfo) => {
 };
 
 module.exports = {
-    generate: generate,
-    extractMembers: extractMembers
+    generate,
+    extractMembers,
+    stripPlatformContent
 };
-

package/lib/list-api-members.js

@@ -0,0 +1,34 @@
+function listMembers(root) {
+    const results = [];
+
+    function walk(node) {
+        if (!node || typeof node !== "object") {
+            return;
+        }
+
+        if (Array.isArray(node.children)) {
+            const parentName = typeof node.name === "string" ? node.name + '.' : '';
+
+            for (const child of node.children) {
+                if (
+                    child &&
+                    typeof child === "object" &&
+                    typeof child.name === "string" &&
+                    typeof child.variant === "string" &&
+                    typeof child.kind === "number" &&
+                    child.variant === "declaration" &&
+                    child.kind > 4 /* skip namespaces and modules */
+                ) {
+                    results.push({ name: parentName + child.name, kind: child.kind });
+                }
+                walk(child);
+            }
+        }
+    }
+
+    walk(root);
+    return results;
+}
+
+module.exports = listMembers;
+

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@progress/kendo-typescript-api-tasks",
     "description": "Kendo UI API docs package gulp tasks",
-    "version": "3.0.2-dev.4+48f7555",
+    "version": "3.0.2-dev.40+d5278df",
     "author": "Progress",
     "license": "Apache-2.0",
     "main": "index.js",
@@ -20,7 +20,7 @@
         "glob": "^11.0.0",
         "gulp": "^5.0.0",
         "handlebars": "^4.7.7",
-        "lodash": "^4.17.21",
+        "lodash": "^4.18.1",
         "mkdirp": "^3.0.1",
         "typedoc": "0.25.2"
     },
@@ -31,5 +31,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "48f755531a2bf251813682e856835dfb072fd969"
+    "gitHead": "d5278df38d8cca85576863592ddf9b1d8e46b462"
 }

package/test/api.js

@@ -348,5 +348,41 @@ describe('API generation', () => {
             expect(/#\s{1}Foo\s{1}API/.test(page)).toBe(true);
         });
     });
+
+    describe('stripPlatformContent', () => {
+        it('strips platform content', () => {
+            const content = `
+                HEADER
+
+                {% platform_content angular %}
+                ANGULAR CONTENT
+                {% endplatform_content %}
+                {% platform_content react %}
+                REACT CONTENT
+                {% endplatform_content %}
+
+                FOOTER
+            `;
+
+            const output = generator.stripPlatformContent(content, 'react');
+
+            expect(output).toBe(`
+                HEADER
+
+                REACT CONTENT
+
+                FOOTER
+            `);
+        });
+
+        it('strips inline platform content', () => {
+            const content =
+                "HEADER {% platform_content angular %}ANGULAR CONTENT{% endplatform_content %}{% platform_content react %}REACT CONTENT{% endplatform_content %} FOOTER";
+
+            const output = generator.stripPlatformContent(content, 'react');
+
+            expect(output).toBe("HEADER REACT CONTENT FOOTER");
+        });
+    });
 });