Skip to content

refactor: normalize variable names for documentation paths in generate script #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Gorniaky merged 1 commit into from
Sep 4, 2026
Merged

refactor: normalize variable names for documentation paths in generate script #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions scripts/docs/generate.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
// dart scripts/docs/generate.dart

import "dart:io";
import "dart:typed_data";

Expand All @@ -10,17 +12,17 @@ import "package:path/path.dart";
import "generate/commands.dart";
import "generate/index.dart";

void main() async {
const docRootPath = "docs";
const docsExt = ".md";
const _docsRootPath = "docs";
const _mdDocsExt = ".md";

final docRootDir = Directory(docRootPath);
void main() async {
final docRootDir = Directory(_docsRootPath);

const filesToPreserve = {"_config.yml"};
final filesToPreserveContents = <File, Uint8List>{};

for (final filename in filesToPreserve) {
final File file = .new(joinAll([docRootPath, filename]));
final File file = .new(joinAll([_docsRootPath, filename]));
if (!await file.exists()) continue;

filesToPreserveContents[file] = await file.readAsBytes();
Expand All @@ -46,7 +48,7 @@ void main() async {

final entities = await docRootDir
.list(recursive: true)
.where((e) => e is File && extension(e.path) == docsExt)
.where((e) => e is File && extension(e.path) == _mdDocsExt)
.toList();

final entitiesPaths = entities.map((e) => e.path).toSet();
Expand Down Expand Up @@ -80,12 +82,9 @@ void main() async {
UnorderedListWithCheckboxSyntax(),
],
inlineSyntaxes: [
_LocalLinkMdSyntax(
localFileList: entitiesPaths,
relativeRootPath: docRootPath,
),
AutolinkSyntax(),
_LocalLinkMdSyntax(localFiles: entitiesPaths),
AutolinkExtensionSyntax(),
AutolinkSyntax(),
CodeSyntax(),
ColorSwatchSyntax(),
DecodeHtmlSyntax(),
Expand Down Expand Up @@ -113,11 +112,10 @@ void main() async {
}

class _LocalLinkMdSyntax extends InlineSyntax {
new({required this.relativeRootPath, required this.localFileList})
: super(r"\[([^\]]+)\]\((.+.md)\)");
new({required this.localFiles})
: super(r"\[([^\]]+)\]\(((\.[\\/])?\w.*.md)\)");

final String relativeRootPath;
final Set<String> localFileList;
final Set<String> localFiles;

@override
bool onMatch(InlineParser parser, Match match) {
Expand All @@ -126,13 +124,15 @@ class _LocalLinkMdSyntax extends InlineSyntax {
parser.addNode(element);

final mdFilePath = match.group(2)!;
final path = joinAll([relativeRootPath, mdFilePath]);
if (localFileList.contains(path)) {
final path = joinAll([_docsRootPath, mdFilePath]);

if (localFiles.contains(path)) {
final htmlFilename = "${basenameWithoutExtension(mdFilePath)}.html";
final htmlFilepath = joinAll([dirname(mdFilePath), htmlFilename]);
element.attributes["href"] = htmlFilepath;
final htmlFilePath = joinAll([dirname(mdFilePath), htmlFilename]);
element.attributes["href"] = htmlFilePath;
return true;
}

element.attributes["href"] = mdFilePath;
return true;
}
Expand Down
Loading