Skip to content

Commit 574e692

Browse files
tigrannajaryantigrannajaryan
committed
Rename stefgen to stefc
1 parent 18ca995 commit 574e692

File tree

274 files changed

+494
-225
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

274 files changed

+494
-225
lines changed

‎.github/workflows/build-and-test.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ jobs:
133133
134134
- name: Generate Java code from test schemas
135135
run: |
136-
cd stefgen/generator
136+
cd stefc/generator
137137
go test -run TestGenerate
138138
139139
- name: Gradle test

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion

‎README.md‎

Lines changed: 1 addition & 1 deletion

‎docs/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ <h2>Example: Define a STEF Schema for JSON-like Data</h2>
6767

6868
<h2>Generate Serializers</h2>
6969
Generate the serializers in Go:
70-
<pre><code class="language-bash"># stefgen --lang=go jsonlike.stef
70+
<pre><code class="language-bash"># stefc --lang=go jsonlike.stef
7171
Generating modifiedfields.go
7272
Generating jsonvalue.go
7373
Generating record.go
@@ -99,7 +99,7 @@ <h2>Learn More</h2>
9999
<ul>
100100
<li><a href="./sdl.html">STEF Schema Definition Language</a></li>
101101
<li><a href="https://github.com/splunk/stef/blob/main/stef-spec/specification.md">STEF Specification</a> (detailed format and protocol)</li>
102-
<li><a href="./stefgen.html">Stefgen Code Generator</a> (generate code from STEF schemas)</li>
102+
<li><a href="./stefc.html">Stefc Compiler</a> (generate code from STEF schemas)</li>
103103
<li><a href="./benchmarks.html">Benchmarks</a> (performance results)</li>
104104
<li><a href="https://github.com/splunk/stef">GitHub Repository</a></li>
105105
</ul>

‎docs/sdl.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,8 +274,8 @@ <h2>Syntax Rules</h2>
274274
</ul>
275275

276276
<h2>Generated Code</h2>
277-
<p>Use the <code>stefgen</code> tool to generate serialization code from your STEF schema:</p>
278-
<pre><code class="language-bash">stefgen --lang=go myschema.stef</code></pre>
277+
<p>Use the <code>stefc</code> tool to generate serialization code from your STEF schema:</p>
278+
<pre><code class="language-bash">stefc --lang=go myschema.stef</code></pre>
279279
<p>This generates efficient serializers and deserializers in your target language.</p>
280280

281281
<h2>Learn More</h2>

docs/stefgen.html renamed to docs/stefc.html

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,32 @@
33
<head>
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6-
<title>Stefgen - STEF Code Generator</title>
6+
<title>Stefc - STEF Compiler</title>
77
<link href="https://fonts.googleapis.com/css?family=Roboto:400,700&display=swap" rel="stylesheet">
88
<link rel="stylesheet" href="./style.css">
99
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/themes/prism.css">
1010
<link rel="stylesheet" href="./prism-stef.css">
1111
</head>
1212
<body>
1313
<header>
14-
<h1>Stefgen</h1>
14+
<h1>Stefc</h1>
1515
<nav>
1616
<a href="./index.html">Home</a>
1717
<a href="https://github.com/splunk/stef">GitHub</a>
1818
<a href="https://github.com/splunk/stef/blob/main/stef-spec/specification.md">Specification</a>
1919
</nav>
2020
</header>
2121
<main>
22-
<p><strong>Stefgen</strong> is a command-line code generator that takes STEF schema files as input and generates type-safe serialization and deserialization code for multiple programming languages. It parses STEF schema definitions and produces optimized code that can efficiently read and write STEF-encoded data.</p>
22+
<p><strong>Stefc</strong> is a command-line compiler and code generator that takes STEF schema files as input and generates type-safe serialization and deserialization code for multiple programming languages. It parses STEF schema definitions and produces optimized code that can efficiently read and write STEF-encoded data.</p>
2323

2424
<h2>Installation</h2>
25-
<p>Build stefgen from source:</p>
26-
<pre><code class="language-bash">cd stefgen
25+
<p>Build stefc from source:</p>
26+
<pre><code class="language-bash">cd stefc
2727
make build</code></pre>
28-
<p>This will create the <code>stefgen</code> binary in the <code>bin/</code> directory.</p>
28+
<p>This will create the <code>stefc</code> binary in the <code>bin/</code> directory.</p>
2929

3030
<h2>Usage</h2>
31-
<pre><code class="language-bash">stefgen [flags] &lt;path-to-schema-file&gt;</code></pre>
31+
<pre><code class="language-bash">stefc [flags] &lt;path-to-schema-file&gt;</code></pre>
3232

3333
<h2>Command Line Arguments</h2>
3434
<table>
@@ -72,19 +72,19 @@ <h2>Examples</h2>
7272

7373
<h3>Generate Go Code</h3>
7474
<pre><code class="language-bash"># Generate Go code from a STEF schema
75-
stefgen -lang=go -outdir=./generated schema.stef</code></pre>
75+
stefc -lang=go -outdir=./generated schema.stef</code></pre>
7676

7777
<h3>Generate Java Code</h3>
7878
<pre><code class="language-bash"># Generate Java code with separate test directory
79-
stefgen -lang=java -outdir=./src/main/java -testoutdir=./src/test/java schema.stef</code></pre>
79+
stefc -lang=java -outdir=./src/main/java -testoutdir=./src/test/java schema.stef</code></pre>
8080

8181
<h3>Generate Java Code (Simple)</h3>
8282
<pre><code class="language-bash"># Generate Java code with tests in same directory
83-
stefgen -lang=java -outdir=./java-gen schema.stef</code></pre>
83+
stefc -lang=java -outdir=./java-gen schema.stef</code></pre>
8484

8585
<h2>Generated Code Structure</h2>
8686

87-
<p>stefgen creates:</p>
87+
<p>stefc creates:</p>
8888
<ul>
8989
<li>Struct, oneof and multimap definitions matching your STEF schema</li>
9090
<li>Type-safe accessors for all fields</li>
@@ -105,7 +105,7 @@ <h3>1. Define Your Schema</h3>
105105
}</code></pre>
106106

107107
<h3>2. Generate Code</h3>
108-
<pre><code class="language-bash">stefgen -lang=go -outdir=./generated user.stef</code></pre>
108+
<pre><code class="language-bash">stefc -lang=go -outdir=./generated user.stef</code></pre>
109109

110110
<h3>3. Use Generated Code</h3>
111111
<p>The generated Go code can then be imported and used in your application:</p>

‎examples/jsonl/internal/jsonstef/common.go‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎examples/jsonl/internal/jsonstef/jsonobject.go‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎examples/jsonl/internal/jsonstef/jsonvalue.go‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎examples/jsonl/internal/jsonstef/jsonvaluearray.go‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)