@infomaximum/package-cli 1.14.0 → 1.16.0

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 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.16.0](https://github.com/Infomaximum/package-cli/compare/v1.15.0...v1.16.0) (2024-02-14)
+
+
+### Features
+
+* подержан definition ([13a3617](https://github.com/Infomaximum/package-cli/commit/13a3617493b7349f4ce39f0353c3fd7cdec1261e))
+
+
+### Bug Fixes
+
+* исправлен шаблон ([a5da473](https://github.com/Infomaximum/package-cli/commit/a5da4737cb2aafd80f716fa984c04e853cb41d35))
+
+## [1.15.0](https://github.com/Infomaximum/package-cli/compare/v1.14.0...v1.15.0) (2023-12-26)
+
+
+### Features
+
+* добавлены шаблоны документации, и истории изменений пакета ([125891b](https://github.com/Infomaximum/package-cli/commit/125891bd80741171216698204dbf8387c6bafa1c))
+
 ## [1.14.0](https://github.com/Infomaximum/package-cli/compare/v1.13.0...v1.14.0) (2023-12-25)
 
 

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

@@ -10,8 +10,10 @@ 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, MANIFEST_JSON_FILE_NAME, } from "../../../const.js";
-import { WIDGET_SETTINGS_TEMPLATE } from "../../../templates/widget/src/settings.js";
-import { WIDGET_PANEL_TEMPLATE } from "../../../templates/widget/src/panel.js";
+import { WIDGET_SETTINGS_TEMPLATE } from "../../../templates/widget/src/definition/settings.js";
+import { WIDGET_PANEL_TEMPLATE } from "../../../templates/widget/src/definition/panel.js";
+import { GET_CHANGELOG_MD, GET_DOC_MD, } from "../../../templates/package/additionalFiles.js";
+import { WIDGET_DEFINITION_TEMPLATE } from "../../../templates/widget/src/definition/definition.js";
 const addIconActionName = "addIcon";
 const addInitActions = (basePath, plop) => {
     plop.setActionType(addIconActionName, function (answers, config, plop) {
@@ -45,6 +47,18 @@ const actions = ({ customWidgetVersion, packageCliVersion }) => {
             path: `package/resources/${packageIconName}.png`,
             template: PACKAGE_ICON_TEMPLATE,
         },
+        ...["ru", "en"].flatMap((language) => [
+            {
+                type: "add",
+                path: `package/${language}/doc.md`,
+                template: GET_DOC_MD(language),
+            },
+            {
+                type: "add",
+                path: `package/${language}/changelog.md`,
+                template: GET_CHANGELOG_MD(language),
+            },
+        ]),
         {
             type: "add",
             path: MANIFEST_JSON_FILE_NAME,
@@ -67,12 +81,17 @@ const actions = ({ customWidgetVersion, packageCliVersion }) => {
         },
         {
             type: "add",
-            path: "src/settings.ts",
+            path: "src/definition/definition.ts",
+            template: WIDGET_DEFINITION_TEMPLATE,
+        },
+        {
+            type: "add",
+            path: "src/definition/settings.ts",
             template: WIDGET_SETTINGS_TEMPLATE,
         },
         {
             type: "add",
-            path: "src/panel.ts",
+            path: "src/definition/panel.ts",
             template: WIDGET_PANEL_TEMPLATE,
         },
         {

package/dist/templates/package/additionalFiles.js

@@ -0,0 +1,20 @@
+export const GET_CHANGELOG_MD = (language) => {
+    switch (language) {
+        case "en":
+            return "<!-- Description of changes  -->";
+        case "ru":
+            return "<!-- Описание изменений -->";
+        default:
+            return "";
+    }
+};
+export const GET_DOC_MD = (language) => {
+    switch (language) {
+        case "en":
+            return "<!-- Package documentation -->";
+        case "ru":
+            return "<!-- Документация по пакету -->";
+        default:
+            return "";
+    }
+};

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

@@ -0,0 +1,32 @@
+export const WIDGET_DEFINITION_TEMPLATE = `\
+import type {
+  IDefinition,
+  IFillSettings,
+  IGroupSettings,
+  IPanelDescriptionCreator,
+  IWidgetDimension,
+  IWidgetDimensionHierarchy,
+  IWidgetMeasure,
+} from "@infomaximum/custom-widget";
+import { fillSettings, type WidgetSettings } from "definition/settings";
+import { createPanelDescription } from "definition/panel";
+
+export class Definition implements IDefinition<WidgetSettings, IGroupSettings> {
+  public createPanelDescription: IPanelDescriptionCreator<
+    WidgetSettings,
+    IGroupSettings
+  > = createPanelDescription;
+
+  public fillSettings: IFillSettings<WidgetSettings> = fillSettings;
+
+  public getDimensions(
+    settings: WidgetSettings
+  ): (IWidgetDimension | IWidgetDimensionHierarchy)[] {
+    return [];
+  }
+
+  public static getMeasures(settings: WidgetSettings): IWidgetMeasure[] {
+    return [];
+  }
+}
+`;

package/dist/templates/widget/src/{panel.js → definition/panel.js}

@@ -3,7 +3,7 @@ import {
   type IPanelDescriptionCreator,
   type IGroupSettings,
 } from "@infomaximum/custom-widget";
-import type { WidgetSettings } from "settings";
+import type { WidgetSettings } from "definition/settings";
 
 export const createPanelDescription: IPanelDescriptionCreator<
   WidgetSettings,

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

@@ -6,18 +6,15 @@ import ReactDOM from "react-dom/client";
 import "./index.css";
 import {
   type IWidget,
-  type IPanelDescription,
   type ICustomWidgetProps,
-  type IWidgetsContext,
-  type IWidgetMeasure,
-  type IWidgetDimension,
-  type IWidgetDimensionHierarchy,
 } from "@infomaximum/custom-widget";
 import manifest from "../${MANIFEST_JSON_FILE_NAME}";
-import { fillSettings, type WidgetSettings } from "settings";
-import { createPanelDescription } from "panel";
+import { type WidgetSettings } from "definition/settings";
+import { Definition } from "definition/definition";
 
 class CustomWidget implements IWidget<WidgetSettings> {
+  public static definition = new Definition();
+
   root: ReactDOM.Root | null = null;
 
   public initialize(container: HTMLElement) {
@@ -47,34 +44,10 @@ class CustomWidget implements IWidget<WidgetSettings> {
   private render(props: ICustomWidgetProps<WidgetSettings>) {
     this.root?.render(
       <React.StrictMode>
-      <div>{{ ${capitalizeHelperName} packageName}}</div>
+        <div>{{ ${capitalizeHelperName} packageName}}</div>
       </React.StrictMode>
     );
   }
-
-  public static createPanelDescription(
-    context: IWidgetsContext,
-    settings: WidgetSettings
-  ): IPanelDescription<WidgetSettings> {
-    return createPanelDescription(context, settings);
-  }
-
-  public static fillSettings(
-    settings: WidgetSettings,
-    context: IWidgetsContext
-  ) {
-    return fillSettings(settings, context);
-  }
-
-  public static getDimensions(
-    settings: WidgetSettings
-  ): (IWidgetDimension | IWidgetDimensionHierarchy)[] {
-    return [];
-  }
-
-  public static getMeasures(settings: WidgetSettings): IWidgetMeasure[] {
-    return [];
-  }
 }
 
 window.im.defineWidget(manifest.uuid, CustomWidget);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infomaximum/package-cli",
-  "version": "1.14.0",
+  "version": "1.16.0",
   "exports": "./dist/index.js",
   "type": "module",
   "license": "Apache-2.0",