@aigne/doc-smith 0.8.12-beta.8 → 0.8.12
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 +15 -0
- package/agents/publish/index.yaml +4 -0
- package/agents/publish/publish-docs.mjs +77 -5
- package/agents/publish/translate-meta.mjs +103 -0
- package/agents/update/generate-document.yaml +30 -28
- package/agents/update/update-document-detail.yaml +3 -1
- package/agents/utils/update-branding.mjs +69 -0
- package/package.json +16 -2
- package/prompts/common/document/role-and-personality.md +3 -1
- package/prompts/detail/d2-diagram/guide.md +7 -1
- package/prompts/detail/d2-diagram/user-prompt.md +3 -0
- package/prompts/detail/generate/system-prompt.md +6 -7
- package/prompts/detail/generate/user-prompt.md +12 -3
- package/prompts/detail/update/user-prompt.md +0 -2
- package/prompts/structure/update/user-prompt.md +0 -4
- package/utils/file-utils.mjs +69 -24
- package/utils/markdown-checker.mjs +0 -20
- package/utils/request.mjs +7 -0
- package/utils/upload-files.mjs +231 -0
- package/utils/utils.mjs +11 -1
- package/.aigne/doc-smith/config.yaml +0 -77
- package/.aigne/doc-smith/history.yaml +0 -37
- package/.aigne/doc-smith/media-description.yaml +0 -91
- package/.aigne/doc-smith/output/structure-plan.json +0 -162
- package/.aigne/doc-smith/preferences.yml +0 -97
- package/.aigne/doc-smith/upload-cache.yaml +0 -1830
- package/.github/PULL_REQUEST_TEMPLATE.md +0 -28
- package/.github/workflows/ci.yml +0 -54
- package/.github/workflows/create-release-pr.yaml +0 -21
- package/.github/workflows/publish-docs.yml +0 -65
- package/.github/workflows/release.yml +0 -49
- package/.github/workflows/reviewer.yml +0 -54
- package/.release-please-manifest.json +0 -3
- package/RELEASE.md +0 -9
- package/assets/screenshots/doc-complete-setup.png +0 -0
- package/assets/screenshots/doc-generate-docs.png +0 -0
- package/assets/screenshots/doc-generate.png +0 -0
- package/assets/screenshots/doc-generated-successfully.png +0 -0
- package/assets/screenshots/doc-publish.png +0 -0
- package/assets/screenshots/doc-regenerate.png +0 -0
- package/assets/screenshots/doc-translate-langs.png +0 -0
- package/assets/screenshots/doc-translate.png +0 -0
- package/assets/screenshots/doc-update.png +0 -0
- package/biome.json +0 -73
- package/codecov.yml +0 -15
- package/docs/_sidebar.md +0 -15
- package/docs/configuration-initial-setup.ja.md +0 -179
- package/docs/configuration-initial-setup.md +0 -198
- package/docs/configuration-initial-setup.zh-TW.md +0 -179
- package/docs/configuration-initial-setup.zh.md +0 -179
- package/docs/configuration-managing-preferences.ja.md +0 -100
- package/docs/configuration-managing-preferences.md +0 -100
- package/docs/configuration-managing-preferences.zh-TW.md +0 -100
- package/docs/configuration-managing-preferences.zh.md +0 -100
- package/docs/configuration.ja.md +0 -69
- package/docs/configuration.md +0 -69
- package/docs/configuration.zh-TW.md +0 -69
- package/docs/configuration.zh.md +0 -69
- package/docs/getting-started.ja.md +0 -107
- package/docs/getting-started.md +0 -107
- package/docs/getting-started.zh-TW.md +0 -107
- package/docs/getting-started.zh.md +0 -107
- package/docs/guides-cleaning-up.ja.md +0 -51
- package/docs/guides-cleaning-up.md +0 -52
- package/docs/guides-cleaning-up.zh-TW.md +0 -51
- package/docs/guides-cleaning-up.zh.md +0 -51
- package/docs/guides-evaluating-documents.ja.md +0 -66
- package/docs/guides-evaluating-documents.md +0 -107
- package/docs/guides-evaluating-documents.zh-TW.md +0 -66
- package/docs/guides-evaluating-documents.zh.md +0 -66
- package/docs/guides-generating-documentation.ja.md +0 -151
- package/docs/guides-generating-documentation.md +0 -89
- package/docs/guides-generating-documentation.zh-TW.md +0 -151
- package/docs/guides-generating-documentation.zh.md +0 -151
- package/docs/guides-interactive-chat.ja.md +0 -85
- package/docs/guides-interactive-chat.md +0 -93
- package/docs/guides-interactive-chat.zh-TW.md +0 -85
- package/docs/guides-interactive-chat.zh.md +0 -85
- package/docs/guides-managing-history.ja.md +0 -48
- package/docs/guides-managing-history.md +0 -53
- package/docs/guides-managing-history.zh-TW.md +0 -48
- package/docs/guides-managing-history.zh.md +0 -48
- package/docs/guides-publishing-your-docs.ja.md +0 -78
- package/docs/guides-publishing-your-docs.md +0 -83
- package/docs/guides-publishing-your-docs.zh-TW.md +0 -78
- package/docs/guides-publishing-your-docs.zh.md +0 -78
- package/docs/guides-translating-documentation.ja.md +0 -95
- package/docs/guides-translating-documentation.md +0 -100
- package/docs/guides-translating-documentation.zh-TW.md +0 -95
- package/docs/guides-translating-documentation.zh.md +0 -95
- package/docs/guides-updating-documentation.ja.md +0 -77
- package/docs/guides-updating-documentation.md +0 -79
- package/docs/guides-updating-documentation.zh-TW.md +0 -77
- package/docs/guides-updating-documentation.zh.md +0 -77
- package/docs/guides.ja.md +0 -32
- package/docs/guides.md +0 -32
- package/docs/guides.zh-TW.md +0 -32
- package/docs/guides.zh.md +0 -32
- package/docs/overview.ja.md +0 -61
- package/docs/overview.md +0 -61
- package/docs/overview.zh-TW.md +0 -61
- package/docs/overview.zh.md +0 -61
- package/docs/release-notes.ja.md +0 -255
- package/docs/release-notes.md +0 -288
- package/docs/release-notes.zh-TW.md +0 -255
- package/docs/release-notes.zh.md +0 -255
- package/prompts/common/afs/afs-tools-usage.md +0 -5
- package/prompts/common/afs/use-afs-instruction.md +0 -1
- package/release-please-config.json +0 -14
- package/tests/agents/chat/chat.test.mjs +0 -46
- package/tests/agents/clear/choose-contents.test.mjs +0 -284
- package/tests/agents/clear/clear-auth-tokens.test.mjs +0 -268
- package/tests/agents/clear/clear-document-config.test.mjs +0 -167
- package/tests/agents/clear/clear-document-structure.test.mjs +0 -380
- package/tests/agents/clear/clear-generated-docs.test.mjs +0 -222
- package/tests/agents/evaluate/code-snippet.test.mjs +0 -163
- package/tests/agents/evaluate/fixtures/api-services.md +0 -87
- package/tests/agents/evaluate/fixtures/js-sdk.md +0 -94
- package/tests/agents/evaluate/generate-report.test.mjs +0 -312
- package/tests/agents/generate/check-document-structure.test.mjs +0 -45
- package/tests/agents/generate/check-need-generate-structure.test.mjs +0 -279
- package/tests/agents/generate/document-structure-tools/add-document.test.mjs +0 -449
- package/tests/agents/generate/document-structure-tools/delete-document.test.mjs +0 -410
- package/tests/agents/generate/document-structure-tools/generate-sub-structure.test.mjs +0 -277
- package/tests/agents/generate/document-structure-tools/move-document.test.mjs +0 -476
- package/tests/agents/generate/document-structure-tools/update-document.test.mjs +0 -548
- package/tests/agents/generate/generate-structure.test.mjs +0 -45
- package/tests/agents/generate/user-review-document-structure.test.mjs +0 -319
- package/tests/agents/history/view.test.mjs +0 -97
- package/tests/agents/init/init.test.mjs +0 -1657
- package/tests/agents/prefs/prefs.test.mjs +0 -431
- package/tests/agents/publish/publish-docs.test.mjs +0 -787
- package/tests/agents/translate/choose-language.test.mjs +0 -311
- package/tests/agents/translate/translate-document.test.mjs +0 -51
- package/tests/agents/update/check-document.test.mjs +0 -463
- package/tests/agents/update/check-update-is-single.test.mjs +0 -300
- package/tests/agents/update/document-tools/update-document-content.test.mjs +0 -329
- package/tests/agents/update/generate-document.test.mjs +0 -51
- package/tests/agents/update/save-and-translate-document.test.mjs +0 -369
- package/tests/agents/update/user-review-document.test.mjs +0 -582
- package/tests/agents/utils/action-success.test.mjs +0 -54
- package/tests/agents/utils/check-detail-result.test.mjs +0 -743
- package/tests/agents/utils/check-feedback-refiner.test.mjs +0 -478
- package/tests/agents/utils/choose-docs.test.mjs +0 -406
- package/tests/agents/utils/exit.test.mjs +0 -70
- package/tests/agents/utils/feedback-refiner.test.mjs +0 -51
- package/tests/agents/utils/find-item-by-path.test.mjs +0 -517
- package/tests/agents/utils/find-user-preferences-by-path.test.mjs +0 -382
- package/tests/agents/utils/format-document-structure.test.mjs +0 -364
- package/tests/agents/utils/fs.test.mjs +0 -267
- package/tests/agents/utils/load-sources.test.mjs +0 -1470
- package/tests/agents/utils/save-docs.test.mjs +0 -109
- package/tests/agents/utils/save-output.test.mjs +0 -315
- package/tests/agents/utils/save-single-doc.test.mjs +0 -364
- package/tests/agents/utils/transform-detail-datasources.test.mjs +0 -320
- package/tests/utils/auth-utils.test.mjs +0 -596
- package/tests/utils/blocklet.test.mjs +0 -336
- package/tests/utils/conflict-detector.test.mjs +0 -355
- package/tests/utils/constants.test.mjs +0 -295
- package/tests/utils/d2-utils.test.mjs +0 -437
- package/tests/utils/deploy.test.mjs +0 -399
- package/tests/utils/docs-finder-utils.test.mjs +0 -650
- package/tests/utils/file-utils.test.mjs +0 -521
- package/tests/utils/history-utils.test.mjs +0 -206
- package/tests/utils/kroki-utils.test.mjs +0 -646
- package/tests/utils/linter/fixtures/css/keyword-error.css +0 -1
- package/tests/utils/linter/fixtures/css/missing-semicolon.css +0 -1
- package/tests/utils/linter/fixtures/css/syntax-error.css +0 -1
- package/tests/utils/linter/fixtures/css/undeclare-variable.css +0 -1
- package/tests/utils/linter/fixtures/css/unused-variable.css +0 -2
- package/tests/utils/linter/fixtures/css/valid-code.css +0 -1
- package/tests/utils/linter/fixtures/dockerfile/keyword-error.dockerfile +0 -1
- package/tests/utils/linter/fixtures/dockerfile/missing-semicolon.dockerfile +0 -2
- package/tests/utils/linter/fixtures/dockerfile/syntax-error.dockerfile +0 -2
- package/tests/utils/linter/fixtures/dockerfile/undeclare-variable.dockerfile +0 -1
- package/tests/utils/linter/fixtures/dockerfile/unused-variable.dockerfile +0 -1
- package/tests/utils/linter/fixtures/dockerfile/valid-code.dockerfile +0 -2
- package/tests/utils/linter/fixtures/go/keyword-error.go +0 -5
- package/tests/utils/linter/fixtures/go/missing-semicolon.go +0 -5
- package/tests/utils/linter/fixtures/go/syntax-error.go +0 -6
- package/tests/utils/linter/fixtures/go/undeclare-variable.go +0 -5
- package/tests/utils/linter/fixtures/go/unused-variable.go +0 -5
- package/tests/utils/linter/fixtures/go/valid-code.go +0 -7
- package/tests/utils/linter/fixtures/js/keyword-error.js +0 -3
- package/tests/utils/linter/fixtures/js/missing-semicolon.js +0 -6
- package/tests/utils/linter/fixtures/js/syntax-error.js +0 -4
- package/tests/utils/linter/fixtures/js/undeclare-variable.js +0 -3
- package/tests/utils/linter/fixtures/js/unused-variable.js +0 -7
- package/tests/utils/linter/fixtures/js/valid-code.js +0 -15
- package/tests/utils/linter/fixtures/json/keyword-error.json +0 -1
- package/tests/utils/linter/fixtures/json/missing-semicolon.json +0 -1
- package/tests/utils/linter/fixtures/json/syntax-error.json +0 -1
- package/tests/utils/linter/fixtures/json/undeclare-variable.json +0 -1
- package/tests/utils/linter/fixtures/json/unused-variable.json +0 -1
- package/tests/utils/linter/fixtures/json/valid-code.json +0 -1
- package/tests/utils/linter/fixtures/jsx/keyword-error.jsx +0 -5
- package/tests/utils/linter/fixtures/jsx/missing-semicolon.jsx +0 -5
- package/tests/utils/linter/fixtures/jsx/syntax-error.jsx +0 -5
- package/tests/utils/linter/fixtures/jsx/undeclare-variable.jsx +0 -5
- package/tests/utils/linter/fixtures/jsx/unused-variable.jsx +0 -4
- package/tests/utils/linter/fixtures/jsx/valid-code.jsx +0 -5
- package/tests/utils/linter/fixtures/python/keyword-error.py +0 -3
- package/tests/utils/linter/fixtures/python/missing-semicolon.py +0 -2
- package/tests/utils/linter/fixtures/python/syntax-error.py +0 -3
- package/tests/utils/linter/fixtures/python/undeclare-variable.py +0 -3
- package/tests/utils/linter/fixtures/python/unused-variable.py +0 -6
- package/tests/utils/linter/fixtures/python/valid-code.py +0 -12
- package/tests/utils/linter/fixtures/ruby/keyword-error.rb +0 -2
- package/tests/utils/linter/fixtures/ruby/missing-semicolon.rb +0 -1
- package/tests/utils/linter/fixtures/ruby/syntax-error.rb +0 -2
- package/tests/utils/linter/fixtures/ruby/undeclare-variable.rb +0 -1
- package/tests/utils/linter/fixtures/ruby/unused-variable.rb +0 -2
- package/tests/utils/linter/fixtures/ruby/valid-code.rb +0 -1
- package/tests/utils/linter/fixtures/sass/keyword-error.sass +0 -2
- package/tests/utils/linter/fixtures/sass/missing-semicolon.sass +0 -3
- package/tests/utils/linter/fixtures/sass/syntax-error.sass +0 -3
- package/tests/utils/linter/fixtures/sass/undeclare-variable.sass +0 -2
- package/tests/utils/linter/fixtures/sass/unused-variable.sass +0 -4
- package/tests/utils/linter/fixtures/sass/valid-code.sass +0 -2
- package/tests/utils/linter/fixtures/scss/keyword-error.scss +0 -1
- package/tests/utils/linter/fixtures/scss/missing-semicolon.scss +0 -1
- package/tests/utils/linter/fixtures/scss/syntax-error.scss +0 -1
- package/tests/utils/linter/fixtures/scss/undeclare-variable.scss +0 -1
- package/tests/utils/linter/fixtures/scss/unused-variable.scss +0 -2
- package/tests/utils/linter/fixtures/scss/valid-code.scss +0 -1
- package/tests/utils/linter/fixtures/shell/keyword-error.sh +0 -5
- package/tests/utils/linter/fixtures/shell/missing-semicolon.sh +0 -3
- package/tests/utils/linter/fixtures/shell/syntax-error.sh +0 -4
- package/tests/utils/linter/fixtures/shell/undeclare-variable.sh +0 -3
- package/tests/utils/linter/fixtures/shell/unused-variable.sh +0 -4
- package/tests/utils/linter/fixtures/shell/valid-code.sh +0 -3
- package/tests/utils/linter/fixtures/ts/keyword-error.ts +0 -1
- package/tests/utils/linter/fixtures/ts/missing-semicolon.ts +0 -1
- package/tests/utils/linter/fixtures/ts/syntax-error.ts +0 -1
- package/tests/utils/linter/fixtures/ts/undeclare-variable.ts +0 -1
- package/tests/utils/linter/fixtures/ts/unused-variable.ts +0 -3
- package/tests/utils/linter/fixtures/ts/valid-code.ts +0 -3
- package/tests/utils/linter/fixtures/tsx/keyword-error.tsx +0 -5
- package/tests/utils/linter/fixtures/tsx/missing-semicolon.tsx +0 -5
- package/tests/utils/linter/fixtures/tsx/syntax-error.tsx +0 -5
- package/tests/utils/linter/fixtures/tsx/undeclare-variable.tsx +0 -6
- package/tests/utils/linter/fixtures/tsx/unused-variable.tsx +0 -6
- package/tests/utils/linter/fixtures/tsx/valid-code.tsx +0 -5
- package/tests/utils/linter/fixtures/vue/keyword-error.vue +0 -6
- package/tests/utils/linter/fixtures/vue/missing-semicolon.vue +0 -6
- package/tests/utils/linter/fixtures/vue/syntax-error.vue +0 -6
- package/tests/utils/linter/fixtures/vue/undeclare-variable.vue +0 -6
- package/tests/utils/linter/fixtures/vue/unused-variable.vue +0 -7
- package/tests/utils/linter/fixtures/vue/valid-code.vue +0 -6
- package/tests/utils/linter/fixtures/yaml/keyword-error.yml +0 -1
- package/tests/utils/linter/fixtures/yaml/missing-semicolon.yml +0 -2
- package/tests/utils/linter/fixtures/yaml/syntax-error.yml +0 -1
- package/tests/utils/linter/fixtures/yaml/undeclare-variable.yml +0 -1
- package/tests/utils/linter/fixtures/yaml/unused-variable.yml +0 -2
- package/tests/utils/linter/fixtures/yaml/valid-code.yml +0 -3
- package/tests/utils/linter/index.test.mjs +0 -440
- package/tests/utils/linter/scan-results.mjs +0 -42
- package/tests/utils/load-config.test.mjs +0 -141
- package/tests/utils/markdown/index.test.mjs +0 -478
- package/tests/utils/mermaid-validator.test.mjs +0 -541
- package/tests/utils/mock-chat-model.mjs +0 -12
- package/tests/utils/preferences-utils.test.mjs +0 -465
- package/tests/utils/save-value-to-config.test.mjs +0 -483
- package/tests/utils/utils.test.mjs +0 -941
|
@@ -1,295 +0,0 @@
|
|
|
1
|
-
import { describe, expect, test } from "bun:test";
|
|
2
|
-
import {
|
|
3
|
-
BLOCKLET_ADD_COMPONENT_DOCS,
|
|
4
|
-
CONFLICT_RESOLUTION_RULES,
|
|
5
|
-
CONFLICT_RULES,
|
|
6
|
-
D2_CONFIG,
|
|
7
|
-
DEFAULT_EXCLUDE_PATTERNS,
|
|
8
|
-
DEFAULT_INCLUDE_PATTERNS,
|
|
9
|
-
DISCUSS_KIT_DID,
|
|
10
|
-
DISCUSS_KIT_STORE_URL,
|
|
11
|
-
DOCUMENT_STYLES,
|
|
12
|
-
DOCUMENTATION_DEPTH,
|
|
13
|
-
FILE_CONCURRENCY,
|
|
14
|
-
KROKI_CONCURRENCY,
|
|
15
|
-
PURPOSE_TO_KNOWLEDGE_MAPPING,
|
|
16
|
-
READER_KNOWLEDGE_LEVELS,
|
|
17
|
-
SUPPORTED_FILE_EXTENSIONS,
|
|
18
|
-
SUPPORTED_LANGUAGES,
|
|
19
|
-
TARGET_AUDIENCES,
|
|
20
|
-
TMP_ASSETS_DIR,
|
|
21
|
-
TMP_DIR,
|
|
22
|
-
TMP_DOCS_DIR,
|
|
23
|
-
} from "../../utils/constants/index.mjs";
|
|
24
|
-
|
|
25
|
-
describe("constants", () => {
|
|
26
|
-
describe("DEFAULT_INCLUDE_PATTERNS", () => {
|
|
27
|
-
test("should contain common programming language patterns", () => {
|
|
28
|
-
expect(DEFAULT_INCLUDE_PATTERNS).toContain("*.js");
|
|
29
|
-
expect(DEFAULT_INCLUDE_PATTERNS).toContain("*.ts");
|
|
30
|
-
expect(DEFAULT_INCLUDE_PATTERNS).toContain("*.py");
|
|
31
|
-
expect(DEFAULT_INCLUDE_PATTERNS).toContain("*.java");
|
|
32
|
-
expect(DEFAULT_INCLUDE_PATTERNS).toContain("*.go");
|
|
33
|
-
expect(DEFAULT_INCLUDE_PATTERNS).toContain("*.rs");
|
|
34
|
-
});
|
|
35
|
-
|
|
36
|
-
test("should contain documentation patterns", () => {
|
|
37
|
-
expect(DEFAULT_INCLUDE_PATTERNS).toContain("*.md");
|
|
38
|
-
expect(DEFAULT_INCLUDE_PATTERNS).toContain("*.rst");
|
|
39
|
-
expect(DEFAULT_INCLUDE_PATTERNS).toContain("*.yaml");
|
|
40
|
-
expect(DEFAULT_INCLUDE_PATTERNS).toContain("*.json");
|
|
41
|
-
});
|
|
42
|
-
|
|
43
|
-
test("should contain media file patterns", () => {
|
|
44
|
-
expect(DEFAULT_INCLUDE_PATTERNS).toContain("*.png");
|
|
45
|
-
expect(DEFAULT_INCLUDE_PATTERNS).toContain("*.jpg");
|
|
46
|
-
expect(DEFAULT_INCLUDE_PATTERNS).toContain("*.svg");
|
|
47
|
-
expect(DEFAULT_INCLUDE_PATTERNS).toContain("*.mp4");
|
|
48
|
-
});
|
|
49
|
-
|
|
50
|
-
test("should be an array of strings", () => {
|
|
51
|
-
expect(Array.isArray(DEFAULT_INCLUDE_PATTERNS)).toBe(true);
|
|
52
|
-
expect(DEFAULT_INCLUDE_PATTERNS.length).toBeGreaterThan(0);
|
|
53
|
-
DEFAULT_INCLUDE_PATTERNS.forEach((pattern) => {
|
|
54
|
-
expect(typeof pattern).toBe("string");
|
|
55
|
-
});
|
|
56
|
-
});
|
|
57
|
-
});
|
|
58
|
-
|
|
59
|
-
describe("DEFAULT_EXCLUDE_PATTERNS", () => {
|
|
60
|
-
test("should contain common exclusion patterns", () => {
|
|
61
|
-
expect(DEFAULT_EXCLUDE_PATTERNS).toContain("**/*node_modules/**");
|
|
62
|
-
expect(DEFAULT_EXCLUDE_PATTERNS).toContain("**/*test/**");
|
|
63
|
-
expect(DEFAULT_EXCLUDE_PATTERNS).toContain("**/*tests/**");
|
|
64
|
-
expect(DEFAULT_EXCLUDE_PATTERNS).toContain("**/dist/**");
|
|
65
|
-
expect(DEFAULT_EXCLUDE_PATTERNS).toContain(".git/**");
|
|
66
|
-
});
|
|
67
|
-
|
|
68
|
-
test("should be an array of strings", () => {
|
|
69
|
-
expect(Array.isArray(DEFAULT_EXCLUDE_PATTERNS)).toBe(true);
|
|
70
|
-
expect(DEFAULT_EXCLUDE_PATTERNS.length).toBeGreaterThan(0);
|
|
71
|
-
DEFAULT_EXCLUDE_PATTERNS.forEach((pattern) => {
|
|
72
|
-
expect(typeof pattern).toBe("string");
|
|
73
|
-
});
|
|
74
|
-
});
|
|
75
|
-
});
|
|
76
|
-
|
|
77
|
-
describe("SUPPORTED_LANGUAGES", () => {
|
|
78
|
-
test("should contain common languages", () => {
|
|
79
|
-
const codes = SUPPORTED_LANGUAGES.map((lang) => lang.code);
|
|
80
|
-
expect(codes).toContain("en");
|
|
81
|
-
expect(codes).toContain("zh");
|
|
82
|
-
expect(codes).toContain("ja");
|
|
83
|
-
expect(codes).toContain("ko");
|
|
84
|
-
expect(codes).toContain("es");
|
|
85
|
-
expect(codes).toContain("fr");
|
|
86
|
-
});
|
|
87
|
-
|
|
88
|
-
test("should have proper structure", () => {
|
|
89
|
-
SUPPORTED_LANGUAGES.forEach((lang) => {
|
|
90
|
-
expect(lang).toHaveProperty("code");
|
|
91
|
-
expect(lang).toHaveProperty("label");
|
|
92
|
-
expect(lang).toHaveProperty("sample");
|
|
93
|
-
expect(typeof lang.code).toBe("string");
|
|
94
|
-
expect(typeof lang.label).toBe("string");
|
|
95
|
-
expect(typeof lang.sample).toBe("string");
|
|
96
|
-
});
|
|
97
|
-
});
|
|
98
|
-
});
|
|
99
|
-
|
|
100
|
-
describe("DOCUMENT_STYLES", () => {
|
|
101
|
-
test("should contain all expected document styles", () => {
|
|
102
|
-
const expectedStyles = [
|
|
103
|
-
"getStarted",
|
|
104
|
-
"completeTasks",
|
|
105
|
-
"findAnswers",
|
|
106
|
-
"understandSystem",
|
|
107
|
-
"solveProblems",
|
|
108
|
-
"mixedPurpose",
|
|
109
|
-
];
|
|
110
|
-
|
|
111
|
-
expectedStyles.forEach((style) => {
|
|
112
|
-
expect(DOCUMENT_STYLES).toHaveProperty(style);
|
|
113
|
-
});
|
|
114
|
-
});
|
|
115
|
-
|
|
116
|
-
test("should have proper structure for each style", () => {
|
|
117
|
-
Object.values(DOCUMENT_STYLES).forEach((style) => {
|
|
118
|
-
expect(style).toHaveProperty("name");
|
|
119
|
-
expect(style).toHaveProperty("description");
|
|
120
|
-
expect(style).toHaveProperty("content");
|
|
121
|
-
expect(typeof style.name).toBe("string");
|
|
122
|
-
expect(typeof style.description).toBe("string");
|
|
123
|
-
expect(typeof style.content).toBe("string");
|
|
124
|
-
});
|
|
125
|
-
});
|
|
126
|
-
});
|
|
127
|
-
|
|
128
|
-
describe("TARGET_AUDIENCES", () => {
|
|
129
|
-
test("should contain all expected audience types", () => {
|
|
130
|
-
const expectedAudiences = [
|
|
131
|
-
"endUsers",
|
|
132
|
-
"developers",
|
|
133
|
-
"devops",
|
|
134
|
-
"decisionMakers",
|
|
135
|
-
"supportTeams",
|
|
136
|
-
"mixedTechnical",
|
|
137
|
-
];
|
|
138
|
-
|
|
139
|
-
expectedAudiences.forEach((audience) => {
|
|
140
|
-
expect(TARGET_AUDIENCES).toHaveProperty(audience);
|
|
141
|
-
});
|
|
142
|
-
});
|
|
143
|
-
|
|
144
|
-
test("should have proper structure for each audience", () => {
|
|
145
|
-
Object.values(TARGET_AUDIENCES).forEach((audience) => {
|
|
146
|
-
expect(audience).toHaveProperty("name");
|
|
147
|
-
expect(audience).toHaveProperty("description");
|
|
148
|
-
expect(audience).toHaveProperty("content");
|
|
149
|
-
expect(typeof audience.name).toBe("string");
|
|
150
|
-
expect(typeof audience.description).toBe("string");
|
|
151
|
-
expect(typeof audience.content).toBe("string");
|
|
152
|
-
});
|
|
153
|
-
});
|
|
154
|
-
});
|
|
155
|
-
|
|
156
|
-
describe("READER_KNOWLEDGE_LEVELS", () => {
|
|
157
|
-
test("should contain all expected knowledge levels", () => {
|
|
158
|
-
const expectedLevels = [
|
|
159
|
-
"completeBeginners",
|
|
160
|
-
"domainFamiliar",
|
|
161
|
-
"experiencedUsers",
|
|
162
|
-
"emergencyTroubleshooting",
|
|
163
|
-
"exploringEvaluating",
|
|
164
|
-
];
|
|
165
|
-
|
|
166
|
-
expectedLevels.forEach((level) => {
|
|
167
|
-
expect(READER_KNOWLEDGE_LEVELS).toHaveProperty(level);
|
|
168
|
-
});
|
|
169
|
-
});
|
|
170
|
-
|
|
171
|
-
test("should have proper structure for each level", () => {
|
|
172
|
-
Object.values(READER_KNOWLEDGE_LEVELS).forEach((level) => {
|
|
173
|
-
expect(level).toHaveProperty("name");
|
|
174
|
-
expect(level).toHaveProperty("description");
|
|
175
|
-
expect(level).toHaveProperty("content");
|
|
176
|
-
expect(typeof level.name).toBe("string");
|
|
177
|
-
expect(typeof level.description).toBe("string");
|
|
178
|
-
expect(typeof level.content).toBe("string");
|
|
179
|
-
});
|
|
180
|
-
});
|
|
181
|
-
});
|
|
182
|
-
|
|
183
|
-
describe("DOCUMENTATION_DEPTH", () => {
|
|
184
|
-
test("should contain all expected depth levels", () => {
|
|
185
|
-
const expectedDepths = ["essentialOnly", "balancedCoverage", "comprehensive", "aiDecide"];
|
|
186
|
-
|
|
187
|
-
expectedDepths.forEach((depth) => {
|
|
188
|
-
expect(DOCUMENTATION_DEPTH).toHaveProperty(depth);
|
|
189
|
-
});
|
|
190
|
-
});
|
|
191
|
-
|
|
192
|
-
test("should have proper structure for each depth", () => {
|
|
193
|
-
Object.values(DOCUMENTATION_DEPTH).forEach((depth) => {
|
|
194
|
-
expect(depth).toHaveProperty("name");
|
|
195
|
-
expect(depth).toHaveProperty("description");
|
|
196
|
-
expect(depth).toHaveProperty("content");
|
|
197
|
-
expect(typeof depth.name).toBe("string");
|
|
198
|
-
expect(typeof depth.description).toBe("string");
|
|
199
|
-
expect(typeof depth.content).toBe("string");
|
|
200
|
-
});
|
|
201
|
-
});
|
|
202
|
-
});
|
|
203
|
-
|
|
204
|
-
describe("PURPOSE_TO_KNOWLEDGE_MAPPING", () => {
|
|
205
|
-
test("should map purposes to knowledge levels", () => {
|
|
206
|
-
expect(PURPOSE_TO_KNOWLEDGE_MAPPING).toHaveProperty("getStarted");
|
|
207
|
-
expect(PURPOSE_TO_KNOWLEDGE_MAPPING).toHaveProperty("findAnswers");
|
|
208
|
-
expect(PURPOSE_TO_KNOWLEDGE_MAPPING).toHaveProperty("solveProblems");
|
|
209
|
-
expect(PURPOSE_TO_KNOWLEDGE_MAPPING).toHaveProperty("exploringEvaluating");
|
|
210
|
-
|
|
211
|
-
expect(PURPOSE_TO_KNOWLEDGE_MAPPING.getStarted).toBe("completeBeginners");
|
|
212
|
-
expect(PURPOSE_TO_KNOWLEDGE_MAPPING.findAnswers).toBe("experiencedUsers");
|
|
213
|
-
});
|
|
214
|
-
});
|
|
215
|
-
|
|
216
|
-
describe("CONFLICT_RULES", () => {
|
|
217
|
-
test("should have internal and cross conflicts", () => {
|
|
218
|
-
expect(CONFLICT_RULES).toHaveProperty("internalConflicts");
|
|
219
|
-
expect(CONFLICT_RULES).toHaveProperty("crossConflicts");
|
|
220
|
-
expect(Array.isArray(CONFLICT_RULES.crossConflicts)).toBe(true);
|
|
221
|
-
});
|
|
222
|
-
|
|
223
|
-
test("should have proper structure for cross conflicts", () => {
|
|
224
|
-
CONFLICT_RULES.crossConflicts.forEach((conflict) => {
|
|
225
|
-
expect(conflict).toHaveProperty("conditions");
|
|
226
|
-
expect(conflict).toHaveProperty("severity");
|
|
227
|
-
expect(conflict).toHaveProperty("reason");
|
|
228
|
-
expect(conflict).toHaveProperty("action");
|
|
229
|
-
expect(conflict).toHaveProperty("conflictingOptions");
|
|
230
|
-
});
|
|
231
|
-
});
|
|
232
|
-
});
|
|
233
|
-
|
|
234
|
-
describe("CONFLICT_RESOLUTION_RULES", () => {
|
|
235
|
-
test("should have resolution rules for different conflict types", () => {
|
|
236
|
-
expect(CONFLICT_RESOLUTION_RULES).toHaveProperty("documentPurpose");
|
|
237
|
-
expect(CONFLICT_RESOLUTION_RULES).toHaveProperty("targetAudienceTypes");
|
|
238
|
-
expect(Array.isArray(CONFLICT_RESOLUTION_RULES.documentPurpose)).toBe(true);
|
|
239
|
-
expect(Array.isArray(CONFLICT_RESOLUTION_RULES.targetAudienceTypes)).toBe(true);
|
|
240
|
-
});
|
|
241
|
-
|
|
242
|
-
test("should have proper structure for resolution rules", () => {
|
|
243
|
-
CONFLICT_RESOLUTION_RULES.documentPurpose.forEach((rule) => {
|
|
244
|
-
expect(rule).toHaveProperty("conflictItems");
|
|
245
|
-
expect(rule).toHaveProperty("strategy");
|
|
246
|
-
expect(rule).toHaveProperty("description");
|
|
247
|
-
expect(Array.isArray(rule.conflictItems)).toBe(true);
|
|
248
|
-
});
|
|
249
|
-
});
|
|
250
|
-
});
|
|
251
|
-
|
|
252
|
-
describe("Numeric constants", () => {
|
|
253
|
-
test("should have valid numeric values", () => {
|
|
254
|
-
expect(typeof KROKI_CONCURRENCY).toBe("number");
|
|
255
|
-
expect(typeof FILE_CONCURRENCY).toBe("number");
|
|
256
|
-
expect(KROKI_CONCURRENCY).toBeGreaterThan(0);
|
|
257
|
-
expect(FILE_CONCURRENCY).toBeGreaterThan(0);
|
|
258
|
-
});
|
|
259
|
-
});
|
|
260
|
-
|
|
261
|
-
describe("String constants", () => {
|
|
262
|
-
test("should have valid string values", () => {
|
|
263
|
-
expect(typeof TMP_DIR).toBe("string");
|
|
264
|
-
expect(typeof TMP_DOCS_DIR).toBe("string");
|
|
265
|
-
expect(typeof TMP_ASSETS_DIR).toBe("string");
|
|
266
|
-
expect(typeof DISCUSS_KIT_DID).toBe("string");
|
|
267
|
-
expect(typeof DISCUSS_KIT_STORE_URL).toBe("string");
|
|
268
|
-
expect(typeof BLOCKLET_ADD_COMPONENT_DOCS).toBe("string");
|
|
269
|
-
expect(typeof D2_CONFIG).toBe("string");
|
|
270
|
-
});
|
|
271
|
-
|
|
272
|
-
test("should have valid URLs", () => {
|
|
273
|
-
expect(DISCUSS_KIT_STORE_URL).toMatch(/^https?:\/\//);
|
|
274
|
-
expect(BLOCKLET_ADD_COMPONENT_DOCS).toMatch(/^https?:\/\//);
|
|
275
|
-
});
|
|
276
|
-
});
|
|
277
|
-
|
|
278
|
-
describe("SUPPORTED_FILE_EXTENSIONS", () => {
|
|
279
|
-
test("should contain common file extensions", () => {
|
|
280
|
-
expect(SUPPORTED_FILE_EXTENSIONS).toContain(".txt");
|
|
281
|
-
expect(SUPPORTED_FILE_EXTENSIONS).toContain(".md");
|
|
282
|
-
expect(SUPPORTED_FILE_EXTENSIONS).toContain(".json");
|
|
283
|
-
expect(SUPPORTED_FILE_EXTENSIONS).toContain(".yaml");
|
|
284
|
-
expect(SUPPORTED_FILE_EXTENSIONS).toContain(".yml");
|
|
285
|
-
});
|
|
286
|
-
|
|
287
|
-
test("should be an array of strings starting with dots", () => {
|
|
288
|
-
expect(Array.isArray(SUPPORTED_FILE_EXTENSIONS)).toBe(true);
|
|
289
|
-
SUPPORTED_FILE_EXTENSIONS.forEach((ext) => {
|
|
290
|
-
expect(typeof ext).toBe("string");
|
|
291
|
-
expect(ext.startsWith(".")).toBe(true);
|
|
292
|
-
});
|
|
293
|
-
});
|
|
294
|
-
});
|
|
295
|
-
});
|