Skip to content

WIP: Rework Api Gen to stabilise output and make it testable #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MangelMaxime wants to merge 12 commits into
base: master
Choose a base branch
from
Open

WIP: Rework Api Gen to stabilise output and make it testable #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
8bac0c4
Add a test-watch target
Dec 11, 2021
a12503f
Start working making the API Gen testable
Dec 11, 2021
5631e4c
WIP
Dec 14, 2021
780b29e
WIP
Dec 16, 2021
cd69e18
WIP: Build.js
Jan 3, 2022
0c87329
WIP
Jan 19, 2022
c0cd911
Stop tracking test-project generated files
Feb 9, 2022
e494389
Npm install needs to be run manually for the build.js to work
Feb 9, 2022
99353a1
Fix release-nuget script
Feb 9, 2022
83ee02b
Update the workflows to use the build.js script
Feb 9, 2022
9dc89bc
Merge branch 'master' into feature/rework_api_gen
Feb 9, 2022
56e1344
Fix package.json + run npm i to update lock file
Feb 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ jobs:
- name: Install and use custom npm version
run: npm i -g npm@7
- name: Setup workspace
run: make setup-dev
run: |
npm install
node build.js setup-dev
- name: Build site
run: make generate-docs
run: node build.js generate-docs
6 changes: 4 additions & 2 deletions .github/workflows/publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@ jobs:
- name: Install and use custom npm version
run: npm i -g npm@7
- name: Setup workspace
run: make setup-dev
run: |
npm install
node build.js setup-dev
- name: Build site
run: make generate-docs
run: node build.js generate-docs
- name: Deploy site
uses: peaceiris/actions-gh-pages@v3
with:
Expand Down
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,7 @@ demos/Thoth\.Elmish\.Demo/output/
fableBuild/
docs_deploy/
.nacara/
test-project/docs/reference/

