markdown-magic 4.8.0 → 4.10.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.
Files changed (66) hide show
  1. package/package.json +7 -7
  2. package/src/argparse/README.md +3 -8
  3. package/src/argparse/argparse.js +7 -313
  4. package/src/argparse/argparse.test.js +168 -90
  5. package/src/argparse/index.js +2 -2
  6. package/src/argparse/splitOutsideQuotes.js +3 -75
  7. package/src/cli-run.js +97 -166
  8. package/src/cli-run.test.js +71 -3
  9. package/src/globparse.js +14 -159
  10. package/src/index.dependency-graph.test.js +49 -0
  11. package/src/index.js +41 -11
  12. package/src/transforms/code/index.js +19 -13
  13. package/src/transforms/index.js +12 -1
  14. package/src/utils/format-md.js +165 -12
  15. package/src/utils/format-md.test.js +175 -0
  16. package/src/utils/remoteRequest.js +30 -6
  17. package/types/src/argparse/argparse.d.ts +2 -32
  18. package/types/src/argparse/argparse.d.ts.map +1 -1
  19. package/types/src/argparse/index.d.ts +2 -2
  20. package/types/src/argparse/splitOutsideQuotes.d.ts +2 -1
  21. package/types/src/argparse/splitOutsideQuotes.d.ts.map +1 -1
  22. package/types/src/cli-run.d.ts +4 -2
  23. package/types/src/cli-run.d.ts.map +1 -1
  24. package/types/src/globparse.d.ts +11 -17
  25. package/types/src/globparse.d.ts.map +1 -1
  26. package/types/src/index.d.ts +36 -9
  27. package/types/src/index.d.ts.map +1 -1
  28. package/types/src/transforms/code/index.d.ts.map +1 -1
  29. package/types/src/utils/format-md.d.ts +12 -0
  30. package/types/src/utils/format-md.d.ts.map +1 -1
  31. package/types/src/utils/fs.d.ts +1 -1
  32. package/types/src/utils/remoteRequest.d.ts.map +1 -1
  33. package/types/_tests/config.d.ts +0 -4
  34. package/types/_tests/config.d.ts.map +0 -1
  35. package/types/_tests/errors.test.d.ts +0 -2
  36. package/types/_tests/errors.test.d.ts.map +0 -1
  37. package/types/_tests/fixtures/js/simple.d.ts +0 -8
  38. package/types/_tests/fixtures/js/simple.d.ts.map +0 -1
  39. package/types/_tests/fixtures/local-code-file-lines.d.ts +0 -1
  40. package/types/_tests/fixtures/local-code-file-lines.d.ts.map +0 -1
  41. package/types/_tests/fixtures/local-code-file.d.ts +0 -2
  42. package/types/_tests/fixtures/local-code-file.d.ts.map +0 -1
  43. package/types/_tests/fixtures/local-code-id.d.ts +0 -3
  44. package/types/_tests/fixtures/local-code-id.d.ts.map +0 -1
  45. package/types/_tests/transforms-toc.test.d.ts +0 -2
  46. package/types/_tests/transforms-toc.test.d.ts.map +0 -1
  47. package/types/_tests/transforms.test.d.ts +0 -2
  48. package/types/_tests/transforms.test.d.ts.map +0 -1
  49. package/types/_tests/utils/diff.d.ts +0 -3
  50. package/types/_tests/utils/diff.d.ts.map +0 -1
  51. package/types/src/argparse/argparse.test.d.ts +0 -2
  52. package/types/src/argparse/argparse.test.d.ts.map +0 -1
  53. package/types/src/argparse/splitOutsideQuotes.test.d.ts +0 -2
  54. package/types/src/argparse/splitOutsideQuotes.test.d.ts.map +0 -1
  55. package/types/src/cli-run.test.d.ts +0 -2
  56. package/types/src/cli-run.test.d.ts.map +0 -1
  57. package/types/src/globparse.test.d.ts +0 -2
  58. package/types/src/globparse.test.d.ts.map +0 -1
  59. package/types/src/index.test.d.ts +0 -2
  60. package/types/src/index.test.d.ts.map +0 -1
  61. package/types/src/transforms/code/resolve-github-file.test.d.ts +0 -2
  62. package/types/src/transforms/code/resolve-github-file.test.d.ts.map +0 -1
  63. package/types/src/utils/fs.test.d.ts +0 -2
  64. package/types/src/utils/fs.test.d.ts.map +0 -1
  65. package/types/src/utils/text.test.d.ts +0 -2
  66. package/types/src/utils/text.test.d.ts.map +0 -1
