Skip to content

Commit

Permalink
chore: remove mdx from docs build
Browse files Browse the repository at this point in the history
We will be updating to mdx@2 soon which is esm only, but built in to
Gatsby. Due to the new documentation build process here and in
`npm/documentation`, there is much less need for us to verify all our
docs here. Therefore, it is best to remove this dependency now to avoid
needing to update it here at the same time as the docs site.
  • Loading branch information
lukekarrys authored and wraithgar committed Nov 1, 2022
1 parent 2293fb2 commit f361796
Show file tree
Hide file tree
Showing 5 changed files with 74 additions and 1,163 deletions.
218 changes: 0 additions & 218 deletions DEPENDENCIES.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,89 +251,10 @@ graph LR;
agentkeepalive-->humanize-ms;
aggregate-error-->clean-stack;
aggregate-error-->indent-string;
ampproject-remapping-->jridgewell-gen-mapping["@jridgewell/gen-mapping"];
ampproject-remapping-->jridgewell-trace-mapping["@jridgewell/trace-mapping"];
ansi-styles-->color-convert;
are-we-there-yet-->delegates;
are-we-there-yet-->readable-stream;
argparse-->sprintf-js;
babel-code-frame-->babel-highlight["@babel/highlight"];
babel-core-->ampproject-remapping["@ampproject/remapping"];
babel-core-->babel-code-frame["@babel/code-frame"];
babel-core-->babel-generator["@babel/generator"];
babel-core-->babel-helper-compilation-targets["@babel/helper-compilation-targets"];
babel-core-->babel-helper-module-transforms["@babel/helper-module-transforms"];
babel-core-->babel-helpers["@babel/helpers"];
babel-core-->babel-parser["@babel/parser"];
babel-core-->babel-template["@babel/template"];
babel-core-->babel-traverse["@babel/traverse"];
babel-core-->babel-types["@babel/types"];
babel-core-->convert-source-map;
babel-core-->debug;
babel-core-->gensync;
babel-core-->json5;
babel-core-->lodash;
babel-core-->resolve;
babel-core-->semver;
babel-core-->source-map;
babel-generator-->babel-types["@babel/types"];
babel-generator-->jridgewell-gen-mapping["@jridgewell/gen-mapping"];
babel-generator-->jsesc;
babel-helper-compilation-targets-->babel-compat-data["@babel/compat-data"];
babel-helper-compilation-targets-->babel-core["@babel/core"];
babel-helper-compilation-targets-->babel-helper-validator-option["@babel/helper-validator-option"];
babel-helper-compilation-targets-->browserslist;
babel-helper-compilation-targets-->semver;
babel-helper-function-name-->babel-template["@babel/template"];
babel-helper-function-name-->babel-types["@babel/types"];
babel-helper-hoist-variables-->babel-types["@babel/types"];
babel-helper-module-imports-->babel-types["@babel/types"];
babel-helper-module-transforms-->babel-helper-environment-visitor["@babel/helper-environment-visitor"];
babel-helper-module-transforms-->babel-helper-module-imports["@babel/helper-module-imports"];
babel-helper-module-transforms-->babel-helper-simple-access["@babel/helper-simple-access"];
babel-helper-module-transforms-->babel-helper-split-export-declaration["@babel/helper-split-export-declaration"];
babel-helper-module-transforms-->babel-helper-validator-identifier["@babel/helper-validator-identifier"];
babel-helper-module-transforms-->babel-template["@babel/template"];
babel-helper-module-transforms-->babel-traverse["@babel/traverse"];
babel-helper-module-transforms-->babel-types["@babel/types"];
babel-helper-simple-access-->babel-types["@babel/types"];
babel-helper-split-export-declaration-->babel-types["@babel/types"];
babel-helpers-->babel-template["@babel/template"];
babel-helpers-->babel-traverse["@babel/traverse"];
babel-helpers-->babel-types["@babel/types"];
babel-highlight-->babel-helper-validator-identifier["@babel/helper-validator-identifier"];
babel-highlight-->chalk;
babel-highlight-->js-tokens;
babel-plugin-apply-mdx-type-prop-->babel-core["@babel/core"];
babel-plugin-apply-mdx-type-prop-->babel-helper-plugin-utils["@babel/helper-plugin-utils"];
babel-plugin-apply-mdx-type-prop-->mdx-js-util["@mdx-js/util"];
babel-plugin-extract-import-names-->babel-helper-plugin-utils["@babel/helper-plugin-utils"];
babel-plugin-proposal-object-rest-spread-->babel-core["@babel/core"];
babel-plugin-proposal-object-rest-spread-->babel-helper-plugin-utils["@babel/helper-plugin-utils"];
babel-plugin-proposal-object-rest-spread-->babel-plugin-syntax-object-rest-spread["@babel/plugin-syntax-object-rest-spread"];
babel-plugin-proposal-object-rest-spread-->babel-plugin-transform-parameters["@babel/plugin-transform-parameters"];
babel-plugin-syntax-jsx-->babel-core["@babel/core"];
babel-plugin-syntax-jsx-->babel-helper-plugin-utils["@babel/helper-plugin-utils"];
babel-plugin-syntax-object-rest-spread-->babel-core["@babel/core"];
babel-plugin-syntax-object-rest-spread-->babel-helper-plugin-utils["@babel/helper-plugin-utils"];
babel-plugin-transform-parameters-->babel-core["@babel/core"];
babel-plugin-transform-parameters-->babel-helper-plugin-utils["@babel/helper-plugin-utils"];
babel-template-->babel-code-frame["@babel/code-frame"];
babel-template-->babel-parser["@babel/parser"];
babel-template-->babel-types["@babel/types"];
babel-traverse-->babel-code-frame["@babel/code-frame"];
babel-traverse-->babel-generator["@babel/generator"];
babel-traverse-->babel-helper-environment-visitor["@babel/helper-environment-visitor"];
babel-traverse-->babel-helper-function-name["@babel/helper-function-name"];
babel-traverse-->babel-helper-hoist-variables["@babel/helper-hoist-variables"];
babel-traverse-->babel-helper-split-export-declaration["@babel/helper-split-export-declaration"];
babel-traverse-->babel-parser["@babel/parser"];
babel-traverse-->babel-types["@babel/types"];
babel-traverse-->debug;
babel-traverse-->globals;
babel-types-->babel-helper-string-parser["@babel/helper-string-parser"];
babel-types-->babel-helper-validator-identifier["@babel/helper-validator-identifier"];
babel-types-->to-fast-properties;
bin-links-->cmd-shim;
bin-links-->npm-normalize-package-bin;
bin-links-->read-cmd-shim;
Expand All @@ -343,10 +264,6 @@ graph LR;
bl-->inherits;
bl-->readable-stream;
brace-expansion-->balanced-match;
browserslist-->caniuse-lite;
browserslist-->electron-to-chromium;
browserslist-->node-releases;
browserslist-->update-browserslist-db;
buffer-->base64-js;
buffer-->ieee754;
builtins-->semver;
Expand All @@ -369,7 +286,6 @@ graph LR;
cacache-->tar;
cacache-->unique-filename;
chalk-->ansi-styles;
chalk-->escape-string-regexp;
chalk-->supports-color;
cidr-regex-->ip-regex;
cli-columns-->string-width;
Expand All @@ -390,7 +306,6 @@ graph LR;
debug-->ms;
decompress-response-->mimic-response;
defaults-->clone;
detab-->repeat-string;
dezalgo-->asap;
dezalgo-->wrappy;
domexception-->webidl-conversions;
Expand Down Expand Up @@ -421,39 +336,6 @@ graph LR;
glob-->once;
glob-->path-is-absolute;
has-->function-bind;
hast-to-hyperscript-->comma-separated-tokens;
hast-to-hyperscript-->property-information;
hast-to-hyperscript-->space-separated-tokens;
hast-to-hyperscript-->style-to-object;
hast-to-hyperscript-->types-unist["@types/unist"];
hast-to-hyperscript-->unist-util-is;
hast-to-hyperscript-->web-namespaces;
hast-util-from-parse5-->hastscript;
hast-util-from-parse5-->property-information;
hast-util-from-parse5-->types-parse5["@types/parse5"];
hast-util-from-parse5-->vfile-location;
hast-util-from-parse5-->vfile;
hast-util-from-parse5-->web-namespaces;
hast-util-raw-->hast-util-from-parse5;
hast-util-raw-->hast-util-to-parse5;
hast-util-raw-->html-void-elements;
hast-util-raw-->parse5;
hast-util-raw-->types-hast["@types/hast"];
hast-util-raw-->unist-util-position;
hast-util-raw-->vfile;
hast-util-raw-->web-namespaces;
hast-util-raw-->xtend;
hast-util-raw-->zwitch;
hast-util-to-parse5-->hast-to-hyperscript;
hast-util-to-parse5-->property-information;
hast-util-to-parse5-->web-namespaces;
hast-util-to-parse5-->xtend;
hast-util-to-parse5-->zwitch;
hastscript-->comma-separated-tokens;
hastscript-->hast-util-parse-selector;
hastscript-->property-information;
hastscript-->space-separated-tokens;
hastscript-->types-hast["@types/hast"];
hosted-git-info-->lru-cache;
html-encoding-sniffer-->whatwg-encoding;
http-proxy-agent-->agent-base;
Expand All @@ -473,16 +355,9 @@ graph LR;
init-package-json-->semver;
init-package-json-->validate-npm-package-license;
init-package-json-->validate-npm-package-name;
is-alphanumerical-->is-alphabetical;
is-alphanumerical-->is-decimal;
is-cidr-->cidr-regex;
is-core-module-->has;
is-fullwidth-code-point-->number-is-nan;
jridgewell-gen-mapping-->jridgewell-set-array["@jridgewell/set-array"];
jridgewell-gen-mapping-->jridgewell-sourcemap-codec["@jridgewell/sourcemap-codec"];
jridgewell-gen-mapping-->jridgewell-trace-mapping["@jridgewell/trace-mapping"];
jridgewell-trace-mapping-->jridgewell-resolve-uri["@jridgewell/resolve-uri"];
jridgewell-trace-mapping-->jridgewell-sourcemap-codec["@jridgewell/sourcemap-codec"];
js-yaml-->argparse;
js-yaml-->esprima;
jsdom-->abab;
Expand Down Expand Up @@ -625,35 +500,6 @@ graph LR;
make-fetch-happen-->socks-proxy-agent;
make-fetch-happen-->ssri;
marked-man-->marked;
mdast-squeeze-paragraphs-->unist-util-remove;
mdast-util-definitions-->unist-util-visit;
mdast-util-to-hast-->mdast-util-definitions;
mdast-util-to-hast-->mdurl;
mdast-util-to-hast-->types-mdast["@types/mdast"];
mdast-util-to-hast-->types-unist["@types/unist"];
mdast-util-to-hast-->unist-builder;
mdast-util-to-hast-->unist-util-generated;
mdast-util-to-hast-->unist-util-position;
mdast-util-to-hast-->unist-util-visit;
mdx-js-mdx-->babel-core["@babel/core"];
mdx-js-mdx-->babel-plugin-apply-mdx-type-prop;
mdx-js-mdx-->babel-plugin-extract-import-names;
mdx-js-mdx-->babel-plugin-syntax-jsx["@babel/plugin-syntax-jsx"];
mdx-js-mdx-->babel-plugin-syntax-object-rest-spread["@babel/plugin-syntax-object-rest-spread"];
mdx-js-mdx-->camelcase-css;
mdx-js-mdx-->detab;
mdx-js-mdx-->hast-util-raw;
mdx-js-mdx-->lodash.uniq;
mdx-js-mdx-->mdast-util-to-hast;
mdx-js-mdx-->mdx-js-util["@mdx-js/util"];
mdx-js-mdx-->remark-footnotes;
mdx-js-mdx-->remark-mdx;
mdx-js-mdx-->remark-parse;
mdx-js-mdx-->remark-squeeze-paragraphs;
mdx-js-mdx-->style-to-object;
mdx-js-mdx-->unified;
mdx-js-mdx-->unist-builder;
mdx-js-mdx-->unist-util-visit;
mime-types-->mime-db;
minimatch-->brace-expansion;
minipass-->yallist;
Expand Down Expand Up @@ -844,7 +690,6 @@ graph LR;
npmcli-docs-->isaacs-string-locale-compare["@isaacs/string-locale-compare"];
npmcli-docs-->jsdom;
npmcli-docs-->marked-man;
npmcli-docs-->mdx-js-mdx["@mdx-js/mdx"];
npmcli-docs-->mkdirp;
npmcli-docs-->npmcli-eslint-config["@npmcli/eslint-config"];
npmcli-docs-->npmcli-template-oss["@npmcli/template-oss"];
Expand Down Expand Up @@ -911,12 +756,6 @@ graph LR;
parse-conflict-json-->json-parse-even-better-errors;
parse-conflict-json-->just-diff-apply;
parse-conflict-json-->just-diff;
parse-entities-->character-entities-legacy;
parse-entities-->character-entities;
parse-entities-->character-reference-invalid;
parse-entities-->is-alphanumerical;
parse-entities-->is-decimal;
parse-entities-->is-hexadecimal;
parse5-->entities;
postcss-selector-parser-->cssesc;
postcss-selector-parser-->util-deprecate;
Expand All @@ -936,7 +775,6 @@ graph LR;
promise-retry-->err-code;
promise-retry-->retry;
promzard-->read;
property-information-->xtend;
pump-->end-of-stream;
pump-->once;
rc-->deep-extend;
Expand All @@ -961,34 +799,6 @@ graph LR;
readdir-scoped-modules-->dezalgo;
readdir-scoped-modules-->graceful-fs;
readdir-scoped-modules-->once;
remark-mdx-->babel-core["@babel/core"];
remark-mdx-->babel-helper-plugin-utils["@babel/helper-plugin-utils"];
remark-mdx-->babel-plugin-proposal-object-rest-spread["@babel/plugin-proposal-object-rest-spread"];
remark-mdx-->babel-plugin-syntax-jsx["@babel/plugin-syntax-jsx"];
remark-mdx-->is-alphabetical;
remark-mdx-->mdx-js-util["@mdx-js/util"];
remark-mdx-->remark-parse;
remark-mdx-->unified;
remark-parse-->ccount;
remark-parse-->collapse-white-space;
remark-parse-->is-alphabetical;
remark-parse-->is-decimal;
remark-parse-->is-whitespace-character;
remark-parse-->is-word-character;
remark-parse-->markdown-escapes;
remark-parse-->parse-entities;
remark-parse-->repeat-string;
remark-parse-->state-toggle;
remark-parse-->trim-trailing-lines;
remark-parse-->trim;
remark-parse-->unherit;
remark-parse-->unist-util-remove-position;
remark-parse-->vfile-location;
remark-parse-->xtend;
remark-squeeze-paragraphs-->mdast-squeeze-paragraphs;
resolve-->is-core-module;
resolve-->path-parse;
resolve-->supports-preserve-symlinks-flag;
rimraf-->glob;
saxes-->xmlchars;
semver-->lru-cache;
Expand Down Expand Up @@ -1018,7 +828,6 @@ graph LR;
string-width-->strip-ansi;
string_decoder-->safe-buffer;
strip-ansi-->ansi-regex;
style-to-object-->inline-style-parser;
supports-color-->has-flag;
tar-->chownr;
tar-->fs-minipass;
Expand All @@ -1042,40 +851,13 @@ graph LR;
tr46-->punycode;
tunnel-agent-->safe-buffer;
type-check-->prelude-ls;
types-hast-->types-unist["@types/unist"];
types-mdast-->types-unist["@types/unist"];
unherit-->inherits;
unherit-->xtend;
unified-->bail;
unified-->extend;
unified-->is-buffer;
unified-->is-plain-obj;
unified-->trough;
unified-->vfile;
unique-filename-->unique-slug;
unique-slug-->imurmurhash;
unist-util-remove-->unist-util-is;
unist-util-remove-position-->unist-util-visit;
unist-util-stringify-position-->types-unist["@types/unist"];
unist-util-visit-->types-unist["@types/unist"];
unist-util-visit-->unist-util-is;
unist-util-visit-->unist-util-visit-parents;
unist-util-visit-parents-->types-unist["@types/unist"];
unist-util-visit-parents-->unist-util-is;
update-browserslist-db-->browserslist;
update-browserslist-db-->escalade;
update-browserslist-db-->picocolors;
url-parse-->querystringify;
url-parse-->requires-port;
validate-npm-package-license-->spdx-correct;
validate-npm-package-license-->spdx-expression-parse;
validate-npm-package-name-->builtins;
vfile-->is-buffer;
vfile-->types-unist["@types/unist"];
vfile-->unist-util-stringify-position;
vfile-->vfile-message;
vfile-message-->types-unist["@types/unist"];
vfile-message-->unist-util-stringify-position;
w3c-xmlserializer-->xml-name-validator;
wcwidth-->defaults;
whatwg-encoding-->iconv-lite;
Expand Down
5 changes: 1 addition & 4 deletions docs/bin/build.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
const run = require('../lib/build.js')
const { paths } = require('../lib/index')

