chore: add docs linter v2 (#31175)

Adds the npm package and package.json script to run docs linter v2 locally.
This commit is contained in:
Charis
2024-12-16 15:04:35 -05:00
committed by GitHub
parent d69902da94
commit ba269fe7d7
2 changed files with 136 additions and 1 deletions

View File

@@ -13,6 +13,7 @@
"postbuild": "npm run build:sitemap",
"start": "next start",
"lint": "next lint",
"lint:mdx": "supa-mdx-lint content/guides --config ../../supa-mdx-lint.config.toml",
"typecheck": "tsc --noEmit",
"test": "vitest --exclude \"**/*.smoke.test.ts\"",
"test:smoke": "npm run codegen:references && vitest -t \"prod smoke test\"",
@@ -108,6 +109,7 @@
},
"devDependencies": {
"@aws-sdk/client-secrets-manager": "^3.410.0",
"@supabase/supa-mdx-lint": "^0.1.7-alpha",
"@types/estree": "1.0.5",
"@types/hast": "^2.3.4",
"@types/jsrsasign": "^10.5.12",

135
package-lock.json generated
View File

@@ -16,7 +16,6 @@
],
"devDependencies": {
"eslint": "^8.57.0",
"nanoid": "^3.3.8",
"prettier": "^4.0.0-alpha.8",
"prettier-plugin-sql-cst": "^0.11.0",
"rimraf": "^6.0.0",
@@ -809,6 +808,7 @@
},
"devDependencies": {
"@aws-sdk/client-secrets-manager": "^3.410.0",
"@supabase/supa-mdx-lint": "^0.1.7-alpha",
"@types/estree": "1.0.5",
"@types/hast": "^2.3.4",
"@types/jsrsasign": "^10.5.12",
@@ -13897,6 +13897,139 @@
"@supabase/node-fetch": "^2.6.14"
}
},
"node_modules/@supabase/supa-mdx-lint": {
"version": "0.1.7-alpha",
"resolved": "https://registry.npmjs.org/@supabase/supa-mdx-lint/-/supa-mdx-lint-0.1.7-alpha.tgz",
"integrity": "sha512-RSlUumUJ1LifWa2+a+t0eGOWay9kkroi1JaMHV8HJf30a92o2U6TaP/tXiAQesgTblZNC+ty2/74Al0rmp/OdQ==",
"dev": true,
"bin": {
"supa-mdx-lint": "src/index.js"
},
"optionalDependencies": {
"@supabase/supa-mdx-lint-darwin": "0.1.7-alpha",
"@supabase/supa-mdx-lint-linux-arm": "0.1.7-alpha",
"@supabase/supa-mdx-lint-linux-arm64": "0.1.7-alpha",
"@supabase/supa-mdx-lint-linux-i686": "0.1.7-alpha",
"@supabase/supa-mdx-lint-linux-x64": "0.1.7-alpha",
"@supabase/supa-mdx-lint-win32-i686": "0.1.7-alpha",
"@supabase/supa-mdx-lint-win32-x64": "0.1.7-alpha"
}
},
"node_modules/@supabase/supa-mdx-lint-darwin": {
"version": "0.1.7-alpha",
"resolved": "https://registry.npmjs.org/@supabase/supa-mdx-lint-darwin/-/supa-mdx-lint-darwin-0.1.7-alpha.tgz",
"integrity": "sha512-ggvl/+g7TRWZ0tBvnTUPART38N8qIo2UgkShGsgi5/BnRdVsw5CwQqqDZT7+enEZRiobbVrE+hUDCTWCManqFA==",
"dev": true,
"optional": true,
"os": [
"darwin"
],
"engines": {
"node": ">=10"
}
},
"node_modules/@supabase/supa-mdx-lint-linux-arm": {
"version": "0.1.7-alpha",
"resolved": "https://registry.npmjs.org/@supabase/supa-mdx-lint-linux-arm/-/supa-mdx-lint-linux-arm-0.1.7-alpha.tgz",
"integrity": "sha512-TxZrhNOAH3NswuA3kITTdiUWF7xUQRmmh6QAfUeYAUj/E0zgH0g31YKhgOgbn+s0L88g+nEHSlGmgWDMibdJ4w==",
"cpu": [
"arm"
],
"dev": true,
"optional": true,
"os": [
"linux",
"freebsd"
],
"engines": {
"node": ">=10"
}
},
"node_modules/@supabase/supa-mdx-lint-linux-arm64": {
"version": "0.1.7-alpha",
"resolved": "https://registry.npmjs.org/@supabase/supa-mdx-lint-linux-arm64/-/supa-mdx-lint-linux-arm64-0.1.7-alpha.tgz",
"integrity": "sha512-e5MGzRdiqjc3mr8JJ3+tbwdbbuQQ4L0m6VBUwy+XQKNNbdlO4b1eP73dQNK5ZU1I8kjE9nloUXYEeTgA+E81kg==",
"cpu": [
"arm64"
],
"dev": true,
"optional": true,
"os": [
"linux",
"freebsd"
],
"engines": {
"node": ">=10"
}
},
"node_modules/@supabase/supa-mdx-lint-linux-i686": {
"version": "0.1.7-alpha",
"resolved": "https://registry.npmjs.org/@supabase/supa-mdx-lint-linux-i686/-/supa-mdx-lint-linux-i686-0.1.7-alpha.tgz",
"integrity": "sha512-C+n7dJ7F14/4+IkzJCmGogPuTtOd+CuYQmseLy+aJkDFDyNicKXjCU4nF7pwtAx5HTMlU8Pnwl6mXyuaqd8e9w==",
"cpu": [
"x86",
"ia32"
],
"dev": true,
"optional": true,
"os": [
"linux",
"freebsd"
],
"engines": {
"node": ">=10"
}
},
"node_modules/@supabase/supa-mdx-lint-linux-x64": {
"version": "0.1.7-alpha",
"resolved": "https://registry.npmjs.org/@supabase/supa-mdx-lint-linux-x64/-/supa-mdx-lint-linux-x64-0.1.7-alpha.tgz",
"integrity": "sha512-Oj7y9y/HBNV1X3F8HvWHeQNKXQxogkgDmxEhaZIojeiHnWXDZ6h6WCgSIWL86URwyjPNGxR4pdoZYsSR4Q8n0Q==",
"cpu": [
"x64"
],
"dev": true,
"optional": true,
"os": [
"linux",
"freebsd"
],
"engines": {
"node": ">=10"
}
},
"node_modules/@supabase/supa-mdx-lint-win32-i686": {
"version": "0.1.7-alpha",
"resolved": "https://registry.npmjs.org/@supabase/supa-mdx-lint-win32-i686/-/supa-mdx-lint-win32-i686-0.1.7-alpha.tgz",
"integrity": "sha512-3t2/KngOEhWsvZu2B8QMS2WsC99uTEpnklu9y5AFq6ln7QhoNjPKnlx4iy2hxaIF/NfN0WJAXIJsBrSn9CfqEA==",
"cpu": [
"x86",
"ia32"
],
"dev": true,
"optional": true,
"os": [
"win32"
],
"engines": {
"node": ">=10"
}
},
"node_modules/@supabase/supa-mdx-lint-win32-x64": {
"version": "0.1.7-alpha",
"resolved": "https://registry.npmjs.org/@supabase/supa-mdx-lint-win32-x64/-/supa-mdx-lint-win32-x64-0.1.7-alpha.tgz",
"integrity": "sha512-LAr/ZV1pDWXjfsicHdd/QahyGX31SN4RMk+3J/s9xWVzQorrwrJwuiWAAQ/osPF4yEtWVb6vriS42f/t+q8oZQ==",
"cpu": [
"x64"
],
"dev": true,
"optional": true,
"os": [
"win32"
],
"engines": {
"node": ">=10"
}
},
"node_modules/@supabase/supabase-js": {
"version": "2.44.3",
"resolved": "https://registry.npmjs.org/@supabase/supabase-js/-/supabase-js-2.44.3.tgz",