Skip to content

Commit 1bde497

Browse files
JamieMasonJamieMason
committed
chore(site): add missing link aliases
1 parent f3a0957 commit 1bde497

14 files changed

Lines changed: 260 additions & 217 deletions

File tree

‎site/remark-plugins/link-aliases.mjs‎

Lines changed: 150 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -1,125 +1,170 @@
1-
import { visit } from "unist-util-visit";
1+
import { visit } from 'unist-util-visit';
22

33
export function linkAliases() {
44
const linksById = {
5-
COMMAND_FIX: "/command/fix/",
6-
COMMAND_FORMAT: "/command/format/",
7-
COMMAND_JSON: "/command/json/",
8-
COMMAND_LINT: "/command/lint/",
9-
COMMAND_LIST: "/command/list/",
10-
COMMAND_UPDATE: "/command/update/",
5+
COMMAND_FIX: '/command/fix/',
6+
COMMAND_FORMAT: '/command/format/',
7+
COMMAND_JSON: '/command/json/',
8+
COMMAND_LINT: '/command/lint/',
9+
COMMAND_LIST: '/command/list/',
10+
COMMAND_UPDATE: '/command/update/',
1111

12-
CONFIG_CUSTOM_TYPES: "/config/custom-types/",
13-
CONFIG_DEPENDENCY_GROUPS: "/config/dependency-groups/",
14-
CONFIG_FORMAT_BUGS: "/config/format-bugs/",
15-
CONFIG_FORMAT_REPOSITORY: "/config/format-repository/",
16-
CONFIG_INDENT: "/config/indent/",
17-
CONFIG_MINIMUM_RELEASE_AGE: "/config/minimum-release-age/",
18-
CONFIG_SEMVER_GROUPS: "/semver-groups/",
19-
CONFIG_SORT_AZ: "/config/sort-az/",
20-
CONFIG_SORT_EXPORTS: "/config/sort-exports/",
21-
CONFIG_SORT_FIRST: "/config/sort-first/",
22-
CONFIG_SORT_PACKAGES: "/config/sort-packages/",
23-
CONFIG_SOURCE: "/config/source/",
24-
CONFIG_SOURCE_MODE: "/config/source-mode/",
25-
CONFIG_STRICT: "/config/strict/",
26-
CONFIG_SYNCPACKRC: "/config/syncpackrc/",
27-
CONFIG_UPDATE_GROUPS: "/update-groups/",
28-
CONFIG_VERSION_GROUPS: "/version-groups/",
12+
CONFIG_CUSTOM_TYPES: '/config/custom-types/',
13+
CONFIG_DEPENDENCY_GROUPS: '/config/dependency-groups/',
14+
CONFIG_FORMAT_BUGS: '/config/format-bugs/',
15+
CONFIG_FORMAT_REPOSITORY: '/config/format-repository/',
16+
CONFIG_INDENT: '/config/indent/',
17+
CONFIG_MAX_CONCURRENT_REQUESTS: '/config/max-concurrent-requests/',
18+
CONFIG_MINIMUM_RELEASE_AGE: '/config/minimum-release-age/',
19+
CONFIG_SEMVER_GROUPS: '/semver-groups/',
20+
CONFIG_SORT_AZ: '/config/sort-az/',
21+
CONFIG_SORT_EXPORTS: '/config/sort-exports/',
22+
CONFIG_SORT_FIRST: '/config/sort-first/',
23+
CONFIG_SORT_PACKAGES: '/config/sort-packages/',
24+
CONFIG_SOURCE: '/config/source/',
25+
CONFIG_SOURCE_MODE: '/config/source-mode/',
26+
CONFIG_STRICT: '/config/strict/',
27+
CONFIG_SYNCPACKRC: '/config/syncpackrc/',
28+
CONFIG_UPDATE_GROUPS: '/update-groups/',
29+
CONFIG_VERSION_GROUPS: '/version-groups/',
2930

30-
GUIDE_PEER_DEPENDENCIES: "/guide/peer-dependencies/",
31+
GUIDE_GETTING_STARTED: '/guide/getting-started/',
32+
GUIDE_MIGRATE_V14: '/guide/migrate-v14/',
33+
GUIDE_MIGRATE_V15: '/guide/migrate-v15/',
34+
GUIDE_PEER_DEPENDENCIES: '/guide/peer-dependencies/',
3135

32-
REF_DEPENDENCY_TYPES: "/dependency-types/",
33-
REF_GLOSSARY: "/glossary/",
34-
REF_SEVERITY: "/config/severity/",
35-
REF_SPECIFIER_TYPES: "/specifier-types/",
36+
REF_DEPENDENCY_TYPES: '/dependency-types/',
37+
REF_GLOSSARY: '/glossary/',
38+
REF_SEVERITY: '/config/severity/',
39+
REF_SPECIFIER_TYPES: '/specifier-types/',
3640

37-
REF_STATUS_CODES: "/status/",
38-
REF_STATUS_CODES_VALID: "/status/#valid",
39-
REF_STATUS_CODES_FIXABLE: "/status/#fixable",
40-
REF_STATUS_CODES_SUSPECT: "/status/#suspect",
41-
REF_STATUS_CODES_UNFIXABLE: "/status/#unfixable",
42-
REF_STATUS_CODES_CONFLICT: "/status/#conflict",
41+
REF_STATUS_CODES: '/status/',
42+
REF_STATUS_CODES_VALID: '/status/#valid',
43+
REF_STATUS_CODES_FIXABLE: '/status/#fixable',
44+
REF_STATUS_CODES_SUSPECT: '/status/#suspect',
45+
REF_STATUS_CODES_UNFIXABLE: '/status/#unfixable',
46+
REF_STATUS_CODES_CONFLICT: '/status/#conflict',
4347

44-
TERM_CUSTOM_TYPE: "/glossary/#custom-type",
45-
TERM_DEPENDENCY: "/glossary/#dependency",
46-
TERM_DEPENDENCY_GROUP: "/glossary/#dependency-group",
47-
TERM_DEPENDENCY_TYPE: "/glossary/#dependency-type",
48-
TERM_INSTANCE: "/glossary/#instance",
49-
TERM_PACKAGE: "/glossary/#package",
50-
TERM_RCFILE: "/glossary/#rcfile",
51-
TERM_SEMVER: "/glossary/#semver",
52-
TERM_SEMVER_GROUP: "/glossary/#semver-group",
53-
TERM_SEMVER_RANGE: "/glossary/#semver-range",
54-
TERM_SEVERITY: "/glossary/#severity",
55-
TERM_SPECIFIER: "/glossary/#specifier",
56-
TERM_SPECIFIER_TYPE: "/glossary/#specifier-type",
57-
TERM_STATUS_CODE: "/glossary/#status-code",
58-
TERM_UPDATE_GROUP: "/glossary/#update-group",
59-
TERM_VERSION_GROUP: "/glossary/#version-group",
60-
TERM_WORKSPACE: "/glossary/#workspace",
48+
TERM_CUSTOM_TYPE: '/glossary/#custom-type',
49+
TERM_DEPENDENCY: '/glossary/#dependency',
50+
TERM_DEPENDENCY_GROUP: '/glossary/#dependency-group',
51+
TERM_DEPENDENCY_TYPE: '/glossary/#dependency-type',
52+
TERM_INSTANCE: '/glossary/#instance',
53+
TERM_PACKAGE: '/glossary/#package',
54+
TERM_RCFILE: '/glossary/#rcfile',
55+
TERM_SEMVER: '/glossary/#semver',
56+
TERM_SEMVER_GROUP: '/glossary/#semver-group',
57+
TERM_SEMVER_RANGE: '/glossary/#semver-range',
58+
TERM_SEVERITY: '/glossary/#severity',
59+
TERM_SPECIFIER: '/glossary/#specifier',
60+
TERM_SPECIFIER_TYPE: '/glossary/#specifier-type',
61+
TERM_STATUS_CODE: '/glossary/#status-code',
62+
TERM_UPDATE_GROUP: '/glossary/#update-group',
63+
TERM_VERSION_GROUP: '/glossary/#version-group',
64+
TERM_WORKSPACE: '/glossary/#workspace',
6165

62-
HREF_ANSI: "https://en.wikipedia.org/wiki/ANSI_escape_code",
63-
HREF_AWS_SDK: "https://aws.amazon.com/sdk-for-javascript/",
64-
HREF_CATEGORIZE_YOUR_DEPENDENCIES: "https://antfu.me/posts/categorize-deps",
65-
HREF_CONDITIONAL_EXPORTS:
66-
"https://nodejs.org/api/packages.html#conditional-exports",
67-
HREF_COSMICONFIG: "https://github.com/cosmiconfig/cosmiconfig",
68-
HREF_DEPENDENCIES:
69-
"https://docs.npmjs.com/cli/v11/configuring-npm/package-json#dependencies",
70-
HREF_DEV_DEPENDENCIES:
71-
"https://docs.npmjs.com/cli/v11/configuring-npm/package-json#devDependencies",
72-
HREF_ENGINES:
73-
"https://docs.npmjs.com/cli/v11/configuring-npm/package-json#engines",
74-
HREF_GLOB: "https://github.com/rust-lang/glob",
75-
HREF_LERNA: "https://lerna.js.org/",
76-
HREF_NEW_ISSUE:
77-
"https://github.com/JamieMason/syncpack-github-action/issues/new",
78-
HREF_NPM_EXEC: "https://docs.npmjs.com/cli/v11/commands/npm-exec",
79-
HREF_NPM_WORKSPACES: "https://docs.npmjs.com/cli/v11/using-npm/workspaces",
80-
HREF_NPX: "https://docs.npmjs.com/cli/v11/commands/npx",
81-
HREF_OVERRIDES:
82-
"https://docs.npmjs.com/cli/v11/configuring-npm/package-json#overrides",
83-
HREF_PACKAGE_MANAGER: "https://nodejs.org/api/packages.html#packagemanager",
84-
HREF_PEER_DEPENDENCIES:
85-
"https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerDependencies",
86-
HREF_PNPM: "https://pnpm.js.org/",
87-
HREF_PNPM_MINIMUM_RELEASE_AGE: "https://pnpm.io/settings#minimumreleaseage",
88-
HREF_PNPM_OVERRIDES: "https://pnpm.io/settings#overrides",
89-
HREF_RESOLUTIONS:
90-
"https://docs.npmjs.com/cli/v11/configuring-npm/package-json#resolutions",
66+
HREF_ANSI: 'https://en.wikipedia.org/wiki/ANSI_escape_code',
67+
HREF_AWS_SDK: 'https://aws.amazon.com/sdk-for-javascript/',
68+
HREF_CATEGORIZE_YOUR_DEPENDENCIES: 'https://antfu.me/posts/categorize-deps',
69+
HREF_CONDITIONAL_EXPORTS: 'https://nodejs.org/api/packages.html#conditional-exports',
70+
HREF_COSMICONFIG: 'https://github.com/cosmiconfig/cosmiconfig',
71+
HREF_DEPENDENCIES: 'https://docs.npmjs.com/cli/v11/configuring-npm/package-json#dependencies',
72+
HREF_DEV_DEPENDENCIES: 'https://docs.npmjs.com/cli/v11/configuring-npm/package-json#devDependencies',
73+
HREF_ENGINES: 'https://docs.npmjs.com/cli/v11/configuring-npm/package-json#engines',
74+
HREF_GLOB: 'https://github.com/rust-lang/glob',
75+
HREF_LERNA: 'https://lerna.js.org/',
76+
HREF_NEW_ISSUE: 'https://github.com/JamieMason/syncpack-github-action/issues/new',
77+
HREF_NPM_EXEC: 'https://docs.npmjs.com/cli/v11/commands/npm-exec',
78+
HREF_NPM_WORKSPACES: 'https://docs.npmjs.com/cli/v11/using-npm/workspaces',
79+
HREF_NPX: 'https://docs.npmjs.com/cli/v11/commands/npx',
80+
HREF_OVERRIDES: 'https://docs.npmjs.com/cli/v11/configuring-npm/package-json#overrides',
81+
HREF_PACKAGE_MANAGER: 'https://nodejs.org/api/packages.html#packagemanager',
82+
HREF_PEER_DEPENDENCIES: 'https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerDependencies',
83+
HREF_PNPM: 'https://pnpm.js.org/',
84+
HREF_PNPM_MINIMUM_RELEASE_AGE: 'https://pnpm.io/settings#minimumreleaseage',
85+
HREF_PNPM_OVERRIDES: 'https://pnpm.io/settings#overrides',
86+
HREF_RESOLUTIONS: 'https://docs.npmjs.com/cli/v11/configuring-npm/package-json#resolutions',
9187
HREF_SYNCPACK_GITHUB_ACTION:
92-
"https://github.com/marketplace/actions/syncpack-synchronise-monorepo-dependency-versions",
93-
HREF_TYPES: "https://github.com/DefinitelyTyped/DefinitelyTyped",
94-
HREF_VERSION:
95-
"https://docs.npmjs.com/cli/v11/configuring-npm/package-json#version",
96-
HREF_WORKSPACE_PROTOCOL:
97-
"https://pnpm.io/workspaces#workspace-protocol-workspace",
98-
HREF_YARN_WORKSPACES: "https://yarnpkg.com/lang/en/docs/workspaces/",
88+
'https://github.com/marketplace/actions/syncpack-synchronise-monorepo-dependency-versions',
89+
HREF_TYPES: 'https://github.com/DefinitelyTyped/DefinitelyTyped',
90+
HREF_VERSION: 'https://docs.npmjs.com/cli/v11/configuring-npm/package-json#version',
91+
HREF_WORKSPACE_PROTOCOL: 'https://pnpm.io/workspaces#workspace-protocol-workspace',
92+
HREF_YARN_WORKSPACES: 'https://yarnpkg.com/lang/en/docs/workspaces/',
9993

100-
SEMVER_GROUP_IGNORED: "/semver-groups/ignored/",
101-
SEMVER_GROUP_WITH_RANGE: "/semver-groups/with-range/",
94+
SEMVER_GROUP_IGNORED: '/semver-groups/ignored/',
95+
SEMVER_GROUP_WITH_RANGE: '/semver-groups/with-range/',
10296

103-
STATUS_SAME_MINOR_MISMATCH: "/status/same-minor-mismatch/",
97+
STATUS_CANNOT_INFER_CATALOG_FILE: '/status/cannot-infer-catalog-file/',
98+
STATUS_DEPENDS_ON_INVALID_LOCAL_PACKAGE: '/status/depends-on-invalid-local-package/',
99+
STATUS_DEPENDS_ON_MISSING_CATALOG_DEFINITION: '/status/depends-on-missing-catalog-definition/',
100+
STATUS_DEPENDS_ON_MISSING_SNAP_TARGET: '/status/depends-on-missing-snap-target/',
101+
STATUS_DIFFERS_TO_CATALOG: '/status/differs-to-catalog/',
102+
STATUS_DIFFERS_TO_HIGHEST_OR_LOWEST_SEMVER: '/status/differs-to-highest-or-lowest-semver/',
103+
STATUS_DIFFERS_TO_HIGHEST_OR_LOWEST_SEMVER_MINOR: '/status/differs-to-highest-or-lowest-semver-minor/',
104+
STATUS_DIFFERS_TO_LOCAL: '/status/differs-to-local/',
105+
STATUS_DIFFERS_TO_NPM_REGISTRY: '/status/differs-to-npm-registry/',
106+
STATUS_DIFFERS_TO_PIN: '/status/differs-to-pin/',
107+
STATUS_DIFFERS_TO_SNAP_TARGET: '/status/differs-to-snap-target/',
108+
STATUS_INVALID_LOCAL_VERSION: '/status/invalid-local-version/',
109+
STATUS_IS_BANNED: '/status/is-banned/',
110+
STATUS_IS_CATALOG: '/status/is-catalog/',
111+
STATUS_IS_CATALOG_DEFINITION: '/status/is-catalog-definition/',
112+
STATUS_IS_HIGHEST_OR_LOWEST_SEMVER: '/status/is-highest-or-lowest-semver/',
113+
STATUS_IS_IDENTICAL_TO_LOCAL: '/status/is-identical-to-local/',
114+
STATUS_IS_IDENTICAL_TO_PIN: '/status/is-identical-to-pin/',
115+
STATUS_IS_IDENTICAL_TO_SNAP_TARGET: '/status/is-identical-to-snap-target/',
116+
STATUS_IS_IGNORED: '/status/is-ignored/',
117+
STATUS_IS_LOCAL_AND_VALID: '/status/is-local-and-valid/',
118+
STATUS_IS_NON_SEMVER_BUT_IDENTICAL: '/status/is-non-semver-but-identical/',
119+
STATUS_MATCH_CONFLICTS_WITH_HIGHEST_OR_LOWEST_SEMVER: '/status/match-conflicts-with-highest-or-lowest-semver/',
120+
STATUS_MATCH_CONFLICTS_WITH_LOCAL: '/status/match-conflicts-with-local/',
121+
STATUS_MATCH_CONFLICTS_WITH_SNAP_TARGET: '/status/match-conflicts-with-snap-target/',
122+
STATUS_MATCHES_SEMVER_GROUP: '/status/matches-semver-group/',
123+
STATUS_MISMATCH_CONFLICTS_WITH_HIGHEST_OR_LOWEST_SEMVER:
124+
'/status/mismatch-conflicts-with-highest-or-lowest-semver/',
125+
STATUS_MISMATCH_CONFLICTS_WITH_LOCAL: '/status/mismatch-conflicts-with-local/',
126+
STATUS_MISMATCH_CONFLICTS_WITH_SNAP_TARGET: '/status/mismatch-conflicts-with-snap-target/',
127+
STATUS_MISSING_FROM_CATALOG: '/status/missing-from-catalog/',
128+
STATUS_MISSING_FROM_CATALOG_AND_NON_SEMVER_MISMATCH: '/status/missing-from-catalog-and-non-semver-mismatch/',
129+
STATUS_NON_SEMVER_MISMATCH: '/status/non-semver-mismatch/',
130+
STATUS_NOT_USING_CATALOG: '/status/not-using-catalog/',
131+
STATUS_NOT_USING_CATALOG_AND_CATALOG_UNKNOWN: '/status/not-using-catalog-and-catalog-unknown/',
132+
STATUS_PIN_OVERRIDES_SEMVER_RANGE: '/status/pin-overrides-semver-range/',
133+
STATUS_PIN_OVERRIDES_SEMVER_RANGE_MISMATCH: '/status/pin-overrides-semver-range-mismatch/',
134+
STATUS_REFUSE_TO_BAN_LOCAL: '/status/refuse-to-ban-local/',
135+
STATUS_REFUSE_TO_CATALOG_LOCAL: '/status/refuse-to-catalog-local/',
136+
STATUS_REFUSE_TO_PIN_LOCAL: '/status/refuse-to-pin-local/',
137+
STATUS_REFUSE_TO_SNAP_LOCAL: '/status/refuse-to-snap-local/',
138+
STATUS_SAME_MINOR_HAS_MAJOR_MISMATCH: '/status/same-minor-has-major-mismatch/',
139+
STATUS_SAME_MINOR_MISMATCH: '/status/same-minor-mismatch/',
140+
STATUS_SAME_MINOR_OVERRIDES_SEMVER_RANGE: '/status/same-minor-overrides-semver-range/',
141+
STATUS_SAME_MINOR_OVERRIDES_SEMVER_RANGE_MISMATCH: '/status/same-minor-overrides-semver-range-mismatch/',
142+
STATUS_SAME_RANGE_MISMATCH: '/status/same-range-mismatch/',
143+
STATUS_SATISFIES_HIGHEST_OR_LOWEST_SEMVER: '/status/satisfies-highest-or-lowest-semver/',
144+
STATUS_SATISFIES_LOCAL: '/status/satisfies-local/',
145+
STATUS_SATISFIES_SAME_MINOR_GROUP: '/status/satisfies-same-minor-group/',
146+
STATUS_SATISFIES_SAME_RANGE_GROUP: '/status/satisfies-same-range-group/',
147+
STATUS_SATISFIES_SNAP_TARGET: '/status/satisfies-snap-target/',
148+
STATUS_SEMVER_RANGE_MISMATCH: '/status/semver-range-mismatch/',
104149

105-
UPDATE_GROUP_IGNORED: "/update-groups/ignored/",
106-
UPDATE_GROUP_TARGETED: "/update-groups/targeted/",
150+
UPDATE_GROUP_IGNORED: '/update-groups/ignored/',
151+
UPDATE_GROUP_TARGETED: '/update-groups/targeted/',
107152

108-
VERSION_GROUP_BANNED: "/version-groups/banned/",
109-
VERSION_GROUP_CATALOG: "/version-groups/catalog/",
110-
VERSION_GROUP_HIGHEST_SEMVER: "/version-groups/highest-semver/",
111-
VERSION_GROUP_IGNORED: "/version-groups/ignored/",
112-
VERSION_GROUP_LOWEST_SEMVER: "/version-groups/lowest-semver/",
113-
VERSION_GROUP_PINNED: "/version-groups/pinned/",
114-
VERSION_GROUP_SAME_MINOR: "/version-groups/same-minor/",
115-
VERSION_GROUP_SAME_RANGE: "/version-groups/same-range/",
116-
VERSION_GROUP_RANGE_ONLY: "/version-groups/range-only/",
117-
VERSION_GROUP_SNAPPED_TO: "/version-groups/snapped-to/",
153+
VERSION_GROUP_BANNED: '/version-groups/banned/',
154+
VERSION_GROUP_CATALOG: '/version-groups/catalog/',
155+
VERSION_GROUP_HIGHEST_SEMVER: '/version-groups/highest-semver/',
156+
VERSION_GROUP_IGNORED: '/version-groups/ignored/',
157+
VERSION_GROUP_LOWEST_SEMVER: '/version-groups/lowest-semver/',
158+
VERSION_GROUP_PINNED: '/version-groups/pinned/',
159+
VERSION_GROUP_SAME_MINOR: '/version-groups/same-minor/',
160+
VERSION_GROUP_SAME_RANGE: '/version-groups/same-range/',
161+
VERSION_GROUP_RANGE_ONLY: '/version-groups/range-only/',
162+
VERSION_GROUP_SNAPPED_TO: '/version-groups/snapped-to/',
118163
};
119164

120165
return function transformer(tree) {
121-
visit(tree, "link", (node) => {
122-
const [id, hash] = node.url.split("#");
166+
visit(tree, 'link', node => {
167+
const [id, hash] = node.url.split('#');
123168
const link = linksById[id];
124169
if (link) {
125170
node.url = hash ? `${link}#${hash}` : link;

0 commit comments

Comments
 (0)