run({
verify: true,
...paths,
})
run(paths)
.then((res) => console.log(`Wrote ${res.length} files`))
.catch((err) => {
process.exitCode = 1
Expand Down
12 changes: 1 addition & 11 deletions docs/lib/build.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ const fs = require('fs/promises')
const ignoreWalk = require('ignore-walk')
const yaml = require('yaml')
const parseFrontMatter = require('front-matter')
const mdx = require('@mdx-js/mdx')

const checkNav = require('./check-nav.js')
const { DOC_EXT, ...transform } = require('./index.js')
Expand All @@ -20,7 +19,7 @@ const readHtml = (path) => fs.readFile(path, 'utf-8')
const readYaml = (path) => fs.readFile(path, 'utf-8').then(yaml.parse)
const makeTransforms = (...args) => (src, trs) => trs.reduce((acc, tr) => tr(acc, ...args), src)

const run = async ({ content, verify, template, nav, man, html, md }) => {
const run = async ({ content, template, nav, man, html, md }) => {
const [contentPaths, templateFile, navFile] = await Promise.all([
readDocs(content),
readHtml(template),
Expand Down Expand Up @@ -113,15 +112,6 @@ const run = async ({ content, verify, template, nav, man, html, md }) => {

checkNav(navFile, entriesByType.md.map(({ path }) => path), DOC_EXT)

if (verify) {
await Promise.all(entriesByType.md.map(async ({ src }) => {
// Test that mdx can parse this markdown file. We don't actually
// use the output, it's just to ensure that the upstream docs
// site (docs.npmjs.com) can parse it when this file gets there.
await mdx(src, { skipExport: true })
}))
}

return docEntries
}

Expand Down
1 change: 0 additions & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
},
"dependencies": {
"@isaacs/string-locale-compare": "^1.1.0",
"@mdx-js/mdx": "^1.6.22",
"cmark-gfm": "^0.9.0",
"front-matter": "^4.0.2",
"ignore-walk": "^6.0.0",
Expand Down
Loading

0 comments on commit f361796

Please sign in to comment.