@@ -1 +1 @@
1
- {"version":3,"file":"cli-run.d.ts","sourceRoot":"","sources":["../../src/cli-run.js"],"names":[],"mappings":";AA0GA,6FA4QC"}
1
+ {"version":3,"file":"cli-run.d.ts","sourceRoot":"","sources":["../../src/cli-run.js"],"names":[],"mappings":";AA8OA,mDAIC;AAED,sDAgDC;AAjLD,2EAyHC"}
@@ -1,18 +1,12 @@
1
- export function getGlobGroupsFromArgs(args: any, opts?: {}): {
2
- globGroups: {
3
- key: any;
4
- rawKey: any;
5
- values: any;
6
- }[];
7
- otherOpts: any[];
8
- };
9
- export function isArrayLike(str: any): boolean;
10
- export function stringLooksLikeFile(value: any): boolean;
11
- export function getValue(val: any): any;
12
- export function trimLeadingDashes(value: any): any;
13
- export function removeNodeModules(value?: string): boolean;
14
- export function coerceStringToRegex(str: any): any;
15
- export function convertToArray(str?: string): any;
16
- export function addValue(value: any, currentCollection: any): any;
17
- export function customIsGlob(arg: any): any;
1
+ import { getGlobGroupsFromArgs } from "@davidwells/dx-args/src/globparse";
2
+ import { isArrayLike } from "@davidwells/dx-args/src/globparse";
3
+ import { stringLooksLikeFile } from "@davidwells/dx-args/src/globparse";
4
+ import { getValue } from "@davidwells/dx-args/src/globparse";
5
+ import { trimLeadingDashes } from "@davidwells/dx-args/src/globparse";
6
+ import { removeNodeModules } from "@davidwells/dx-args/src/globparse";
7
+ import { coerceStringToRegex } from "@davidwells/dx-args/src/globparse";
8
+ import { convertToArray } from "@davidwells/dx-args/src/globparse";
9
+ import { addValue } from "@davidwells/dx-args/src/globparse";
10
+ import { customIsGlob } from "@davidwells/dx-args/src/globparse";
11
+ export { getGlobGroupsFromArgs, isArrayLike, stringLooksLikeFile, getValue, trimLeadingDashes, removeNodeModules, coerceStringToRegex, convertToArray, addValue, customIsGlob };
18
12
  //# sourceMappingURL=globparse.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"globparse.d.ts","sourceRoot":"","sources":["../../src/globparse.js"],"names":[],"mappings":"AA6EA;;;;;;;EA8EC;AA5ID,+CAGC;AAED,yDAOC;AAED,wCAEC;AAED,mDAEC;AAED,2DAKC;AAED,mDAOC;AAED,kDAGC;AAED,kEASC;AAED,4CAMC"}
1
+ {"version":3,"file":"globparse.d.ts","sourceRoot":"","sources":["../../src/globparse.js"],"names":[],"mappings":""}
@@ -1,18 +1,32 @@
1
+ declare namespace _exports {
2
+ export { SyntaxType, FilePathsOrGlobs, ProcessFileOptions, MarkdownMagicOptions, OutputConfig, MarkdownMagicResult };
3
+ }
4
+ declare namespace _exports {
5
+ export { markdownMagic };
6
+ export { parseMarkdown };
7
+ export { blockTransformer };
8
+ export { processFile };
9
+ export { stringUtils };
10
+ export namespace __private {
11
+ export { createDependencyGraph };
12
+ }
13
+ }
14
+ export = _exports;
1
15
  /**
2
16
  * Allowed file syntaxes
3
17
  */
