From 86729c85cadac0875c64489591454124dab92ced Mon Sep 17 00:00:00 2001 From: Artur Stolear Date: Wed, 24 Jul 2024 20:27:59 +0200 Subject: [PATCH] markdown linting --- .azure/ci.yml | 2 +- .editorconfig | 2 +- .github/workflows/ci.yml | 2 +- .markdownlint.yml | 10 + dist/azure/overview.md | 4 +- docs/cloning.md | 4 +- .../examples/azure/gitreleasemanager/setup.md | 6 + .../{execute/usage-examples.md => execute.md} | 30 ++- docs/examples/azure/gitversion/index.md | 4 +- .../{setup/usage-examples.md => setup.md} | 2 +- .../github/gitreleasemanager/setup.md | 6 + .../{execute/usage-examples.md => execute.md} | 19 +- docs/examples/github/gitversion/index.md | 4 +- .../{setup/usage-examples.md => setup.md} | 2 +- docs/versions.md | 2 + envs/gitversion/execute/github.env | 2 +- package-lock.json | 236 ++++++++++++++++++ package.json | 3 + 18 files changed, 318 insertions(+), 22 deletions(-) create mode 100644 .markdownlint.yml rename docs/examples/azure/gitversion/{execute/usage-examples.md => execute.md} (96%) rename docs/examples/azure/gitversion/{setup/usage-examples.md => setup.md} (92%) rename docs/examples/github/gitversion/{execute/usage-examples.md => execute.md} (97%) rename docs/examples/github/gitversion/{setup/usage-examples.md => setup.md} (92%) diff --git a/.azure/ci.yml b/.azure/ci.yml index 60c1f57f9..ea2a35361 100644 --- a/.azure/ci.yml +++ b/.azure/ci.yml @@ -42,7 +42,7 @@ jobs: npm install displayName: 'Install dependencies' - pwsh: | - npm run lint:check && npm run format:check + npm run lint:check && npm run format:check && npm run mdlint:check displayName: 'Check code formatting' - pwsh: | npm run build:tools diff --git a/.editorconfig b/.editorconfig index f2c851a77..776a543c0 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,4 +1,4 @@ -# http://editorconfig.org +# https://editorconfig.org root = true [*] diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 31c467c28..1a5d35b57 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -36,7 +36,7 @@ jobs: npm install name: Install dependencies - run: | - npm run lint:check && npm run format:check + npm run lint:check && npm run format:check && npm run mdlint:check name: Check code formatting - run: | npm run build:tools diff --git a/.markdownlint.yml b/.markdownlint.yml new file mode 100644 index 000000000..a715d78f3 --- /dev/null +++ b/.markdownlint.yml @@ -0,0 +1,10 @@ +MD033: + allowed_elements: + - details + - summary + - b + - i +MD013: false + +MD041: + level: 1 diff --git a/dist/azure/overview.md b/dist/azure/overview.md index 824799e69..6b84562fa 100644 --- a/dist/azure/overview.md +++ b/dist/azure/overview.md @@ -1,4 +1,6 @@ -Versioning when using Git, solved. GitVersion looks at your Git history and works out the [semantic version](http://semver.org) of the commit being built. +# GitTools bundle for Azure Pipelines + +Versioning when using Git, solved. GitVersion looks at your Git history and works out the [semantic version](https://semver.org) of the commit being built. It works with most branching strategies but has been designed mainly around GitFlow and GitHubFlow (pull request workflow). The calculated version numbers can then be accessed through variables such as `$(GitVersion.FullSemVer)` and `$(GitVersion.SemVer)`. It is also very configurable to allow it to work with most release workflows! diff --git a/docs/cloning.md b/docs/cloning.md index c361392b1..a2941b9f8 100644 --- a/docs/cloning.md +++ b/docs/cloning.md @@ -1,4 +1,6 @@ -In order for the gitversion to properly work you need to clone the repository with the entire history: +# Cloning + +In order for the GitVersion to properly work you need to clone the repository with the entire history: ```yaml # GitHub Actions syntax diff --git a/docs/examples/azure/gitreleasemanager/setup.md b/docs/examples/azure/gitreleasemanager/setup.md index b693cd234..064e3308f 100644 --- a/docs/examples/azure/gitreleasemanager/setup.md +++ b/docs/examples/azure/gitreleasemanager/setup.md @@ -1,3 +1,9 @@ +# Setup GitReleaseManager Task (gitreleasemanager/setup) Usage Examples + +Find out how to use the **gitreleasemanager/setup** task using the examples below. + +> The examples use version _2.0.1_ of the GitReleaseManager Setup task. It is recommended to use the latest released version in your own workflows. + ## Inputs The Setup GitReleaseManager action accepts the following inputs: diff --git a/docs/examples/azure/gitversion/execute/usage-examples.md b/docs/examples/azure/gitversion/execute.md similarity index 96% rename from docs/examples/azure/gitversion/execute/usage-examples.md rename to docs/examples/azure/gitversion/execute.md index ee28332e5..e476ad885 100644 --- a/docs/examples/azure/gitversion/execute/usage-examples.md +++ b/docs/examples/azure/gitversion/execute.md @@ -106,11 +106,13 @@ The Execute GitVersion task creates the following job-scoped variables and multi - commitsSinceVersionSourcePadded (since 5.2.0, removed in 6.0.0) - uncommittedChanges (since 5.5.0) - commitDate + --- ## Execution Examples ### Example 1 +
Calculate the version for the build. @@ -121,20 +123,23 @@ steps: - task: gitversion/execute@2.0.1 displayName: Determine Version ``` +
### Example 2
- Calculate the version for the build using a config file with the default name **GitVersion.yml**. + Calculate the version for the build using a config file with the default name GitVersion.yml. + ```yaml steps: # gitversion/setup@2.0.1 task omitted for brevity. - - task: gitversion/execute@2.0.1 +- task: gitversion/execute@2.0.1 displayName: Determine Version inputs: useConfigFile: true + ``` Example contents of **GitVersion.yml**: @@ -147,12 +152,13 @@ branches: pull-request: tag: pr ``` +
### Example 3
- Calculate the version for the build using a config file named **VersionConfig.yml** in the root of the working folder. + Calculate the version for the build using a config file named VersionConfig.yml in the root of the working folder. ```yaml steps: @@ -164,12 +170,13 @@ steps: useConfigFile: true configFilePath: 'VersionConfig.yml' ``` +
### Example 4
- Show the effective configuration for GitVersion by running the **/showConfig** command (passed as an additional argument). + Show the effective configuration for GitVersion by running the /showConfig command (passed as an additional argument). ```yaml steps: @@ -180,6 +187,7 @@ steps: inputs: additionalArguments: '/showConfig' ``` +
### Example 5 @@ -197,6 +205,7 @@ steps: disableCache: true disableNormalization: true ``` + ### Example 6 @@ -213,6 +222,7 @@ steps: inputs: updateAssemblyInfo: true ``` + ### Example 7 @@ -231,17 +241,20 @@ steps: update-build-number=false next-version=2.0.1 ``` + ## Output usage -The outputs can be accessed using the syntax `$(.)` or `$(.GitVersion_)`, where `` is the ID assigned to the step that calls the action, by subsequent steps later in the same job. +The outputs can be accessed using the syntax `$(.)` or `$(.GitVersion_)`, +where `` is the ID assigned to the step that calls the action, by subsequent steps later in the same job. The action also creates environment variables of the form `$()` or `$(GitVersion_)` for use by other steps in the same job. The multi-job output variables can be accessed across jobs and stages, in both conditions and variables. -**GitVersion also automatically updates the pre-defined Build variable `Build.BuildNumber`.** You can disable the default behavior by setting the `update-build-number` to `false` in the configuration file or by using the `overrideConfig` input. +**GitVersion also automatically updates the pre-defined Build variable `Build.BuildNumber`.** +You can disable the default behavior by setting the `update-build-number` to `false` in the configuration file or by using the `overrideConfig` input. ### Example 8 @@ -310,9 +323,11 @@ jobs: env: myvar_GitVersion_FullSemVer: $(version_step.GitVersion_FullSemVer) ``` + ### Example 9 +
Calculate the version for the build and use the output in a subsequent job. @@ -396,9 +411,11 @@ jobs: env: localvar_GitVersion_FullSemVer: $(myvar_GitVersion_FullSemVer) ``` +
### Example 10 +
Calculate the version for the build and use the output in a subsequent stage. @@ -489,4 +506,5 @@ stages: env: localvar_GitVersion_FullSemVer: $(myvar_GitVersion_FullSemVer) ``` +
diff --git a/docs/examples/azure/gitversion/index.md b/docs/examples/azure/gitversion/index.md index f6c039288..ab13dcbb4 100644 --- a/docs/examples/azure/gitversion/index.md +++ b/docs/examples/azure/gitversion/index.md @@ -6,8 +6,8 @@ Note: You need to run the Setup step before the Execute step, otherwise the Exec ## Setup GitVersion (gitversion/setup) -- [Usage examples](setup/usage-examples.md) +- [Usage examples](setup.md) ## Execute GitVersion (gitversion/execute) -- [Usage examples](execute/usage-examples.md) +- [Usage examples](execute.md) diff --git a/docs/examples/azure/gitversion/setup/usage-examples.md b/docs/examples/azure/gitversion/setup.md similarity index 92% rename from docs/examples/azure/gitversion/setup/usage-examples.md rename to docs/examples/azure/gitversion/setup.md index d17e65e93..7ca79103d 100644 --- a/docs/examples/azure/gitversion/setup/usage-examples.md +++ b/docs/examples/azure/gitversion/setup.md @@ -2,7 +2,7 @@ Find out how to use the **gitversion/setup** task using the examples below. -> The examples use version _2.0.1_ of the GitVersion Execute task. It is recommended to use the latest released version in your own workflows. +> The examples use version _2.0.1_ of the GitVersion Setup task. It is recommended to use the latest released version in your own workflows. ## Inputs diff --git a/docs/examples/github/gitreleasemanager/setup.md b/docs/examples/github/gitreleasemanager/setup.md index 96cfbb86f..f3280f6bd 100644 --- a/docs/examples/github/gitreleasemanager/setup.md +++ b/docs/examples/github/gitreleasemanager/setup.md @@ -1,3 +1,9 @@ +# Setup GitReleaseManager Action (gitreleasemanager/setup) Usage Examples + +Find out how to use the **gitreleasemanager/setup** action using the examples below. + +> The examples use version _2.0.1_ of the GitReleaseManager Setup action. It is recommended to use the latest released version in your own workflows. + ## Inputs The Setup GitReleaseManager action accepts the following inputs: diff --git a/docs/examples/github/gitversion/execute/usage-examples.md b/docs/examples/github/gitversion/execute.md similarity index 97% rename from docs/examples/github/gitversion/execute/usage-examples.md rename to docs/examples/github/gitversion/execute.md index f78eb62a8..b93a24b18 100644 --- a/docs/examples/github/gitversion/execute/usage-examples.md +++ b/docs/examples/github/gitversion/execute.md @@ -108,6 +108,7 @@ The Execute GitVersion action creates the following outputs: - commitsSinceVersionSourcePadded (since 5.2.0, removed in 6.0.0) - uncommittedChanges (since 5.5.0) - commitDate + --- ## Execution Examples @@ -124,12 +125,13 @@ steps: - name: Determine Version uses: gittools/actions/gitversion/execute@v2.0.1 ``` + ### Example 2
- Calculate the version for the build using a config file with the default name **GitVersion.yml**. + Calculate the version for the build using a config file with the default name GitVersion.yml. ```yaml steps: @@ -149,12 +151,13 @@ branches: pull-request: tag: pr ``` +
### Example 3
- Calculate the version for the build using a config file named **VersionConfig.yml** in the root of the working folder. + Calculate the version for the build using a config file named VersionConfig.yml in the root of the working folder. ```yaml steps: @@ -166,12 +169,13 @@ steps: useConfigFile: true configFilePath: VersionConfig.yml ``` +
### Example 4
- Show the effective configuration for GitVersion by running the **/showConfig** command (passed as an additional argument). + Show the effective configuration for GitVersion by running the /showConfig command (passed as an additional argument). ```yaml steps: @@ -183,6 +187,7 @@ steps: useConfigFile: true additionalArguments: '/showConfig' ``` +
### Example 5 @@ -200,6 +205,7 @@ steps: disableCache: true disableNormalization: true ``` + ### Example 6 @@ -216,6 +222,7 @@ steps: with: updateAssemblyInfo: true ``` + ### Example 7 @@ -234,11 +241,13 @@ steps: update-build-number=false next-version=2.0.1 ``` + ## Output usage -The outputs can be accessed using the syntax `${{ steps..outputs. }}` or `${{ steps..outputs.GitVersion_ }}`, where `` is the ID assigned to the step that calls the action, by subsequent steps later in the same job. +The outputs can be accessed using the syntax `${{ steps..outputs. }}` or `${{ steps..outputs.GitVersion_ }}`, +where `` is the ID assigned to the step that calls the action, by subsequent steps later in the same job. The action also creates environment variables of the form `${{ env. }}` or `${{ env.GitVersion_ }}` for use by other steps in the same job. @@ -323,6 +332,7 @@ jobs: env: myvar_GitVersion_FullSemVer: ${{ steps.version_step.outputs.GitVersion_FullSemVer }} ``` + ### Example 9 @@ -468,4 +478,5 @@ jobs: name: Use direct output from previous job (bash - outputs without prefix) shell: bash ``` + diff --git a/docs/examples/github/gitversion/index.md b/docs/examples/github/gitversion/index.md index 59c243ec6..b60f74465 100644 --- a/docs/examples/github/gitversion/index.md +++ b/docs/examples/github/gitversion/index.md @@ -6,8 +6,8 @@ Note: You need to run the Setup step before the Execute step, otherwise the Exec ## Setup GitVersion (gitversion/setup) -- [Usage examples](setup/usage-examples.md) +- [Usage examples](setup.md) ## Execute GitVersion (gitversion/execute) -- [Usage examples](execute/usage-examples.md) +- [Usage examples](execute.md) diff --git a/docs/examples/github/gitversion/setup/usage-examples.md b/docs/examples/github/gitversion/setup.md similarity index 92% rename from docs/examples/github/gitversion/setup/usage-examples.md rename to docs/examples/github/gitversion/setup.md index 500e6c787..750d71b58 100644 --- a/docs/examples/github/gitversion/setup/usage-examples.md +++ b/docs/examples/github/gitversion/setup.md @@ -2,7 +2,7 @@ Find out how to use the **gitversion/setup** action using the examples below. -> The examples use version _2.0.1_ of the GitVersion Execute action. It is recommended to use the latest released version in your own workflows. +> The examples use version _2.0.1_ of the GitVersion Setup action. It is recommended to use the latest released version in your own workflows. ## Inputs diff --git a/docs/versions.md b/docs/versions.md index e4c6101d6..5e8f42eec 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -1,3 +1,5 @@ +# Versions and Compatibility + | GitTools/actions | GitVersion | GitReleaseManager | |------------------|------------------|--------------------| | v1.x | `>=5.2.0 <6.1.0` | `>=0.10.0 <0.18.0` | diff --git a/envs/gitversion/execute/github.env b/envs/gitversion/execute/github.env index 863b2804a..5ed0e7ad0 100644 --- a/envs/gitversion/execute/github.env +++ b/envs/gitversion/execute/github.env @@ -1,4 +1,4 @@ GITHUB_WORKSPACE=. RUNNER_TEMP=./.test/temp RUNNER_TOOL_CACHE=./.test/tools -GITVERSION_PATH=./.test/tools/GitVersion.Tool/6.10.0 +GITVERSION_PATH=./.test/tools/GitVersion.Tool/6.0.0 diff --git a/package-lock.json b/package-lock.json index f01a74e4a..2cd32a7b4 100644 --- a/package-lock.json +++ b/package-lock.json @@ -25,6 +25,7 @@ "eslint-plugin-promise": "^7.0.0", "eslint-plugin-vitest": "^0.5.4", "glob": "^11.0.0", + "markdownlint-cli": "^0.41.0", "npm-run-all2": "^6.2.2", "prettier": "^3.3.3", "tfx-cli": "^0.17.0", @@ -2137,6 +2138,15 @@ "node": ">=0.1.90" } }, + "node_modules/commander": { + "version": "12.1.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-12.1.0.tgz", + "integrity": "sha512-Vw8qHK3bZM9y/P10u3Vib8o/DdkvA2OtPtZvD871QKjy74Wj1WSKFILMPRPSdUSx5RFK1arlJzEtA4PkFgnbuA==", + "dev": true, + "engines": { + "node": ">=18" + } + }, "node_modules/compress-commons": { "version": "1.2.2", "resolved": "https://registry.npmjs.org/compress-commons/-/compress-commons-1.2.2.tgz", @@ -2340,6 +2350,15 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/deep-extend": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", + "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", + "dev": true, + "engines": { + "node": ">=4.0.0" + } + }, "node_modules/deep-is": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", @@ -2465,6 +2484,18 @@ "node": ">=10.13.0" } }, + "node_modules/entities": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", + "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", + "dev": true, + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, "node_modules/es-abstract": { "version": "1.23.3", "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.23.3.tgz", @@ -4047,6 +4078,15 @@ "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", "dev": true }, + "node_modules/ini": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/ini/-/ini-4.1.3.tgz", + "integrity": "sha512-X7rqawQBvfdjS10YU1y1YVreA3SsLrW9dX2CewP2EbBJM4ypVNLDkO5y04gejPwKIY9lR+7r9gn3rFPt/kmWFg==", + "dev": true, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, "node_modules/internal-slot": { "version": "1.0.7", "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.7.tgz", @@ -4574,6 +4614,21 @@ "json5": "lib/cli.js" } }, + "node_modules/jsonc-parser": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.2.1.tgz", + "integrity": "sha512-AilxAyFOAcK5wA1+LeaySVBrHsGQvUFCDWXKpZjzaL0PqW+xfBOttn8GNtWKFWqneyMZj41MWF9Kl6iPWLwgOA==", + "dev": true + }, + "node_modules/jsonpointer": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/jsonpointer/-/jsonpointer-5.0.1.tgz", + "integrity": "sha512-p/nXbhSEcu3pZRdkW1OfJhpsVtW1gd4Wa1fnQc9YLiTfAjn0312eMKimbdIQzuZl9aa9xUGaRlP9T/CJE/ditQ==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/jsx-ast-utils": { "version": "3.3.5", "resolved": "https://registry.npmjs.org/jsx-ast-utils/-/jsx-ast-utils-3.3.5.tgz", @@ -4662,6 +4717,15 @@ "immediate": "~3.0.5" } }, + "node_modules/linkify-it": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.0.tgz", + "integrity": "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==", + "dev": true, + "dependencies": { + "uc.micro": "^2.0.0" + } + }, "node_modules/locate-path": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", @@ -4740,6 +4804,139 @@ "@jridgewell/sourcemap-codec": "^1.4.15" } }, + "node_modules/markdown-it": { + "version": "14.1.0", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.0.tgz", + "integrity": "sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg==", + "dev": true, + "dependencies": { + "argparse": "^2.0.1", + "entities": "^4.4.0", + "linkify-it": "^5.0.0", + "mdurl": "^2.0.0", + "punycode.js": "^2.3.1", + "uc.micro": "^2.1.0" + }, + "bin": { + "markdown-it": "bin/markdown-it.mjs" + } + }, + "node_modules/markdownlint": { + "version": "0.34.0", + "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.34.0.tgz", + "integrity": "sha512-qwGyuyKwjkEMOJ10XN6OTKNOVYvOIi35RNvDLNxTof5s8UmyGHlCdpngRHoRGNvQVGuxO3BJ7uNSgdeX166WXw==", + "dev": true, + "dependencies": { + "markdown-it": "14.1.0", + "markdownlint-micromark": "0.1.9" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/DavidAnson" + } + }, + "node_modules/markdownlint-cli": { + "version": "0.41.0", + "resolved": "https://registry.npmjs.org/markdownlint-cli/-/markdownlint-cli-0.41.0.tgz", + "integrity": "sha512-kp29tKrMKdn+xonfefjp3a/MsNzAd9c5ke0ydMEI9PR98bOjzglYN4nfMSaIs69msUf1DNkgevAIAPtK2SeX0Q==", + "dev": true, + "dependencies": { + "commander": "~12.1.0", + "get-stdin": "~9.0.0", + "glob": "~10.4.1", + "ignore": "~5.3.1", + "js-yaml": "^4.1.0", + "jsonc-parser": "~3.2.1", + "jsonpointer": "5.0.1", + "markdownlint": "~0.34.0", + "minimatch": "~9.0.4", + "run-con": "~1.3.2", + "smol-toml": "~1.2.0" + }, + "bin": { + "markdownlint": "markdownlint.js" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/markdownlint-cli/node_modules/glob": { + "version": "10.4.5", + "resolved": "https://registry.npmjs.org/glob/-/glob-10.4.5.tgz", + "integrity": "sha512-7Bv8RF0k6xjo7d4A/PxYLbUCfb6c+Vpd2/mB2yRDlew7Jb5hEXiCD9ibfO7wpk8i4sevK6DFny9h7EYbM3/sHg==", + "dev": true, + "dependencies": { + "foreground-child": "^3.1.0", + "jackspeak": "^3.1.2", + "minimatch": "^9.0.4", + "minipass": "^7.1.2", + "package-json-from-dist": "^1.0.0", + "path-scurry": "^1.11.1" + }, + "bin": { + "glob": "dist/esm/bin.mjs" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/markdownlint-cli/node_modules/jackspeak": { + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-3.4.3.tgz", + "integrity": "sha512-OGlZQpz2yfahA/Rd1Y8Cd9SIEsqvXkLVoSw/cgwhnhFMDbsQFeZYoJJ7bIZBS9BcamUW96asq/npPWugM+RQBw==", + "dev": true, + "dependencies": { + "@isaacs/cliui": "^8.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + }, + "optionalDependencies": { + "@pkgjs/parseargs": "^0.11.0" + } + }, + "node_modules/markdownlint-cli/node_modules/lru-cache": { + "version": "10.4.3", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.4.3.tgz", + "integrity": "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==", + "dev": true + }, + "node_modules/markdownlint-cli/node_modules/path-scurry": { + "version": "1.11.1", + "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.11.1.tgz", + "integrity": "sha512-Xa4Nw17FS9ApQFJ9umLiJS4orGjm7ZzwUrwamcGQuHSzDyth9boKDaycYdDcZDuqYATXw4HFXgaqWTctW/v1HA==", + "dev": true, + "dependencies": { + "lru-cache": "^10.2.0", + "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0" + }, + "engines": { + "node": ">=16 || 14 >=14.18" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/markdownlint-micromark": { + "version": "0.1.9", + "resolved": "https://registry.npmjs.org/markdownlint-micromark/-/markdownlint-micromark-0.1.9.tgz", + "integrity": "sha512-5hVs/DzAFa8XqYosbEAEg6ok6MF2smDj89ztn9pKkCtdKHVdPQuGMH7frFfYL9mLkvfFe4pTyAMffLbjf3/EyA==", + "dev": true, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/DavidAnson" + } + }, + "node_modules/mdurl": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.0.0.tgz", + "integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==", + "dev": true + }, "node_modules/memorystream": { "version": "0.3.1", "resolved": "https://registry.npmjs.org/memorystream/-/memorystream-0.3.1.tgz", @@ -5442,6 +5639,15 @@ "node": ">=6" } }, + "node_modules/punycode.js": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz", + "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==", + "dev": true, + "engines": { + "node": ">=6" + } + }, "node_modules/qs": { "version": "6.12.3", "resolved": "https://registry.npmjs.org/qs/-/qs-6.12.3.tgz", @@ -5728,6 +5934,21 @@ "fsevents": "~2.3.2" } }, + "node_modules/run-con": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/run-con/-/run-con-1.3.2.tgz", + "integrity": "sha512-CcfE+mYiTcKEzg0IqS08+efdnH0oJ3zV0wSUFBNrMHMuxCtXvBCLzCJHatwuXDcu/RlhjTziTo/a1ruQik6/Yg==", + "dev": true, + "dependencies": { + "deep-extend": "^0.6.0", + "ini": "~4.1.0", + "minimist": "^1.2.8", + "strip-json-comments": "~3.1.1" + }, + "bin": { + "run-con": "cli.js" + } + }, "node_modules/run-parallel": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", @@ -5982,6 +6203,15 @@ "node": ">=8" } }, + "node_modules/smol-toml": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/smol-toml/-/smol-toml-1.2.2.tgz", + "integrity": "sha512-fVEjX2ybKdJKzFL46VshQbj9PuA4IUKivalgp48/3zwS9vXzyykzQ6AX92UxHSvWJagziMRLeHMgEzoGO7A8hQ==", + "dev": true, + "engines": { + "node": ">= 18" + } + }, "node_modules/source-map-js": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.0.tgz", @@ -6746,6 +6976,12 @@ } } }, + "node_modules/uc.micro": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz", + "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==", + "dev": true + }, "node_modules/unbox-primitive": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.2.tgz", diff --git a/package.json b/package.json index aef5a5075..5ccad3a3d 100644 --- a/package.json +++ b/package.json @@ -18,6 +18,8 @@ "lint:fix": "eslint --ext .ts src --fix", "format:check": "prettier --check \"src/**/*.ts\"", "format:fix": "prettier --write \"src/**/*.ts\"", + "mdlint:check": "markdownlint docs dist", + "mdlint:fix": "markdownlint --fix docs dist", "build:tools": "vite build --config src/tools/vite.config.mts", "build:agents": "run-p build:agent:local build:agent:azure build:agent:github", @@ -56,6 +58,7 @@ "eslint-plugin-promise": "^7.0.0", "eslint-plugin-vitest": "^0.5.4", "glob": "^11.0.0", + "markdownlint-cli": "^0.41.0", "npm-run-all2": "^6.2.2", "prettier": "^3.3.3", "tfx-cli": "^0.17.0",