mdat 0.6.13 → 0.6.15
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/bin/cli.js +356 -33
- package/dist/index.js +249 -27
- package/dist/readme/init.d.ts +16 -0
- package/dist/readme/templates/index.d.ts +36 -0
- package/package.json +16 -16
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
export type Symbolize<T extends Record<string, unknown>> = {
|
|
2
|
+
[x in keyof T]: T[x] | symbol;
|
|
3
|
+
};
|
|
4
|
+
type MdatReadmeInitOptions = {
|
|
5
|
+
compound: boolean;
|
|
6
|
+
expand: boolean;
|
|
7
|
+
output: string;
|
|
8
|
+
overwrite: boolean;
|
|
9
|
+
template: string;
|
|
10
|
+
};
|
|
11
|
+
export declare function initReadmeInteractive(): Promise<string>;
|
|
12
|
+
/**
|
|
13
|
+
* @return Path to the created readme file.
|
|
14
|
+
*/
|
|
15
|
+
export declare function initReadme(options?: Partial<MdatReadmeInitOptions>): Promise<string>;
|
|
16
|
+
export {};
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
export type Template = {
|
|
2
|
+
content: {
|
|
3
|
+
compound: string;
|
|
4
|
+
explicit: string;
|
|
5
|
+
};
|
|
6
|
+
description: string;
|
|
7
|
+
exampleLink: `https://${string}.md`;
|
|
8
|
+
};
|
|
9
|
+
export type Templates = Record<string, Template>;
|
|
10
|
+
declare const _default: {
|
|
11
|
+
'MDAT Readme': {
|
|
12
|
+
content: {
|
|
13
|
+
compound: string;
|
|
14
|
+
explicit: string;
|
|
15
|
+
};
|
|
16
|
+
description: string;
|
|
17
|
+
exampleLink: "https://github.com/kitschpatrol/mdat/blob/main/readme.md";
|
|
18
|
+
};
|
|
19
|
+
'Standard Readme Basic': {
|
|
20
|
+
content: {
|
|
21
|
+
compound: string;
|
|
22
|
+
explicit: string;
|
|
23
|
+
};
|
|
24
|
+
description: string;
|
|
25
|
+
exampleLink: "https://github.com/RichardLitt/standard-readme/blob/main/example-readmes/minimal-readme.md";
|
|
26
|
+
};
|
|
27
|
+
'Standard Readme Full': {
|
|
28
|
+
content: {
|
|
29
|
+
compound: string;
|
|
30
|
+
explicit: string;
|
|
31
|
+
};
|
|
32
|
+
description: string;
|
|
33
|
+
exampleLink: "https://github.com/RichardLitt/standard-readme/blob/main/example-readmes/maximal-readme.md";
|
|
34
|
+
};
|
|
35
|
+
};
|
|
36
|
+
export default _default;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "mdat",
|
|
3
|
-
"version": "0.6.
|
|
3
|
+
"version": "0.6.15",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "CLI tool and library implementing the Markdown Autophagic Template (MDAT) system. MDAT lets you use comments as dynamic content templates in Markdown files, making it easy to generate and update readme boilerplate.",
|
|
6
6
|
"repository": {
|
|
@@ -42,20 +42,24 @@
|
|
|
42
42
|
"cli"
|
|
43
43
|
],
|
|
44
44
|
"dependencies": {
|
|
45
|
-
"@types/node": "^20.14.1",
|
|
46
|
-
"@types/which": "^3.0.4",
|
|
47
|
-
"@types/yargs": "^17.0.32",
|
|
48
45
|
"@clack/prompts": "^0.7.0",
|
|
49
46
|
"@kitschpatrol/tldraw-cli": "^4.5.4",
|
|
50
47
|
"@types/mdast": "^4.0.4",
|
|
48
|
+
"@types/node": "^20.14.1",
|
|
51
49
|
"@types/unist": "^3.0.2",
|
|
52
|
-
"
|
|
53
|
-
"
|
|
50
|
+
"@types/which": "^3.0.4",
|
|
51
|
+
"@types/yargs": "^17.0.32",
|
|
54
52
|
"cosmiconfig": "^9.0.0",
|
|
55
53
|
"cosmiconfig-typescript-loader": "^5.0.0",
|
|
56
54
|
"execa": "^9.1.0",
|
|
57
|
-
"find-up": "^7.0.0",
|
|
58
55
|
"globby": "^14.0.1",
|
|
56
|
+
"read-pkg": "^9.0.1",
|
|
57
|
+
"which": "^4.0.0"
|
|
58
|
+
},
|
|
59
|
+
"devDependencies": {
|
|
60
|
+
"chalk": "^5.3.0",
|
|
61
|
+
"chevrotain": "^11.0.3",
|
|
62
|
+
"find-up": "^7.0.0",
|
|
59
63
|
"is-executable": "^2.0.1",
|
|
60
64
|
"mdast-util-toc": "^7.1.0",
|
|
61
65
|
"nanoid": "^5.0.7",
|
|
@@ -64,28 +68,24 @@
|
|
|
64
68
|
"pkg-dir": "^8.0.0",
|
|
65
69
|
"plur": "^5.1.0",
|
|
66
70
|
"pretty-ms": "^9.0.0",
|
|
67
|
-
"read-pkg": "^9.0.1",
|
|
68
71
|
"remark": "^15.0.1",
|
|
69
72
|
"remark-gfm": "^4.0.0",
|
|
70
73
|
"to-vfile": "^8.0.0",
|
|
74
|
+
"tsup": "^8.1.0",
|
|
71
75
|
"type-fest": "^4.19.0",
|
|
76
|
+
"typescript": "^5.4.5",
|
|
72
77
|
"untildify": "^5.0.0",
|
|
73
78
|
"vfile": "^6.0.1",
|
|
74
|
-
"
|
|
79
|
+
"vitest": "^1.6.0",
|
|
75
80
|
"yargs": "^17.7.2",
|
|
76
81
|
"zod": "^3.23.8",
|
|
77
|
-
"remark-mdat": "0.6.
|
|
78
|
-
},
|
|
79
|
-
"devDependencies": {
|
|
80
|
-
"tsup": "^8.1.0",
|
|
81
|
-
"typescript": "^5.4.5",
|
|
82
|
-
"vitest": "^1.6.0"
|
|
82
|
+
"remark-mdat": "0.6.15"
|
|
83
83
|
},
|
|
84
84
|
"publishConfig": {
|
|
85
85
|
"access": "public"
|
|
86
86
|
},
|
|
87
87
|
"scripts": {
|
|
88
|
-
"build": "tsup && tsc -p tsconfig.build.json",
|
|
88
|
+
"build": "tsup && tsc -p tsconfig.build.lib.json",
|
|
89
89
|
"dev": "pnpm run test",
|
|
90
90
|
"mdat": "./bin/cli.js readme --config ../../.mdatrc.ts",
|
|
91
91
|
"pretest": "pnpm run build",
|