@infomaximum/package-cli 1.6.1 → 1.7.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.7.0](https://github.com/Infomaximum/package-cli/compare/v1.6.1...v1.7.0) (2023-12-04)
+
+
+### Features
+
+* удаление лишних файлов после сборки пакета ([db79fdd](https://github.com/Infomaximum/package-cli/commit/db79fdd1e15f94961b383ca2295a3eddbd32516a))
+
 ### [1.6.1](https://github.com/Infomaximum/package-cli/compare/v1.6.0...v1.6.1) (2023-12-04)
 
 

package/README.md

@@ -6,25 +6,35 @@ Package-cli - предоставляет разработчикам набор
     <img alt="npm" src="https://img.shields.io/npm/v/@infomaximum/package-cli?style=for-the-badge">
 </a>
 
-## Установка
+## Инициализация проекта
 
-```bash
-yarn add -D @infomaximum/package-cli
-```
+Для создания нового пакета с виджетом необходимо выполнить следующую команду:
 
-## Примеры использования
+`npx @infomaximum/package-cli widget init my_widget`
 
-Сборка пакета с виджетом:
+После выполнения данной команды будет создан шаблонный проект **my_widget** и инициализирован git репозиторий.
 
-```bash
-yarn im-package-cli widget build --entry ./src/index.tsx
-```
+## Разработка виджета
 
-Создание нового пакета с виджетом:
+Для разработки виджета нужно выполнить команду:
 
-```bash
-npx @infomaximum/package-cli widget init project_name
-```
+`yarn build:dev`
+
+Данная команда выполняет сборку пакета для разработки. Далее, пакет (собранный архив из папки build) необходимо загрузить в систему. Для этого добавляем пакет в маркетплейс либо в пространство, а так же добавляем разрабатываемый виджет на холст (дашбординг).
+
+Затем необходимо запустить сервер разработки следующей командой:
+
+`yarn start`
+
+В результате будет запущен сервер отслеживающий изменения проекта и выполняющий горячую перезагрузку разрабатываемого компонента.
+
+## Сборка пакета
+
+Для того чтобы пользователи имели возможность использовать разработанный вами виджет, необходимо выполнить сборку пакета, для этого выполняем команду:
+
+`yarn build`
+
+Полученный в результате выполнения данной команды пакет можно загрузить в маркетплейс.
 
 ## Вывод всех доступных команд
 

package/dist/configs/webpack/buildPa/321/201kage.js

@@ -1,19 +1,21 @@
 import ZipPlugin from "zip-webpack-plugin";
+import RemovePlugin from "remove-files-webpack-plugin";
 import CopyWebpackPlugin from "copy-webpack-plugin";
 import path from "path";
 import { JsonModifyWebpackPlugin } from "@infomaximum/json-modify-webpack-plugin";
 import { systemRequire } from "../../utils.js";
-import { BUILD_ARCHIVE_EXT, BUILD_WIDGET_CONFIG_NAME, WIDGET_ARCHIVE_NAME, } from "../../const.js";
+import { BUILD_ARCHIVE_EXT, BUILD_WIDGET_CONFIG_NAME, MANIFEST_REG_EXP, WIDGET_ARCHIVE_FULL_NAME, } from "../../const.js";
 const packageFilename = "main.js";
 export const getPackageConfig = (mode, PATHS) => {
     const widgetVersion = systemRequire(PATHS.appPackageJson).version;
     const manifestPackageName = systemRequire(PATHS.packageManifest).name;
+    const widgetPackageName = `${manifestPackageName}_${widgetVersion}`;
     return {
         mode,
         name: "package",
         entry: [
             PATHS.packageManifest,
-            path.resolve(PATHS.appBuild, `${WIDGET_ARCHIVE_NAME}.${BUILD_ARCHIVE_EXT}`),
+            path.resolve(PATHS.appBuild, WIDGET_ARCHIVE_FULL_NAME),
         ],
         output: {
             path: PATHS.appBuild,
@@ -23,7 +25,7 @@ export const getPackageConfig = (mode, PATHS) => {
         module: {
             rules: [
                 {
-                    test: /manifest.json$/i,
+                    test: MANIFEST_REG_EXP,
                     type: "asset/resource",
                     generator: {
                         filename: "manifest[ext]",
@@ -42,15 +44,28 @@ export const getPackageConfig = (mode, PATHS) => {
             new CopyWebpackPlugin({
                 patterns: [{ from: PATHS.packagePath }],
             }),
+            new RemovePlugin({
+                after: {
+                    root: PATHS.appBuild,
+                    test: [
+                        {
+                            folder: ".",
+                            method: () => true,
+                            recursive: true,
+                        },
+                    ],
+                    exclude: [`${widgetPackageName}.${BUILD_ARCHIVE_EXT}`],
+                },
+            }),
             new ZipPlugin({
-                filename: `${manifestPackageName}_${widgetVersion}`,
+                filename: widgetPackageName,
                 extension: BUILD_ARCHIVE_EXT,
                 exclude: [packageFilename],
             }),
             new JsonModifyWebpackPlugin({
                 matchers: [
                     {
-                        matcher: /^manifest.json$/,
+                        matcher: MANIFEST_REG_EXP,
                         action: (currentJsonContent) => {
                             currentJsonContent.version = widgetVersion;
                             return currentJsonContent;

package/dist/configs/webpack/common.js

@@ -2,7 +2,7 @@ import ForkTsCheckerWebpackPlugin from "fork-ts-checker-webpack-plugin";
 import { TsconfigPathsPlugin } from "tsconfig-paths-webpack-plugin";
 import webpack, {} from "webpack";
 import { systemRequire } from "../../utils.js";
-import { BUILD_WIDGET_CONFIG_NAME } from "../../const.js";
+import { BUILD_WIDGET_CONFIG_NAME, MANIFEST_REG_EXP } from "../../const.js";
 const { ProgressPlugin } = webpack;
 const isProduction = (mode) => mode === "production";
 const isDevelopment = (mode) => mode === "development";
@@ -121,7 +121,7 @@ export const getCommonWidgetConfig = (mode, PATHS) => {
                     type: "asset/inline",
                 },
                 {
-                    test: /manifest.json$/i,
+                    test: MANIFEST_REG_EXP,
                     type: "asset/resource",
                     generator: {
                         filename: "[name][ext]",

package/dist/configs/webpack/sections/plugins/zipWidget.js

@@ -1,8 +1,9 @@
 import ZipPlugin from "zip-webpack-plugin";
-import { BUILD_ARCHIVE_EXT, WIDGET_ARCHIVE_NAME } from "../../../../const.js";
-export const getZipWidgetPlugin = () => {
+import { BUILD_ARCHIVE_EXT, MANIFEST_JSON_FILE_NAME, WIDGET_ARCHIVE_NAME, } from "../../../../const.js";
+export const getZipWidgetPlugin = (isOnlyManifest) => {
     return new ZipPlugin({
         filename: WIDGET_ARCHIVE_NAME,
         extension: BUILD_ARCHIVE_EXT,
+        include: isOnlyManifest ? [MANIFEST_JSON_FILE_NAME] : undefined,
     });
 };

package/dist/const.js

@@ -3,5 +3,8 @@ export const CUSTOM_PACKAGE_CLI_LIB_NAME = "@infomaximum/package-cli";
 export const BUILD_WIDGET_CONFIG_NAME = "build-widget";
 export const WIDGET_ARCHIVE_NAME = "widget";
 export const BUILD_ARCHIVE_EXT = "zip";
+export const WIDGET_ARCHIVE_FULL_NAME = `${WIDGET_ARCHIVE_NAME}.${BUILD_ARCHIVE_EXT}`;
 export const DEFAULT_HOST = "localhost";
 export const DEFAULT_PORT = "5555";
+export const MANIFEST_JSON_FILE_NAME = "manifest.json";
+export const MANIFEST_REG_EXP = new RegExp(`${MANIFEST_JSON_FILE_NAME}$`, "i");

package/dist/paths.js

@@ -2,6 +2,7 @@ import fs from "node:fs";
 import path from "node:path";
 import { systemRequire } from "./utils.js";
 import chalk from "chalk";
+import { MANIFEST_JSON_FILE_NAME } from "./const.js";
 const appDirectory = fs.realpathSync(process.cwd());
 const _resolveApp = (cwd = appDirectory) => (relativePath) => path.resolve(cwd, relativePath);
 const moduleFileExtensions = [
@@ -37,9 +38,9 @@ export const generatePaths = (args) => {
             return generateIndexPath(cwd, entryPath);
         },
         appPackageJson: resolveApp("package.json"),
-        manifestJson: resolveApp("manifest.json"),
+        manifestJson: resolveApp(MANIFEST_JSON_FILE_NAME),
         packagePath,
-        packageManifest: resolveApp(path.resolve(packagePath, "manifest.json")),
+        packageManifest: resolveApp(path.resolve(packagePath, MANIFEST_JSON_FILE_NAME)),
         appTsConfig: resolveApp("tsconfig.json"),
         appNodeModules: resolveApp("node_modules"),
         publicPath: "/",

package/dist/scripts/widget/build.js

@@ -11,13 +11,14 @@ import { getZipWidgetPlugin } from "../../configs/webpack/sections/plugins/zipWi
 export const runBuild = (args) => __awaiter(void 0, void 0, void 0, function* () {
     const mode = "production";
     const { entry, host, port } = args;
+    const isOnlyManifest = !!(host && port);
     const PATHS = generatePaths({
         entryPath: entry,
     });
     const sections = {
-        plugins: [getZipWidgetPlugin()],
+        plugins: [getZipWidgetPlugin(isOnlyManifest)],
     };
-    if (host && port) {
+    if (isOnlyManifest) {
         sections.plugins.push(getModifyManifestWidgetPlugin({
             host,
             port,

package/dist/scripts/widget/init/actions.js

@@ -9,7 +9,7 @@ import { WIDGET_INDEX_TEMPLATE } from "../../../templates/widget/src/widgetIndex
 import { APP_D_TS_TEMPLATE } from "../../../templates/widget/src/widgetAppDTs.js";
 import { WIDGET_INDEX_CSS_TEMPLATE } from "../../../templates/widget/src/widgetIndexCSS.js";
 import { WIDGET_PACKAGE_JSON_TEMPLATE } from "../../../templates/widget/widgetPackageJson.js";
-import { CUSTOM_PACKAGE_CLI_LIB_NAME, CUSTOM_WIDGET_LIB_NAME, } from "../../../const.js";
+import { CUSTOM_PACKAGE_CLI_LIB_NAME, CUSTOM_WIDGET_LIB_NAME, MANIFEST_JSON_FILE_NAME, } from "../../../const.js";
 const addIconActionName = "addIcon";
 const addInitActions = (basePath, plop) => {
     plop.setActionType(addIconActionName, function (answers, config, plop) {
@@ -31,7 +31,7 @@ const actions = ({ customWidgetVersion, packageCliVersion }) => {
     return [
         {
             type: "add",
-            path: "package/manifest.json",
+            path: `package/${MANIFEST_JSON_FILE_NAME}`,
             template: PACKAGE_MANIFEST_TEMPLATE,
             data: {
                 packageIconName,
@@ -45,7 +45,7 @@ const actions = ({ customWidgetVersion, packageCliVersion }) => {
         },
         {
             type: "add",
-            path: "manifest.json",
+            path: MANIFEST_JSON_FILE_NAME,
             template: WIDGET_MANIFEST_TEMPLATE,
         },
         {

package/dist/templates/widget/src/widgetIndex.js

@@ -1,3 +1,4 @@
+import { MANIFEST_JSON_FILE_NAME } from "../../../const.js";
 import { capitalizeHelperName } from "../../../scripts/widget/init/helpers.js";
 export const WIDGET_INDEX_TEMPLATE = `\
 import React from "react";
@@ -9,7 +10,7 @@ import {
   type IBaseWidgetSettings,
   type ICustomWidgetProps,
 } from "@infomaximum/custom-widget";
-import manifest from "../manifest.json";
+import manifest from "../${MANIFEST_JSON_FILE_NAME}";
 
 interface Settings extends IBaseWidgetSettings {}
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infomaximum/package-cli",
-  "version": "1.6.1",
+  "version": "1.7.0",
   "exports": "./dist/index.js",
   "type": "module",
   "license": "Apache-2.0",
@@ -26,9 +26,6 @@
     "@infomaximum/json-modify-webpack-plugin": "^1.0.1",
     "@pmmmwh/react-refresh-webpack-plugin": "^0.5.11",
     "@svgr/webpack": "^8.1.0",
-    "@types/node": "^20.9.0",
-    "@types/semver": "^7.5.6",
-    "@types/zip-webpack-plugin": "^3.0.6",
     "autoprefixer": "^10.4.16",
     "babel-loader": "^9.1.3",
     "babel-plugin-inline-json-import": "^0.3.2",
@@ -45,6 +42,7 @@
     "postcss-loader": "^7.3.3",
     "postcss-preset-env": "^9.3.0",
     "react-refresh": "^0.14.0",
+    "remove-files-webpack-plugin": "^1.5.0",
     "sass": "^1.69.5",
     "sass-loader": "^13.3.2",
     "semver": "^7.5.4",
@@ -58,6 +56,10 @@
     "zip-webpack-plugin": "^4.0.1"
   },
   "devDependencies": {
+    "@types/node": "^20.9.0",
+    "@types/webpack": "^5.28.5",
+    "@types/semver": "^7.5.6",
+    "@types/zip-webpack-plugin": "^3.0.6",
     "prettier": "^3.1.0",
     "rimraf": "^5.0.5",
     "typescript": "~5.3.2"
@@ -65,7 +67,8 @@
   "resolutions": {
     "wrap-ansi": "7.0.0",
     "string-width": "4.1.0",
-    "strip-ansi": "6.0.0"
+    "strip-ansi": "6.0.0",
+    "@types/webpack": "^5.28.5"
   },
   "engines": {
     "node": ">=16"