remark-mdat 2.2.1 → 2.2.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.
package/dist/index.d.ts CHANGED
@@ -193,9 +193,11 @@ declare function mdatStrip(tree: Root, _file: VFile): void;
193
193
  //#endregion
194
194
  //#region src/lib/mdat/log.d.ts
195
195
  /**
196
- * Set the logger instance for the module.
197
- * Export this for library consumers to inject their own logger.
198
- * @param logger - Accepts either a LogLayer instance or a Console- or Stream-like log target
196
+ * Set the logger instance for the module. Export this for library consumers to
197
+ * inject their own logger.
198
+ *
199
+ * @param logger - Accepts either a LogLayer instance or a Console- or
200
+ * Stream-like log target
199
201
  */
200
202
  declare function setLogger(logger?: ILogBasic | ILogLayer<unknown>): void;
201
203
  //#endregion
@@ -224,7 +226,11 @@ declare function reporterMdat(files: VFile[]): void;
224
226
  //#region src/lib/remark-mdat.d.ts
225
227
  /** Configuration for the remarkMdat plugin. */
226
228
  type Options = {
227
- /** Rules mapping comment keywords to expansion content. Merged with built-in defaults. */rules?: Rules;
229
+ /**
230
+ * Rules mapping comment keywords to expansion content. Merged with built-in
231
+ * defaults.
232
+ */
233
+ rules?: Rules;
228
234
  };
229
235
  /** Zod schema for validating {@link Options}. */
230
236
  declare const optionsSchema: z.ZodObject<{
package/dist/index.js CHANGED
@@ -19,9 +19,11 @@ let log = createLogger({
19
19
  name: "remark-mdat"
20
20
  });
21
21
  /**
22
- * Set the logger instance for the module.
23
- * Export this for library consumers to inject their own logger.
24
- * @param logger - Accepts either a LogLayer instance or a Console- or Stream-like log target
22
+ * Set the logger instance for the module. Export this for library consumers to
23
+ * inject their own logger.
24
+ *
25
+ * @param logger - Accepts either a LogLayer instance or a Console- or
26
+ * Stream-like log target
25
27
  */
26
28
  function setLogger(logger) {
27
29
  log = injectionHelper(logger);
@@ -456,7 +458,7 @@ function splitHtmlIntoMdastNodes(mdastNode) {
456
458
  return mdastNodes;
457
459
  }
458
460
  function addStartPoint(position, start) {
459
- if (position === void 0 || start === void 0) return void 0;
461
+ if (position === void 0 || start === void 0) return;
460
462
  const startLine = position.start.line - 1 + start.line;
461
463
  const endLine = position.end.line - 1 + start.line;
462
464
  return {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "remark-mdat",
3
- "version": "2.2.1",
3
+ "version": "2.2.3",
4
4
  "description": "A remark plugin implementing the Markdown Autophagic Template (MDAT) system.",
5
5
  "keywords": [
6
6
  "mdat",
@@ -46,7 +46,7 @@
46
46
  "gray-matter-es": "^0.2.1",
47
47
  "hast-util-from-html": "^2.0.3",
48
48
  "json5": "^2.2.3",
49
- "lognow": "^0.6.1",
49
+ "lognow": "^0.6.2",
50
50
  "picocolors": "^1.1.1",
51
51
  "remark": "^15.0.1",
52
52
  "remark-gfm": "^4.0.1",
@@ -55,19 +55,19 @@
55
55
  "unist-util-visit": "^5.1.0",
56
56
  "vfile": "^6.0.3",
57
57
  "vfile-message": "^4.0.3",
58
- "zod": "^4.3.6"
58
+ "zod": "^4.4.3"
59
59
  },
60
60
  "devDependencies": {
61
61
  "@arethetypeswrong/core": "^0.18.2",
62
- "@kitschpatrol/shared-config": "^7.4.1",
63
- "@types/node": "~20.19.39",
64
- "@vitest/coverage-v8": "^4.1.5",
65
- "bumpp": "^11.0.1",
66
- "publint": "^0.3.18",
62
+ "@kitschpatrol/shared-config": "^7.6.0",
63
+ "@types/node": "~20.19.41",
64
+ "@vitest/coverage-v8": "^4.1.6",
65
+ "bumpp": "^11.1.0",
66
+ "publint": "^0.3.21",
67
67
  "shx": "^0.4.0",
68
- "tsdown": "^0.21.9",
68
+ "tsdown": "^0.22.0",
69
69
  "typescript": "~5.9.3",
70
- "vitest": "^4.1.5"
70
+ "vitest": "^4.1.6"
71
71
  },
72
72
  "engines": {
73
73
  "node": ">=20.19.6"
@@ -87,8 +87,8 @@
87
87
  "dev": "pnpm test",
88
88
  "fix": "ksc fix",
89
89
  "lint": "ksc lint",
90
- "release": "bumpp --commit 'Release: %s' && pnpm build && NPM_AUTH_TOKEN=$(op read 'op://Personal/npm/token') && pnpm publish",
91
- "release-preview": "bumpp --preid preview --commit 'Release: %s' && pnpm build && NPM_AUTH_TOKEN=$(op read 'op://Personal/npm/token') && pnpm publish --tag preview",
90
+ "release": "bumpp --commit 'Release: %s' && pnpm build && NPM_AUTH_TOKEN=$(op read 'op://Personal/npm/token') pnpm publish",
91
+ "release-preview": "bumpp --preid preview --commit 'Release: %s' && pnpm build && NPM_AUTH_TOKEN=$(op read 'op://Personal/npm/token') pnpm publish --tag preview",
92
92
  "test": "vitest run"
93
93
  }
94
94
  }
package/readme.md CHANGED
@@ -7,7 +7,7 @@
7
7
  <!-- badges -->
8
8
 
9
9
  [![NPM Package remark-mdat](https://img.shields.io/npm/v/remark-mdat.svg)](https://npmjs.com/package/remark-mdat)
10
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
10
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/mit/)
11
11
  [![CI](https://github.com/kitschpatrol/remark-mdat/actions/workflows/ci.yml/badge.svg)](https://github.com/kitschpatrol/remark-mdat/actions/workflows/ci.yml)
12
12
 
13
13
  <!-- /badges -->
@@ -432,10 +432,14 @@ Thanks to the [unified team](https://github.com/orgs/unifiedjs/people) for their
432
432
 
433
433
  ## Contributing
434
434
 
435
- [Issues](https://github.com/kitschpatrol/remark-mdat/issues) and pull requests are welcome.
435
+ [Issues](https://github.com/kitschpatrol/remark-mdat/issues) are welcome and appreciated.
436
+
437
+ Please open an issue to discuss changes before submitting a pull request. Unsolicited PRs (especially AI-generated ones) are unlikely to be merged.
438
+
439
+ This repository uses [@kitschpatrol/shared-config](https://github.com/kitschpatrol/shared-config) (via its `ksc` CLI) for linting and formatting, plus [MDAT](https://github.com/kitschpatrol/mdat) for readme placeholder expansion.
436
440
 
437
441
  ## License
438
442
 
439
- [MIT](license.txt) © Eric Mika
443
+ [MIT](license.txt) © [Eric Mika](https://ericmika.com)
440
444
 
441
445
  <!-- /footer -->