@vkontakte/vkui-tokens 4.29.3 → 4.29.4

package/build/compilers/docs/__test__/testLinks.d.ts

@@ -0,0 +1,7 @@
+export interface BaseTheme {
+    /**
+     * @desc Link with text {@link https://google.com Google}.
+     *       Link without text {@link https://google.com}
+     */
+    importedBaseProp: string;
+}

package/build/compilers/docs/__test__/testLinks.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/compilers/docs/compileDocsJSON.d.ts

@@ -1,7 +1,15 @@
 import { SpecialTokens, Theme } from '../../../interfaces/general';
+export type Description = {
+    type: 'text';
+    text: string;
+} | {
+    type: 'link';
+    url: string;
+    text: string;
+};
 export interface ThemePropertyDoc {
     tags: string[];
-    desc: string;
+    desc: Description[];
 }
 export type ThemeDocs = {
     [name: string]: ThemePropertyDoc;

package/build/compilers/docs/compileDocsJSON.js

@@ -18,6 +18,34 @@ exports.compileDocsJSON = exports.getTypeDocs = void 0;
 var path_1 = __importDefault(require("path"));
 var ts_morph_1 = require("ts-morph");
 var capitalize_1 = require("../../helpers/capitalize");
+function getTagDescription(tag) {
+    return tag
+        .getText()
+        .map(function (part) {
+        switch (part.kind) {
+            case 'text':
+                return {
+                    type: 'text',
+                    text: part.text,
+                };
+            case 'linkText': {
+                var _a = part.text.split(' '), url = _a[0], urlText = _a[1];
+                if (!url) {
+                    throw new Error('[desc] Ожидаемый формат ссылки в JSDoc `{@link url urlText}` или `{@link url}`');
+                }
+                return {
+                    url: url,
+                    type: 'link',
+                    text: urlText || url,
+                };
+            }
+            case 'link':
+            default:
+                return null;
+        }
+    })
+        .filter(function (i) { return i !== null; });
+}
 function getTagText(tag) {
     return tag
         .getText()
@@ -47,19 +75,20 @@ function getExportedTypeDeclarations(file, typeName) {
 function mapJsDocTagsToThemePropertyDoc(tags) {
     var doc = {
         tags: [],
-        desc: '',
+        desc: [],
     };
     tags.forEach(function (tag) {
         var tagName = tag.getName();
-        var tagText = getTagText(tag);
         if (tagName === 'desc' || tagName === 'description') {
-            doc.desc = tagText;
+            doc.desc = getTagDescription(tag);
         }
         else if (tagName === 'tags') {
-            doc.tags = tagText.split(',').map(function (tag) { return tag.trim(); });
+            var docTags = getTagText(tag);
+            doc.tags = docTags.split(',').map(function (tag) { return tag.trim(); });
         }
         else if (tagName === 'tag') {
-            doc.tags.push(tagText);
+            var docTag = getTagText(tag);
+            doc.tags.push(docTag);
         }
     });
     return doc;
@@ -71,13 +100,24 @@ function getTypeDocs(filePath, name) {
     });
     var file = project.addSourceFileAtPath(filePath);
     var declarations = getExportedTypeDeclarations(file, name);
-    return declarations.reduce(function (all, declaration) {
-        var properties = declaration.getType().getApparentProperties();
-        var docs = properties.reduce(function (all, prop) {
-            all[prop.getName()] = mapJsDocTagsToThemePropertyDoc(prop.getJsDocTags());
-            return all;
+    return declarations.reduce(function (prevDocs, declaration) {
+        var rawProperties = declaration.getType().getApparentProperties();
+        var parsedProperties = rawProperties
+            .reduce(function (acc, prop) {
+            acc.push([prop.getName(), mapJsDocTagsToThemePropertyDoc(prop.getJsDocTags())]);
+            return acc;
+        }, [])
+            .sort(function (_a, _b) {
+            var a = _a[0];
+            var b = _b[0];
+            return a.localeCompare(b);
+        });
+        var docs = parsedProperties.reduce(function (acc, _a) {
+            var key = _a[0], value = _a[1];
+            acc[key] = value;
+            return acc;
         }, {});
-        return __assign(__assign({}, all), docs);
+        return __assign(__assign({}, prevDocs), docs);
     }, {});
 }
 exports.getTypeDocs = getTypeDocs;

package/build/compilers/docs/compileDocsJSON.test.js

@@ -6,32 +6,65 @@ describe('compileDocsJSON', function () {
         var docs = (0, compileDocsJSON_1.getTypeDocs)('src/build/compilers/docs/__test__/testRecursiveReexport.ts', 'BaseTheme');
         expect(docs).toEqual({
             importedBaseProp: {
-                desc: 'Short desc tag',
+                desc: [
+                    {
+                        type: 'text',
+                        text: 'Short desc tag',
+                    },
+                ],
                 tags: ['tag1', 'tag2'],
             },
         });
     });
+    it('should correct compile documentation with jsdoc link', function () {
+        var docs = (0, compileDocsJSON_1.getTypeDocs)('src/build/compilers/docs/__test__/testLinks.ts', 'BaseTheme');
+        expect(docs).toEqual({
+            importedBaseProp: {
+                desc: [
+                    {
+                        type: 'text',
+                        text: 'Link with text ',
+                    },
+                    {
+                        type: 'link',
+                        url: 'https://google.com',
+                        text: 'Google',
+                    },
+                    {
+                        type: 'text',
+                        text: '.\nLink without text ',
+                    },
+                    {
+                        type: 'link',
+                        url: 'https://google.com',
+                        text: 'https://google.com',
+                    },
+                ],
+                tags: [],
+            },
+        });
+    });
     it('should correct compile documentation with imports', function () {
         var docs = (0, compileDocsJSON_1.getTypeDocs)('src/build/compilers/docs/__test__/testTheme.ts', 'ThemeTest');
         expect(docs).toEqual({
             prop: {
-                desc: '',
+                desc: [],
                 tags: ['empty description'],
             },
             propWithoutDoc: {
-                desc: '',
+                desc: [],
                 tags: [],
             },
             localBaseProp: {
-                desc: 'Empty tags',
+                desc: [{ type: 'text', text: 'Empty tags' }],
                 tags: [],
             },
             importedBaseProp: {
-                desc: 'Short desc tag',
+                desc: [{ type: 'text', text: 'Short desc tag' }],
                 tags: ['tag1', 'tag2'],
             },
             derivedProp: {
-                desc: 'Long description tag',
+                desc: [{ type: 'text', text: 'Long description tag' }],
                 tags: ['tagListItem1', 'tagListItem2', 'tagListItem3'],
             },
         });

package/build/compilers/styles/helpers/tokenProcessors.d.ts

@@ -6,7 +6,7 @@ export declare const EStyleTypes: {
     readonly LESS: "less";
     readonly STYL: "styl";
 };
-export type Formats = typeof EStyleTypes[keyof typeof EStyleTypes];
+export type Formats = (typeof EStyleTypes)[keyof typeof EStyleTypes];
 export declare const varDeclarations: {
     readonly css: (prop: any, prefix?: string) => string;
     readonly pcss: (prop: any, prefix?: string) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vkontakte/vkui-tokens",
-  "version": "4.29.3",
+  "version": "4.29.4",
   "description": "Репозиторий, который содержит в себе дизайн-токены и другие инструменты объединенной дизайн-системы VKUI и Paradigm",
   "license": "MIT",
   "main": "utils/descriptions.js",
@@ -73,7 +73,7 @@
     "jest": "29.4.1",
     "jest-junit": "15.0.0",
     "lodash": "4.17.21",
-    "prettier": "2.8.0",
+    "prettier": "2.8.4",
     "react": "18.2.0",
     "react-dom": "18.2.0",
     "rimraf": "4.4.0",