Merge remote-tracking branch 'origin/main' into feat/dark-mode

gleam-lang · Mar 5, 2024 · 9be1568 · 9be1568
2 parents e4de966 + e1d6c11
commit 9be1568
Show file tree

Hide file tree

Showing 67 changed files with 76 additions and 23 deletions.
diff --git a/bin/download-compiler b/bin/download-compiler
@@ -2,7 +2,7 @@
 
 set -eu
 
-VERSION="v0.34.1"
+VERSION="v1.0.0"
 
 rm -fr wasm-compiler
 mkdir wasm-compiler

diff --git a/...er0_basics/lesson01_hello_world/text.html → ...pter0_basics/lesson01_hello_world/en.html b/...er0_basics/lesson01_hello_world/text.html → ...pter0_basics/lesson01_hello_world/en.html
diff --git a/...cs/lesson02_unqualified_imports/text.html → ...sics/lesson02_unqualified_imports/en.html b/...cs/lesson02_unqualified_imports/text.html → ...sics/lesson02_unqualified_imports/en.html
diff --git a/...0_basics/lesson03_type_checking/text.html → ...er0_basics/lesson03_type_checking/en.html b/...0_basics/lesson03_type_checking/text.html → ...er0_basics/lesson03_type_checking/en.html
diff --git a/...t/chapter0_basics/lesson04_ints/text.html → ...ent/chapter0_basics/lesson04_ints/en.html b/...t/chapter0_basics/lesson04_ints/text.html → ...ent/chapter0_basics/lesson04_ints/en.html
diff --git a/...chapter0_basics/lesson05_floats/text.html → ...t/chapter0_basics/lesson05_floats/en.html b/...chapter0_basics/lesson05_floats/text.html → ...t/chapter0_basics/lesson05_floats/en.html
diff --git a/..._basics/lesson06_number_formats/text.html → ...r0_basics/lesson06_number_formats/en.html b/..._basics/lesson06_number_formats/text.html → ...r0_basics/lesson06_number_formats/en.html
diff --git a/...apter0_basics/lesson07_equality/text.html → ...chapter0_basics/lesson07_equality/en.html b/...apter0_basics/lesson07_equality/text.html → ...chapter0_basics/lesson07_equality/en.html
diff --git a/...hapter0_basics/lesson08_strings/text.html → .../chapter0_basics/lesson08_strings/en.html b/...hapter0_basics/lesson08_strings/text.html → .../chapter0_basics/lesson08_strings/en.html
diff --git a/.../chapter0_basics/lesson09_bools/text.html → ...nt/chapter0_basics/lesson09_bools/en.html b/.../chapter0_basics/lesson09_bools/text.html → ...nt/chapter0_basics/lesson09_bools/en.html
diff --git a/...er0_basics/lesson10_assignments/text.html → ...pter0_basics/lesson10_assignments/en.html b/...er0_basics/lesson10_assignments/text.html → ...pter0_basics/lesson10_assignments/en.html
diff --git a/...asics/lesson11_discard_patterns/text.html → ..._basics/lesson11_discard_patterns/en.html b/...asics/lesson11_discard_patterns/text.html → ..._basics/lesson11_discard_patterns/en.html
diff --git a/...asics/lesson12_type_annotations/text.html → ..._basics/lesson12_type_annotations/en.html b/...asics/lesson12_type_annotations/text.html → ..._basics/lesson12_type_annotations/en.html
diff --git a/...r0_basics/lesson13_type_aliases/text.html → ...ter0_basics/lesson13_type_aliases/en.html b/...r0_basics/lesson13_type_aliases/text.html → ...ter0_basics/lesson13_type_aliases/en.html
diff --git a/...chapter0_basics/lesson14_blocks/text.html → ...t/chapter0_basics/lesson14_blocks/en.html b/...chapter0_basics/lesson14_blocks/text.html → ...t/chapter0_basics/lesson14_blocks/en.html
diff --git a/.../chapter0_basics/lesson15_lists/text.html → ...nt/chapter0_basics/lesson15_lists/en.html b/.../chapter0_basics/lesson15_lists/text.html → ...nt/chapter0_basics/lesson15_lists/en.html
diff --git a/...pter0_basics/lesson16_constants/text.html → ...hapter0_basics/lesson16_constants/en.html b/...pter0_basics/lesson16_constants/text.html → ...hapter0_basics/lesson16_constants/en.html
diff --git a/...r1_functions/lesson00_functions/text.html → ...ter1_functions/lesson00_functions/en.html b/...r1_functions/lesson00_functions/text.html → ...ter1_functions/lesson00_functions/en.html
diff --git a/...lesson03_higher_order_functions/text.html → ...s/lesson03_higher_order_functions/en.html b/...lesson03_higher_order_functions/text.html → ...s/lesson03_higher_order_functions/en.html
diff --git a/...ns/lesson04_anonymous_functions/text.html → ...ions/lesson04_anonymous_functions/en.html b/...ns/lesson04_anonymous_functions/text.html → ...ions/lesson04_anonymous_functions/en.html
diff --git a/...ions/lesson05_function_captures/text.html → ...ctions/lesson05_function_captures/en.html b/...ions/lesson05_function_captures/text.html → ...ctions/lesson05_function_captures/en.html
diff --git a/src/content/chapter1_functions/lesson06_generic_functions/code.gleam b/src/content/chapter1_functions/lesson06_generic_functions/code.gleam
@@ -14,6 +14,7 @@ pub fn main() {
   io.debug(twice("Hello", exclaim))
 }
 
