markdown-magic-scripts - npm Package Compare versions

Comparing version 1.3.0 to 1.4.0

CHANGELOG.md

 # Changelog
 
-## [1.3.0](https://github.com/ioncakephper/markdown-magic-scripts/compare/v1.2.1...v1.3.0) (2025-10-15)
+## [1.4.0](https://github.com/ioncakephper/markdown-magic-scripts/compare/v1.3.0...v1.4.0) (2025-10-16)
 
@@ -8,5 +8,11 @@
 
-* **markdown:** add markdown-magic v3 compatibility ([5de280d](https://github.com/ioncakephper/markdown-magic-scripts/commit/5de280d072fc95061e7b09a32088fe0aca6f85e6))
-* **markdown:** add markdown-magic v3 compatibility ([7f83b89](https://github.com/ioncakephper/markdown-magic-scripts/commit/7f83b89f3fb020e5a2459255fcdcf576303fe777))
+* **scripts:** add prep script for publishing workflow ([2c52d43](https://github.com/ioncakephper/markdown-magic-scripts/commit/2c52d43d506bac462dd42294ad5a17dba1f102d1))
 
+## [1.3.0](https://github.com/ioncakephper/markdown-magic-scripts/compare/v1.2.1...v1.3.0) (2025-10-15)
+
+### Features
+
+- **markdown:** add markdown-magic v3 compatibility ([5de280d](https://github.com/ioncakephper/markdown-magic-scripts/commit/5de280d072fc95061e7b09a32088fe0aca6f85e6))
+- **markdown:** add markdown-magic v3 compatibility ([7f83b89](https://github.com/ioncakephper/markdown-magic-scripts/commit/7f83b89f3fb020e5a2459255fcdcf576303fe777))
+
 ## [1.2.1](https://github.com/ioncakephper/markdown-magic-scripts/compare/v1.2.0...v1.2.1) (2025-10-15)
@@ -13,0 +19,0 @@

index.js

@@ -0,0 +0,0 @@ const fs = require('fs');

package.json

 {
   "name": "markdown-magic-scripts",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Automatically generate a dynamic, customizable dashboard of your npm scripts in your README.md using this markdown-magic transform. Keep your project documentation in sync with your package.json.",
@@ -50,2 +50,3 @@ "keywords": [
     "lint:fix": "eslint . --ext .js,.json,.yaml,.md --fix",
+    "prep": "npm run docs && npm run fix",
     "test": "jest"
@@ -75,4 +76,5 @@ },
       "category": "dev"
-    }
+    },
+    "prep": "Prepare the package for publishing by updating docs and fixing formatting"
   }
 }

README.md

@@ -8,2 +8,3 @@ # 📦 markdown‑magic‑scripts
 <!-- doc-gen TOC -->
+
 - [📖 Examples](#examples)
@@ -182,15 +183,17 @@ - [Default (table)](#default-table)
 <!-- doc-gen OPTIONS -->
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `baseUrl` | string | "./package.json" | base URL for line number links. Default: "./package.json" |
-| `commandBlock` | boolean |  | in list mode, show commands in fenced code blocks (true) or inline (false). |
-| `commandLang` | string | "bash" | language for fenced code blocks. Default: "bash" |
-| `compact` | boolean | false | in list mode, only show script names. Default: false |
-| `format` | string |  | output format: "table" (default) or "list" |
-| `groupBy` | string|null | null | group scripts by a metadata field (e.g. "category"). Default: null |
-| `lineNumbers` | boolean | true | show the line number where each script is defined. Default: true |
-| `linkLineNumbers` | boolean | true | make line numbers clickable links. Default: true |
-| `metaKey` | string | "scriptsMeta" | name of the metadata object in package.json. Default: "scriptsMeta" |
-| `showCommands` | boolean | true | show or hide the command column/text. Default: true |
-| `sort` | boolean | true | whether to sort scripts alphabetically. Default: true |
+
+| Option            | Type    | Default          | Description                                                                 |
+| ----------------- | ------- | ---------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------ |
+| `baseUrl`         | string  | "./package.json" | base URL for line number links. Default: "./package.json"                   |
+| `commandBlock`    | boolean |                  | in list mode, show commands in fenced code blocks (true) or inline (false). |
+| `commandLang`     | string  | "bash"           | language for fenced code blocks. Default: "bash"                            |
+| `compact`         | boolean | false            | in list mode, only show script names. Default: false                        |
+| `format`          | string  |                  | output format: "table" (default) or "list"                                  |
+| `groupBy`         | string  | null             | null                                                                        | group scripts by a metadata field (e.g. "category"). Default: null |
+| `lineNumbers`     | boolean | true             | show the line number where each script is defined. Default: true            |
+| `linkLineNumbers` | boolean | true             | make line numbers clickable links. Default: true                            |
+| `metaKey`         | string  | "scriptsMeta"    | name of the metadata object in package.json. Default: "scriptsMeta"         |
+| `showCommands`    | boolean | true             | show or hide the command column/text. Default: true                         |
+| `sort`            | boolean | true             | whether to sort scripts alphabetically. Default: true                       |
+
 <!-- end-doc-gen -->
@@ -207,2 +210,3 @@
 <!-- doc-gen fileTree -->
+
 ```
@@ -224,2 +228,3 @@ └── markdown-magic-scripts/
 ```
+
 <!-- end-doc-gen -->
@@ -230,11 +235,14 @@
 <!-- doc-gen SCRIPTS -->
-| Script | Command | Description | Category | Line |
-| -------- | -------- | -------- | -------- | -------- |
-| `docs` | `npx markdown-magic README.md --config ./markdown-magic.config.js` | Update automated documentation content in README.md |  | [65](./package.json#L65) |
-| `fix` | `npm run lint:fix && npm run format && npm run format:package` | Run lint:fix and format scripts |  | [70](./package.json#L70) |
-| `format` | `prettier --write .` | Format all source files |  | [68](./package.json#L68) |
-| `format:package` | `prettier --write package.json` | Format package.json |  | [69](./package.json#L69) |
-| `lint` | `eslint . --ext .js,.json,.yaml,.md` | Lint all source files |  | [66](./package.json#L66) |
-| `lint:fix` | `eslint . --ext .js,.json,.yaml,.md --fix` | Fix linting issues |  | [67](./package.json#L67) |
-| `test` | `jest` | Run tests | dev | [50](./package.json#L50) |
+
+| Script           | Command                                                            | Description                                                               | Category | Line                     |
+| ---------------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------- | -------- | ------------------------ |
+| `docs`           | `npx markdown-magic README.md --config ./markdown-magic.config.js` | Update automated documentation content in README.md                       |          | [66](./package.json#L66) |
+| `fix`            | `npm run lint:fix && npm run format && npm run format:package`     | Run lint:fix and format scripts                                           |          | [71](./package.json#L71) |
+| `format`         | `prettier --write .`                                               | Format all source files                                                   |          | [69](./package.json#L69) |
+| `format:package` | `prettier --write package.json`                                    | Format package.json                                                       |          | [70](./package.json#L70) |
+| `lint`           | `eslint . --ext .js,.json,.yaml,.md`                               | Lint all source files                                                     |          | [67](./package.json#L67) |
+| `lint:fix`       | `eslint . --ext .js,.json,.yaml,.md --fix`                         | Fix linting issues                                                        |          | [68](./package.json#L68) |
+| `prep`           | `npm run docs && npm run fix`                                      | Prepare the package for publishing by updating docs and fixing formatting |          | [76](./package.json#L76) |
+| `test`           | `jest`                                                             | Run tests                                                                 | dev      | [51](./package.json#L51) |
+
 <!-- end-doc-gen -->
@@ -241,0 +249,0 @@

transforms/options-docs.js

@@ -0,0 +0,0 @@ // transforms/options-docs.js

New alerts

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

25355

7.34%

Number of lines in readme file

307

2.68%

No dependency changes