# Ignore generated API file
docs/reference/
37 changes: 20 additions & 17 deletions .vscode/launch.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,6 @@
"name": ".NET Core Launch (console)",
"type": "coreclr",
"request": "launch",
"WARNING01": "*********************************************************************************",
"WARNING02": "The C# extension was unable to automatically decode projects in the current",
"WARNING03": "workspace to create a runnable launch.json file. A template launch.json file has",
"WARNING04": "been created as a placeholder.",
"WARNING05": "",
"WARNING06": "If OmniSharp is currently unable to load your project, you can attempt to resolve",
"WARNING07": "this by restoring any missing project dependencies (example: run 'dotnet restore')",
"WARNING08": "and by fixing any reported errors from building the projects in your workspace.",
"WARNING09": "If this allows OmniSharp to now load your project then --",
"WARNING10": " * Delete this file",
"WARNING11": " * Open the Visual Studio Code command palette (View->Command Palette)",
"WARNING12": " * run the command: '.NET: Generate Assets for Build and Debug'.",
"WARNING13": "",
"WARNING14": "If your project requires a more complex launch configuration, you may wish to delete",
"WARNING15": "this configuration and pick a different template using the 'Add Configuration...'",
"WARNING16": "button at the bottom of this file.",
"WARNING17": "*********************************************************************************",
"preLaunchTask": "build",
"program": "${workspaceFolder}/src/Nacara.ApiGen/Source/bin/Debug/net5.0/Nacara.ApiGen.dll",
"args": [
Expand All @@ -41,6 +24,26 @@
"console": "internalConsole",
"stopAtEntry": false
},
{
"name": "ApiGen - TestProject",
"type": "coreclr",
"request": "launch",
"preLaunchTask": "build",
"program": "${workspaceFolder}/src/Nacara.ApiGen/Source/bin/Debug/net5.0/Nacara.ApiGen.dll",
"args": [
"--project",
"TestProject",
"-lib",
"${workspaceFolder}/src/Nacara.ApiGen/Tests/Project/bin/Debug/net5.0/publish",
"--output",
"${workspaceFolder}/temp/",
"--base-url",
"/test-project/"
],
"cwd": "${workspaceFolder}",
"console": "internalConsole",
"stopAtEntry": false
},
{
"name": ".NET Core Attach",
"type": "coreclr",
Expand Down
22 changes: 21 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,10 +85,30 @@ generate-docs: build
--base-url /Nacara/
npx nacara

test: build
publish-test-project:
cd $(NACARA_API_GEN_DIR)/Tests && dotnet publish Project

run-api-gen-against-test-project: publish-test-project
dotnet run --project src/Nacara.ApiGen/Source/Nacara.ApiGen.fsproj -- \
--project TestProject \
-lib src/Nacara.ApiGen/Tests/Project/bin/Debug/net5.0/publish \
--output temp \
--base-url /test-project/

run-watch-api-gen-against-test-project:
dotnet run --project src/Nacara.ApiGen/Source/Nacara.ApiGen.fsproj -- \
--project TestProject \
-lib src/Nacara.ApiGen/Tests/Project/bin/Debug/net5.0/publish \
--output temp \
--base-url /test-project/

test: build publish-test-project
@$(call log_target_info, "Testing...")
cd $(NACARA_API_GEN_DIR)/Tests && dotnet run

test-watch: publish-test-project
@$(call log_target_info, "Testing...")
cd $(NACARA_API_GEN_DIR)/Tests && dotnet watch

release: test
@$(call log_target_info, "Releasing...")
Expand Down
18 changes: 18 additions & 0 deletions Nacara.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "Nacara.ApiGen", "src\Nacara
EndProject
Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "Nacara.ApiGen.Tests", "src\Nacara.ApiGen\Tests\Nacara.ApiGen.Tests.fsproj", "{7DAA7671-A915-408E-B412-73B3A516E626}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Tests", "Tests", "{BC9237A6-23A3-443C-A796-3919AC6A3DDD}"
EndProject
Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "TestProject", "src\Nacara.ApiGen\Tests\Project\TestProject.fsproj", "{8F362717-DDD3-4506-AC05-C3025E37F323}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -94,6 +98,18 @@ Global
{7DAA7671-A915-408E-B412-73B3A516E626}.Release|x64.Build.0 = Release|Any CPU
{7DAA7671-A915-408E-B412-73B3A516E626}.Release|x86.ActiveCfg = Release|Any CPU
{7DAA7671-A915-408E-B412-73B3A516E626}.Release|x86.Build.0 = Release|Any CPU
{8F362717-DDD3-4506-AC05-C3025E37F323}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{8F362717-DDD3-4506-AC05-C3025E37F323}.Debug|Any CPU.Build.0 = Debug|Any CPU
{8F362717-DDD3-4506-AC05-C3025E37F323}.Debug|x64.ActiveCfg = Debug|Any CPU
{8F362717-DDD3-4506-AC05-C3025E37F323}.Debug|x64.Build.0 = Debug|Any CPU
{8F362717-DDD3-4506-AC05-C3025E37F323}.Debug|x86.ActiveCfg = Debug|Any CPU
{8F362717-DDD3-4506-AC05-C3025E37F323}.Debug|x86.Build.0 = Debug|Any CPU
{8F362717-DDD3-4506-AC05-C3025E37F323}.Release|Any CPU.ActiveCfg = Release|Any CPU
{8F362717-DDD3-4506-AC05-C3025E37F323}.Release|Any CPU.Build.0 = Release|Any CPU
{8F362717-DDD3-4506-AC05-C3025E37F323}.Release|x64.ActiveCfg = Release|Any CPU
{8F362717-DDD3-4506-AC05-C3025E37F323}.Release|x64.Build.0 = Release|Any CPU
{8F362717-DDD3-4506-AC05-C3025E37F323}.Release|x86.ActiveCfg = Release|Any CPU
{8F362717-DDD3-4506-AC05-C3025E37F323}.Release|x86.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(NestedProjects) = preSolution
{EA2D1C6A-99E8-41F3-9F4A-FB07625468EB} = {73B853F7-42BA-45D8-8B5F-32FD8BB1D9DD}
Expand All @@ -104,5 +120,7 @@ Global
{A92658AE-2EE4-4B0D-96A5-915A1ACDCB21} = {73B853F7-42BA-45D8-8B5F-32FD8BB1D9DD}
{47F5787A-ED21-435A-B01C-48FD6CE092DB} = {A92658AE-2EE4-4B0D-96A5-915A1ACDCB21}
{7DAA7671-A915-408E-B412-73B3A516E626} = {A92658AE-2EE4-4B0D-96A5-915A1ACDCB21}
{BC9237A6-23A3-443C-A796-3919AC6A3DDD} = {A92658AE-2EE4-4B0D-96A5-915A1ACDCB21}
{8F362717-DDD3-4506-AC05-C3025E37F323} = {BC9237A6-23A3-443C-A796-3919AC6A3DDD}
EndGlobalSection
EndGlobal
Loading