+// The name `value` refers to the same type multiple times
 fn twice(argument: value, function: fn(value) -> value) -> value {
   function(function(argument))
 }
diff --git a/...ions/lesson06_generic_functions/text.html → ...ctions/lesson06_generic_functions/en.html b/...ions/lesson06_generic_functions/text.html → ...ctions/lesson06_generic_functions/en.html
diff --git a/...r1_functions/lesson07_pipelines/text.html → ...ter1_functions/lesson07_pipelines/en.html b/...r1_functions/lesson07_pipelines/text.html → ...ter1_functions/lesson07_pipelines/en.html
diff --git a/...ons/lesson08_labelled_arguments/text.html → ...tions/lesson08_labelled_arguments/en.html b/...ons/lesson08_labelled_arguments/text.html → ...tions/lesson08_labelled_arguments/en.html
diff --git a/...lesson09_documentation_comments/text.html → ...s/lesson09_documentation_comments/en.html b/...lesson09_documentation_comments/text.html → ...s/lesson09_documentation_comments/en.html
diff --git a/...functions/lesson10_deprecations/text.html → ...1_functions/lesson10_deprecations/en.html b/...functions/lesson10_deprecations/text.html → ...1_functions/lesson10_deprecations/en.html
@@ -4,11 +4,11 @@
   attribute.
 </p>
 <p>
-  If a deprecated function is reference the compiler will emit a warning,
+  If a deprecated function is referenced the compiler will emit a warning,
   letting the programmer know they ought to update their code.
 </p>
 <p>
   The deprecation attribute takes a message and this will be displayed to the
   user in the warning. In the message explain to the user the new approach or
-  replacement function, or direct them on documentation on how to upgrade.
+  replacement function, or direct them to documentation on how to upgrade.
 </p>
diff --git a/...ntrol/lesson01_case_expressions/text.html → ...control/lesson01_case_expressions/en.html b/...ntrol/lesson01_case_expressions/text.html → ...control/lesson01_case_expressions/en.html
diff --git a/...trol/lesson02_variable_patterns/text.html → ...ontrol/lesson02_variable_patterns/en.html b/...trol/lesson02_variable_patterns/text.html → ...ontrol/lesson02_variable_patterns/en.html
diff --git a/...ontrol/lesson03_string_patterns/text.html → ..._control/lesson03_string_patterns/en.html b/...ontrol/lesson03_string_patterns/text.html → ..._control/lesson03_string_patterns/en.html
diff --git a/..._control/lesson04_list_patterns/text.html → ...ow_control/lesson04_list_patterns/en.html b/..._control/lesson04_list_patterns/text.html → ...ow_control/lesson04_list_patterns/en.html
diff --git a/...flow_control/lesson05_recursion/text.html → ...2_flow_control/lesson05_recursion/en.html b/...flow_control/lesson05_recursion/text.html → ...2_flow_control/lesson05_recursion/en.html
diff --git a/src/content/chapter2_flow_control/lesson06_tail_calls/code.gleam b/src/content/chapter2_flow_control/lesson06_tail_calls/code.gleam
@@ -15,7 +15,7 @@ fn factorial_loop(x: Int, accumulator: Int) -> Int {
     1 -> accumulator
 
     // The last thing this function does is call itself
-    // In the previous lesson the last thing it did was multiple two ints
+    // In the previous lesson the last thing it did was multiply two ints
     _ -> factorial_loop(x - 1, accumulator * x)
   }
 }
