feat: api history (#73)

* feat(api-history): basic parsing

* feat(api-history): try to detect basic user error

* feat(api-history): zod validation

* feat(api-history): switch to json schema and ajv instead of zod

* refactor(api-history): remove namespace in schema title

* feat(api-history): optimize imports, more async

* feat(api-history): remove `removed` schema property

* fix(api-history): add missing param to usage

* feat(api-history): basic tests

* feat(api-history): cli schema option

* fix(api-history): delete links from fixtures

* feat(api-history): use mockup schema

* style(api-history): remove old comments

* feat(api-history): add format test

* test(api-history): remove snapshot, destructure regex matches

Co-authored-by: David Sanders <[email protected]>

* feat(api-history): use `hast-util-from-markdown` instead of regex

Signed-off-by: Piotr Płaczek <[email protected]>

* style(api-history): slightly nicer formatting

* feat(api-history): remove redundant `validate-with-schema` flag

* feat(api-history): check breaking changes header exists

* feat(api-history): check placement

* feat(api-history): check strings (previously check descriptions)

* fix(api-history): change check descriptions to check strings in help

* style(api-history): catch-up on linting

* feat(api-history): check pull request links

* test(api-history): explicitly specify default flags

* feat(api-history): warnings, nicer errors

* test(api-history): check all numbers in each test

* test(api-history): large amount of api history

* refactor(api-history): remove `--check-pull-request-links`

* style(api-history): catch up on lint

* fix(api-history): unnecessary lowercase

electron/website#594 (comment)

* fix(api-history): match api history block more consistently

* feat(api-history): skip documents without html comments

* fix(api-history): remove debug `console.log`

* Apply suggestions from code review

Co-authored-by: David Sanders <[email protected]>

* style(api-history): lint fix

* style(api-history): reorder imports

#73 (comment)

* docs(api-history): comments for script options

#73 (comment)

* fix(api-history): remove `fs.access()` before `fs.readFile()`

#73 (comment)

* test(api-history): use `fs.mkdtemp()` instead of fixtures folder

#73 (comment)

* test(api-history): use newest schema

#73 (comment)

* test(api-history): use newest `breaking-changes.md`

#73 (comment)

* test(api-history): rename fixture to avoid conflict with other `.spec.ts`

* chore: retain .md extension

Signed-off-by: David Sanders <[email protected]>

* chore: maintainer committed yarn.lock

Signed-off-by: David Sanders <[email protected]>

* test: ignore API history files in links spec

Signed-off-by: David Sanders <[email protected]>

---------

Signed-off-by: Piotr Płaczek <[email protected]>
Signed-off-by: David Sanders <[email protected]>
Co-authored-by: David Sanders <[email protected]>

Author: piotrpdev

Diff for: bin/lint-markdown-api-history.ts

@@ -9,7 +9,8 @@
     "electron-markdownlint": "./dist/bin/markdownlint-cli-wrapper.js",
     "lint-roller-markdown-links": "./dist/bin/lint-markdown-links.js",
     "lint-roller-markdown-standard": "./dist/bin/lint-markdown-standard.js",
-    "lint-roller-markdown-ts-check": "./dist/bin/lint-markdown-ts-check.js"
+    "lint-roller-markdown-ts-check": "./dist/bin/lint-markdown-ts-check.js",
+    "lint-roller-markdown-api-history": "./dist/bin/lint-markdown-api-history.js"
   },
   "files": [
     "configs",
@@ -61,8 +62,10 @@
   },
   "dependencies": {
     "@dsanders11/vscode-markdown-languageservice": "^0.3.0",
+    "ajv": "^8.16.0",
     "balanced-match": "^2.0.0",
     "glob": "^8.1.0",
+    "hast-util-from-html": "^2.0.1",
     "markdown-it": "^13.0.1",
     "markdownlint-cli": "^0.40.0",
     "mdast-util-from-markdown": "^1.3.0",
@@ -72,7 +75,8 @@
     "unist-util-visit": "^4.1.2",
     "vscode-languageserver": "^8.1.0",
     "vscode-languageserver-textdocument": "^1.0.8",
-    "vscode-uri": "^3.0.7"
+    "vscode-uri": "^3.0.7",
+    "yaml": "^2.4.5"
   },
   "peerDependencies": {
     "typescript": ">= 4.7.0"