@docusaurus/utils 4.0.0-canary-6936 → 4.0.0-canary-6938
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/index.d.ts +1 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js.map +1 -1
- package/lib/tags.d.ts +2 -4
- package/lib/tags.d.ts.map +1 -1
- package/lib/tags.js +16 -30
- package/lib/tags.js.map +1 -1
- package/package.json +4 -5
- package/src/index.ts +0 -1
- package/src/tags.ts +18 -38
package/lib/index.d.ts
CHANGED
|
@@ -10,7 +10,7 @@ export { mergeTranslations, updateTranslationFileMessages, getPluginI18nPath, ge
|
|
|
10
10
|
export { mapAsyncSequential, findAsyncSequential } from './jsUtils';
|
|
11
11
|
export { normalizeUrl, getEditUrl, fileToPath, encodePath, isValidPathname, resolvePathname, parseURLPath, parseLocalURLPath, parseURLOrPath, toURLPath, serializeURLPath, hasSSHProtocol, buildHttpsUrl, buildSshUrl, } from './urlUtils';
|
|
12
12
|
export type { URLPath } from './urlUtils';
|
|
13
|
-
export { type Tag, type TagsFile, type TagsFileInput, type TagMetadata, type TagsListItem, type TagModule, type
|
|
13
|
+
export { type Tag, type TagsFile, type TagsFileInput, type TagMetadata, type TagsListItem, type TagModule, type TagsPluginOptions, groupTaggedItems, getTagVisibility, } from './tags';
|
|
14
14
|
export { unwrapMdxCodeBlocks, admonitionTitleToDirectiveLabel, createExcerpt, DEFAULT_PARSE_FRONT_MATTER, parseMarkdownContentTitle, parseMarkdownFile, } from './markdownUtils';
|
|
15
15
|
export { parseMarkdownHeadingId, escapeMarkdownHeadingIds, writeMarkdownHeadingId, type HeadingIdSyntax, type WriteHeadingIDOptions, } from './markdownHeadingIdUtils';
|
|
16
16
|
export { type ContentPaths, type SourceToPermalink, resolveMarkdownLinkPathname, } from './markdownLinks';
|
package/lib/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,EACtB,wBAAwB,EACxB,YAAY,EACZ,uBAAuB,EACvB,6BAA6B,EAC7B,UAAU,EACV,qBAAqB,EACrB,2BAA2B,EAC3B,YAAY,EACZ,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAC,QAAQ,EAAE,kBAAkB,EAAC,MAAM,aAAa,CAAC;AACzD,OAAO,EACL,iBAAiB,EACjB,6BAA6B,EAC7B,iBAAiB,EACjB,eAAe,GAChB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAC,kBAAkB,EAAE,mBAAmB,EAAC,MAAM,WAAW,CAAC;AAClE,OAAO,EACL,YAAY,EACZ,UAAU,EACV,UAAU,EACV,UAAU,EACV,eAAe,EACf,eAAe,EACf,YAAY,EACZ,iBAAiB,EACjB,cAAc,EACd,SAAS,EACT,gBAAgB,EAChB,cAAc,EACd,aAAa,EACb,WAAW,GACZ,MAAM,YAAY,CAAC;AACpB,YAAY,EAAC,OAAO,EAAC,MAAM,YAAY,CAAC;AACxC,OAAO,EACL,KAAK,GAAG,EACR,KAAK,QAAQ,EACb,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,EACtB,wBAAwB,EACxB,YAAY,EACZ,uBAAuB,EACvB,6BAA6B,EAC7B,UAAU,EACV,qBAAqB,EACrB,2BAA2B,EAC3B,YAAY,EACZ,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAC,QAAQ,EAAE,kBAAkB,EAAC,MAAM,aAAa,CAAC;AACzD,OAAO,EACL,iBAAiB,EACjB,6BAA6B,EAC7B,iBAAiB,EACjB,eAAe,GAChB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAC,kBAAkB,EAAE,mBAAmB,EAAC,MAAM,WAAW,CAAC;AAClE,OAAO,EACL,YAAY,EACZ,UAAU,EACV,UAAU,EACV,UAAU,EACV,eAAe,EACf,eAAe,EACf,YAAY,EACZ,iBAAiB,EACjB,cAAc,EACd,SAAS,EACT,gBAAgB,EAChB,cAAc,EACd,aAAa,EACb,WAAW,GACZ,MAAM,YAAY,CAAC;AACpB,YAAY,EAAC,OAAO,EAAC,MAAM,YAAY,CAAC;AACxC,OAAO,EACL,KAAK,GAAG,EACR,KAAK,QAAQ,EACb,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,iBAAiB,EACtB,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,QAAQ,CAAC;AAChB,OAAO,EACL,mBAAmB,EACnB,+BAA+B,EAC/B,aAAa,EACb,0BAA0B,EAC1B,yBAAyB,EACzB,iBAAiB,GAClB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,EACtB,KAAK,eAAe,EACpB,KAAK,qBAAqB,GAC3B,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,2BAA2B,GAC5B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAC,KAAK,cAAc,EAAE,KAAK,OAAO,EAAE,aAAa,EAAC,MAAM,WAAW,CAAC;AAC3E,OAAO,EACL,aAAa,EACb,SAAS,EACT,SAAS,EACT,yBAAyB,EACzB,eAAe,EACf,6BAA6B,EAC7B,UAAU,EACV,wBAAwB,GACzB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAC,MAAM,aAAa,CAAC;AAC1D,OAAO,EACL,iBAAiB,EACjB,aAAa,EACb,kBAAkB,EAClB,4BAA4B,EAC5B,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,GACzB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAC,eAAe,EAAC,MAAM,eAAe,CAAC;AAC9C,OAAO,EACL,eAAe,EACf,YAAY,EACZ,kBAAkB,EAClB,wBAAwB,EACxB,uBAAuB,GACxB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAC,OAAO,EAAE,UAAU,EAAC,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAC,aAAa,EAAC,MAAM,cAAc,CAAC;AAE3C,OAAO,EACL,kBAAkB,EAClB,KAAK,cAAc,EACnB,KAAK,qBAAqB,GAC3B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,cAAc,EAAE,YAAY,EAAE,QAAQ,EAAC,MAAM,WAAW,CAAC;AAEjE,OAAO,EAAC,aAAa,EAAE,gBAAgB,EAAC,MAAM,QAAQ,CAAC"}
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,yCAiBqB;AAhBnB,+GAAA,kBAAkB,OAAA;AAClB,+GAAA,kBAAkB,OAAA;AAClB,+GAAA,kBAAkB,OAAA;AAClB,mHAAA,sBAAsB,OAAA;AACtB,qHAAA,wBAAwB,OAAA;AACxB,mHAAA,sBAAsB,OAAA;AACtB,qHAAA,wBAAwB,OAAA;AACxB,yGAAA,YAAY,OAAA;AACZ,oHAAA,uBAAuB,OAAA;AACvB,0HAAA,6BAA6B,OAAA;AAC7B,uGAAA,UAAU,OAAA;AACV,kHAAA,qBAAqB,OAAA;AACrB,wHAAA,2BAA2B,OAAA;AAC3B,yGAAA,YAAY,OAAA;AACZ,8GAAA,iBAAiB,OAAA;AACjB,kHAAA,qBAAqB,OAAA;AAEvB,yCAAyD;AAAjD,qGAAA,QAAQ,OAAA;AAAE,+GAAA,kBAAkB,OAAA;AACpC,yCAKqB;AAJnB,8GAAA,iBAAiB,OAAA;AACjB,0HAAA,6BAA6B,OAAA;AAC7B,8GAAA,iBAAiB,OAAA;AACjB,4GAAA,eAAe,OAAA;AAEjB,qCAAkE;AAA1D,6GAAA,kBAAkB,OAAA;AAAE,8GAAA,mBAAmB,OAAA;AAC/C,uCAeoB;AAdlB,wGAAA,YAAY,OAAA;AACZ,sGAAA,UAAU,OAAA;AACV,sGAAA,UAAU,OAAA;AACV,sGAAA,UAAU,OAAA;AACV,2GAAA,eAAe,OAAA;AACf,2GAAA,eAAe,OAAA;AACf,wGAAA,YAAY,OAAA;AACZ,6GAAA,iBAAiB,OAAA;AACjB,0GAAA,cAAc,OAAA;AACd,qGAAA,SAAS,OAAA;AACT,4GAAA,gBAAgB,OAAA;AAChB,0GAAA,cAAc,OAAA;AACd,yGAAA,aAAa,OAAA;AACb,uGAAA,WAAW,OAAA;AAGb,+
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,yCAiBqB;AAhBnB,+GAAA,kBAAkB,OAAA;AAClB,+GAAA,kBAAkB,OAAA;AAClB,+GAAA,kBAAkB,OAAA;AAClB,mHAAA,sBAAsB,OAAA;AACtB,qHAAA,wBAAwB,OAAA;AACxB,mHAAA,sBAAsB,OAAA;AACtB,qHAAA,wBAAwB,OAAA;AACxB,yGAAA,YAAY,OAAA;AACZ,oHAAA,uBAAuB,OAAA;AACvB,0HAAA,6BAA6B,OAAA;AAC7B,uGAAA,UAAU,OAAA;AACV,kHAAA,qBAAqB,OAAA;AACrB,wHAAA,2BAA2B,OAAA;AAC3B,yGAAA,YAAY,OAAA;AACZ,8GAAA,iBAAiB,OAAA;AACjB,kHAAA,qBAAqB,OAAA;AAEvB,yCAAyD;AAAjD,qGAAA,QAAQ,OAAA;AAAE,+GAAA,kBAAkB,OAAA;AACpC,yCAKqB;AAJnB,8GAAA,iBAAiB,OAAA;AACjB,0HAAA,6BAA6B,OAAA;AAC7B,8GAAA,iBAAiB,OAAA;AACjB,4GAAA,eAAe,OAAA;AAEjB,qCAAkE;AAA1D,6GAAA,kBAAkB,OAAA;AAAE,8GAAA,mBAAmB,OAAA;AAC/C,uCAeoB;AAdlB,wGAAA,YAAY,OAAA;AACZ,sGAAA,UAAU,OAAA;AACV,sGAAA,UAAU,OAAA;AACV,sGAAA,UAAU,OAAA;AACV,2GAAA,eAAe,OAAA;AACf,2GAAA,eAAe,OAAA;AACf,wGAAA,YAAY,OAAA;AACZ,6GAAA,iBAAiB,OAAA;AACjB,0GAAA,cAAc,OAAA;AACd,qGAAA,SAAS,OAAA;AACT,4GAAA,gBAAgB,OAAA;AAChB,0GAAA,cAAc,OAAA;AACd,yGAAA,aAAa,OAAA;AACb,uGAAA,WAAW,OAAA;AAGb,+BAUgB;AAFd,wGAAA,gBAAgB,OAAA;AAChB,wGAAA,gBAAgB,OAAA;AAElB,iDAOyB;AANvB,oHAAA,mBAAmB,OAAA;AACnB,gIAAA,+BAA+B,OAAA;AAC/B,8GAAA,aAAa,OAAA;AACb,2HAAA,0BAA0B,OAAA;AAC1B,0HAAA,yBAAyB,OAAA;AACzB,kHAAA,iBAAiB,OAAA;AAEnB,mEAMkC;AALhC,gIAAA,sBAAsB,OAAA;AACtB,kIAAA,wBAAwB,OAAA;AACxB,gIAAA,sBAAsB,OAAA;AAIxB,iDAIyB;AADvB,4HAAA,2BAA2B,OAAA;AAE7B,qCAA2E;AAAhC,wGAAA,aAAa,OAAA;AACxD,yCASqB;AARnB,0GAAA,aAAa,OAAA;AACb,sGAAA,SAAS,OAAA;AACT,sGAAA,SAAS,OAAA;AACT,sHAAA,yBAAyB,OAAA;AACzB,4GAAA,eAAe,OAAA;AACf,0HAAA,6BAA6B,OAAA;AAC7B,uGAAA,UAAU,OAAA;AACV,qHAAA,wBAAwB,OAAA;AAE1B,yCAA0D;AAAlD,oGAAA,OAAO,OAAA;AAAE,uGAAA,UAAU,OAAA;AAAE,qGAAA,QAAQ,OAAA;AACrC,+CAOwB;AANtB,iHAAA,iBAAiB,OAAA;AACjB,6GAAA,aAAa,OAAA;AACb,kHAAA,kBAAkB,OAAA;AAClB,4HAAA,4BAA4B,OAAA;AAI9B,6CAA8C;AAAtC,8GAAA,eAAe,OAAA;AACvB,iDAMyB;AALvB,gHAAA,eAAe,OAAA;AACf,6GAAA,YAAY,OAAA;AACZ,mHAAA,kBAAkB,OAAA;AAClB,yHAAA,wBAAwB,OAAA;AACxB,wHAAA,uBAAuB,OAAA;AAEzB,mEAA6D;AAArD,iHAAA,OAAO,OAAA;AAAE,oHAAA,UAAU,OAAA;AAC3B,2CAA2C;AAAnC,2GAAA,aAAa,OAAA;AAErB,qDAI2B;AAHzB,qHAAA,kBAAkB,OAAA;AAKpB,iCAAiE;AAAzD,qGAAA,cAAc,OAAA;AAAE,mGAAA,YAAY,OAAA;AAAE,+FAAA,QAAQ,OAAA;AAE9C,+BAAuD;AAA/C,qGAAA,aAAa,OAAA;AAAE,wGAAA,gBAAgB,OAAA"}
|
package/lib/tags.d.ts
CHANGED
|
@@ -4,7 +4,6 @@
|
|
|
4
4
|
* This source code is licensed under the MIT license found in the
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
6
6
|
*/
|
|
7
|
-
import type { Optional } from 'utility-types';
|
|
8
7
|
export type Tag = {
|
|
9
8
|
/** The display label of a tag */
|
|
10
9
|
label: string;
|
|
@@ -36,16 +35,15 @@ export type TagModule = TagsListItem & {
|
|
|
36
35
|
/** Is this tag unlisted? (when it only contains unlisted items) */
|
|
37
36
|
unlisted: boolean;
|
|
38
37
|
};
|
|
39
|
-
export type FrontMatterTag = string | Optional<Tag, 'description'>;
|
|
40
38
|
export declare function normalizeTag({ tag, tagsFile, tagsBaseRoutePath, }: {
|
|
41
|
-
tag:
|
|
39
|
+
tag: string;
|
|
42
40
|
tagsBaseRoutePath: string;
|
|
43
41
|
tagsFile: TagsFile | null;
|
|
44
42
|
}): TagMetadata;
|
|
45
43
|
export declare function normalizeTags({ options, source, frontMatterTags, tagsBaseRoutePath, tagsFile, }: {
|
|
46
44
|
options: TagsPluginOptions;
|
|
47
45
|
source: string;
|
|
48
|
-
frontMatterTags:
|
|
46
|
+
frontMatterTags: string[] | undefined;
|
|
49
47
|
tagsBaseRoutePath: string;
|
|
50
48
|
tagsFile: TagsFile | null;
|
|
51
49
|
}): TagMetadata[];
|
package/lib/tags.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tags.d.ts","sourceRoot":"","sources":["../src/tags.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;
|
|
1
|
+
{"version":3,"file":"tags.d.ts","sourceRoot":"","sources":["../src/tags.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,MAAM,MAAM,GAAG,GAAG;IAChB,iCAAiC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,oEAAoE;IACpE,SAAS,EAAE,MAAM,CAAC;IAClB,yCAAyC;IACzC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AAEhE,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAG3C,MAAM,MAAM,iBAAiB,GAAG;IAE9B,6BAA6B;IAC7B,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI,GAAG,SAAS,CAAC;IACxC,4DAA4D;IAC5D,YAAY,EAAE,QAAQ,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC;CACnD,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,GAAG,GAAG;IAC9B,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,0DAA0D;AAC1D,MAAM,MAAM,YAAY,GAAG,GAAG,GAAG;IAC/B,0CAA0C;IAC1C,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,yDAAyD;AACzD,MAAM,MAAM,SAAS,GAAG,YAAY,GAAG;IACrC,sCAAsC;IAEtC,WAAW,EAAE,MAAM,CAAC;IACpB,mEAAmE;IACnE,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AA8BF,wBAAgB,YAAY,CAAC,EAC3B,GAAG,EACH,QAAQ,EACR,iBAAiB,GAClB,EAAE;IACD,GAAG,EAAE,MAAM,CAAC;IACZ,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;CAC3B,GAAG,WAAW,CAed;AAED,wBAAgB,aAAa,CAAC,EAC5B,OAAO,EACP,MAAM,EACN,eAAe,EACf,iBAAiB,EACjB,QAAQ,GACT,EAAE;IACD,OAAO,EAAE,iBAAiB,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACtC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;CAC3B,GAAG,WAAW,EAAE,CAQhB;AAED,wBAAgB,gBAAgB,CAAC,EAC/B,IAAI,EACJ,MAAM,EACN,OAAO,GACR,EAAE;IACD,IAAI,EAAE,WAAW,EAAE,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,iBAAiB,CAAC;CAC5B,GAAG,IAAI,CAcP;AAED,KAAK,eAAe,CAAC,IAAI,IAAI;IAC3B,GAAG,EAAE,WAAW,CAAC;IACjB,KAAK,EAAE,IAAI,EAAE,CAAC;CACf,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EACnC,KAAK,EAAE,SAAS,IAAI,EAAE;AACtB;;;GAGG;AACH,WAAW,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,SAAS,WAAW,EAAE,GAClD;IAAC,CAAC,SAAS,EAAE,MAAM,GAAG,eAAe,CAAC,IAAI,CAAC,CAAA;CAAC,CA0B9C;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,EACrC,KAAK,EACL,UAAU,GACX,EAAE;IACD,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,UAAU,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC;CACrC,GAAG;IACF,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,IAAI,EAAE,CAAC;CACrB,CAaA"}
|
package/lib/tags.js
CHANGED
|
@@ -21,45 +21,31 @@ const urlUtils_1 = require("./urlUtils");
|
|
|
21
21
|
function normalizeTagPermalink({ tagsBaseRoutePath, permalink, }) {
|
|
22
22
|
return (0, urlUtils_1.normalizeUrl)([tagsBaseRoutePath, permalink]);
|
|
23
23
|
}
|
|
24
|
-
function normalizeInlineTag(tagsBaseRoutePath,
|
|
25
|
-
function toTagObject(tagString) {
|
|
26
|
-
return {
|
|
27
|
-
inline: true,
|
|
28
|
-
label: tagString,
|
|
29
|
-
permalink: lodash_1.default.kebabCase(tagString),
|
|
30
|
-
description: undefined,
|
|
31
|
-
};
|
|
32
|
-
}
|
|
33
|
-
const tag = typeof frontMatterTag === 'string'
|
|
34
|
-
? toTagObject(frontMatterTag)
|
|
35
|
-
: { ...frontMatterTag, description: frontMatterTag.description };
|
|
24
|
+
function normalizeInlineTag(tagsBaseRoutePath, tag) {
|
|
36
25
|
return {
|
|
37
26
|
inline: true,
|
|
38
|
-
label: tag
|
|
27
|
+
label: tag,
|
|
39
28
|
permalink: normalizeTagPermalink({
|
|
40
|
-
permalink: tag
|
|
29
|
+
permalink: lodash_1.default.kebabCase(tag),
|
|
41
30
|
tagsBaseRoutePath,
|
|
42
31
|
}),
|
|
43
|
-
description:
|
|
32
|
+
description: undefined,
|
|
44
33
|
};
|
|
45
34
|
}
|
|
46
35
|
function normalizeTag({ tag, tagsFile, tagsBaseRoutePath, }) {
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
permalink:
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
};
|
|
60
|
-
}
|
|
36
|
+
const tagDescription = tagsFile?.[tag];
|
|
37
|
+
if (tagDescription) {
|
|
38
|
+
// pre-defined tag from tags.yml
|
|
39
|
+
return {
|
|
40
|
+
inline: false,
|
|
41
|
+
label: tagDescription.label,
|
|
42
|
+
permalink: normalizeTagPermalink({
|
|
43
|
+
permalink: tagDescription.permalink,
|
|
44
|
+
tagsBaseRoutePath,
|
|
45
|
+
}),
|
|
46
|
+
description: tagDescription.description,
|
|
47
|
+
};
|
|
61
48
|
}
|
|
62
|
-
// legacy inline tag object, always inline, unknown because isn't a string
|
|
63
49
|
return normalizeInlineTag(tagsBaseRoutePath, tag);
|
|
64
50
|
}
|
|
65
51
|
function normalizeTags({ options, source, frontMatterTags, tagsBaseRoutePath, tagsFile, }) {
|
package/lib/tags.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tags.js","sourceRoot":"","sources":["../src/tags.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;AAEH,4DAAuB;AACvB,wEAAwC;AACxC,yCAAwC;
|
|
1
|
+
{"version":3,"file":"tags.js","sourceRoot":"","sources":["../src/tags.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;AAEH,4DAAuB;AACvB,wEAAwC;AACxC,yCAAwC;AA2CxC,8EAA8E;AAC9E,2EAA2E;AAC3E,4DAA4D;AAC5D,SAAS,qBAAqB,CAAC,EAC7B,iBAAiB,EACjB,SAAS,GAIV;IACC,OAAO,IAAA,uBAAY,EAAC,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC,CAAC;AACtD,CAAC;AAED,SAAS,kBAAkB,CACzB,iBAAyB,EACzB,GAAW;IAEX,OAAO;QACL,MAAM,EAAE,IAAI;QACZ,KAAK,EAAE,GAAG;QACV,SAAS,EAAE,qBAAqB,CAAC;YAC/B,SAAS,EAAE,gBAAC,CAAC,SAAS,CAAC,GAAG,CAAC;YAC3B,iBAAiB;SAClB,CAAC;QACF,WAAW,EAAE,SAAS;KACvB,CAAC;AACJ,CAAC;AAED,sBAA6B,EAC3B,GAAG,EACH,QAAQ,EACR,iBAAiB,GAKlB;IACC,MAAM,cAAc,GAAG,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC;IACvC,IAAI,cAAc,EAAE,CAAC;QACnB,gCAAgC;QAChC,OAAO;YACL,MAAM,EAAE,KAAK;YACb,KAAK,EAAE,cAAc,CAAC,KAAK;YAC3B,SAAS,EAAE,qBAAqB,CAAC;gBAC/B,SAAS,EAAE,cAAc,CAAC,SAAS;gBACnC,iBAAiB;aAClB,CAAC;YACF,WAAW,EAAE,cAAc,CAAC,WAAW;SACxC,CAAC;IACJ,CAAC;IACD,OAAO,kBAAkB,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;AACpD,CAAC;AAED,uBAA8B,EAC5B,OAAO,EACP,MAAM,EACN,eAAe,EACf,iBAAiB,EACjB,QAAQ,GAOT;IACC,MAAM,IAAI,GAAG,CAAC,eAAe,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAC/C,YAAY,CAAC,EAAC,GAAG,EAAE,iBAAiB,EAAE,QAAQ,EAAC,CAAC,CACjD,CAAC;IACF,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACtB,gBAAgB,CAAC,EAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAC,CAAC,CAAC;IAC5C,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,0BAAiC,EAC/B,IAAI,EACJ,MAAM,EACN,OAAO,GAKR;IACC,IAAI,OAAO,CAAC,YAAY,KAAK,QAAQ,EAAE,CAAC;QACtC,OAAO;IACT,CAAC;IACD,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACpD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,iBAAiB,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC3E,MAAM,aAAa,GAAG,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnD,gBAAM,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CACjC,SAAS,aAAa,aAAa,MAAM,uBACvC,OAAO,CAAC,IAAI,IAAI,UAClB,EAAE,CACH,CAAC;IACJ,CAAC;AACH,CAAC;AAOD;;;;;;;GAOG;AACH,0BACE,KAAsB;AACtB;;;GAGG;AACH,WAAmD;IAEnD,MAAM,MAAM,GAAiD,EAAE,CAAC;IAEhE,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACrB,WAAW,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;;YAChC,0BAA0B;YAC1B,yEAAyE;YACzE,yDAAyD;YACzD,oCAAoC;YACpC,MAAM,MAAC,GAAG,CAAC,SAAS,MAApB,MAAM,OAAoB;gBACxB,GAAG;gBACH,KAAK,EAAE,EAAE;aACV,EAAC;YAEF,oBAAoB;YACpB,MAAM,CAAC,GAAG,CAAC,SAAS,CAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,mEAAmE;IACnE,wDAAwD;IACxD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACtC,KAAK,CAAC,KAAK,GAAG,gBAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,0BAAuC,EACrC,KAAK,EACL,UAAU,GAIX;IAIC,MAAM,gBAAgB,GAAG,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACjD,iEAAiE;IACjE,uDAAuD;IACvD,IAAI,gBAAgB,EAAE,CAAC;QACrB,OAAO,EAAC,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAC,CAAC;IAC9C,CAAC;IACD,2DAA2D;IAC3D,mCAAmC;IACnC,OAAO;QACL,QAAQ,EAAE,KAAK;QACf,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;KACvD,CAAC;AACJ,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docusaurus/utils",
|
|
3
|
-
"version": "4.0.0-canary-
|
|
3
|
+
"version": "4.0.0-canary-6938",
|
|
4
4
|
"description": "Node utility functions for Docusaurus packages.",
|
|
5
5
|
"main": "./lib/index.js",
|
|
6
6
|
"types": "./lib/index.d.ts",
|
|
@@ -15,9 +15,9 @@
|
|
|
15
15
|
"license": "MIT",
|
|
16
16
|
"dependencies": {
|
|
17
17
|
"@11ty/gray-matter": "^3.0.0",
|
|
18
|
-
"@docusaurus/fs": "4.0.0-canary-
|
|
19
|
-
"@docusaurus/logger": "4.0.0-canary-
|
|
20
|
-
"@docusaurus/types": "4.0.0-canary-
|
|
18
|
+
"@docusaurus/fs": "4.0.0-canary-6938",
|
|
19
|
+
"@docusaurus/logger": "4.0.0-canary-6938",
|
|
20
|
+
"@docusaurus/types": "4.0.0-canary-6938",
|
|
21
21
|
"execa": "^10.0.1",
|
|
22
22
|
"github-slugger": "^2.0.0",
|
|
23
23
|
"jiti": "^2.7.0",
|
|
@@ -26,7 +26,6 @@
|
|
|
26
26
|
"p-queue": "^9.3.3",
|
|
27
27
|
"resolve-pathname": "^3.0.0",
|
|
28
28
|
"tslib": "^2.8.1",
|
|
29
|
-
"utility-types": "^3.11.0",
|
|
30
29
|
"webpack": "^5.111.0"
|
|
31
30
|
},
|
|
32
31
|
"engines": {
|
package/src/index.ts
CHANGED
package/src/tags.ts
CHANGED
|
@@ -8,7 +8,6 @@
|
|
|
8
8
|
import _ from 'lodash';
|
|
9
9
|
import logger from '@docusaurus/logger';
|
|
10
10
|
import {normalizeUrl} from './urlUtils';
|
|
11
|
-
import type {Optional} from 'utility-types';
|
|
12
11
|
|
|
13
12
|
export type Tag = {
|
|
14
13
|
/** The display label of a tag */
|
|
@@ -51,8 +50,6 @@ export type TagModule = TagsListItem & {
|
|
|
51
50
|
unlisted: boolean;
|
|
52
51
|
};
|
|
53
52
|
|
|
54
|
-
export type FrontMatterTag = string | Optional<Tag, 'description'>;
|
|
55
|
-
|
|
56
53
|
// We always apply tagsBaseRoutePath on purpose. For versioned docs, v1/doc.md
|
|
57
54
|
// and v2/doc.md tags with custom permalinks don't lead to the same created
|
|
58
55
|
// page. tagsBaseRoutePath is different for each doc version
|
|
@@ -68,30 +65,16 @@ function normalizeTagPermalink({
|
|
|
68
65
|
|
|
69
66
|
function normalizeInlineTag(
|
|
70
67
|
tagsBaseRoutePath: string,
|
|
71
|
-
|
|
68
|
+
tag: string,
|
|
72
69
|
): TagMetadata {
|
|
73
|
-
function toTagObject(tagString: string): TagMetadata {
|
|
74
|
-
return {
|
|
75
|
-
inline: true,
|
|
76
|
-
label: tagString,
|
|
77
|
-
permalink: _.kebabCase(tagString),
|
|
78
|
-
description: undefined,
|
|
79
|
-
};
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
const tag: Tag =
|
|
83
|
-
typeof frontMatterTag === 'string'
|
|
84
|
-
? toTagObject(frontMatterTag)
|
|
85
|
-
: {...frontMatterTag, description: frontMatterTag.description};
|
|
86
|
-
|
|
87
70
|
return {
|
|
88
71
|
inline: true,
|
|
89
|
-
label: tag
|
|
72
|
+
label: tag,
|
|
90
73
|
permalink: normalizeTagPermalink({
|
|
91
|
-
permalink: tag
|
|
74
|
+
permalink: _.kebabCase(tag),
|
|
92
75
|
tagsBaseRoutePath,
|
|
93
76
|
}),
|
|
94
|
-
description:
|
|
77
|
+
description: undefined,
|
|
95
78
|
};
|
|
96
79
|
}
|
|
97
80
|
|
|
@@ -100,26 +83,23 @@ export function normalizeTag({
|
|
|
100
83
|
tagsFile,
|
|
101
84
|
tagsBaseRoutePath,
|
|
102
85
|
}: {
|
|
103
|
-
tag:
|
|
86
|
+
tag: string;
|
|
104
87
|
tagsBaseRoutePath: string;
|
|
105
88
|
tagsFile: TagsFile | null;
|
|
106
89
|
}): TagMetadata {
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
permalink:
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
};
|
|
120
|
-
}
|
|
90
|
+
const tagDescription = tagsFile?.[tag];
|
|
91
|
+
if (tagDescription) {
|
|
92
|
+
// pre-defined tag from tags.yml
|
|
93
|
+
return {
|
|
94
|
+
inline: false,
|
|
95
|
+
label: tagDescription.label,
|
|
96
|
+
permalink: normalizeTagPermalink({
|
|
97
|
+
permalink: tagDescription.permalink,
|
|
98
|
+
tagsBaseRoutePath,
|
|
99
|
+
}),
|
|
100
|
+
description: tagDescription.description,
|
|
101
|
+
};
|
|
121
102
|
}
|
|
122
|
-
// legacy inline tag object, always inline, unknown because isn't a string
|
|
123
103
|
return normalizeInlineTag(tagsBaseRoutePath, tag);
|
|
124
104
|
}
|
|
125
105
|
|
|
@@ -132,7 +112,7 @@ export function normalizeTags({
|
|
|
132
112
|
}: {
|
|
133
113
|
options: TagsPluginOptions;
|
|
134
114
|
source: string;
|
|
135
|
-
frontMatterTags:
|
|
115
|
+
frontMatterTags: string[] | undefined;
|
|
136
116
|
tagsBaseRoutePath: string;
|
|
137
117
|
tagsFile: TagsFile | null;
|
|
138
118
|
}): TagMetadata[] {
|