diff --git a/...low_control/lesson06_tail_calls/text.html → ..._flow_control/lesson06_tail_calls/en.html b/...low_control/lesson06_tail_calls/text.html → ..._flow_control/lesson06_tail_calls/en.html
diff --git a/...control/lesson07_list_recursion/text.html → ...w_control/lesson07_list_recursion/en.html b/...control/lesson07_list_recursion/text.html → ...w_control/lesson07_list_recursion/en.html
@@ -1,9 +1,9 @@
 <p>
-  Most commonly functions in the
+  While it is more common to use functions in the
   <a href="https://hexdocs.pm/gleam_stdlib/gleam/list.html"
     ><code>gleam/list</code></a
   >
-  module are used to iterate across a list, but at times you may prefer to work
+  module to iterate across a list, at times you may prefer to work
   with the list directly.
 </p>
 <p>

diff --git a/...trol/lesson08_multiple_subjects/text.html → ...ontrol/lesson08_multiple_subjects/en.html b/...trol/lesson08_multiple_subjects/text.html → ...ontrol/lesson08_multiple_subjects/en.html
diff --git a/...l/lesson09_alternative_patterns/text.html → ...rol/lesson09_alternative_patterns/en.html b/...l/lesson09_alternative_patterns/text.html → ...rol/lesson09_alternative_patterns/en.html
diff --git a/...ontrol/lesson10_pattern_aliases/text.html → ..._control/lesson10_pattern_aliases/en.html b/...ontrol/lesson10_pattern_aliases/text.html → ..._control/lesson10_pattern_aliases/en.html
diff --git a/...r2_flow_control/lesson11_guards/text.html → ...ter2_flow_control/lesson11_guards/en.html b/...r2_flow_control/lesson11_guards/text.html → ...ter2_flow_control/lesson11_guards/en.html
diff --git a/...ter3_data_types/lesson00_tuples/text.html → ...apter3_data_types/lesson00_tuples/en.html b/...ter3_data_types/lesson00_tuples/text.html → ...apter3_data_types/lesson00_tuples/en.html
@@ -14,7 +14,7 @@
   and <code>#(1.4, 10, 48)</code> has the type <code>#(Float, Int, Int)</code>.
 </p>
 <p>
-  Tuples are most commonly used to return 2 or 3 values from a function. Other
-  times it is often is clearer to use a <em>custom type</em>, which we will
-  cover next.
+  Tuples are most commonly used to return 2 or 3 values from a function. 
+  Often it is clearer to use a <em>custom type</em> where a tuple could
+  be used, We will cover custom types next.
 </p>
diff --git a/...ata_types/lesson01_custom_types/text.html → ..._data_types/lesson01_custom_types/en.html b/...ata_types/lesson01_custom_types/text.html → ..._data_types/lesson01_custom_types/en.html
diff --git a/...er3_data_types/lesson02_records/text.html → ...pter3_data_types/lesson02_records/en.html b/...er3_data_types/lesson02_records/text.html → ...pter3_data_types/lesson02_records/en.html
@@ -1,6 +1,9 @@
-<p>Variants of a record can hold other data within them.</p>
 <p>
-  These fields can be given labels, and like function argument labels they can
+  A variant of a custom type can hold other data within it. In this case
+  the variant is called a record.
+</p>
+<p>
+  The fields of a record can be given labels, and like function argument labels they can
   be optionally used when calling the record constructor. Typically labels will
   be used for variants that define them.
 </p>

diff --git a/...types/lesson03_record_accessors/text.html → ...a_types/lesson03_record_accessors/en.html b/...types/lesson03_record_accessors/text.html → ...a_types/lesson03_record_accessors/en.html
diff --git a/...a_types/lesson04_record_updates/text.html → ...ata_types/lesson04_record_updates/en.html b/...a_types/lesson04_record_updates/text.html → ...ata_types/lesson04_record_updates/en.html
diff --git a/...hapter3_data_types/lesson05_nil/text.html → .../chapter3_data_types/lesson05_nil/en.html b/...hapter3_data_types/lesson05_nil/text.html → .../chapter3_data_types/lesson05_nil/en.html
diff --git a/...er3_data_types/lesson06_results/text.html → ...pter3_data_types/lesson06_results/en.html b/...er3_data_types/lesson06_results/text.html → ...pter3_data_types/lesson06_results/en.html
@@ -18,7 +18,7 @@
   failure.
 </p>
 <p>
