Script improvements, favicon (#36)

Author: robertbastian

astro.config.mjs

@@ -5,9 +5,9 @@ import starlightLinksValidator from 'starlight-links-validator'
 
 
 // !! UPDATE LATEST VERSION HERE !!
-// format semver with underscores to make it look like a semver would in a URL
-var latest_display_name = 'Version 2.0';
-var latest_dir_name = '2_0';
+let latest_version = '2.0';
+
+let latest_dir_name = latest_version.replace('.', '-');
 
 // https://astro.build/config
 export default defineConfig({
@@ -16,6 +16,24 @@ export default defineConfig({
 	integrations: [
 		starlight({
 			title: 'ICU4X',
+			head: [
+				{
+					tag: 'link',
+					attrs: {
+						rel: "icon",
+						href: "/icon_black.png",
+						media: "(prefers-color-scheme: light)",
+					}
+				},
+				{
+					tag: 'link',
+					attrs: {
+						rel: "icon",
+						href: "/icon_white.png",
+						media: "(prefers-color-scheme: dark)",
+					}
+				},
+			],
 			social: {
 				github: 'https://github.com/unicode-org/icu4x',
 			},
@@ -50,7 +68,7 @@ export default defineConfig({
 					],
 				},
 				{
-					label: latest_display_name,
+					label: 'Version 2.0',
 					badge: {
 						text: 'New',
 						variant: 'success',
@@ -71,7 +89,7 @@ export default defineConfig({
 							items: [
 								{
 									label: 'Rust',
-									link: 'https://docs.rs/icu/2.0.0',
+									link: 'https://docs.rs/icu/2.0',
 									badge: { text: '↗', variant: 'tip' },
 									attrs: { target: '_blank' },
 

public/icon_black.png

@@ -160,7 +160,7 @@ This will generate a `my_data_blob.postcard` file containing the serialized data
 
 Unlike `BakedDataProvider`, `BlobDataProvider` (and `FsDataProvider`) does not perform locale fallbacking. For example, if `en-US` is requested but only `en` data is available, then the data request will fail. To enable fallback, we can wrap the provider in a `LocaleFallbackProvider`.
 
-Note that fallback comes at a cost, as fallbacking code and data has to be included and executed on every request. If you don't need fallback (disclaimer: you probably do), you can use the `BlobDataProvider` directly (for baked data, see [`Options::skip_internal_fallback`](https://docs.rs/icu_provider_baked/2.0.0/icu_provider_baked/export/struct.Options.html)).
+Note that fallback comes at a cost, as fallbacking code and data has to be included and executed on every request. If you don't need fallback (disclaimer: you probably do), you can use the `BlobDataProvider` directly (for baked data, see [`Options::skip_internal_fallback`](https://docs.rs/icu_provider_baked/2.0/icu_provider_baked/export/struct.Options.html)).
 
 We can then use the provider in our code:
 
@@ -268,4 +268,4 @@ We have learned how to generate data and load it into our programs, optimize dat
 
 For a deeper dive into configuring your data providers in code, see [data-provider-runtime.md].
 
-You can learn more about datagen, including the Rust API which we have not used in this tutorial, by reading [the docs](https://docs.rs/icu_provider_export/2.0.0/).
+You can learn more about datagen, including the Rust API which we have not used in this tutorial, by reading [the docs](https://docs.rs/icu_provider_export/2.0/).

public/icon_white.png

@@ -218,7 +218,7 @@ Now we would also like to format the current time.
 
 ### Rust Part 4
 
-Use the API documentation for [`icu::time::DateTime`](https://docs.rs/icu/2.0.0/icu/time/struct.DateTime.html) and [`icu::datetime::fieldsets`](https://docs.rs/icu/2.0.0/icu/datetime/fieldsets/index.html) to expand your app to format both date and time.
+Use the API documentation for [`icu::time::DateTime`](https://docs.rs/icu/2.0/icu/time/struct.DateTime.html) and [`icu::datetime::fieldsets`](https://docs.rs/icu/2.0/icu/datetime/fieldsets/index.html) to expand your app to format both date and time.
 
 ### JavaScript Part 4
 

src/assets/i18n-languages-montmarte-love-wall.jpg

@@ -165,7 +165,7 @@ This concludes this introduction tutorial. With the help of `Locale` and `DateTi
 
 Internationalization is a broad domain and there are many more components in `ICU4X`.
 
-Next, learn how to [generate optimized data for your binary](/2_0/tutorials/data-management), [configure your Cargo.toml file](https://github.com/unicode-org/icu4x/tree/release%2F2.0/tutorials/../examples/cargo), or continue exploring by reading [the docs](https://docs.rs/icu/2.0.0/).
+Next, learn how to [generate optimized data for your binary](/2_0/tutorials/data-management), [configure your Cargo.toml file](https://github.com/unicode-org/icu4x/tree/release%2F2.0/tutorials/../examples/cargo), or continue exploring by reading [the docs](https://docs.rs/icu/2.0/).
 
 
 

src/content/docs/2_0/tutorials/data-management.md

@@ -138,8 +138,6 @@ function icu4xGfmToAstroMd(content: string, inFilePath: string, ctx: Context) {
 
   const order = TUTORIAL_ORDER.get(inFilePath.split('/')[inFilePath.split('/').length - 1]);
 
-  console.log(inFilePath);
-
   const frontMatter = icu4xAstroMdFrontMatter(foundTitle, order);
 
   let replacementContent = transformMdBody(content, ctx);
@@ -202,9 +200,9 @@ function printHelp() {
   console.log("Convert ICU4X Github repo Markdown tutorials to Astro MDX files");
   console.log();
   console.log("Usage:");
-  console.log("\tnpm run icu4x-convert -- --inDir=<input-dir> --outDir=<output-dir> --icu4xRef=<ICU4X-git-ref> --webDirName=<version-based-dir-name> --sitePrefix=<site-prefix-str-else-emptystr> --astroVersion=<semver>");
+  console.log("\tnpm run icu4x-convert -- --icu4xDir=<input-dir> --icu4xVersion=<minor version> [--icu4xRef=<ICU4X-git-ref>] [--sitePrefix=<site-prefix-str-else-emptystr>] --astroVersion=<semver>");
   console.log();
-  console.log("Example: npm run icu4x-convert -- --inDir=/path/to/icu4x/tutorials/ --outDir=/path/to/icu4x-docs/src/content/docs/ --icu4xVersion=1.5.0 --icu4xRef=release/1.5 --webDirName=1_5 [--sitePrefix=/uriPrefix] --astroVersion=4.16.18")
+  console.log("Example: npm run icu4x-convert -- --icu4xDir=../path/to/icu4x/ --icu4xVersion=2.1 [--icu4xRef=release/2.1-draft] [--sitePrefix=/uriPrefix] --astroVersion=4.16.18")
 }
 
 /**
@@ -214,23 +212,16 @@ function printHelp() {
 function parseCLIArgs() {
   let parsedArgs = parseArgs({
     options: {
-      inDir: {
+      icu4xDir: {
         type: "string",
         short: "i",
       },
-      outDir: {
-        type: "string",
-        short: "o",
-      },
       icu4xVersion: {
         type: "string",
       },
       icu4xRef: {
         type: "string",
       },
-      webDirName: {
-        type: "string",
-      },
       // site prefix, as used by static site generator tools.
       // if this were hosted on Github pages,
       sitePrefix: {
@@ -246,17 +237,20 @@ function parseCLIArgs() {
     let returnVal = {
       positionals: positionals,
       values: {
-        inDir: values["inDir"] ?? (() => {throw new Error("Need inDir")})(),
-        outDir: values["outDir"] ?? (() => {throw new Error("Need outDir")})(),
+        icu4xDir: values["icu4xDir"] ?? (() => {throw new Error("Need icu4xDir")})(),
         icu4xVersion: values["icu4xVersion"] ?? (() => {throw new Error("Need icu4xVersion")})(),
-        icu4xRef: values["icu4xRef"] ?? (() => {throw new Error("Need icu4xRef")})(),
-        webDirName: values["webDirName"] ?? (() => {throw new Error("Need webDirName")})(),
+        icu4xRef: values["icu4xRef"] ?? `release/${values["icu4xVersion"]}`,
         sitePrefix: values["sitePrefix"] ?? "",  // default value for sitePrefix is "" because
                                                  // URIs for base site icu4x.unicode.org do not need
                                                  // a prefix, unlike hosting on Github Pages
         astroVersion: values["astroVersion"] ?? (() => {throw new Error("Need astroVersion")})(),
       }
     };
+
+    if ((values.icu4xVersion.match(/\./g) || []).length > 1) {
+      console.log("use only a minor version, e.g. 2.1")
+      process.exit(1);
+    }
     return returnVal;
   } catch (err) {
     console.error('Missing CLI options.', err);
@@ -265,31 +259,29 @@ function parseCLIArgs() {
   }
 }
 
-function genConfigEntry(icu4xRef, webDirName, icu4xVersion) {
-  
-}
-
 // "main"
 
 try {
+  process.chdir(path.join(import.meta.dirname, '..'));
+
   const parsedArgs = parseCLIArgs();
   console.log("argv", process.argv);
   let {values, positionals} = parsedArgs;
 
-  const inputDirPath: string = values["inDir"];
+  const icu4xDir: string = values["icu4xDir"];
   const icu4xVersion = values["icu4xVersion"];
   const icu4xRef = values["icu4xRef"];
   const sitePrefix = values["sitePrefix"];
-  const webDirName = values["webDirName"];
-  const outputDirPath = path.join(values["outDir"], webDirName);
+  const webDirName = icu4xVersion.replace('.', '_');
+  const outputDirPath = path.join('src/content/docs', webDirName);
 
   const context = new Context({icu4xVersion, icu4xRef, webDirName, sitePrefix});
 
-  await convertDirFiles(inputDirPath, outputDirPath, context);
+  await convertDirFiles(path.join(icu4xDir, 'tutorials'), outputDirPath, context);
 
   console.log(
     `{
-    label: latest_display_name,
+    label: 'Version ${icu4xVersion}',
     badge: {
       text: 'New',
       variant: 'success',
@@ -347,7 +339,7 @@ try {
 
 
   console.log("Markdown conversion finished successfully");
-  console.log("Task: Add the above JSON to astro.config.mjs if it doesn't exist yet, set the previous version to collapsed: true");
+  console.log("Task: Add the above JSON to astro.config.mjs if it doesn't exist yet");
   console.log(`Task: Make sure to dump artifacts in public/${webDirName}`);
 
 } catch (error: unknown) {