Merge pull request #1235 from lf-lang/lfc-to-cli

Rename org.lflang.lfc to org.lflang.cli

.github/scripts/package_lfc.sh

@@ -6,8 +6,8 @@ set -euo pipefail
 ./gradlew clean buildLfc
 
 # find the version number
-jar_path="org.lflang.lfc/build/libs/org.lflang.lfc-*-all.jar"
-version="$(ls ${jar_path} | xargs -n 1 basename | sed 's/^org.lflang.lfc-\(.*\)-all.jar$/\1/')"
+jar_path="org.lflang.cli/build/libs/org.lflang.cli-*-lfc.jar"
+version="$(ls ${jar_path} | xargs -n 1 basename | sed 's/^org.lflang.cli-\(.*\)-lfc.jar$/\1/')"
 
 # use a different naming convention for nightly build artifacts
 if [[ "$#" > 0 && "$1" = "nightly" ]]; then
@@ -22,7 +22,7 @@ mkdir -p "${outname}/lib/scripts"
 mkdir -p "${outname}/lib/jars"
 
 # move the jar
-mv org.lflang.lfc/build/libs/org.lflang.lfc-*-all.jar "${outname}/lib/jars"
+mv org.lflang.cli/build/libs/org.lflang.cli-*-lfc.jar "${outname}/lib/jars"
 
 # copy the Bash scripts
 cp -a lib/scripts "${outname}/lib/"

.github/workflows/ci.yml

@@ -31,8 +31,9 @@ jobs:
     needs: cancel
 
   # Run tests for the standalone compiler.
+  # TODO: Change this back to master branch once merged!
   cli-tests:
-    uses: lf-lang/lingua-franca/.github/workflows/cli-tests.yml@master
+    uses: lf-lang/lingua-franca/.github/workflows/cli-tests.yml@lfc-to-cli
     needs: cancel
 
   # Run the C benchmark tests. 

.github/workflows/cli-tests.yml

@@ -15,9 +15,9 @@ jobs:
           submodules: true
       - name: Prepare build environment
         uses: ./.github/actions/prepare-build-env
-      - name: Run standalone lfc tests
+      - name: Run standalone cli tests
         run: |
-          ./gradlew :org.lflang.lfc:test --stacktrace
+          ./gradlew :org.lflang.cli:test --stacktrace
       - name: Test Bash scripts (Linux or macOS only)
         run: |
           .github/scripts/test-lfc.sh

bin/lfc.ps1

@@ -7,11 +7,11 @@
 $base="$PSScriptRoot\.."
 $java_home = "$Env:JAVA_HOME"
 $java_cmd = "$java_home\bin\java.exe"
