From e27237013ed5da75b1af45dc5a92f18ee30ce73d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A9di-R=C3=A9mi=20Hashim?= Date: Tue, 22 Jul 2025 10:09:57 +0200 Subject: [PATCH 1/3] Don't ignore Stdlib_* files when generating doc tests --- tests/docstring_tests/DocTest.res | 6 +----- tests/docstring_tests/DocTest.res.js | 2 +- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/tests/docstring_tests/DocTest.res b/tests/docstring_tests/DocTest.res index 5e1c520dd9..9e8563e239 100644 --- a/tests/docstring_tests/DocTest.res +++ b/tests/docstring_tests/DocTest.res @@ -65,11 +65,7 @@ let extractExamples = async () => { let docFiles = files->Array.filter(f => switch f { // Ignore Js modules and RescriptTools for now - // Avoid Stdlib modules showing up as both "Stdlib_X" and "Stdlib.X" - | f - if f->String.startsWith("Js") || - f->String.startsWith("RescriptTools") || - f->String.startsWith("Stdlib_") => false + | f if f->String.startsWith("Js") || f->String.startsWith("RescriptTools") => false | f if f->String.endsWith(".resi") => true | f if f->String.endsWith(".res") && !(files->Array.includes(f ++ "i")) => true | _ => false diff --git a/tests/docstring_tests/DocTest.res.js b/tests/docstring_tests/DocTest.res.js index f202642d02..ee8d7396aa 100644 --- a/tests/docstring_tests/DocTest.res.js +++ b/tests/docstring_tests/DocTest.res.js @@ -68,7 +68,7 @@ let batchSize = Nodeos.cpus().length; async function extractExamples() { let files = Nodefs.readdirSync("runtime"); let docFiles = files.filter(f => { - if (f.startsWith("Js") || f.startsWith("RescriptTools") || f.startsWith("Stdlib_")) { + if (f.startsWith("Js") || f.startsWith("RescriptTools")) { return false; } else if (f.endsWith(".resi")) { return true; From 233db86040de4afe813c4c66ee2d7b7375af76c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A9di-R=C3=A9mi=20Hashim?= Date: Tue, 22 Jul 2025 10:10:45 +0200 Subject: [PATCH 2/3] Use correct test IDs when ignoring doc tests due to node.js version --- tests/docstring_tests/DocTest.res | 22 +++++++++++----------- tests/docstring_tests/DocTest.res.js | 20 ++++++++++---------- 2 files changed, 21 insertions(+), 21 deletions(-) diff --git a/tests/docstring_tests/DocTest.res b/tests/docstring_tests/DocTest.res index 9e8563e239..feeed50aae 100644 --- a/tests/docstring_tests/DocTest.res +++ b/tests/docstring_tests/DocTest.res @@ -12,22 +12,22 @@ let nodeVersion = let ignoreRuntimeTests = [ ( - // Ignore some tests require Node.js v20+ + // Ignore tests that require Node.js v20+ 20, - ["Stdlib.Array.toReversed", "Stdlib.Array.toSorted"], + ["Stdlib_Array.toReversed", "Stdlib_Array.toSorted"], ), ( - // Ignore some tests require Node.js v22+ + // Ignore tests that require Node.js v22+ 22, [ - "Stdlib.Promise.withResolvers", - "Stdlib.Set.union", - "Stdlib.Set.isSupersetOf", - "Stdlib.Set.isSubsetOf", - "Stdlib.Set.isDisjointFrom", - "Stdlib.Set.intersection", - "Stdlib.Set.symmetricDifference", - "Stdlib.Set.difference", + "Stdlib_Promise.withResolvers", + "Stdlib_Set.union", + "Stdlib_Set.isSupersetOf", + "Stdlib_Set.isSubsetOf", + "Stdlib_Set.isDisjointFrom", + "Stdlib_Set.intersection", + "Stdlib_Set.symmetricDifference", + "Stdlib_Set.difference", ], ), ] diff --git a/tests/docstring_tests/DocTest.res.js b/tests/docstring_tests/DocTest.res.js index ee8d7396aa..32c194051a 100644 --- a/tests/docstring_tests/DocTest.res.js +++ b/tests/docstring_tests/DocTest.res.js @@ -21,21 +21,21 @@ let ignoreRuntimeTests = [ [ 20, [ - "Stdlib.Array.toReversed", - "Stdlib.Array.toSorted" + "Stdlib_Array.toReversed", + "Stdlib_Array.toSorted" ] ], [ 22, [ - "Stdlib.Promise.withResolvers", - "Stdlib.Set.union", - "Stdlib.Set.isSupersetOf", - "Stdlib.Set.isSubsetOf", - "Stdlib.Set.isDisjointFrom", - "Stdlib.Set.intersection", - "Stdlib.Set.symmetricDifference", - "Stdlib.Set.difference" + "Stdlib_Promise.withResolvers", + "Stdlib_Set.union", + "Stdlib_Set.isSupersetOf", + "Stdlib_Set.isSubsetOf", + "Stdlib_Set.isDisjointFrom", + "Stdlib_Set.intersection", + "Stdlib_Set.symmetricDifference", + "Stdlib_Set.difference" ] ] ]; From d4c7dab4325c08754884ce4abf6d361476b3b088 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A9di-R=C3=A9mi=20Hashim?= Date: Tue, 22 Jul 2025 10:17:10 +0200 Subject: [PATCH 3/3] Add CHANGELOG entry --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index b7b7da1acf..85ad1a9514 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -28,6 +28,7 @@ - Add rust linting to CI with `clippy`. https://github.com/rescript-lang/rescript/pull/7675 - AST: use `Typ.arrows` for creation, after the refactoring of arrow types. https://github.com/rescript-lang/rescript/pull/7662 +- Don't skip Stdlib docstring tests. https://github.com/rescript-lang/rescript/pull/7694 #### :bug: Bug fix