-  Commonly Gleam programs and library will define custom types with a variant
+  Commonly a Gleam program or library will define a custom type with a variant
   for each possible problem that can arise, along with any error information
   that would be useful to the programmer.
 </p>

diff --git a/..._data_types/lesson07_bit_arrays/text.html → ...r3_data_types/lesson07_bit_arrays/en.html b/..._data_types/lesson07_bit_arrays/text.html → ...r3_data_types/lesson07_bit_arrays/en.html
@@ -22,5 +22,5 @@
 </ul>
 <p>
   Bit arrays have limited support when compiling to JavaScript, not all options
-  can be used. Full bit array support will be implemented in future.
+  can be used. Full bit array support will be implemented in the future.
 </p>
diff --git a/...sson00_standard_library_package/text.html → ...lesson00_standard_library_package/en.html b/...sson00_standard_library_package/text.html → ...lesson00_standard_library_package/en.html
diff --git a/...rd_library/lesson01_list_module/text.html → ...dard_library/lesson01_list_module/en.html b/...rd_library/lesson01_list_module/text.html → ...dard_library/lesson01_list_module/en.html
diff --git a/..._library/lesson02_result_module/text.html → ...rd_library/lesson02_result_module/en.html b/..._library/lesson02_result_module/text.html → ...rd_library/lesson02_result_module/en.html
diff --git a/...rd_library/lesson03_dict_module/text.html → ...dard_library/lesson03_dict_module/en.html b/...rd_library/lesson03_dict_module/text.html → ...dard_library/lesson03_dict_module/en.html
diff --git a/..._library/lesson04_option_module/text.html → ...rd_library/lesson04_option_module/en.html b/..._library/lesson04_option_module/text.html → ...rd_library/lesson04_option_module/en.html
diff --git a/..._advanced_features/lesson00_use/text.html → ...r5_advanced_features/lesson00_use/en.html b/..._advanced_features/lesson00_use/text.html → ...r5_advanced_features/lesson00_use/en.html
diff --git a/...ced_features/lesson01_use_sugar/text.html → ...anced_features/lesson01_use_sugar/en.html b/...ced_features/lesson01_use_sugar/text.html → ...anced_features/lesson01_use_sugar/en.html
diff --git a/...advanced_features/lesson02_todo/text.html → ...5_advanced_features/lesson02_todo/en.html b/...advanced_features/lesson02_todo/text.html → ...5_advanced_features/lesson02_todo/en.html
diff --git a/...dvanced_features/lesson03_panic/text.html → ..._advanced_features/lesson03_panic/en.html b/...dvanced_features/lesson03_panic/text.html → ..._advanced_features/lesson03_panic/en.html
diff --git a/src/content/chapter5_advanced_features/lesson04_let_assert/code.gleam b/src/content/chapter5_advanced_features/lesson04_let_assert/code.gleam
@@ -0,0 +1,16 @@
+import gleam/io
+
+pub fn main() {
+  let a = unsafely_get_first_element([123])
+  io.debug(a)
+
+  let b = unsafely_get_first_element([])
+  io.debug(b)
+}
+
+pub fn unsafely_get_first_element(items: List(a)) -> a {
+  // This will panic if the list is empty.
+  // A regular `let` would not permit this partial pattern
+  let assert [first, ..] = items
+  first
+}
diff --git a/src/content/chapter5_advanced_features/lesson04_let_assert/en.html b/src/content/chapter5_advanced_features/lesson04_let_assert/en.html
@@ -0,0 +1,15 @@
+<p>
+  <code>let assert</code> is the final way to intentionally crash your Gleam
+  program. It is similar to the <code>panic</code> keyword in that it crashes
+  when the program has reached a point that should never be reached.
+</p>
+<p>
+  <code>let assert</code> is similar to <code>let</code> in that it is a way to
+  assign values to variables, but it is different in that the pattern can be
+  <i>partial</i>. The pattern does not need to match every possible value of the
+  type being assigned.
+</p>
+<p>
+  Like <code>panic</code> this feature should be used sparingly, and likely not
+  at all in libraries.
+</p>
diff --git a/...ed_features/lesson04_externals/code.gleam → ...ed_features/lesson05_externals/code.gleam b/...ed_features/lesson04_externals/code.gleam → ...ed_features/lesson05_externals/code.gleam
diff --git a/...ced_features/lesson04_externals/text.html → ...anced_features/lesson05_externals/en.html b/...ced_features/lesson04_externals/text.html → ...anced_features/lesson05_externals/en.html
diff --git a/...esson05_multi_target_externals/code.gleam → ...esson06_multi_target_externals/code.gleam b/...esson05_multi_target_externals/code.gleam → ...esson06_multi_target_externals/code.gleam
diff --git a/...lesson05_multi_target_externals/text.html → ...s/lesson06_multi_target_externals/en.html b/...lesson05_multi_target_externals/text.html → ...s/lesson06_multi_target_externals/en.html
diff --git a/...son06_external_gleam_fallbacks/code.gleam → ...son07_external_gleam_fallbacks/code.gleam b/...son06_external_gleam_fallbacks/code.gleam → ...son07_external_gleam_fallbacks/code.gleam
diff --git a/...sson06_external_gleam_fallbacks/text.html → ...lesson07_external_gleam_fallbacks/en.html b/...sson06_external_gleam_fallbacks/text.html → ...lesson07_external_gleam_fallbacks/en.html
diff --git a/src/tour.gleam b/src/tour.gleam
@@ -79,8 +79,8 @@ const what_next_html = "
 </p>
 
 <p>