-$jarpath_dev="$base\org.lflang.lfc\build\libs\org.lflang.lfc-*-all.jar"
-$jarpath_release="$base\lib\jars\org.lflang.lfc-*-all.jar"
+$jarpath_dev="$base\org.lflang.cli\build\libs\org.lflang.cli-*-lfc.jar"
+$jarpath_release="$base\lib\jars\org.lflang.cli-*-lfc.jar"
 
 function Test-Dev {
-    Test-Path "$base\org.lflang.lfc" -PathType container
+    Test-Path "$base\org.lflang.cli" -PathType container
 }
 
 function Get-JarPath {

lib/scripts/include.sh

@@ -21,10 +21,10 @@ set -euo pipefail
 # Paths (relative to ${base}), which is assumed to have been set.
 src_pkg_name="org.lflang"
 src_pkg_path="${base}/${src_pkg_name}"
-lfc_src_pkg_name="${src_pkg_name}.lfc"
+lfc_src_pkg_name="${src_pkg_name}.cli"
 lfc_src_pkg_path="${base}/${lfc_src_pkg_name}"
-lfc_jar_build_path_pattern="${lfc_src_pkg_name}/build/libs/${lfc_src_pkg_name}-*-all.jar"
-lfc_jar_release_path_pattern="lib/jars/${lfc_src_pkg_name}-*-all.jar"
+lfc_jar_build_path_pattern="${lfc_src_pkg_name}/build/libs/${lfc_src_pkg_name}-*-lfc.jar"
+lfc_jar_release_path_pattern="lib/jars/${lfc_src_pkg_name}-*-lfc.jar"
 
 # Enter directory silently (without printing).
 pushd() {

org.lflang.lfc/build.gradle → org.lflang.cli/build.gradle

@@ -31,9 +31,10 @@ apply plugin: 'com.github.johnrengelman.shadow'
 task buildLfc() {
     apply plugin: 'application'
     apply plugin: 'com.github.johnrengelman.shadow'
-    mainClassName = 'org.lflang.lfc.Main'
+    mainClassName = 'org.lflang.cli.Lfc'
 
     shadowJar {
+        archiveClassifier.set('lfc')
         exclude 'test/*'
         minimize() {
             exclude(dependency('log4j:log4j:.*'))
@@ -57,6 +58,6 @@ task runLfc(type: JavaExec) {
     description = "Build and run lfc, use --args to pass arguments"
     group = "application"
     classpath = sourceSets.main.runtimeClasspath
-    mainClass = 'org.lflang.lfc.Main'
+    mainClass = 'org.lflang.cli.Lfc'
     workingDir = '..'
 }

org.lflang.lfc/src/org/lflang/lfc/LFStandaloneModule.java → org.lflang.cli/src/org/lflang/cli/LFStandaloneModule.java

@@ -26,7 +26,7 @@
  * generated by Xtext 2.23.0
  */
 
-package org.lflang.lfc;
+package org.lflang.cli;
 
 import java.util.Objects;
 

org.lflang.lfc/src/org/lflang/lfc/Main.java → org.lflang.cli/src/org/lflang/cli/Lfc.java

@@ -2,7 +2,7 @@
  * Stand-alone version of the Lingua Franca compiler (lfc).
  */
 
-package org.lflang.lfc;
+package org.lflang.cli;
 
 import java.io.IOException;
 import java.nio.file.Files;
@@ -49,7 +49,7 @@
  * @author {Marten Lohstroh <[email protected]>}
  * @author {Christian Menard <[email protected]>}
  */
-public class Main {
+public class Lfc {
 
     /// current lfc version as printed by --version
     private static final String VERSION = "0.2.2-SNAPSHOT";
@@ -189,7 +189,7 @@ public static void main(final String[] args) {
         final Injector injector = new LFStandaloneSetup(new LFRuntimeModule(), new LFStandaloneModule(reporter))
             .createInjectorAndDoEMFRegistration();
         // Main instance.
-        final Main main = injector.getInstance(Main.class);
+        final Lfc main = injector.getInstance(Lfc.class);
         // Apache Commons Options object configured to according to available CLI arguments.
         Options options = CLIOption.getOptions();
         // CLI arguments parser.

org.lflang.lfc/src/org/lflang/lfc/ReportingUtil.kt → org.lflang.cli/src/org/lflang/cli/ReportingUtil.kt

@@ -22,7 +22,7 @@
  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-package org.lflang.lfc
+package org.lflang.cli
 
 import com.google.inject.Inject
 import com.google.inject.Singleton

org.lflang.lfc/src/org/lflang/lfc/StandaloneErrorReporter.java → org.lflang.cli/src/org/lflang/cli/StandaloneErrorReporter.java

@@ -25,7 +25,7 @@
  * POSSIBILITY OF SUCH DAMAGE.
  ***************/
 
-package org.lflang.lfc;
+package org.lflang.cli;
 
 import java.nio.file.Path;
 

org.lflang.lfc/src/org/lflang/lfc/StandaloneIssueAcceptor.java → org.lflang.cli/src/org/lflang/cli/StandaloneIssueAcceptor.java

@@ -1,4 +1,4 @@
-package org.lflang.lfc;
+package org.lflang.cli;
 
 import java.io.IOException;
 import java.nio.file.Path;

org.lflang.lfc/test/kotlin/org/lflang/lfc/tests/LfIssueReportingTest.kt → org.lflang.cli/test/kotlin/org/lflang/cli/tests/LfcIssueReportingTest.kt

@@ -21,14 +21,14 @@
  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-package org.lflang.lfc.tests
+package org.lflang.cli.tests
 
 import junit.framework.Assert.assertEquals
 import junit.framework.AssertionFailedError
 import org.junit.Test
 import org.lflang.LFRuntimeModule
 import org.lflang.LFStandaloneSetup
-import org.lflang.lfc.*
+import org.lflang.cli.*
 import java.io.*
 import java.nio.charset.StandardCharsets
 import java.nio.file.Files
@@ -45,7 +45,7 @@ class SpyPrintStream {
 }
 
 
-class LfIssueReportingTest {
+class LfcIssueReportingTest {
     /*
         Note: when executing these tests in Intellij, I get the following error:
 
@@ -115,7 +115,7 @@ class LfIssueReportingTest {
         val backend = ReportingBackend(Io(err = stderr.ps), AnsiColors(useColors), 2)
         val injector = LFStandaloneSetup(LFRuntimeModule(), LFStandaloneModule(backend))
             .createInjectorAndDoEMFRegistration()
-        val main = injector.getInstance(Main::class.java)
+        val main = injector.getInstance(Lfc::class.java)
 
         val packageName = loader.packageName.replace('.', '/')
         // relative to root of gradle project

org.lflang/src/org/lflang/generator/IntegratedBuilder.java

@@ -79,7 +79,7 @@ public GeneratorResult run(
         CancelIndicator cancelIndicator
     ) {
         // FIXME: A refactoring of the following line is needed. This refactor will affect FileConfig and
-        //  org.lflang.lfc.Main. The issue is that there is duplicated code.
+        //  org.lflang.cli.Lfc. The issue is that there is duplicated code.
         fileAccess.setOutputPath(
             FileConfig.findPackageRoot(Path.of(uri.path()), s -> {}).resolve(FileConfig.DEFAULT_SRC_GEN_DIR).toString()
         );

settings.gradle

@@ -1,3 +1,3 @@
 include 'org.lflang'
-include 'org.lflang.lfc'
+include 'org.lflang.cli'
 include 'org.lflang.tests'