Move contributor docs editor message structure tree generator from test to tools directory (#3663)

This commit is contained in:
Keavon Chambers
2026-01-20 23:53:15 -08:00
committed by GitHub
parent 7af60e02a3
commit 781fa7ae95
13 changed files with 142 additions and 111 deletions

View File

@@ -1,3 +1,5 @@
// TODO: Port this script to Rust as part of `tools/editor-message-tree/src/main.rs`
/* eslint-disable no-console */
import fs from "fs";

1
website/.gitignore vendored
View File

@@ -1,5 +1,6 @@
node_modules/
public/
generated/
static/*
!static/js/
content/learn/node-catalog

View File

@@ -23,7 +23,7 @@
"eslint-plugin-prettier": "^5.5.5",
"prettier": "^3.8.0",
"sass": "1.97.2",
"tar": "^7.5.4",
"tar": "^7.5.6",
"typescript-eslint": "^8.53.1"
}
},
@@ -4122,9 +4122,9 @@
}
},
"node_modules/tar": {
"version": "7.5.4",
"resolved": "https://registry.npmjs.org/tar/-/tar-7.5.4.tgz",
"integrity": "sha512-AN04xbWGrSTDmVwlI4/GTlIIwMFk/XEv7uL8aa57zuvRy6s4hdBed+lVq2fAZ89XDa7Us3ANXcE3Tvqvja1kTA==",
"version": "7.5.6",
"resolved": "https://registry.npmjs.org/tar/-/tar-7.5.6.tgz",
"integrity": "sha512-xqUeu2JAIJpXyvskvU3uvQW8PAmHrtXp2KDuMJwQqW8Sqq0CaZBAQ+dKS3RBXVhU4wC5NjAdKrmh84241gO9cA==",
"dev": true,
"license": "BlueOak-1.0.0",
"dependencies": {

View File

@@ -12,7 +12,7 @@
"type": "module",
"scripts": {
"postinstall": "node .build-scripts/install.ts",
"generate-editor-structure": "node .build-scripts/generate-editor-structure.ts ../hierarchical_message_system_tree.txt ../hierarchical_message_system_tree.html",
"generate-editor-structure": "node .build-scripts/generate-editor-structure.ts generated/hierarchical_message_system_tree.txt generated/hierarchical_message_system_tree.html",
"lint": "eslint . && tsc --noEmit",
"lint-fix": "eslint . --fix && tsc --noEmit"
},
@@ -28,7 +28,7 @@
"eslint": "^9.39.2",
"prettier": "^3.8.0",
"sass": "1.97.2",
"tar": "^7.5.4",
"tar": "^7.5.6",
"typescript-eslint": "^8.53.1"
},
"dependencies": {

View File

@@ -40,12 +40,14 @@
{% endmacro text_balancer %}
{% macro hierarchical_message_system_tree() %}
{%- set content = load_data(path = "../../hierarchical_message_system_tree.html", format = "plain", required = false) -%}
{%- set content = load_data(path = "../generated/hierarchical_message_system_tree.html", format = "plain", required = false) -%}
{%- set fallback = "<pre>THIS CONTENT IS FILLED IN WHEN CI BUILDS THE WEBSITE.
TO TEST IT LOCALLY, FROM THE `website` DIRECTORY, RUN:
TO TEST IT LOCALLY, FROM THE ROOT OF THE PROJECT, RUN:
cargo test --package graphite-editor --lib -- messages::message::test::generate_message_tree
cd tools/editor-message-tree
cargo run
cd ../../website
npm run generate-editor-structure</pre>" -%}
{{ content | default(value = fallback) | safe }}
{% endmacro hierarchical_message_system_tree %}