-  Read the <a href=\"https://gleam.run/getting-started/\">Gleam getting started
-  documentation</a> to learn more about the language and its tooling.
+  Read the <a href=\"https://gleam.run/writing-gleam\">Writing Gleam
+  guide</a> to learn how to create and develop a Gleam project.
 </p>
 <p>
   Join the <a href=\"https://discord.gg/Fm8Pwmy\">the Gleam Discord server</a>
@@ -184,7 +184,7 @@ fn read_file(path: String) -> snag.Result(String) {
 
 fn load_lesson(chapter_path: String, names: FileNames) -> snag.Result(Lesson) {
   use code <- result.try(read_file(names.path <> "/code.gleam"))
-  use text <- result.try(read_file(names.path <> "/text.html"))
+  use text <- result.try(read_file(names.path <> "/en.html"))
 
   Ok(Lesson(
     name: names.name,
@@ -540,7 +540,7 @@ fn lesson_html(page: Lesson) -> String {
       metaprop("twitter:title", title),
       metaprop("twitter:description", description),
       metaprop("twitter:image", "https://gleam.run/images/og-image.png"),
-      link("shortcut icon", "https://gleam.run/images/lucy-circle.svg"),
+      link("shortcut icon", "https://gleam.run/images/lucy/lucy.svg"),
       link("stylesheet", "/common.css"),
       link("stylesheet", "/style.css"),
       h(
@@ -560,7 +560,17 @@ fn lesson_html(page: Lesson) -> String {
     ]),
     h("body", [], [
       h("nav", [#("class", "navbar")], [
-        h("a", [#("href", "/")], [text("Gleam Language Tour")]),
+        h("a", [#("href", "/"), #("class", "logo")], [
+          h(
+            "img",
+            [
+              #("src", "https://gleam.run/images/lucy/lucy.svg"),
+              #("alt", "Lucy the star, Gleam's mascot"),
+            ],
+            [],
+          ),
+          text("Gleam Language Tour"),
+        ]),
         h("div", [#("class", "nav-right")], [
           h("div", [#("class", "theme-picker")], [
             h(

diff --git a/static/style.css b/static/style.css
@@ -112,6 +112,18 @@ a code {
   color: inherit;
 }
 
+.navbar .logo {
+  display: flex;
+  align-items: center;
+}
+
+.navbar .logo img {
+  display: inline-block;
+  height: 2em;
+  transform: rotate(-10deg);
+  margin-right: 0.5em;
+}
+
 .navbar a:visited,
 .navbar a {
   text-decoration: none;

diff --git a/static/worker.js b/static/worker.js
@@ -16,10 +16,6 @@ console.log = (...args) => {
   logged += args.map((e) => `${e}`).join(" ") + "\n";
 };
 
-function resetLogCapture() {
-  logged = "";
-}
-
 async function loadProgram(js) {
   const url = new URL(import.meta.url);
   url.pathname = "";
@@ -36,6 +32,7 @@ async function loadProgram(js) {
 }
 
 async function compileEval(code) {
+  logged = "";
   const result = {
     log: null,
     error: null,
@@ -47,7 +44,6 @@ async function compileEval(code) {
     project.compilePackage("javascript");
     const js = project.readCompiledJavaScript("main");
     const main = await loadProgram(js);
-    resetLogCapture();
     if (main) main();
   } catch (error) {
     console.error(error);