4
- export type SyntaxType = "md" | "js" | "yml" | "yaml";
18
+ type SyntaxType = "md" | "js" | "yml" | "yaml";
5
19
  /**
6
20
  * Path to file, files or Glob string or Glob Array
7
21
  */
8
- export type FilePathsOrGlobs = string | Array<string>;
9
- export type ProcessFileOptions = import("comment-block-replacer").ProcessFileOptions;
22
+ type FilePathsOrGlobs = string | Array<string>;
23
+ type ProcessFileOptions = import("comment-block-replacer").ProcessFileOptions;
10
24
  /**
11
25
  * Configuration for markdown magic
12
26
  *
13
27
  * Below is the main config for `markdown-magic`
14
28
  */
15
- export type MarkdownMagicOptions = {
29
+ type MarkdownMagicOptions = {
16
30
  /**
17
31
  * - Files to process.
18
32
  */
@@ -81,7 +95,7 @@ export type MarkdownMagicOptions = {
81
95
  /**
82
96
  * Optional output configuration
83
97
  */
84
- export type OutputConfig = {
98
+ type OutputConfig = {
85
99
  /**
86
100
  * - Change output path of new content. Default behavior is replacing the original file
87
101
  */
@@ -102,7 +116,7 @@ export type OutputConfig = {
102
116
  /**
103
117
  * Result of markdown processing
104
118
  */
105
- export type MarkdownMagicResult = {
119
+ type MarkdownMagicResult = {
106
120
  /**
107
121
  * - Any errors encountered.
108
122
  */
@@ -183,12 +197,25 @@ export type MarkdownMagicResult = {
183
197
  console.log(`Processing complete`, result)
184
198
  })
185
199
  */
186
- export function markdownMagic(globOrOpts?: FilePathsOrGlobs | MarkdownMagicOptions, options?: MarkdownMagicOptions): Promise<MarkdownMagicResult>;
200
+ declare function markdownMagic(globOrOpts?: FilePathsOrGlobs | MarkdownMagicOptions, options?: MarkdownMagicOptions): Promise<MarkdownMagicResult>;
187
201
  import { blockTransformer } from "comment-block-transformer";
188
202
  import { processFile } from "comment-block-replacer";
189
- export namespace stringUtils {
203
+ declare namespace stringUtils {
190
204
  export { stringBreak };
191
205
  }
206
+ /**
207
+ * Create graph data for deterministic dependency ordering
208
+ * @param {Array<{id: string, blocks: Array<any>, dependencies?: Array<string>}>} blockItems
209
+ * @returns {{itemsWithBlocks: Array<any>, itemIds: Array<string>, graph: Array<[string, string]>}}
210
+ */
211
+ declare function createDependencyGraph(blockItems?: Array<{
212
+ id: string;
213
+ blocks: Array<any>;
214
+ dependencies?: Array<string>;
215
+ }>): {
216
+ itemsWithBlocks: Array<any>;
217
+ itemIds: Array<string>;
218
+ graph: Array<[string, string]>;
219
+ };
192
220
  import stringBreak = require("./utils/string-break");
193
- export { parseMarkdown, blockTransformer, processFile };
194
221
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":";;;yBAkDa,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,MAAM;;;;+BAK5B,MAAM,GAAC,KAAK,CAAC,MAAM,CAAC;iCAIpB,OAAO,wBAAwB,EAAE,kBAAkB;;;;;;;;;;YASlD,gBAAgB;;;;;;;;aAEhB,YAAY,GAAC,MAAM;;;;aACnB,UAAU;;;;WACV,MAAM;;;;YACN,MAAM;;;;UACN,MAAM;;;;oBACN,OAAO;;;;iBACP,OAAO;;;;UACP,OAAO;;;;YACP,OAAO;;;;aACP,OAAO;;;;8BACP,OAAO;;;;8BACP,OAAO;;;;0BACP,OAAO;;;;gBACP,MAAM;;;;;;;;;gBAMN,MAAM;;;;qBACN,OAAO;;;;;;;;8BAEP,OAAO;;;;;;;;;;;;;kBAQP,KAAK,CAAC,MAAM,CAAC;;;;;;AApD3B;;;GAGG;AAEH;;;GAGG;AAEH;;GAEG;AAEH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;;;GAOG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;;;GAgBG;AACH,2CARW,gBAAgB,GAAC,oBAAoB,YACrC,oBAAoB,GAClB,OAAO,CAAC,mBAAmB,CAAC,CAqmBxC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;kBAkDa,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,MAAM;;;;wBAK5B,MAAM,GAAC,KAAK,CAAC,MAAM,CAAC;0BAIpB,OAAO,wBAAwB,EAAE,kBAAkB;;;;;;;;;;YASlD,gBAAgB;;;;;;;;aAEhB,YAAY,GAAC,MAAM;;;;aACnB,UAAU;;;;WACV,MAAM;;;;YACN,MAAM;;;;UACN,MAAM;;;;oBACN,OAAO;;;;iBACP,OAAO;;;;UACP,OAAO;;;;YACP,OAAO;;;;aACP,OAAO;;;;8BACP,OAAO;;;;8BACP,OAAO;;;;0BACP,OAAO;;;;gBACP,MAAM;;;;;;;;;gBAMN,MAAM;;;;qBACN,OAAO;;;;;;;;8BAEP,OAAO;;;;;;;;;;;;;kBAQP,KAAK,CAAC,MAAM,CAAC;;;;;;AApD3B;;;GAGG;AAEH;;;GAGG;AAEH;;GAEG;AAEH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;;;GAOG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;;;GAgBG;AACH,4CARW,gBAAgB,GAAC,oBAAoB,YACrC,oBAAoB,GAClB,OAAO,CAAC,mBAAmB,CAAC,CA+nBxC;;;;;;AAuCD;;;;GAIG;AACH,oDAHW,KAAK,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IAAC,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;CAAC,CAAC,GACnE;IAAC,eAAe,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAAC,KAAK,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;CAAC,CAkBjG"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/transforms/code/index.js"],"names":[],"mappings":";;;AA+CiB,kDA+JhB;;;;;;;;;SAzLa,MAAM;;;;aACN,MAAM;;;;aACN,MAAM;;;;YACN,MAAM;;;;cACN,MAAM;;;;mBACN,OAAO"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/transforms/code/index.js"],"names":[],"mappings":";;;AA+CiB,kDAqKhB;;;;;;;;;SA/La,MAAM;;;;aACN,MAAM;;;;aACN,MAAM;;;;YACN,MAAM;;;;cACN,MAAM;;;;mBACN,OAAO"}
@@ -1,2 +1,14 @@
1
1
  export function formatMd(content: any, options?: {}): any;
2
+ export function parseMarkdownHeadings(content: any): {
3
+ level: number;
4
+ text: string;
5
+ normalizedText: string;
6
+ start: number;
7
+ end: any;
8
+ }[];
9
+ export function selectMarkdownSections(content: any, options?: {}): any;
10
+ export function normalizeHeadingText(text?: string): string;
11
+ export function coerceListOption(value: any): string[];
12
+ export function coerceHeadingLevels(value: any): number[];
13
+ export function mergeRanges(ranges: any): any;
2
14
  //# sourceMappingURL=format-md.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"format-md.d.ts","sourceRoot":"","sources":["../../../src/utils/format-md.js"],"names":[],"mappings":"AAGA,0DAyBC"}
1
+ {"version":3,"file":"format-md.d.ts","sourceRoot":"","sources":["../../../src/utils/format-md.js"],"names":[],"mappings":"AAGA,0DA4BC;AAuCD;;;;;;IAgDC;AArFD,wEAmCC;AAwDD,4DAMC;AAMD,uDAQC;AAED,0DAIC;AAED,8CAaC"}
@@ -30,6 +30,6 @@ export function getGitignoreContents(filePath?: string): Promise<string[]>;
30
30
  * @returns {string} Relative path
31
31
  */
32
32
  export function convertToRelativePath(file: string, cwd: string): string;
33
- import fs_1 = require("fs");
33
+ import fs_1 = require("node:fs/promises");
34
34
  import fs = fs_1.promises;
35
35
  //# sourceMappingURL=fs.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"remoteRequest.d.ts","sourceRoot":"","sources":["../../../src/utils/remoteRequest.js"],"names":[],"mappings":"AAMA,kFAmBC"}
1
+ {"version":3,"file":"remoteRequest.d.ts","sourceRoot":"","sources":["../../../src/utils/remoteRequest.js"],"names":[],"mappings":"AASA,kFAwCC"}
@@ -1,4 +0,0 @@
1
- export const FIXTURE_DIR: string;
2
- export const MARKDOWN_FIXTURE_DIR: string;
3
- export const OUTPUT_DIR: string;
4
- //# sourceMappingURL=config.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../_tests/config.js"],"names":[],"mappings":"AACA,iCAAoD;AACpD,0CAAyD;AACzD,gCAAmD"}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=errors.test.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"errors.test.d.ts","sourceRoot":"","sources":["../../_tests/errors.test.js"],"names":[],"mappings":""}
@@ -1,8 +0,0 @@
1
- /**
2
- * comment inside
3
- */
4
- /****************
5
- comment inside
6
- ******************/
7
- declare var x: string;
8
- //# sourceMappingURL=simple.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"simple.d.ts","sourceRoot":"","sources":["../../../../_tests/fixtures/js/simple.js"],"names":[],"mappings":"AAqBA;;GAEG;AAIH;;mBAEmB;AAGnB,sBAAa"}
@@ -1 +0,0 @@
1
- //# sourceMappingURL=local-code-file-lines.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"local-code-file-lines.d.ts","sourceRoot":"","sources":["../../../_tests/fixtures/local-code-file-lines.js"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- export function run(): void;
2
- //# sourceMappingURL=local-code-file.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"local-code-file.d.ts","sourceRoot":"","sources":["../../../_tests/fixtures/local-code-file.js"],"names":[],"mappings":"AAYqB,4BAGpB"}
@@ -1,3 +0,0 @@
1
- declare function _exports(filePath: any, config: any): Promise<void>;
2
- export = _exports;
3
- //# sourceMappingURL=local-code-id.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"local-code-id.d.ts","sourceRoot":"","sources":["../../../_tests/fixtures/local-code-id.js"],"names":[],"mappings":"AAUiB,qEAyBhB"}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=transforms-toc.test.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"transforms-toc.test.d.ts","sourceRoot":"","sources":["../../_tests/transforms-toc.test.js"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=transforms.test.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"transforms.test.d.ts","sourceRoot":"","sources":["../../_tests/transforms.test.js"],"names":[],"mappings":""}
@@ -1,3 +0,0 @@
1
- declare function _exports(actual: any, expected: any): any;
2
- export = _exports;
3
- //# sourceMappingURL=diff.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"diff.d.ts","sourceRoot":"","sources":["../../../_tests/utils/diff.js"],"names":[],"mappings":"AA8HiB,2DAShB"}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=argparse.test.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"argparse.test.d.ts","sourceRoot":"","sources":["../../../src/argparse/argparse.test.js"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=splitOutsideQuotes.test.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"splitOutsideQuotes.test.d.ts","sourceRoot":"","sources":["../../../src/argparse/splitOutsideQuotes.test.js"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=cli-run.test.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"cli-run.test.d.ts","sourceRoot":"","sources":["../../src/cli-run.test.js"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=globparse.test.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"globparse.test.d.ts","sourceRoot":"","sources":["../../src/globparse.test.js"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=index.test.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../../src/index.test.js"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=resolve-github-file.test.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"resolve-github-file.test.d.ts","sourceRoot":"","sources":["../../../../src/transforms/code/resolve-github-file.test.js"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=fs.test.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"fs.test.d.ts","sourceRoot":"","sources":["../../../src/utils/fs.test.js"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=text.test.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"text.test.d.ts","sourceRoot":"","sources":["../../../src/utils/text.test.js"],"names":[],"mappings":""}