Combine both license generations into one file

Mikayla Maki created 3 years ago

Change summary

crates/zed/src/menus.rs         |  6 +-----
crates/zed/src/zed.rs           | 22 +++-------------------
script/generate-licenses        | 31 +++++++++++++++++++------------
script/licenses/template.hbs.md | 12 +++---------
styles/src/buildLicenses.ts     |  9 ++++-----
5 files changed, 30 insertions(+), 50 deletions(-)

Detailed changes

crates/zed/src/menus.rs

@@ -339,11 +339,7 @@ pub fn menus() -> Vec<Menu<'static>> {
                 },
                 MenuItem::Action {
                     name: "View Dependency Licenses",
-                    action: Box::new(crate::OpenSoftwareLicenses),
-                },
-                MenuItem::Action {
-                    name: "View Theme Licenses",
-                    action: Box::new(crate::OpenThemeLicenses),
+                    action: Box::new(crate::OpenLicenses),
                 },
                 MenuItem::Separator,
                 MenuItem::Action {

crates/zed/src/zed.rs

@@ -57,8 +57,7 @@ actions!(
         DebugElements,
         OpenSettings,
         OpenLog,
-        OpenSoftwareLicenses,
-        OpenThemeLicenses,
+        OpenLicenses,
         OpenTelemetryLog,
         OpenKeymap,
         OpenDefaultSettings,
@@ -180,32 +179,17 @@ pub fn init(app_state: &Arc<AppState>, cx: &mut gpui::MutableAppContext) {
     });
     cx.add_action({
         let app_state = app_state.clone();
-        move |workspace: &mut Workspace,
-              _: &OpenSoftwareLicenses,
-              cx: &mut ViewContext<Workspace>| {
+        move |workspace: &mut Workspace, _: &OpenLicenses, cx: &mut ViewContext<Workspace>| {
             open_bundled_file(
                 workspace,
                 app_state.clone(),
-                "software_licenses.md",
+                "licenses.md",
                 "Open Source License Attribution",
                 "Markdown",
                 cx,
             );
         }
     });
-    cx.add_action({
-        let app_state = app_state.clone();
-        move |workspace: &mut Workspace, _: &OpenThemeLicenses, cx: &mut ViewContext<Workspace>| {
-            open_bundled_file(
-                workspace,
-                app_state.clone(),
-                "theme_licenses.md",
-                "Theme License Attribution",
-                "Markdown",
-                cx,
-            );
-        }
-    });
     cx.add_action({
         let app_state = app_state.clone();
         move |workspace: &mut Workspace, _: &OpenTelemetryLog, cx: &mut ViewContext<Workspace>| {

script/generate-licenses

@@ -2,20 +2,27 @@
 
 set -e
 
-[[ "$(cargo about --version)" == "cargo-about 0.5.2" ]] || cargo install cargo-about --locked --git https://github.com/zed-industries/cargo-about --branch error-code-on-warn
+OUTPUT_FILE=$(pwd)/assets/licenses.md
 
-echo "Generating cargo licenses"
-cargo about generate --fail-on-missing-license -o assets/software_licenses.md -c script/licenses/zed-licenses.toml script/licenses/template.hbs.md
+> $OUTPUT_FILE
 
-# cargo about automatically html-escapes all output, so we need to undo it here: 
-sed -i '' 's/"/"/g' assets/software_licenses.md
-sed -i '' 's/'/'\''/g' assets/software_licenses.md # `'\''` ends the string, appends a single quote, and re-opens the string
-sed -i '' 's/=/=/g' assets/software_licenses.md
-sed -i '' 's/`/`/g' assets/software_licenses.md
-sed -i '' 's/&lt;/</g' assets/software_licenses.md
-sed -i '' 's/&gt;/>/g' assets/software_licenses.md
+echo -e "# ###### THEME LICENSES ######\n" >> $OUTPUT_FILE
 
-# Now make theme licenses
 echo "Generating theme licenses"
 cd styles
-npm run build-licenses
+npm run --silent build-licenses >> $OUTPUT_FILE
+cd ..
+
+echo -e "# ###### CODE LICENSES ######\n" >> $OUTPUT_FILE
+
+[[ "$(cargo about --version)" == "cargo-about 0.5.2" ]] || cargo install cargo-about --locked --git https://github.com/zed-industries/cargo-about --branch error-code-on-warn
+
+echo "Generating cargo licenses"
+cargo about generate --fail-on-missing-license -c script/licenses/zed-licenses.toml script/licenses/template.hbs.md >> $OUTPUT_FILE
+
+sed -i '' 's/&quot;/"/g' $OUTPUT_FILE
+sed -i '' 's/&#x27;/'\''/g' $OUTPUT_FILE # The ` '\'' ` thing ends the string, appends a single quote, and re-opens the string
+sed -i '' 's/&#x3D;/=/g' $OUTPUT_FILE
+sed -i '' 's/&#x60;/`/g' $OUTPUT_FILE
+sed -i '' 's/&lt;/</g' $OUTPUT_FILE
+sed -i '' 's/&gt;/>/g' $OUTPUT_FILE

script/licenses/template.hbs.md

@@ -1,20 +1,15 @@
-# Third Party Licenses
-
-This page lists the licenses of the projects used in Zed.
-
 ## Overview of licenses:
 
 {{#each overview}}
 * {{name}} ({{count}})
 {{/each}}
 
-## All license texts:
-
+### All license texts:
 {{#each licenses}}
 
-### {{name}}
+#### {{name}}
   
-#### Used by:
+##### Used by:
 
 {{#each used_by}}
 * [{{crate.name}} {{crate.version}}]({{#if crate.repository}} {{crate.repository}} {{else}} https://crates.io/crates/{{crate.name}} {{/if}})
@@ -23,5 +18,4 @@ This page lists the licenses of the projects used in Zed.
 {{text}}
 
 --------------------------------------------------------------------------------
-           
 {{/each}}

styles/src/buildLicenses.ts

@@ -6,7 +6,7 @@ import {
 import { Meta } from "./themes/common/colorScheme";
 import https from "https";
 import crypto from "crypto";
-const license_file = `${__dirname}/../../assets/theme_licenses.md`
+
 const accepted_licenses_file = `${__dirname}/../../script/licenses/zed-licenses.toml`
 
 // Use the cargo-about configuration file as the source of truth for supported licenses.
@@ -62,14 +62,13 @@ function getLicenseText(schemeMeta: Meta[], callback: (meta: Meta, license_text:
   }
 }
 
-function writeLicense(schemeMeta: Meta, text: String, stream: fs.WriteStream) {
-  stream.write(`# [${schemeMeta.name}](${schemeMeta.url})\n\n${text}\n******************************************************************************** \n`)
+function writeLicense(schemeMeta: Meta, text: String) {
+  process.stdout.write(`## [${schemeMeta.name}](${schemeMeta.url})\n\n${text}\n********************************************************************************\n\n`)
 }
 
 const accepted_licenses = parseAcceptedToml(accepted_licenses_file);
 checkLicenses(schemeMeta, accepted_licenses)
 
-const stream = fs.createWriteStream(license_file);
 getLicenseText(schemeMeta, (meta, text) => {
-  writeLicense(meta, text, stream)
+  writeLicense(meta, text)
 });