mdat 1.0.1 → 1.0.3

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.
@@ -1,4 +1,4 @@
1
- import { type LoaderResult } from 'cosmiconfig';
1
+ import type { LoaderResult } from 'cosmiconfig';
2
2
  /**
3
3
  * Lets arbitrary JSON objects (like from package.json) become reasonably good mdat rule sets
4
4
  * HOWEVER cosmiconfig treats package.json as a special case and will always load only specific keys from it
@@ -1,7 +1,7 @@
1
- import { type Root } from 'mdast';
1
+ import type { Root } from 'mdast';
2
2
  import { VFile } from 'vfile';
3
- import { type ConfigLoaded, type ConfigToLoad, type loadConfig, type RulesToLoad } from './config';
4
- import { type AmbientRemarkConfig } from './utilities';
3
+ import type { ConfigLoaded, ConfigToLoad, loadConfig, RulesToLoad } from './config';
4
+ import type { AmbientRemarkConfig } from './utilities';
5
5
  type Loader = typeof loadConfig;
6
6
  type ProcessorGetter = typeof getCleanProcessor | typeof getExpandProcessor;
7
7
  export declare function processFiles(files: string | string[], loader: Loader, processorGetter: ProcessorGetter, name?: string, output?: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
@@ -1,5 +1,5 @@
1
- import { type VFile } from 'vfile';
2
- import { type ConfigToLoad, type RulesToLoad } from '../config';
1
+ import type { VFile } from 'vfile';
2
+ import type { ConfigToLoad, RulesToLoad } from '../config';
3
3
  /**
4
4
  * Expands MDAT readme comments in the closest readme.md file
5
5
  * Basically an alias to `expandReadmeFiles()` with certain arguments elided.
@@ -1,5 +1,6 @@
1
- import { type Simplify } from 'type-fest';
2
- import { type ConfigLoaded, loadConfig } from '../config';
1
+ import type { Simplify } from 'type-fest';
2
+ import type { ConfigLoaded } from '../config';
3
+ import { loadConfig } from '../config';
3
4
  type ReadmeConfigLoaded = Simplify<ConfigLoaded & {
4
5
  packageFile: string;
5
6
  }>;
@@ -1,4 +1,4 @@
1
- import { type Root } from 'mdast';
1
+ import type { Root } from 'mdast';
2
2
  declare const _default: {
3
3
  'table-of-contents': {
4
4
  applicationOrder: number;
@@ -1,4 +1,4 @@
1
- import { type ProgramInfo } from './parsers/index';
1
+ import type { ProgramInfo } from './parsers/index';
2
2
  /**
3
3
  * Converts a ProgramInfo object extracted by one of the help parsers into a big
4
4
  * beautiful Markdown table.
@@ -1,4 +1,4 @@
1
- import { type ProgramInfo } from './parsers/index';
1
+ import type { ProgramInfo } from './parsers/index';
2
2
  /**
3
3
  * Tries to parse a help string into an object through a process of trial and
4
4
  * error with the available parsers.
@@ -1,4 +1,4 @@
1
- import { type ProgramInfo } from './index';
1
+ import type { ProgramInfo } from './index';
2
2
  /**
3
3
  * Converts am unstructured help string emitted from a CLI tool built with the
4
4
  * `meow` CLI library and turn it into a structured POJO describing the
@@ -1,4 +1,4 @@
1
- import { type ProgramInfo } from './index';
1
+ import type { ProgramInfo } from './index';
2
2
  /**
3
3
  * Converts am unstructured help string emitted from a CLI tool built with the
4
4
  * `Yargs` CLI library and turn it into a structured POJO describing the
@@ -1,4 +1,4 @@
1
- import { type ConfigResult as AmbientRemarkConfig } from 'unified-engine';
1
+ import type { ConfigResult as AmbientRemarkConfig } from 'unified-engine';
2
2
  export { type ConfigResult as AmbientRemarkConfig } from 'unified-engine';
3
3
  export declare function getInputOutputPaths(inputs: string[], output: string | undefined, name: string | undefined, extension: string | undefined): Array<{
4
4
  input: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mdat",
3
- "version": "1.0.1",
3
+ "version": "1.0.3",
4
4
  "description": "CLI tool and TypeScript 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.",
5
5
  "keywords": [
6
6
  "mdat",
@@ -37,48 +37,48 @@
37
37
  "dist/*"
38
38
  ],
39
39
  "dependencies": {
40
- "@clack/prompts": "^0.10.0",
41
- "@kitschpatrol/tldraw-cli": "^4.6.31",
40
+ "@clack/prompts": "^0.10.1",
41
+ "@kitschpatrol/tldraw-cli": "^4.7.0",
42
42
  "@types/mdast": "^4.0.4",
43
- "@types/node": "^18.19.79",
43
+ "@types/node": "^18.19.123",
44
44
  "@types/unist": "^3.0.3",
45
45
  "@types/which": "^3.0.4",
46
46
  "@types/yargs": "^17.0.33",
47
47
  "cosmiconfig": "^9.0.0",
48
48
  "cosmiconfig-typescript-loader": "^6.1.0",
49
- "execa": "^9.5.2",
49
+ "execa": "^9.6.0",
50
50
  "globby": "^14.1.0",
51
51
  "read-pkg": "^9.0.1",
52
- "remark-mdat": "^1.0.2",
53
- "type-fest": "^4.36.0",
52
+ "remark-mdat": "^1.0.5",
53
+ "type-fest": "^4.41.0",
54
54
  "unified-engine": "^11.2.2",
55
55
  "vfile": "^6.0.3",
56
56
  "which": "^5.0.0"
57
57
  },
58
58
  "devDependencies": {
59
- "@kitschpatrol/shared-config": "^5.2.0",
60
- "bumpp": "^10.0.3",
61
- "chalk": "^5.4.1",
59
+ "@kitschpatrol/shared-config": "^5.5.0",
60
+ "bumpp": "^10.2.3",
62
61
  "chevrotain": "^11.0.3",
63
62
  "find-up": "^7.0.0",
64
63
  "is-executable": "^2.0.1",
65
64
  "mdast-util-toc": "^7.1.0",
66
- "nanoid": "^5.1.2",
65
+ "nanoid": "^5.1.5",
67
66
  "package-up": "^5.0.0",
68
67
  "path-type": "^6.0.0",
68
+ "picocolors": "^1.1.1",
69
69
  "pkg-dir": "^8.0.0",
70
70
  "plur": "^5.1.0",
71
- "pretty-bytes": "^6.1.1",
71
+ "pretty-bytes": "^7.0.1",
72
72
  "pretty-ms": "^9.2.0",
73
73
  "remark": "^15.0.1",
74
74
  "remark-gfm": "^4.0.1",
75
75
  "to-vfile": "^8.0.0",
76
- "tsup": "^8.4.0",
77
- "typescript": "~5.7.3",
76
+ "tsup": "^8.5.0",
77
+ "typescript": "~5.8.3",
78
78
  "untildify": "^5.0.0",
79
- "vitest": "^3.0.7",
79
+ "vitest": "^3.2.4",
80
80
  "yargs": "^17.7.2",
81
- "zod": "^3.24.2"
81
+ "zod": "^3.25.76"
82
82
  },
83
83
  "engines": {
84
84
  "node": "^18.19.0 || >=20.11.0"
package/readme.md CHANGED
@@ -745,7 +745,7 @@ See the [Examples section](https://github.com/kitschpatrol/remark-mdat#examples)
745
745
 
746
746
  | File | Original | Gzip | Brotli |
747
747
  | ------------ | -------- | ------- | ------ |
748
- | package.json | 2.7 kB | 1.2 kB | 1.1 kB |
748
+ | package.json | 2.6 kB | 1.2 kB | 998 B |
749
749
  | readme.md | 57.5 kB | 11.4 kB | 9.1 kB |
750
750
 
751
751
  <!-- /size-table -->