@dxtmisha/scripts 0.11.7 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +67 -0
- package/ai-resources/componentMaterials.md +19 -0
- package/ai-resources/componentPrompt.md +381 -0
- package/ai-resources/componentWiki.md +13 -0
- package/bin/arguments.ts +168 -0
- package/bin/build-packages.ts +12 -2
- package/bin/build-publish-packages.ts +12 -2
- package/bin/design-component.ts +7 -1
- package/bin/design-constructor.ts +22 -3
- package/bin/design-figma.ts +26 -4
- package/bin/design-flags.ts +14 -2
- package/bin/design-library.ts +7 -1
- package/bin/design-package.ts +29 -5
- package/bin/design-prompt.ts +22 -3
- package/bin/design-screenshot.ts +12 -2
- package/bin/design-types-save.ts +32 -5
- package/bin/design-types.ts +32 -6
- package/bin/design-ui.ts +21 -3
- package/bin/design-wiki-storm.ts +11 -3
- package/dist/AiZAi-x3CInynJ.js +232 -0
- package/dist/PropertiesConfig-ChizwW5y.js +250 -0
- package/{src/config.ts → dist/config.d.ts} +179 -158
- package/dist/config.js +20 -0
- package/dist/figmaApiTypes-CArSsNW8.js +6 -0
- package/dist/library-ai.d.ts +482 -0
- package/dist/library-ai.js +2 -0
- package/dist/library-figma.d.ts +462 -0
- package/dist/library-figma.js +75 -0
- package/dist/library-ui.d.ts +586 -0
- package/dist/library-ui.js +3760 -0
- package/dist/library.d.ts +4677 -0
- package/dist/library.js +1436 -0
- package/dist/propertyTypes-DflziKuR.js +236 -0
- package/package.json +69 -20
- package/bin/ai-doc.ts +0 -7
- package/bin/build-functional.ts +0 -5
- package/bin/design-component-wiki.ts +0 -11
- package/src/classes/Ai/AiAbstract.ts +0 -242
- package/src/classes/Ai/AiClaude.ts +0 -26
- package/src/classes/Ai/AiClaudeAgent.ts +0 -16
- package/src/classes/Ai/AiClaudeAgentLite.ts +0 -86
- package/src/classes/Ai/AiClaudeCli.ts +0 -24
- package/src/classes/Ai/AiClaudeCliLite.ts +0 -108
- package/src/classes/Ai/AiClaudeLite.ts +0 -112
- package/src/classes/Ai/AiDoc.ts +0 -81
- package/src/classes/Ai/AiDocItem.ts +0 -27
- package/src/classes/Ai/AiDocItemAbstract.ts +0 -209
- package/src/classes/Ai/AiDocItemClasses.ts +0 -27
- package/src/classes/Ai/AiDocItemComposables.ts +0 -20
- package/src/classes/Ai/AiDocType.ts +0 -45
- package/src/classes/Ai/AiGoogle.ts +0 -26
- package/src/classes/Ai/AiGoogleCli.ts +0 -24
- package/src/classes/Ai/AiGoogleCliLite.ts +0 -108
- package/src/classes/Ai/AiGoogleLite.ts +0 -78
- package/src/classes/Ai/AiOpenAi.ts +0 -26
- package/src/classes/Ai/AiOpenAiLite.ts +0 -107
- package/src/classes/Ai/AiZAi.ts +0 -17
- package/src/classes/Ai/AiZAiLite.ts +0 -77
- package/src/classes/Ai/ApiTmp.ts +0 -43
- package/src/classes/BrowserItem.ts +0 -408
- package/src/classes/Build/BuildFunctional.ts +0 -54
- package/src/classes/Build/BuildPackages.ts +0 -137
- package/src/classes/Build/BuildPublishPackages.ts +0 -105
- package/src/classes/BuildItem.ts +0 -187
- package/src/classes/Component/ComponentCreator.ts +0 -45
- package/src/classes/Component/ComponentItem.ts +0 -161
- package/src/classes/Component/ComponentWiki.ts +0 -258
- package/src/classes/Component/ComponentWikiFile.ts +0 -138
- package/src/classes/Design/DesignCommand.ts +0 -243
- package/src/classes/Design/DesignComponent.ts +0 -824
- package/src/classes/Design/DesignConstructor.ts +0 -222
- package/src/classes/Design/DesignConstructors.ts +0 -101
- package/src/classes/Design/DesignFigma.ts +0 -61
- package/src/classes/Design/DesignFlags.ts +0 -215
- package/src/classes/Design/DesignReplace.ts +0 -672
- package/src/classes/Design/DesignScreenshot.ts +0 -133
- package/src/classes/Design/DesignStructure.ts +0 -201
- package/src/classes/Design/DesignStructureClasses.ts +0 -105
- package/src/classes/Design/DesignStructureItemAbstract.ts +0 -52
- package/src/classes/Design/DesignStructureRead.ts +0 -349
- package/src/classes/Design/DesignStructureStyles.ts +0 -45
- package/src/classes/Design/DesignTypes.ts +0 -94
- package/src/classes/Design/DesignTypesAi.ts +0 -135
- package/src/classes/Design/DesignTypesDescription.ts +0 -119
- package/src/classes/Design/DesignTypesMake.ts +0 -460
- package/src/classes/Design/DesignTypesMcp.ts +0 -90
- package/src/classes/Design/DesignTypesPrompts.ts +0 -332
- package/src/classes/Design/DesignTypescript.ts +0 -244
- package/src/classes/Design/DesignUi.ts +0 -143
- package/src/classes/Design/DesignWiki.ts +0 -52
- package/src/classes/Design/DesignWikiStorm.ts +0 -95
- package/src/classes/Design/DesignWikiStormItem.ts +0 -316
- package/src/classes/FigmaApi.ts +0 -190
- package/src/classes/Git/GitRead.ts +0 -261
- package/src/classes/Library/LibraryAiMcpItem.ts +0 -67
- package/src/classes/Library/LibraryAiPrompt.ts +0 -268
- package/src/classes/Library/LibraryAiPromptItem.ts +0 -331
- package/src/classes/Library/LibraryAiWiki.ts +0 -127
- package/src/classes/Library/LibraryAiWikiItem.ts +0 -79
- package/src/classes/Library/LibraryExport.ts +0 -167
- package/src/classes/Library/LibraryFlags.ts +0 -62
- package/src/classes/Library/LibraryItems.ts +0 -138
- package/src/classes/Library/LibraryList.ts +0 -189
- package/src/classes/Library/LibraryMedia.ts +0 -139
- package/src/classes/Library/LibraryPlugin.ts +0 -73
- package/src/classes/Library/LibraryTypes.ts +0 -130
- package/src/classes/Package/PackageFile.ts +0 -154
- package/src/classes/Package/PackageInit.ts +0 -54
- package/src/classes/Package/PackageItem.ts +0 -329
- package/src/classes/Properties/Properties.ts +0 -175
- package/src/classes/Properties/PropertiesCache.ts +0 -248
- package/src/classes/Properties/PropertiesConfig.ts +0 -213
- package/src/classes/Properties/PropertiesConvector.ts +0 -52
- package/src/classes/Properties/PropertiesFile.ts +0 -522
- package/src/classes/Properties/PropertiesImport.ts +0 -182
- package/src/classes/Properties/PropertiesItems.ts +0 -605
- package/src/classes/Properties/PropertiesKeys.ts +0 -121
- package/src/classes/Properties/PropertiesMain.ts +0 -138
- package/src/classes/Properties/PropertiesPalette.ts +0 -149
- package/src/classes/Properties/PropertiesPath.ts +0 -193
- package/src/classes/Properties/PropertiesScss.ts +0 -261
- package/src/classes/Properties/PropertiesSeparator.ts +0 -118
- package/src/classes/Properties/PropertiesSettings.ts +0 -104
- package/src/classes/Properties/PropertiesStandard.ts +0 -180
- package/src/classes/Properties/PropertiesTool.ts +0 -80
- package/src/classes/Properties/PropertiesTypes.ts +0 -147
- package/src/classes/Properties/PropertiesValues.ts +0 -75
- package/src/classes/Properties/PropertiesWrap.ts +0 -187
- package/src/classes/Properties/convector/convectorColor.ts +0 -27
- package/src/classes/Properties/convector/convectorFontFamilies.ts +0 -18
- package/src/classes/Properties/convector/convectorShadow.ts +0 -61
- package/src/classes/Properties/convector/convectorTypography.ts +0 -19
- package/src/classes/Properties/to/PropertiesToAbstract.ts +0 -51
- package/src/classes/Properties/to/PropertiesToAnimate.ts +0 -59
- package/src/classes/Properties/to/PropertiesToClass.ts +0 -49
- package/src/classes/Properties/to/PropertiesToClone.ts +0 -114
- package/src/classes/Properties/to/PropertiesToComponent.ts +0 -52
- package/src/classes/Properties/to/PropertiesToDrag.ts +0 -231
- package/src/classes/Properties/to/PropertiesToDuplicate.ts +0 -165
- package/src/classes/Properties/to/PropertiesToFull.ts +0 -36
- package/src/classes/Properties/to/PropertiesToLink.ts +0 -259
- package/src/classes/Properties/to/PropertiesToMedia.ts +0 -187
- package/src/classes/Properties/to/PropertiesToMulti.ts +0 -101
- package/src/classes/Properties/to/PropertiesToNone.ts +0 -46
- package/src/classes/Properties/to/PropertiesToPalette.ts +0 -241
- package/src/classes/Properties/to/PropertiesToProperty.ts +0 -31
- package/src/classes/Properties/to/PropertiesToRemove.ts +0 -33
- package/src/classes/Properties/to/PropertiesToReplace.ts +0 -77
- package/src/classes/Properties/to/PropertiesToRoot.ts +0 -40
- package/src/classes/Properties/to/PropertiesToSimilar.ts +0 -128
- package/src/classes/Properties/to/PropertiesToSort.ts +0 -146
- package/src/classes/Properties/to/PropertiesToState.ts +0 -65
- package/src/classes/Properties/to/PropertiesToStyle.ts +0 -52
- package/src/classes/Properties/to/PropertiesToSub.ts +0 -95
- package/src/classes/Properties/to/PropertiesToSubclass.ts +0 -76
- package/src/classes/Properties/to/PropertiesToVar.ts +0 -194
- package/src/classes/Properties/to/PropertiesToVariable.ts +0 -176
- package/src/classes/Styles/Styles.ts +0 -247
- package/src/classes/Styles/StylesClasses.ts +0 -86
- package/src/classes/Styles/StylesProperties.ts +0 -197
- package/src/classes/Styles/StylesRoot.ts +0 -103
- package/src/classes/Styles/StylesTool.ts +0 -112
- package/src/classes/Styles/to/StylesToAbstract.ts +0 -93
- package/src/classes/Styles/to/StylesToAnimate.ts +0 -19
- package/src/classes/Styles/to/StylesToClass.ts +0 -25
- package/src/classes/Styles/to/StylesToClassFull.ts +0 -19
- package/src/classes/Styles/to/StylesToContainer.ts +0 -24
- package/src/classes/Styles/to/StylesToMedia.ts +0 -19
- package/src/classes/Styles/to/StylesToProperty.ts +0 -123
- package/src/classes/Styles/to/StylesToRoot.ts +0 -14
- package/src/classes/Styles/to/StylesToSelector.ts +0 -71
- package/src/classes/Styles/to/StylesToVar.ts +0 -105
- package/src/classes/Styles/to/StylesToVirtual.ts +0 -33
- package/src/composables/useAi.ts +0 -38
- package/src/demo/ai.ts +0 -10
- package/src/functions/getComponentPaths.ts +0 -13
- package/src/functions/getConfigAi.ts +0 -14
- package/src/functions/getConstructorProperties.ts +0 -54
- package/src/functions/getDirname.ts +0 -17
- package/src/functions/getNameDirByPaths.ts +0 -16
- package/src/functions/getPackageJson.ts +0 -19
- package/src/functions/hasNativeDirname.ts +0 -8
- package/src/functions/run.ts +0 -47
- package/src/functions/toPathStandardSep.ts +0 -14
- package/src/library-ai.ts +0 -10
- package/src/library.ts +0 -73
- package/src/media/ai/ai-doc-types.ts +0 -21
- package/src/media/properties/css.ts +0 -634
- package/src/media/properties/cssSelector.ts +0 -74
- package/src/media/properties/cssVirtual.ts +0 -12
- package/src/media/properties/listSort.ts +0 -113
- package/src/media/properties/style.ts +0 -81
- package/src/media/templates/component/DesignComponent.mdx +0 -30
- package/src/media/templates/component/DesignComponent.stories.ts +0 -34
- package/src/media/templates/component/DesignComponent.vue +0 -54
- package/src/media/templates/component/DesignComponentAiWiki.vue +0 -25
- package/src/media/templates/component/index.ts +0 -13
- package/src/media/templates/component/props.ts +0 -27
- package/src/media/templates/component/styleToken.scss +0 -17
- package/src/media/templates/component/wiki.ts +0 -13
- package/src/media/templates/component/wikiData.ts +0 -28
- package/src/media/templates/componentDoc/ComponentDoc.vue +0 -26
- package/src/media/templates/componentDoc/index.ts +0 -12
- package/src/media/templates/componentDoc/materials/README.md +0 -8
- package/src/media/templates/componentDoc/materials/prompt.md +0 -38
- package/src/media/templates/componentDoc/subcomponents/_.gitignore.txt +0 -0
- package/src/media/templates/componentDoc/types.ts +0 -15
- package/src/media/templates/componentDoc/wiki/ComponentDoc.mdx +0 -13
- package/src/media/templates/componentDoc/wiki/ComponentDoc.stories.ts +0 -24
- package/src/media/templates/componentDoc/wiki/prompt.md +0 -41
- package/src/media/templates/constructors/Constructors.ts +0 -33
- package/src/media/templates/constructors/ConstructorsDesign.tsx +0 -129
- package/src/media/templates/constructors/basicTypes.ts +0 -0
- package/src/media/templates/constructors/index.ts +0 -5
- package/src/media/templates/constructors/props.ts +0 -28
- package/src/media/templates/constructors/style.scss +0 -5
- package/src/media/templates/constructors/types.ts +0 -47
- package/src/media/templates/packages/figma/README.md +0 -1
- package/src/media/templates/packages/figma/_.gitignore.txt +0 -29
- package/src/media/templates/packages/figma/ai.sample.config.ts +0 -2
- package/src/media/templates/packages/figma/design.config.json +0 -3
- package/src/media/templates/packages/figma/index.html +0 -12
- package/src/media/templates/packages/figma/manifest.json +0 -25
- package/src/media/templates/packages/figma/package.json +0 -37
- package/src/media/templates/packages/figma/src/App.vue +0 -9
- package/src/media/templates/packages/figma/src/classes/_.gitignore.txt +0 -1
- package/src/media/templates/packages/figma/src/code.ts +0 -16
- package/src/media/templates/packages/figma/src/components/_.gitignore.txt +0 -1
- package/src/media/templates/packages/figma/src/composables/_.gitignore.txt +0 -1
- package/src/media/templates/packages/figma/src/config.ts +0 -0
- package/src/media/templates/packages/figma/src/functions/_.gitignore.txt +0 -1
- package/src/media/templates/packages/figma/src/library.ts +0 -0
- package/src/media/templates/packages/figma/src/main.ts +0 -4
- package/src/media/templates/packages/figma/src/media/_.gitignore.txt +0 -1
- package/src/media/templates/packages/figma/src/storybook/_.gitignore.txt +0 -1
- package/src/media/templates/packages/figma/src/types/_.gitignore.txt +0 -1
- package/src/media/templates/packages/figma/src/vite-env.d.ts +0 -1
- package/src/media/templates/packages/figma/tsconfig.app.json +0 -12
- package/src/media/templates/packages/figma/tsconfig.json +0 -7
- package/src/media/templates/packages/figma/tsconfig.node.json +0 -8
- package/src/media/templates/packages/figma/vite.config.ts +0 -7
- package/src/media/templates/packages/library/README.md +0 -1
- package/src/media/templates/packages/library/_.gitignore.txt +0 -27
- package/src/media/templates/packages/library/ai-description.md +0 -15
- package/src/media/templates/packages/library/design.config.json +0 -3
- package/src/media/templates/packages/library/index.html +0 -12
- package/src/media/templates/packages/library/materials/README.md +0 -8
- package/src/media/templates/packages/library/materials/prompt.md +0 -45
- package/src/media/templates/packages/library/package.json +0 -46
- package/src/media/templates/packages/library/src/App.vue +0 -8
- package/src/media/templates/packages/library/src/classes/_.gitignore.txt +0 -1
- package/src/media/templates/packages/library/src/components/_.gitignore.txt +0 -1
- package/src/media/templates/packages/library/src/composables/_.gitignore.txt +0 -1
- package/src/media/templates/packages/library/src/functions/_.gitignore.txt +0 -1
- package/src/media/templates/packages/library/src/library.ts +0 -0
- package/src/media/templates/packages/library/src/main.ts +0 -6
- package/src/media/templates/packages/library/src/style.scss +0 -0
- package/src/media/templates/packages/library/src/types/_.gitignore.txt +0 -1
- package/src/media/templates/packages/library/src/vite-env.d.ts +0 -1
- package/src/media/templates/packages/library/tsconfig.app.json +0 -11
- package/src/media/templates/packages/library/tsconfig.json +0 -7
- package/src/media/templates/packages/library/tsconfig.node.json +0 -7
- package/src/media/templates/packages/library/vite.config.ts +0 -14
- package/src/media/templates/packages/nitro/README.md +0 -1
- package/src/media/templates/packages/nitro/_.gitignore.txt +0 -28
- package/src/media/templates/packages/nitro/index.html +0 -2
- package/src/media/templates/packages/nitro/package.json +0 -25
- package/src/media/templates/packages/nitro/server/plugins/ui-plugin.ts +0 -7
- package/src/media/templates/packages/nitro/server/routes/api/hello.ts +0 -13
- package/src/media/templates/packages/nitro/src/App.vue +0 -10
- package/src/media/templates/packages/nitro/src/assets/_.gitignore.txt +0 -0
- package/src/media/templates/packages/nitro/src/components/_.gitignore.txt +0 -0
- package/src/media/templates/packages/nitro/src/composables/_.gitignore.txt +0 -0
- package/src/media/templates/packages/nitro/src/entry-client.ts +0 -13
- package/src/media/templates/packages/nitro/src/entry-server.ts +0 -29
- package/src/media/templates/packages/nitro/src/main.ts +0 -14
- package/src/media/templates/packages/nitro/src/pages/HomePage.vue +0 -8
- package/src/media/templates/packages/nitro/src/router.ts +0 -11
- package/src/media/templates/packages/nitro/src/style.scss +0 -0
- package/src/media/templates/packages/nitro/src/templates/main.html +0 -21
- package/src/media/templates/packages/nitro/src/vite-env.d.ts +0 -11
- package/src/media/templates/packages/nitro/tsconfig.app.json +0 -14
- package/src/media/templates/packages/nitro/tsconfig.json +0 -7
- package/src/media/templates/packages/nitro/tsconfig.node.json +0 -12
- package/src/media/templates/packages/nitro/vite.config.ts +0 -17
- package/src/media/templates/packages/project/README.md +0 -1
- package/src/media/templates/packages/project/_.gitignore.txt +0 -28
- package/src/media/templates/packages/project/design.config.json +0 -3
- package/src/media/templates/packages/project/index.html +0 -12
- package/src/media/templates/packages/project/materials/README.md +0 -8
- package/src/media/templates/packages/project/materials/prompt.md +0 -41
- package/src/media/templates/packages/project/package.json +0 -13
- package/src/media/templates/packages/project/public/_.gitignore.txt +0 -0
- package/src/media/templates/packages/project/src/App.vue +0 -12
- package/src/media/templates/packages/project/src/assets/_.gitignore.txt +0 -0
- package/src/media/templates/packages/project/src/components/_.gitignore.txt +0 -0
- package/src/media/templates/packages/project/src/composables/_.gitignore.txt +0 -0
- package/src/media/templates/packages/project/src/main.ts +0 -6
- package/src/media/templates/packages/project/src/style.scss +0 -0
- package/src/media/templates/packages/project/src/vite-env.d.ts +0 -1
- package/src/media/templates/packages/project/tsconfig.app.json +0 -11
- package/src/media/templates/packages/project/tsconfig.json +0 -7
- package/src/media/templates/packages/project/tsconfig.node.json +0 -7
- package/src/media/templates/packages/project/vite.config.ts +0 -7
- package/src/media/templates/prompts/aiCodeGlobalPrompt.en.md +0 -22
- package/src/media/templates/prompts/aiCodeGlobalPrompt.ru.md +0 -21
- package/src/media/templates/prompts/aiCodeVuePrompt.en.md +0 -17
- package/src/media/templates/prompts/aiCodeVuePrompt.ru.md +0 -17
- package/src/media/templates/prompts/aiDocClassPrompt.en.txt +0 -63
- package/src/media/templates/prompts/aiDocClassPrompt.ru.txt +0 -63
- package/src/media/templates/prompts/aiDocComposablePrompt.en.txt +0 -67
- package/src/media/templates/prompts/aiDocComposablePrompt.ru.txt +0 -67
- package/src/media/templates/prompts/aiDocFunctionPrompt.en.txt +0 -57
- package/src/media/templates/prompts/aiDocFunctionPrompt.ru.txt +0 -57
- package/src/media/templates/prompts/componentPrompt.en.txt +0 -182
- package/src/media/templates/prompts/componentPrompt.ru.txt +0 -182
- package/src/media/templates/prompts/demoClassEn.mdx +0 -111
- package/src/media/templates/prompts/demoClassRu.mdx +0 -111
- package/src/media/templates/prompts/demoComponentEn.mdx +0 -282
- package/src/media/templates/prompts/demoComponentRu.mdx +0 -282
- package/src/media/templates/prompts/demoComposableEn.mdx +0 -103
- package/src/media/templates/prompts/demoComposableRu.mdx +0 -103
- package/src/media/templates/prompts/demoDocEn.mdx +0 -30
- package/src/media/templates/prompts/demoDocRu.mdx +0 -30
- package/src/media/templates/viteComponentTemplateConfig.ts +0 -14
- package/src/types/aiTypes.ts +0 -19
- package/src/types/configTypes.ts +0 -69
- package/src/types/designTypes.ts +0 -167
- package/src/types/figmaApiTypes.ts +0 -337
- package/src/types/gitTypes.ts +0 -59
- package/src/types/libraryTypes.ts +0 -49
- package/src/types/propertyTypes.ts +0 -586
- package/src/types/screenshotTypes.ts +0 -55
- package/src/types/webTypes.ts +0 -134
- package/src/vite-env.d.ts +0 -1
|
@@ -1,182 +0,0 @@
|
|
|
1
|
-
You are a professional technical writer and developer. Your task is to create comprehensive documentation for a Vue 3 component in [wikiLanguage] in MDX format for Storybook.
|
|
2
|
-
|
|
3
|
-
Use the following template and style.
|
|
4
|
-
|
|
5
|
-
### Input Data:
|
|
6
|
-
- Component code, types, and current stories (will be provided at the end of the request).
|
|
7
|
-
- Fully analyze the component code, including props, emits, slots, and expose.
|
|
8
|
-
- Section title: [title] (insert it into <Meta title='...'/>).
|
|
9
|
-
- [title] insert as is, this is a label for the script.
|
|
10
|
-
- Documentation must be in [wikiLanguage].
|
|
11
|
-
- All headings and descriptions must be in [wikiLanguage] (all content described in the "Documentation Structure" section must be in [wikiLanguage], e.g., "Parameters", "Returns").
|
|
12
|
-
|
|
13
|
-
### Documentation Structure:
|
|
14
|
-
|
|
15
|
-
1. **Description**:
|
|
16
|
-
- Start directly with text (NO markdown heading `## Description` or similar).
|
|
17
|
-
- Paragraph with description: purpose of the component, main use cases, benefits.
|
|
18
|
-
|
|
19
|
-
2. **Key Features**:
|
|
20
|
-
- Bold text title: `**Key features:**` (in [wikiLanguage]) on a separate line (NOT a markdown heading `##`).
|
|
21
|
-
- Bulleted list.
|
|
22
|
-
- Format: `- Description of the feature.` (simple sentences starting with capital letters).
|
|
23
|
-
|
|
24
|
-
3. **Typical Use Cases**:
|
|
25
|
-
- Bold text title: `**Typical use cases:**` or `**Typical Usage Scenarios:**` (in [wikiLanguage]) on a separate line (NOT a markdown heading `##`).
|
|
26
|
-
- Bulleted list.
|
|
27
|
-
- Format: `- Use case description.`
|
|
28
|
-
|
|
29
|
-
4. **Basic Usage**:
|
|
30
|
-
- Code example showing basic usage of the component.
|
|
31
|
-
- Code examples MUST be wrapped using the Storybook `<Source />` component instead of standard markdown backticks. Add `import { Source } from '@storybook/addon-docs/blocks';` at the top of the MDX file if not already present.
|
|
32
|
-
Format:
|
|
33
|
-
```md
|
|
34
|
-
<Source
|
|
35
|
-
code={`
|
|
36
|
-
<script setup>
|
|
37
|
-
// Script code
|
|
38
|
-
</script>
|
|
39
|
-
|
|
40
|
-
<template>
|
|
41
|
-
<Component />
|
|
42
|
-
</template>
|
|
43
|
-
`}
|
|
44
|
-
language="html"
|
|
45
|
-
/>
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
5. **Logical Property Groups (Props)**:
|
|
49
|
-
- Do not create a single general list of all properties. Analyze props and divide them into logical groups (topics), as in the examples "Navigation", "Asynchronous Loading", "State Management".
|
|
50
|
-
- For each group create a separate section:
|
|
51
|
-
- Heading `## Functionality Name` (in [wikiLanguage], e.g., "AJAX Loading" or "Navigation").
|
|
52
|
-
- Text description: Explain how the properties of this group work together and what problem they solve.
|
|
53
|
-
- List of group properties: `- propName — description`.
|
|
54
|
-
- Code example: Show the use of specifically these properties together. Wrap the code example using the Storybook `<Source />` component:
|
|
55
|
-
```md
|
|
56
|
-
<Source
|
|
57
|
-
code={`
|
|
58
|
-
// code here
|
|
59
|
-
`}
|
|
60
|
-
language="html"
|
|
61
|
-
/>
|
|
62
|
-
```
|
|
63
|
-
- Skip obvious properties (standard attributes) if they do not affect specific logic.
|
|
64
|
-
|
|
65
|
-
6. **Data Types** (Optional, if there are additional important types not described in the Function section):
|
|
66
|
-
- Heading `## Data Types` (in [wikiLanguage], e.g., "Data Types" or "Типы данных")
|
|
67
|
-
|
|
68
|
-
7. **Events**:
|
|
69
|
-
- Heading `## Events` (in [wikiLanguage], e.g., "Events" or "События")
|
|
70
|
-
- For each event:
|
|
71
|
-
- Header `### `eventName`` (the name must be wrapped in backticks).
|
|
72
|
-
- A brief paragraph describing when the event triggers.
|
|
73
|
-
- **Parameters:**
|
|
74
|
-
- Header: `**Parameters:**` (in [wikiLanguage], e.g., "Parameters:" or "Параметры:")
|
|
75
|
-
- List: `- `paramName: paramType` — parameter description.`
|
|
76
|
-
- **Structure of Custom Types (if applicable):**
|
|
77
|
-
- Header: `**TypeName structure:**` (in [wikiLanguage], e.g., "EventClickValue structure:" or "Структура EventClickValue:") (or `**TypeName structure:** same as for `otherEventName` event` if identical).
|
|
78
|
-
- List: `- `fieldName: fieldType` — field description.`
|
|
79
|
-
- **Code Example (if the event is complex):**
|
|
80
|
-
- Code examples MUST be wrapped using the Storybook `<Source />` component instead of standard markdown backticks. Remember to add `import { Source } from '@storybook/addon-docs/blocks';` at the top of the MDX file if not already present:
|
|
81
|
-
```md
|
|
82
|
-
<Source
|
|
83
|
-
code={`
|
|
84
|
-
<script setup>
|
|
85
|
-
// code example here
|
|
86
|
-
</script>
|
|
87
|
-
`}
|
|
88
|
-
language="html"
|
|
89
|
-
/>
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
8. **Expose (Component Methods & Properties)**:
|
|
93
|
-
- Heading `## Expose` (in [wikiLanguage], e.g., "Expose" or "Expose")
|
|
94
|
-
- Under the heading, present the list of public methods, reactive references (Refs), and computed variables exposed by the component, in the clean, signature-based bullet format:
|
|
95
|
-
- For methods: `- `methodName(paramName: paramType): returnType` — Description.`
|
|
96
|
-
- For reactive states (Refs/Computed): `- `propertyName: PropertyType` — Description.`
|
|
97
|
-
- Standard types include `boolean`, `void`, `Ref<any>`, `ComputedRef<any>`, etc.
|
|
98
|
-
|
|
99
|
-
9. **Slots**:
|
|
100
|
-
- Heading `## Slots` (in [wikiLanguage], e.g., "Slots" or "Слоты")
|
|
101
|
-
- Under the heading, present the list of slots in the clean, signature-based bullet format:
|
|
102
|
-
- For slots without parameters: `- `slotName: Type` — Description.`
|
|
103
|
-
- For slots with parameters: `- `slotName(paramName: paramType): Type` — Description.`
|
|
104
|
-
- Standard return type is usually `VNode` or `any`.
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
### Storybook Layout Helpers:
|
|
108
|
-
When writing Storybook stories (`*.stories.ts`) and examples in the MDX documentation, you MUST use the predefined showcase helper classes. These styles are imported globally and start with the `.wiki-storybook-` prefix. Do not write custom inline styles or new CSS classes for showcase layout, positioning, placeholders, or containers; use the following helper classes:
|
|
109
|
-
|
|
110
|
-
- **Containers & Layouts**:
|
|
111
|
-
- `.wiki-storybook-container` — enables container queries (`container-type: inline-size`).
|
|
112
|
-
- `.wiki-storybook-group` — a 12-column CSS Grid layout (`grid-template-columns: repeat(12, 1fr)`) with an `8px` gap, perfect for presenting multiple items or variations.
|
|
113
|
-
- Modifiers: `&--gapX2` (gap `16px`), `&--gapX3` (gap `24px`), `&--gapX4` (gap `32px`).
|
|
114
|
-
- `.wiki-storybook-flex` — basic flexbox wrapper (`display: flex; flex-wrap: wrap`) with an `8px` gap.
|
|
115
|
-
- `.wiki-storybook-flex-align-center` — same as flex wrapper, but aligns items vertically (`align-items: center`).
|
|
116
|
-
- `.wiki-storybook-flex-center` — centers items horizontally and vertically with an `8px` gap.
|
|
117
|
-
- `.wiki-storybook-flex-column` — vertical flexbox layout (`display: flex; flex-direction: column`) with a `16px` gap.
|
|
118
|
-
- `.wiki-storybook-decreased` — constrains maximum width of the showcase block to `72%`.
|
|
119
|
-
- `.wiki-storybook-decreasedX2` — constrains showcase block width responsively (`64%` at `md` screens, `48%` at `lg` screens).
|
|
120
|
-
|
|
121
|
-
- **Showcase Items (`.wiki-storybook-item`)**:
|
|
122
|
-
Used to display components inside a unified visual frame (aspect-ratio `1/1` by default, border, rounded corners, hidden overflow):
|
|
123
|
-
- `.wiki-storybook-item__label` — a small floaty label at the top-left corner (`font-size: 12px`, semi-transparent blurred background) for labeling specific variations. Use `.wiki-storybook-item__label--static` to make it flow statically inside the block without absolute positioning.
|
|
124
|
-
- `&--padding` — adds standard `16px` padding inside the item box.
|
|
125
|
-
- `&--paddingX2` — adds double standard `32px` padding.
|
|
126
|
-
- `&--rectangle` — sets a `16:9` aspect ratio and spans all 12 columns in a grid.
|
|
127
|
-
- `&--widescreen` — sets a `32:9` aspect ratio and spans all 12 columns in a grid.
|
|
128
|
-
- `&--compact` — sets a `64:9` aspect ratio and spans all 12 columns in a grid.
|
|
129
|
-
- `&--auto` — sets aspect ratio to `auto` and spans all 12 columns in a grid.
|
|
130
|
-
- `&--squared--xs`, `&--squared--sm`, `&--squared--md`, `&--squared--lg`, `&--squared--max` — responsive grid item spans. For instance, `--squared--sm` spans 6 columns on mobile, 4 columns on tablet (640px+), and 2 columns on desktop (1024px+).
|
|
131
|
-
- `&--center` — flex-centers internal elements.
|
|
132
|
-
- `&--widthAuto` — sets width to `auto`.
|
|
133
|
-
- `&--overflowVisible` — overrides `overflow: hidden` to `overflow: visible` (useful for dropdowns or modals).
|
|
134
|
-
- `&--overflowAuto` — sets overflow to `auto`.
|
|
135
|
-
- `&--borderNone` — hides default border.
|
|
136
|
-
- `&--rtl` — sets Right-to-Left (RTL) text and flex layout direction.
|
|
137
|
-
|
|
138
|
-
- **Mock Components & Placeholders**:
|
|
139
|
-
- `.wiki-storybook-card` — a mock card (`320px` width, rounded borders) to simulate real-world layout placement:
|
|
140
|
-
- `.wiki-storybook-card__image` — 128px high cover image.
|
|
141
|
-
- `.wiki-storybook-card__content` — vertical flex layout with `16px` padding and `16px` gap.
|
|
142
|
-
- `.wiki-storybook-card__label` — title with `20px` font size.
|
|
143
|
-
- `.wiki-storybook-card__information` — muted descriptions (`14px` size, gray).
|
|
144
|
-
- `.wiki-storybook-card__actions` — horizontal actions flex wrapper (`8px` gap).
|
|
145
|
-
- `.wiki-storybook-button` — standard story action trigger button. Modifiers for status colors: `&--success` (green), `&--error` (red), `&--warning` (yellow), `&--info` (blue).
|
|
146
|
-
- `.wiki-storybook-dummy` — visual placeholder box (`32px` high, dark translucent grey).
|
|
147
|
-
- Colors: `&--color--blue`, `&--color--red`, `&--color--green`.
|
|
148
|
-
- Sizes: `&--size--sm` (height `64px`), `&--size--md` (height `128px`), `&--size--lg` (height `256px`).
|
|
149
|
-
|
|
150
|
-
### Instructions:
|
|
151
|
-
1. Study the provided component code (including props, emits, slots, expose).
|
|
152
|
-
2. Identify all public interfaces.
|
|
153
|
-
3. Generate documentation strictly following the template above.
|
|
154
|
-
3.1. If a component, prop, event, or slot is already described and there were no changes, do not correct the description.
|
|
155
|
-
3.2. Try to keep original descriptions unchanged.
|
|
156
|
-
4. Use the correct terminology (Props, Events, Slots, Expose).
|
|
157
|
-
4.1. All headings must be in [wikiLanguage].
|
|
158
|
-
4.2. In Storybook stories and MDX code examples, you MUST use the predefined layout helper classes (described above) instead of inline styles or custom CSS blocks.
|
|
159
|
-
4.3. Do not modify the original component code under any circumstances unless explicitly requested.
|
|
160
|
-
4.4. Strictly follow all rules in this prompt. There is zero tolerance for hallucinations: do not invent, assume, or add any non-existent properties, methods, events, slots, or external package dependencies.
|
|
161
|
-
4.5. Do not use horizontal lines (rules like `---` or `***`) and do not use markdown tables anywhere in the documentation. Structure all information using headings, paragraphs, lists, and code blocks.
|
|
162
|
-
5. Do not add unnecessary introductions or conclusions, only MDX.
|
|
163
|
-
6. Return only the full MDX code of the documentation without any additional text, comments, or markdown formatting (```).
|
|
164
|
-
7. The result must be exclusively text (response), do not attach any files.
|
|
165
|
-
8. Response format. Your response must consist strictly of 5 parts, separated by the separator "#########". Do not add any text before or after this format.
|
|
166
|
-
|
|
167
|
-
**Technical Requirements (strictly preserve the following lines without changes):**
|
|
168
|
-
- `const meta = ...` — Storybook configuration.
|
|
169
|
-
- `import * as Component from ...` — component import.
|
|
170
|
-
- `import { Meta } from '@storybook/addon-docs/blocks'` — system import.
|
|
171
|
-
- `import { StorybookMain } from '@dxtmisha/wiki/storybook'` — system import.
|
|
172
|
-
|
|
173
|
-
Format:
|
|
174
|
-
[short description in a few words (3-5) about the component's purpose]
|
|
175
|
-
#########
|
|
176
|
-
[original component code (*.vue) with comments for methods (add them if missing). If all comments are already present, return --FULL--]
|
|
177
|
-
#########
|
|
178
|
-
[original component typing code (types.ts) with comments for props, emits, slots, and expose (add them if missing). If all comments are already present, return --FULL--]
|
|
179
|
-
#########
|
|
180
|
-
[original stories code (*.stories.ts). Analyze and add missing scenarios (stories) if necessary. If current stories are sufficient, return --FULL--]
|
|
181
|
-
#########
|
|
182
|
-
[the documentation itself in MDX format following the template above].
|
|
@@ -1,182 +0,0 @@
|
|
|
1
|
-
Ты — профессиональный технический писатель и разработчик. Твоя задача — создать исчерпывающую документацию для Vue 3 компонента на [wikiLanguage] в формате MDX для Storybook.
|
|
2
|
-
|
|
3
|
-
Используй следующий шаблон и стиль.
|
|
4
|
-
|
|
5
|
-
### Входные данные:
|
|
6
|
-
- Код компонента, типы и текущие stories (будут предоставлены в конце запроса).
|
|
7
|
-
- Полностью проанализируй код компонента, включая props, emits, slots и expose.
|
|
8
|
-
- Заголовок раздела: [title] (вставь его в <Meta title='...'/>).
|
|
9
|
-
- [title] вставить как есть, это метка для скрипта.
|
|
10
|
-
- Документация должна быть на [wikiLanguage].
|
|
11
|
-
- Все заголовки и описания должны быть на [wikiLanguage] (все содержимое, описанное в разделе "Структура документации", должно быть на языке [wikiLanguage], пример "Параметры", "Возвращает").
|
|
12
|
-
|
|
13
|
-
### Структура документации:
|
|
14
|
-
|
|
15
|
-
1. **Описание**:
|
|
16
|
-
- Начинай непосредственно с текста (БЕЗ заголовка markdown `## Описание` или аналогичного).
|
|
17
|
-
- Абзац с описанием: назначение компонента, основные сценарии использования, преимущества.
|
|
18
|
-
|
|
19
|
-
2. **Основные возможности (Key Features)**:
|
|
20
|
-
- Полужирный заголовок списка: `**Основные возможности:**` (на языке [wikiLanguage]) на отдельной строке (НЕ заголовок markdown `##`).
|
|
21
|
-
- Список с буллитами.
|
|
22
|
-
- Формат: `- Описание возможности.` (простые предложения, начинающиеся с заглавной буквы).
|
|
23
|
-
|
|
24
|
-
3. **Типичные сценарии использования (Typical Use Cases)**:
|
|
25
|
-
- Полужирный заголовок списка: `**Типичные сценарии использования:**` (на языке [wikiLanguage]) на отдельной строке (НЕ заголовок markdown `##`).
|
|
26
|
-
- Список с буллитами.
|
|
27
|
-
- Формат: `- Сценарий использования.`
|
|
28
|
-
|
|
29
|
-
4. **Пример использования (Basic Usage)**:
|
|
30
|
-
- Пример кода с использованием компонента.
|
|
31
|
-
- Примеры кода ОБЯЗАТЕЛЬНО должны быть обернуты в компонент Storybook `<Source />` вместо стандартного markdown-форматирования (три обратные кавычки). Добавь `import { Source } from '@storybook/addon-docs/blocks';` в самый верх MDX файла, если его там еще нет.
|
|
32
|
-
Формат:
|
|
33
|
-
```md
|
|
34
|
-
<Source
|
|
35
|
-
code={`
|
|
36
|
-
<script setup>
|
|
37
|
-
// Код скрипта
|
|
38
|
-
</script>
|
|
39
|
-
|
|
40
|
-
<template>
|
|
41
|
-
<Component />
|
|
42
|
-
</template>
|
|
43
|
-
`}
|
|
44
|
-
language="html"
|
|
45
|
-
/>
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
5. **Логические группы свойств (Props)**:
|
|
49
|
-
- Не создавай единый общий список всех свойств. Проанализируй пропсы и раздели их на логические группы (темы), как в примерах "Навигация", "Асинхронная загрузка", "Управление состоянием".
|
|
50
|
-
- Для каждой группы создай отдельный раздел:
|
|
51
|
-
- Заголовок `## Название функциональности` (на языке [wikiLanguage], например, "AJAX загрузка" или "Навигация").
|
|
52
|
-
- Текстовое описание: Объясни, как свойства этой группы работают вместе и какую задачу решают.
|
|
53
|
-
- Список свойств группы: `- propName — описание`.
|
|
54
|
-
- Пример кода: Покажи использование именно этих свойств в связке. Пример кода ОБЯЗАТЕЛЬНО должен быть обернут в компонент Storybook `<Source />`:
|
|
55
|
-
```md
|
|
56
|
-
<Source
|
|
57
|
-
code={`
|
|
58
|
-
// код здесь
|
|
59
|
-
`}
|
|
60
|
-
language="html"
|
|
61
|
-
/>
|
|
62
|
-
```
|
|
63
|
-
- Пропусти очевидные свойства (стандартные атрибуты), если они не влияют на специфическую логику.
|
|
64
|
-
|
|
65
|
-
6. **Типы данных** (Опционально, если есть дополнительные важные типы, которые не описаны в разделе Функция):
|
|
66
|
-
- Заголовок `## Типы данных` (на языке [wikiLanguage], например, "Data Types" или "Типы данных")
|
|
67
|
-
|
|
68
|
-
7. **Events (События)**:
|
|
69
|
-
- Заголовок `## Events` (на языке [wikiLanguage], например, "Events" или "События")
|
|
70
|
-
- Для каждого события:
|
|
71
|
-
- Заголовок `### \`имяСобытия\`` (имя события обязательно должно быть обернуто в обратные кавычки).
|
|
72
|
-
- Краткое текстовое описание того, когда событие срабатывает.
|
|
73
|
-
- **Параметры:**
|
|
74
|
-
- Заголовок: `**Параметры:**` (на языке [wikiLanguage], например, "Parameters:" или "Параметры:")
|
|
75
|
-
- Список: `- \`имяПараметра: типПараметра\` — описание параметра.`
|
|
76
|
-
- **Структура сложных типов (если применимо):**
|
|
77
|
-
- Заголовок: `**Структура TypeName:**` (на языке [wikiLanguage], например, "EventClickValue structure:" или "Структура EventClickValue:") (или `**Структура TypeName:** такая же, как для события \`другоеСобытие\``, если они идентичны).
|
|
78
|
-
- Список: `- \`имяПоля: типПоля\` — описание поля.`
|
|
79
|
-
- **Пример кода (если событие сложное):**
|
|
80
|
-
- Примеры кода ОБЯЗАТЕЛЬНО должны быть обернуты в компонент Storybook `<Source />` вместо стандартного markdown-форматирования (три обратные кавычки). Не забудь добавить `import { Source } from '@storybook/addon-docs/blocks';` в самый верх MDX файла, если его там еще нет:
|
|
81
|
-
```md
|
|
82
|
-
<Source
|
|
83
|
-
code={`
|
|
84
|
-
<script setup>
|
|
85
|
-
// пример кода здесь
|
|
86
|
-
</script>
|
|
87
|
-
`}
|
|
88
|
-
language="html"
|
|
89
|
-
/>
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
8. **Expose (Публичные методы и свойства компонента)**:
|
|
93
|
-
- Заголовок `## Expose` (на языке [wikiLanguage], например, "Expose" или "Expose")
|
|
94
|
-
- Внутри раздела выводи список публичных методов, реактивных ссылок (Refs) и вычисляемых свойств (Computed), доступных через ref компонента, в чистом маркированном формате сигнатур:
|
|
95
|
-
- Для методов: `- `имяМетода(имяПараметра: типПараметра): возвращаемыйТип` — Описание.`
|
|
96
|
-
- Для реактивных переменных/свойств: `- `имяСвойства: ТипСвойства` — Описание.`
|
|
97
|
-
- Стандартные типы возвращаемых значений: `boolean`, `void`, `Ref<any>`, `ComputedRef<any>` и т.д.
|
|
98
|
-
|
|
99
|
-
9. **Slots (Слоты)**:
|
|
100
|
-
- Заголовок `## Slots` (на языке [wikiLanguage], например, "Slots" or "Слоты")
|
|
101
|
-
- Внутри раздела выводи список слотов в чистом маркированном формате сигнатур:
|
|
102
|
-
- Для слотов без параметров: `- `имяСлота: Тип` — Описание.`
|
|
103
|
-
- Для слотов с параметрами: `- `имяСлота(имяПараметра: типПараметра): Тип` — Описание.`
|
|
104
|
-
- Стандартный тип возвращаемого значения обычно `VNode` или `any`.
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
### Вспомогательные стили Storybook:
|
|
108
|
-
При написании сценариев Storybook (`*.stories.ts`) и примеров кода в MDX-документации ОБЯЗАТЕЛЬНО используй предопределенные вспомогательные классы для демонстрации. Эти стили импортируются глобально и имеют префикс `.wiki-storybook-`. Избегай написания кастомных инлайн-стилей или новых CSS-классов для лейаута, позиционирования, заглушек или контейнеров. Используй следующие готовые классы:
|
|
109
|
-
|
|
110
|
-
- **Контейнеры и сетки**:
|
|
111
|
-
- `.wiki-storybook-container` — включает контейнерные запросы (`container-type: inline-size`).
|
|
112
|
-
- `.wiki-storybook-group` — CSS Grid сетка на 12 колонок (`grid-template-columns: repeat(12, 1fr)`) с отступом `8px`. Отлично подходит для демонстрации нескольких вариантов компонента.
|
|
113
|
-
- Модификаторы: `&--gapX2` (отступ `16px`), `&--gapX3` (отступ `24px`), `&--gapX4` (отступ `32px`).
|
|
114
|
-
- `.wiki-storybook-flex` — базовая flex-обертка (`display: flex; flex-wrap: wrap`) с отступом `8px`.
|
|
115
|
-
- `.wiki-storybook-flex-align-center` — flex-обертка с центрированием элементов по вертикали (`align-items: center`).
|
|
116
|
-
- `.wiki-storybook-flex-center` — полное центрирование элементов (горизонтальное и вертикальное) с отступом `8px`.
|
|
117
|
-
- `.wiki-storybook-flex-column` — вертикальный flex-контейнер (`display: flex; flex-direction: column`) с отступом `16px`.
|
|
118
|
-
- `.wiki-storybook-decreased` — уменьшает максимальную ширину блока до `72%`.
|
|
119
|
-
- `.wiki-storybook-decreasedX2` — адаптивно уменьшает ширину блока (`64%` на экранах `md`, `48%` на экранах `lg`).
|
|
120
|
-
|
|
121
|
-
- **Демонстрационные карточки (`.wiki-storybook-item`)**:
|
|
122
|
-
Используются для отображения компонентов внутри единого визуального блока (по умолчанию aspect-ratio `1/1`, рамка, скругление углов, скрытый overflow):
|
|
123
|
-
- `.wiki-storybook-item__label` — небольшая плавающая метка в левом верхнем углу (`font-size: 12px`, полупрозрачный размытый фон) для подписи вариаций. Класс `.wiki-storybook-item__label--static` делает метку статичной без абсолютного позиционирования.
|
|
124
|
-
- `&--padding` — добавляет стандартные внутренние отступы `16px`.
|
|
125
|
-
- `&--paddingX2` — добавляет двойные стандартные отступы `32px`.
|
|
126
|
-
- `&--rectangle` — устанавливает соотношение сторон `16:9` и растягивает блок на все 12 колонок в сетке.
|
|
127
|
-
- `&--widescreen` — соотношение сторон `32:9`, растягивает блок на все 12 колонок в сетке.
|
|
128
|
-
- `&--compact` — соотношение сторон `64:9`, растягивает блок на все 12 колонок в сетке.
|
|
129
|
-
- `&--auto` — автоматическое соотношение сторон, растягивает блок на все 12 колонок в сетке.
|
|
130
|
-
- `&--squared--xs`, `&--squared--sm`, `&--squared--md`, `&--squared--lg`, `&--squared--max` — адаптивное управление шириной квадратных блоков. Например, `--squared--sm` занимает 6 колонок на мобильных, 4 колонки на планшетах (от 640px) и 2 колонки на десктопах (от 1024px).
|
|
131
|
-
- `&--center` — выравнивает содержимое по центру с помощью flex.
|
|
132
|
-
- `&--widthAuto` — устанавливает ширину `auto`.
|
|
133
|
-
- `&--overflowVisible` — сбрасывает `overflow: hidden` на `overflow: visible` (необходимо для выпадающих меню, модалок).
|
|
134
|
-
- `&--overflowAuto` — включает автоматическую прокрутку (`overflow: auto`).
|
|
135
|
-
- `&--borderNone` — скрывает стандартную границу/рамку блока.
|
|
136
|
-
- `&--rtl` — включает режим отображения справа налево (Right-to-Left).
|
|
137
|
-
|
|
138
|
-
- **Тестовые компоненты и заглушки**:
|
|
139
|
-
- `.wiki-storybook-card` — тестовая карточка (ширина `320px`, скругления, рамка) для симуляции реального интерфейса:
|
|
140
|
-
- `.wiki-storybook-card__image` — обложка высотой 128px.
|
|
141
|
-
- `.wiki-storybook-card__content` — vertical flex-контейнер с отступами `16px` и расстоянием `16px`.
|
|
142
|
-
- `.wiki-storybook-card__label` — заголовок с размером шрифта `20px`.
|
|
143
|
-
- `.wiki-storybook-card__information` — серый текст описания (`14px`).
|
|
144
|
-
- `.wiki-storybook-card__actions` — горизонтальный контейнер для кнопок (`8px`).
|
|
145
|
-
- `.wiki-storybook-button` — кнопка-заглушка для обработки кликов. Модификаторы для статусных цветов: `&--success` (зеленый), `&--error` (красный), `&--warning` (желтый), `&--info` (синий).
|
|
146
|
-
- `.wiki-storybook-dummy` — визуальный блок-заглушка (`32px` высотой, полупрозрачный серый).
|
|
147
|
-
- Цвета: `&--color--blue`, `&--color--red`, `&--color--green`.
|
|
148
|
-
- Размеры (высота): `&--size--sm` (`64px`), `&--size--md` (`128px`), `&--size--lg` (`256px`).
|
|
149
|
-
|
|
150
|
-
### Инструкции:
|
|
151
|
-
1. Изучи предоставленный код компонента (включая props, emits, slots, expose).
|
|
152
|
-
2. Определи все публичные интерфейсы.
|
|
153
|
-
3. Сформируй документацию строго по шаблону выше.
|
|
154
|
-
3.1. Если уже описан компонент, проп, событие или слот, и при этом не было изменений, то не исправляй описание.
|
|
155
|
-
3.2. Старайся сохранять оригинальные описания без изменений.
|
|
156
|
-
4. Используй правильную терминологию (Props, Events, Slots, Expose).
|
|
157
|
-
4.1. Все заголовки должны быть на языке [wikiLanguage].
|
|
158
|
-
4.2. В сценариях Storybook и примерах MDX-кода вы ОБЯЗАНЫ использовать предопределенные классы-помощники разметки (описанные выше) вместо инлайн-стилей или кастомных блоков CSS.
|
|
159
|
-
4.3. Ни при каких обстоятельствах не изменяй оригинальный код компонента, если об этом явно не попросили.
|
|
160
|
-
4.4. Строго следуй всем правилам и инструкциям данного промпта. Никаких галлюцинаций: категорически запрещено придумывать, домысливать или добавлять несуществующие свойства (props), методы (expose), события (events), слоты (slots) или внешние зависимости.
|
|
161
|
-
4.5. Не используй горизонтальные линии (разделители вроде `---` или `***`) и не используй таблицы markdown в документации. Структурируй всю информацию с помощью заголовков, абзацев, списков и блоков кода.
|
|
162
|
-
5. Не добавляй лишних введений или заключений, только MDX.
|
|
163
|
-
6. Верни только полный MDX-код документации без какого-либо дополнительного текста, комментариев или форматирования markdown (```).
|
|
164
|
-
7. Результат должен быть исключительно в виде текста (ответа), не прикрепляй никаких файлов.
|
|
165
|
-
8. Формат ответа. Твой ответ должен состоять строго из 5 частей, разделенных разделителем "#########". Не добавляй никакого текста до или после этого формата.
|
|
166
|
-
|
|
167
|
-
**Технические требования (строго сохранить следующие строки без изменений):**
|
|
168
|
-
- `const meta = ...` — конфигурация Storybook.
|
|
169
|
-
- `import * as Component from ...` — импорт компонента.
|
|
170
|
-
- `import { Meta } from '@storybook/addon-docs/blocks'` — системный импорт.
|
|
171
|
-
- `import { StorybookMain } from '@dxtmisha/wiki/storybook'` — системный импорт.
|
|
172
|
-
|
|
173
|
-
Формат:
|
|
174
|
-
[короткое описание в несколько слов (3-5) о назначении компонента]
|
|
175
|
-
#########
|
|
176
|
-
[оригинальный код компонента (*.vue) с комментариями к методам (добавь их, если они отсутствуют). Если все комментарии уже присутствуют, верни --FULL--]
|
|
177
|
-
#########
|
|
178
|
-
[оригинальный код типизации компонента (types.ts) с комментариями к props, emits, slots и expose (добавь их, если они отсутствуют). Если все комментарии уже присутствуют, верни --FULL--]
|
|
179
|
-
#########
|
|
180
|
-
[оригинальный код stories (*.stories.ts). Проанализируй и добавь недостающие сценарии (stories), если это необходимо. Если текущие stories достаточны, верни --FULL--]
|
|
181
|
-
#########
|
|
182
|
-
[сама документация в MDX формате по шаблону выше].
|
|
@@ -1,111 +0,0 @@
|
|
|
1
|
-
import {Meta} from '@storybook/addon-docs/blocks'
|
|
2
|
-
|
|
3
|
-
<Meta title='[title]'/>
|
|
4
|
-
|
|
5
|
-
# Class TaskManager
|
|
6
|
-
|
|
7
|
-
An advanced manager for handling asynchronous tasks with support for priorities, dependencies, and execution queues. Allows organizing complex workflows with state control and error handling.
|
|
8
|
-
|
|
9
|
-
## Key Features
|
|
10
|
-
|
|
11
|
-
- **Execution Queues** — management of sequential and parallel execution
|
|
12
|
-
- **Prioritization** — weight system for determining task launch order
|
|
13
|
-
- **Dependencies** — ability to specify tasks that must be completed before the current one
|
|
14
|
-
- **Retries** — automatic task restart on failures
|
|
15
|
-
- **Event Model** — subscription to status changes and execution progress
|
|
16
|
-
|
|
17
|
-
## Data Types
|
|
18
|
-
|
|
19
|
-
### Task Configuration (TaskConfig)
|
|
20
|
-
|
|
21
|
-
Configuration object defining parameters for the created task.
|
|
22
|
-
|
|
23
|
-
**TaskConfig Properties:**
|
|
24
|
-
- `id?: string` — unique identifier (auto-generated if not specified)
|
|
25
|
-
- `handler: (ctx: TaskContext) => Promise<any>` — task execution function
|
|
26
|
-
- `priority?: number` — execution priority (default: `10`)
|
|
27
|
-
- `dependencies?: string[]` — array of task IDs that this task depends on
|
|
28
|
-
- `retry?: RetryOptions` — settings for retry attempts on error
|
|
29
|
-
- `timeout?: number` — maximum execution time in ms
|
|
30
|
-
|
|
31
|
-
```javascript
|
|
32
|
-
const config = {
|
|
33
|
-
priority: 100,
|
|
34
|
-
dependencies: ['auth-task'],
|
|
35
|
-
timeout: 5000,
|
|
36
|
-
handler: async (ctx) => {
|
|
37
|
-
return await api.fetchData()
|
|
38
|
-
}
|
|
39
|
-
}
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
### Execution Result (TaskResult<T>)
|
|
43
|
-
|
|
44
|
-
Object returned after task completion.
|
|
45
|
-
|
|
46
|
-
**TaskResult Properties:**
|
|
47
|
-
- `taskId: string` — identifier of the completed task
|
|
48
|
-
- `status: 'success' | 'error' | 'timeout'` — final status
|
|
49
|
-
- `data?: T` — data returned by the handler (on success)
|
|
50
|
-
- `error?: Error` — error object (on failure)
|
|
51
|
-
- `executionTime: number` — execution time in milliseconds
|
|
52
|
-
|
|
53
|
-
## Class Methods
|
|
54
|
-
|
|
55
|
-
### `registerTask`
|
|
56
|
-
|
|
57
|
-
Registers a new task in the scheduler system.
|
|
58
|
-
|
|
59
|
-
**Parameters:**
|
|
60
|
-
- `config: TaskConfig` — task configuration
|
|
61
|
-
|
|
62
|
-
**Returns:** `string` — identifier of the registered task
|
|
63
|
-
|
|
64
|
-
```javascript
|
|
65
|
-
import { TaskManager } from '@dxtmisha/functional'
|
|
66
|
-
|
|
67
|
-
const taskId = TaskManager.registerTask({
|
|
68
|
-
priority: 50,
|
|
69
|
-
handler: async () => {
|
|
70
|
-
console.log('Executing critical task')
|
|
71
|
-
return 'done'
|
|
72
|
-
}
|
|
73
|
-
})
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
### `executeAll`
|
|
77
|
-
|
|
78
|
-
Starts execution of all registered tasks considering their dependencies and priorities.
|
|
79
|
-
|
|
80
|
-
**Parameters:**
|
|
81
|
-
- `concurrency: number` — maximum number of parallel tasks (default: `5`)
|
|
82
|
-
|
|
83
|
-
**Returns:** `Promise<Map<string, TaskResult<any>>>` — map of execution results
|
|
84
|
-
|
|
85
|
-
```javascript
|
|
86
|
-
// Run with a limit of 3 parallel threads
|
|
87
|
-
const results = await TaskManager.executeAll(3)
|
|
88
|
-
|
|
89
|
-
if (results.get(taskId).status === 'success') {
|
|
90
|
-
console.log('Task completed successfully')
|
|
91
|
-
}
|
|
92
|
-
```
|
|
93
|
-
|
|
94
|
-
### `onProgress`
|
|
95
|
-
|
|
96
|
-
Subscribes to progress updates of a task group execution.
|
|
97
|
-
|
|
98
|
-
**Parameters:**
|
|
99
|
-
- `callback: (progress: number, active: number) => void` — callback function
|
|
100
|
-
|
|
101
|
-
**Returns:** `() => void` — unsubscribe function
|
|
102
|
-
|
|
103
|
-
```javascript
|
|
104
|
-
const unsubscribe = TaskManager.onProgress((percent, activeCount) => {
|
|
105
|
-
console.log(`Progress: ${percent}%, Active tasks: ${activeCount}`)
|
|
106
|
-
})
|
|
107
|
-
|
|
108
|
-
// Unsubscribe later
|
|
109
|
-
unsubscribe()
|
|
110
|
-
```
|
|
111
|
-
|
|
@@ -1,111 +0,0 @@
|
|
|
1
|
-
import {Meta} from '@storybook/addon-docs/blocks'
|
|
2
|
-
|
|
3
|
-
<Meta title='[title]'/>
|
|
4
|
-
|
|
5
|
-
# Класс TaskManager
|
|
6
|
-
|
|
7
|
-
Продвинутый менеджер для управления асинхронными задачами с поддержкой приоритетов, зависимостей и очередей выполнения. Позволяет организовывать сложные рабочие процессы с контролем состояния и обработкой ошибок.
|
|
8
|
-
|
|
9
|
-
## Основные возможности
|
|
10
|
-
|
|
11
|
-
- **Очереди выполнения** — управление последовательным и параллельным выполнением
|
|
12
|
-
- **Приоритезация** — система весов для определения порядка запуска задач
|
|
13
|
-
- **Зависимости** — возможность указать задачи, которые должны быть выполнены перед текущей
|
|
14
|
-
- **Повторные попытки** — автоматический перезапуск задач при сбоях
|
|
15
|
-
- **Событийная модель** — подписка на изменение статуса и прогресса выполнения
|
|
16
|
-
|
|
17
|
-
## Типы данных
|
|
18
|
-
|
|
19
|
-
### Конфигурация задачи (TaskConfig)
|
|
20
|
-
|
|
21
|
-
Объект конфигурации, определяющий параметры создаваемой задачи.
|
|
22
|
-
|
|
23
|
-
**Свойства TaskConfig:**
|
|
24
|
-
- `id?: string` — уникальный идентификатор (генерируется автоматически, если не указан)
|
|
25
|
-
- `handler: (ctx: TaskContext) => Promise<any>` — функция выполнения задачи
|
|
26
|
-
- `priority?: number` — приоритет выполнения (по умолчанию: `10`)
|
|
27
|
-
- `dependencies?: string[]` — массив ID задач, от которых зависит данная задача
|
|
28
|
-
- `retry?: RetryOptions` — настройки повторных попыток при ошибке
|
|
29
|
-
- `timeout?: number` — максимальное время выполнения в мс
|
|
30
|
-
|
|
31
|
-
```javascript
|
|
32
|
-
const config = {
|
|
33
|
-
priority: 100,
|
|
34
|
-
dependencies: ['auth-task'],
|
|
35
|
-
timeout: 5000,
|
|
36
|
-
handler: async (ctx) => {
|
|
37
|
-
return await api.fetchData()
|
|
38
|
-
}
|
|
39
|
-
}
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
### Результат выполнения (TaskResult<T>)
|
|
43
|
-
|
|
44
|
-
Объект, возвращаемый после завершения задачи.
|
|
45
|
-
|
|
46
|
-
**Свойства TaskResult:**
|
|
47
|
-
- `taskId: string` — идентификатор выполненной задачи
|
|
48
|
-
- `status: 'success' | 'error' | 'timeout'` — итоговый статус
|
|
49
|
-
- `data?: T` — данные, возвращенные обработчиком (при успехе)
|
|
50
|
-
- `error?: Error` — объект ошибки (при сбое)
|
|
51
|
-
- `executionTime: number` — время выполнения в миллисекундах
|
|
52
|
-
|
|
53
|
-
## Методы класса
|
|
54
|
-
|
|
55
|
-
### `registerTask`
|
|
56
|
-
|
|
57
|
-
Регистрирует новую задачу в системе планировщика.
|
|
58
|
-
|
|
59
|
-
**Параметры:**
|
|
60
|
-
- `config: TaskConfig` — конфигурация задачи
|
|
61
|
-
|
|
62
|
-
**Возвращает:** `string` — идентификатор зарегистрированной задачи
|
|
63
|
-
|
|
64
|
-
```javascript
|
|
65
|
-
import { TaskManager } from '@dxtmisha/functional'
|
|
66
|
-
|
|
67
|
-
const taskId = TaskManager.registerTask({
|
|
68
|
-
priority: 50,
|
|
69
|
-
handler: async () => {
|
|
70
|
-
console.log('Выполнение важной задачи')
|
|
71
|
-
return 'done'
|
|
72
|
-
}
|
|
73
|
-
})
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
### `executeAll`
|
|
77
|
-
|
|
78
|
-
Запускает выполнение всех зарегистрированных задач с учетом их зависимостей и приоритетов.
|
|
79
|
-
|
|
80
|
-
**Параметры:**
|
|
81
|
-
- `concurrency: number` — максимальное количество параллельных задач (по умолчанию: `5`)
|
|
82
|
-
|
|
83
|
-
**Возвращает:** `Promise<Map<string, TaskResult<any>>>` — карта результатов выполнения
|
|
84
|
-
|
|
85
|
-
```javascript
|
|
86
|
-
// Запуск с ограничением в 3 параллельных потока
|
|
87
|
-
const results = await TaskManager.executeAll(3)
|
|
88
|
-
|
|
89
|
-
if (results.get(taskId).status === 'success') {
|
|
90
|
-
console.log('Задача выполнена успешно')
|
|
91
|
-
}
|
|
92
|
-
```
|
|
93
|
-
|
|
94
|
-
### `onProgress`
|
|
95
|
-
|
|
96
|
-
Подписывается на обновления прогресса выполнения группы задач.
|
|
97
|
-
|
|
98
|
-
**Параметры:**
|
|
99
|
-
- `callback: (progress: number, active: number) => void` — функция обратного вызова
|
|
100
|
-
|
|
101
|
-
**Возвращает:** `() => void` — функция отписки
|
|
102
|
-
|
|
103
|
-
```javascript
|
|
104
|
-
const unsubscribe = TaskManager.onProgress((percent, activeCount) => {
|
|
105
|
-
console.log(`Прогресс: ${percent}%, Активных задач: ${activeCount}`)
|
|
106
|
-
})
|
|
107
|
-
|
|
108
|
-
// Позже отписаться
|
|
109
|
-
unsubscribe()
|
|
110
|
-
```
|
|
111
|
-
|