@diplodoc/cli 4.6.3 → 4.7.0-beta-1

package/package.json

@@ -3,7 +3,7 @@
   "author": "Yandex Data UI Team <data-ui@yandex-team.ru>",
   "description": "Make documentation using yfm-docs in Markdown and HTML formats",
   "license": "MIT",
-  "version": "4.6.3",
+  "version": "4.7.0-beta-1",
   "repository": {
     "type": "git",
     "url": "git@github.com:diplodoc-platform/cli.git"
@@ -14,6 +14,7 @@
   "main": "build/index.js",
   "files": [
     "build",
+    "assets",
     "src"
   ],
   "scripts": {
@@ -25,27 +26,21 @@
     "git:head": "git checkout master && git pull"
   },
   "engines": {
-    "node": ">=18.*",
-    "npm:": ">=9.*"
+    "node": ">=18.*"
   },
   "dependencies": {
-    "@apidevtools/swagger-parser": "^10.1.0",
     "@aws-sdk/client-s3": "^3.369.0",
-    "@diplodoc/client": "^1.0.2",
-    "@diplodoc/markdown-translation": "^1.0.1",
-    "@diplodoc/mermaid-extension": "^1.1.3",
-    "@diplodoc/openapi-extension": "^1.4.4",
-    "@diplodoc/transform": "^4.3.0",
+    "@diplodoc/client": "^2.0.0-beta-1",
+    "@diplodoc/latex-extension": "^1.0.0",
+    "@diplodoc/markdown-translation": "^1.0.2",
+    "@diplodoc/mermaid-extension": "^1.2.1",
+    "@diplodoc/openapi-extension": "^1.4.10",
+    "@diplodoc/transform": "^4.7.3",
     "@octokit/core": "4.2.4",
-    "@types/glob": "^8.0.0",
-    "@types/json-stringify-safe": "^5.0.0",
     "@yandex-cloud/nodejs-sdk": "^2.2.2",
     "ajv": "^8.11.0",
     "async": "^3.2.4",
-    "aws-sdk": "^2.1425.0",
-    "bem-cn-lite": "^4.1.0",
     "chalk": "4.1.2",
-    "dotenv": "^16.0.3",
     "fast-xml-parser": "^4.0.11",
     "glob": "^8.0.3",
     "highlight.js": "^11.7.0",
@@ -66,13 +61,15 @@
     "yargs": "17.7.2"
   },
   "devDependencies": {
-    "@diplodoc/eslint-config": "^1.0.14",
-    "@diplodoc/prettier-config": "^1.0.0",
+    "@diplodoc/eslint-config": "^2.0.0",
+    "@diplodoc/prettier-config": "^2.0.0",
     "@diplodoc/tsconfig": "^1.0.2",
     "@types/async": "^3.2.15",
     "@types/chalk": "2.2.0",
+    "@types/glob": "^8.1.0",
     "@types/html-escaper": "^3.0.0",
     "@types/js-yaml": "4.0.5",
+    "@types/json-stringify-safe": "^5.0.3",
     "@types/lodash": "4.14.195",
     "@types/mime-types": "2.1.1",
     "@types/node": "14.*",
@@ -80,21 +77,11 @@
     "@types/tar-stream": "^2.2.2",
     "@types/yargs": "17.0.24",
     "esbuild": "^0.17.17",
-    "eslint": "^8.0.0",
     "husky": "8.0.3",
     "lint-staged": "13.2.2",
     "lodash": "4.17.21",
-    "prettier": "^3.0.3",
-    "ts-jest": "29.1.0",
-    "ts-node": "^10.9.1",
     "typescript": "4.9.5"
   },
-  "overrides": {
-    "react-sortable-hoc": {
-      "react": "^18.2.0",
-      "react-dom": "^18.2.0"
-    }
-  },
   "husky": {
     "hooks": {
       "pre-commit": "lint-staged"
@@ -106,20 +93,6 @@
       "git add"
     ]
   },
-  "pkg": {
-    "scripts": [
-      "build/index.js",
-      "build/linter.js",
-      "build/plugins/*.js",
-      "build/lint-rules/*.js",
-      "build/default-lint-config.js",
-      "build/head-content.js"
-    ],
-    "assets": [
-      "build/app.client.js",
-      "build/app.client.css"
-    ]
-  },
   "keywords": [
     "markdown",
     "yandex",

package/src/constants.ts

@@ -1,4 +1,4 @@
-import {dirname} from 'path';
+import {resolve} from 'path';
 const os = require('os');
 const notes = require('@diplodoc/transform/lib/plugins/notes');
 const anchors = require('@diplodoc/transform/lib/plugins/anchors');
@@ -18,16 +18,15 @@ const table = require('@diplodoc/transform/lib/plugins/table');
 const term = require('@diplodoc/transform/lib/plugins/term');
 const changelog = require('@diplodoc/transform/lib/plugins/changelog');
 const mermaid = require('@diplodoc/mermaid-extension');
+const latex = require('@diplodoc/latex-extension');
 const openapi = require('@diplodoc/openapi-extension');
 
 includes.collect = require('@diplodoc/transform/lib/plugins/includes/collect');
 images.collect = require('@diplodoc/transform/lib/plugins/images/collect');
 changelog.collect = require('@diplodoc/transform/lib/plugins/changelog/collect');
 
-export const BUILD_FOLDER = 'build';
+export const ASSETS_FOLDER = resolve(__dirname, '../assets');
 export const BUNDLE_FOLDER = '_bundle';
-export const BUNDLE_JS_FILENAME = 'app.client.js';
-export const BUNDLE_CSS_FILENAME = 'app.client.css';
 export const TMP_INPUT_FOLDER = '.tmp_input';
 export const TMP_OUTPUT_FOLDER = '.tmp_output';
 export const MAIN_TIMER_ID = 'Build time';
@@ -67,8 +66,6 @@ export enum ResourceType {
     script = 'script',
 }
 
-export const BUILD_FOLDER_PATH = dirname(require.resolve('@diplodoc/client'));
-
 export const YFM_PLUGINS = [
     meta,
     deflist,
@@ -88,6 +85,7 @@ export const YFM_PLUGINS = [
     term,
     openapi.transform(),
     mermaid.transform(),
+    latex.transform(),
     changelog,
 ];
 

package/src/steps/processAssets.ts

@@ -1,10 +1,11 @@
 import walkSync from 'walk-sync';
 import shell from 'shelljs';
 
-import client from '../../scripts/client';
 import {ArgvService} from '../services';
 import {copyFiles} from '../utils';
 
+import {ASSETS_FOLDER} from '../constants';
+
 /**
  * Processes assets files (everything except .yaml and .md files)
  * @param {string} outputBundlePath
@@ -23,8 +24,5 @@ export function processAssets(outputBundlePath: string) {
 
     /* Copy js bundle to user' output folder */
     shell.mkdir('-p', outputBundlePath);
-
-    for (const path of Object.values(client.dst)) {
-        shell.cp(path, outputBundlePath);
-    }
+    shell.cp(ASSETS_FOLDER + '/*', outputBundlePath);
 }

package/src/utils/markup.ts

@@ -1,11 +1,15 @@
+import {join} from 'path';
 import {platform} from 'process';
 
 import {CUSTOM_STYLE, Platforms, ResourceType} from '../constants';
 import {Resources, SinglePageResult} from '../models';
 import {ArgvService, PluginService} from '../services';
 import {preprocessPageHtmlForSinglePage} from './singlePage';
-import {DocInnerProps, DocPageData, render} from '@diplodoc/client';
-import client from '../../scripts/client';
+
+import {DocInnerProps, DocPageData, render} from '@diplodoc/client/ssr';
+import manifest from '@diplodoc/client/manifest';
+
+const dst = (bundlePath: string) => (target: string) => join(bundlePath, target);
 
 export interface TitleMeta {
     title?: string;
@@ -44,7 +48,10 @@ export function generateStaticMarkup(
                         height: 100vh;
                     }
                 </style>
-                <link type="text/css" rel="stylesheet" href="${client.bundle.css(pathToBundle)}" />
+                ${manifest.css
+                    .map(dst(pathToBundle))
+                    .map((src: string) => `<link type="text/css" rel="stylesheet" href="${src}" />`)
+                    .join('\n')}
                 ${PluginService.getHeadContent()}
                 ${resources}
             </head>
@@ -54,9 +61,13 @@ export function generateStaticMarkup(
                    window.STATIC_CONTENT = ${staticContent}
                    window.__DATA__ = ${JSON.stringify(props)};
                 </script>
-                <script type="application/javascript" src="${client.bundle.js(
-                    pathToBundle,
-                )}"></script>
+                ${manifest.js
+                    .map(dst(pathToBundle))
+                    .map(
+                        (src: string) =>
+                            `<script type="application/javascript" src="${src}"></script>`,
+                    )
+                    .join('\n')}
             </body>
         </html>
     `;

package/src/steps/publishFilesToS3.ts

@@ -1,51 +0,0 @@
-import {readFileSync} from 'fs';
-import walkSync from 'walk-sync';
-import {join, resolve} from 'path';
-import S3 from 'aws-sdk/clients/s3';
-import mime from 'mime-types';
-
-import {ArgvService} from '../services';
-import {convertBackSlashToSlash, logger} from '../utils';
-
-const DEFAULT_PREFIX = process.env.YFM_STORAGE_PREFIX ?? '';
-
-export async function publishFilesToS3(): Promise<void> {
-    const {
-        output: outputFolderPath,
-        ignore = [],
-        storageEndpoint: endpoint,
-        storageBucket: bucket,
-        storagePrefix: prefix = DEFAULT_PREFIX,
-        storageKeyId: accessKeyId,
-        storageSecretKey: secretAccessKey,
-    } = ArgvService.getConfig();
-
-    const s3Client = new S3({
-        endpoint,
-        accessKeyId,
-        secretAccessKey,
-    });
-
-    const filesToPublish: string[] = walkSync(resolve(outputFolderPath), {
-        directories: false,
-        includeBasePath: false,
-        ignore,
-    });
-
-    await Promise.all(
-        filesToPublish.map(async (pathToFile) => {
-            const mimeType = mime.lookup(pathToFile);
-
-            const params: S3.Types.PutObjectRequest = {
-                ContentType: mimeType ? mimeType : undefined,
-                Bucket: bucket,
-                Key: convertBackSlashToSlash(join(prefix, pathToFile)),
-                Body: readFileSync(resolve(outputFolderPath, pathToFile)),
-            };
-
-            logger.upload(pathToFile);
-
-            return s3Client.upload(params).promise();
-        }),
-    );
-}