Merge pull request #133 from nickvdyck/chore/build

chore: redo build setup

.config/dotnet-tools.json

@@ -2,12 +2,6 @@
   "version": 1,
   "isRoot": true,
   "tools": {
-    "nuke.globaltool": {
-      "version": "0.24.0",
-      "commands": [
-        "nuke"
-      ]
-    },
     "minver-cli": {
       "version": "2.0.0",
       "commands": [

.editorconfig

@@ -8,7 +8,7 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[*.{yml,json,csproj}]
+[*.{yml,json,csproj,props,targets}]
 indent_size = 2
 
 [.babelrc]

.github/workflows/release-workflow.yml

@@ -34,14 +34,14 @@ jobs:
     - name: Checkout code
       uses: actions/checkout@v1
 
-    - name: Restore Tools
-      run: dotnet tool restore
-
     - name: Install dependencies
-      run: dotnet nuke setup
+      run: make setup
+
+    - name: Lint
+      run: make lint
 
-    - name: Package app
-      run: dotnet nuke
+    - name: Build & Package
+      run: make
 
     - name: Get the version
       id: get_version

.github/workflows/workflow.yml

@@ -27,23 +27,17 @@ jobs:
     - name: Checkout code
       uses: actions/checkout@v1
 
-    - name: Restore Tools
-      run: dotnet tool restore
-
     - name: Install dependencies
-      run: dotnet nuke setup
+      run: make setup
 
     - name: Lint
-      run: dotnet nuke lint
+      run: make lint
 
     - name: Build & Package
-      run: dotnet nuke
-
-    - name: Unit Test Client
-      run: yarn --cwd src/WebTty.Hosting/Client/ test --coverage --coverageDirectory ../../../.tmp/webtty.hosting/client
+      run: make
 
-    - name: Unit Test Server
-      run: dotnet nuke test
+    - name: Test
+      run: make test
 
     - name: Codecov Upload Coverage
       uses: codecov/codecov-action@v1

Directory.Build.props

@@ -1,6 +1,6 @@
 <Project>
 
-  <Import Project="BuildOutput.props" />
+  <Import Project="Common.props" />
 
   <PropertyGroup>
     <Authors>Nick Van Dyck</Authors>
@@ -25,7 +25,7 @@
 
     <IsPackaging>false</IsPackaging>
     <RestoreSources Condition="'$(IsPackaging)' == 'true'">
-      $(RestoreSources);../../artifacts;https://api.nuget.org/v3/index.json
+      $(MSBuildThisFileDirectory)artifacts;$(RestoreSources);https://api.nuget.org/v3/index.json
     </RestoreSources>
 
     <MinVerAutoIncrement>minor</MinVerAutoIncrement>

Makefile

@@ -0,0 +1,91 @@
+.PHONY: purge clean default install uninstall setup test
+.DEFAULT_GOAL := default
+
+ARTIFACTS 		:= $(shell pwd)/artifacts
+BUILD			:= $(shell pwd)/.build
+TEMP			:= $(shell pwd)/.tmp
+CONFIGURATION	:= Release
+WEBTTY_EXEC		:= src/WebTty.Exec/WebTty.Exec.csproj
+WEBTTY_CLIENT	:= src/WebTty.Hosting/Client
+CLI_PROJECT		:= src/WebTty/WebTty.csproj
+CLI_TOOL		:= webtty
+RUNTIME 		:= linux-x64
+
+purge:
+	rm -rf $(BUILD)
+	rm -rf $(ARTIFACTS)
+	rm -rf $(TEMP)
+
+clean:
+	rm -rf $(ARTIFACTS)
+	dotnet clean
+
+restore:
+	dotnet restore
+	dotnet tool restore
+
+setup: restore
+	dotnet run --project tools/jsonschema/jsonschema.csproj
+	dotnet build -c $(CONFIGURATION)
+
+default:
+	$(MAKE) package
+
+package: restore package-exec
+	dotnet restore --force-evaluate
+	dotnet build -c $(CONFIGURATION) /property:IsPackaging=True $(CLI_PROJECT)
+	dotnet pack $(CLI_PROJECT) --configuration $(CONFIGURATION) \
+		--no-build \
+		--output $(ARTIFACTS) \
+		--include-symbols
+
+package-exec:
+	dotnet pack $(WEBTTY_EXEC) \
+		--configuration $(CONFIGURATION) \
+		--output $(ARTIFACTS) \
+		--version-suffix build.$(shell date "+%Y%m%d%H%M%S")
+
+package-native:
+	dotnet publish $(CLI_PROJECT) -c $(CONFIGURATION) \
+		--output $(BUILD)/publish/$(RUNTIME) \
+		--runtime $(RUNTIME) \
+		/property:PublishTrimmed=true \
+		/property:PublishSingleFile=true
+
+	@mkdir -p $(ARTIFACTS)
+	@cp $(BUILD)/publish/$(RUNTIME)/$(CLI_TOOL) $(ARTIFACTS)/$(CLI_TOOL).$(RUNTIME)
+
+package-osx:
+	$(MAKE) package-native RUNTIME=osx-x64
+
+install:
+	dotnet tool install --global --add-source $(ARTIFACTS) \
+		--version $$(dotnet minver -t v -a minor -v e) \
+		$(CLI_TOOL)
+
+uninstall:
+	dotnet tool uninstall --global $(CLI_TOOL)
+
+lint: types
+	yarn --cwd $(WEBTTY_CLIENT) lint
+
+types:
+	yarn --cwd $(WEBTTY_CLIENT) tsc --noEmit
+
+test:
+	yarn --cwd $(WEBTTY_CLIENT) test --coverage --coverageDirectory $(TEMP)/webtty.hosting/client
+
+	dotnet test test/WebTty.Test/WebTty.Test.csproj -c Release \
+		/property:CollectCoverage=true \
+		/property:CoverletOutputFormat=lcov \
+		/property:CoverletOutput=$(TEMP)/webtty.test/lcov.info
+
+	dotnet test test/WebTty.Api.Test/WebTty.Api.Test.csproj -c Release \
+		/property:CollectCoverage=true \
+		/property:CoverletOutputFormat=lcov \
+		/property:CoverletOutput=$(TEMP)/webtty.api.test/lcov.info
+
+	dotnet test test/WebTty.Integration.Test/WebTty.Integration.Test.csproj -c Release \
+		/property:CollectCoverage=true \
+		/property:CoverletOutputFormat=lcov \
+		/property:CoverletOutput=$(TEMP)/webtty.integration.test/lcov.info

README.md

@@ -28,20 +28,24 @@ dotnet tool install -g webtty
 ```
 λ webtty --help
 
-🔌 WebSocket based terminal emulator
+webtty:
+  🔌 Simple command-line tool for sharing a terminal over the web.
 
-Usage: webtty [options] -- [command] [<arguments...>]
+Usage:
+  webtty [options] [[--] <additional arguments>...]]
 
 Options:
-  -a, --address=VALUE        IP address to use [localhost]. Use any to listen
-                               to any available address. Ex (0.0.0.0, any, 192.
-                               168.2.3, ...)
-  -s, --unix-socket=VALUE    Use the given Unix domain socket path for the
-                               server to listen to
-  -p, --port=VALUE           Port to use [5000]. Use 0 for a dynamic port.
-      --path=VALUE           Path to use, defaults to /tty
-      --version              Show current version
-  -?, -h, --help             Show help information
+  -a, --address <address>         IP address to use [localhost]. Use any to listen to any available
+                                  address. Ex (0.0.0.0, any, 192.168.2.3, ...).
+  -s, --unix-socket <filepath>    Use the given Unix domain socket path for the server to listen to
+  -p, --port <port>               Port to use [5000]. Use 0 for a dynamic port.
+  --path <path>                   Path to use, defaults to /pty
+  --theme <theme>                 Theme to use, uses a simple black theme by default
+  --version                       Show version information
+  -?, -h, --help                  Show help and usage information
+
+Additional Arguments:
+  Arguments passed to the application that is being run.
 ```
 
 [ci-url]: https://github.com/nickvdyck/webtty

src/WebTty.Api/WebTty.Api.csproj

@@ -12,7 +12,7 @@
   </ItemGroup>
 
   <ItemGroup Condition="'$(IsPackaging)' == 'true'">
-    <PackageReference Include="WebTty.Exec" Version="0.1.0-build.*" Pack="true" />
+    <PackageReference Include="WebTty.Exec" Version="1.0.0-build.*" Pack="true" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(IsPackaging)' == 'false'">

src/WebTty.Exec/Directory.Build.props

@@ -1,13 +1,16 @@
 <Project>
 
-  <Import Project="Version.props" />
-  <Import Project="../../BuildOutput.props" />
+  <Import Project="../../Common.props" />
 
   <PropertyGroup>
     <LangVersion>latest</LangVersion>
     <RootNamespace>WebTty.Exec</RootNamespace>
     <EnableDefaultCompileItems>false</EnableDefaultCompileItems>
     <AssemblyName>WebTty.Exec</AssemblyName>
+
+    <VersionPrefix>1.0.0</VersionPrefix>
+    <PackageVersion>$(VersionPrefix)</PackageVersion>
+    <PackageVersion Condition="'$(VersionSuffix)' != ''">$(PackageVersion)-$(VersionSuffix)</PackageVersion>
   </PropertyGroup>
 
 </Project>