Split ARCtrl project into language-specific project files #446

HLWeil · 2024-10-02T12:27:51Z

Removed all python and javascript specific dependencies from all projects except for top-level ARCtrl.

There, created an ARCtrl.Javascript and ARCtrl.Python project file, which contain the corresponding dependencies and IO-implementations.

closes #445

@MangelMaxime

MangelMaxime · 2024-10-02T13:13:53Z

src/ARCtrl/ARCtrl.Javascript.fsproj

+    <TargetFramework>netstandard2.0</TargetFramework>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <DefineConstants>FABLE_COMPILER_JAVASCRIPT;FABLE_COMPILER;FABLE_COMPILER_TYPESCRIPT</DefineConstants>
+  </PropertyGroup>
+  <PropertyGroup>
+    <Authors>nfdi4plants, Lukas Weil, Kevin Frey, Kevin Schneider, Oliver Maus</Authors>
+    <Description>Library for management of Annotated Research Contexts (ARCs) using an in-memory representation and runtimer agnostic contract systems.</Description>
+    <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <PackageIcon>logo.png</PackageIcon>
+    <PackageTags>ARC F# FSharp dotnet .Net bioinformatics biology fable-library datascience dataplant nfdi metadata</PackageTags>
+    <PackageProjectUrl>https://github.com/nfdi4plants/ARCtrl</PackageProjectUrl>
+    <RepositoryUrl>https://github.com/nfdi4plants/ARCtrl</RepositoryUrl>
+    <RepositoryType>git</RepositoryType>
+  </PropertyGroup>
+  <ItemGroup>
+    <Compile Include="Json\Decode.fs" />
+    <Compile Include="Json\Encode.fs" />
+    <Compile Include="Json\Comment.fs" />
+    <Compile Include="Json\OntologyAnnotation.fs" />
+    <Compile Include="Json\OntologySourceReference.fs" />
+    <Compile Include="Json\DataFile.fs" />
+    <Compile Include="Json\Data.fs" />
+    <Compile Include="Json\Person.fs" />
+    <Compile Include="Json\Publication.fs" />
+    <Compile Include="Json\Process\Value.fs" />
+    <Compile Include="Json\Process\Factor.fs" />
+    <Compile Include="Json\Process\FactorValue.fs" />
+    <Compile Include="Json\Process\ProtocolParameter.fs" />
+    <Compile Include="Json\Process\MaterialType.fs" />
+    <Compile Include="Json\Process\MaterialAttribute.fs" />
+    <Compile Include="Json\Process\Component.fs" />
+    <Compile Include="Json\Process\Protocol.fs" />
+    <Compile Include="Json\Process\MaterialAttributeValue.fs" />
+    <Compile Include="Json\Process\Material.fs" />
+    <Compile Include="Json\Process\Source.fs" />
+    <Compile Include="Json\Process\Sample.fs" />
+    <Compile Include="Json\Process\ProcessParameterValue.fs" />
+    <Compile Include="Json\Process\ProcessInput.fs" />
+    <Compile Include="Json\Process\ProcessOutput.fs" />
+    <Compile Include="Json\Process\Process.fs" />
+    <Compile Include="Json\Process\ProcessSequence.fs" />
+    <Compile Include="Json\Process\StudyMaterials.fs" />
+    <Compile Include="Json\Table\Compression.fs" />
+    <Compile Include="Json\Table\CompositeCell.fs" />
+    <Compile Include="Json\Table\IOType.fs" />
+    <Compile Include="Json\Table\CompositeHeader.fs" />
+    <Compile Include="Json\Table\ArcTable.fs" />
+    <Compile Include="Json\Table\Templates.fs" />
+    <Compile Include="Json\DataMap\DataMap.fs" />
+    <Compile Include="Json\Assay.fs" />
+    <Compile Include="Json\Study.fs" />
+    <Compile Include="Json\Investigation.fs" />
+    <Compile Include="Json\ROCrateObject.fs" />
+    <Compile Include="Json\ARC.fs" />
+    <Compile Include="WebRequest\WebRequest.Node.fs" />
+    <Compile Include="WebRequest\WebRequest.fs" />
+    <Compile Include="Template.Web.fs" />
+    <Compile Include="ARC.fs" />
+    <Compile Include="Json.fs" />
+    <Compile Include="Xlsx.fs" />
+    <None Include="README.md" />
+  </ItemGroup>


If you want to avoid duplication of the code you can move it to ARCTrl.Common.props and include it in your different project.

Some of the properties (like Authors, License) can even be moved to the top level Directory.Build.props

Will try, thanks!

MangelMaxime · 2024-10-02T13:31:22Z

src/ARCtrl/ARCtrl.Javascript.fsproj

+    <ProjectReference Include="..\Spreadsheet\ARCtrl.Spreadsheet.fsproj" />
+  </ItemGroup>
+  <ItemGroup>
+    <Content Include="*.fsproj; **\*.fs; **\*.fsi" PackagePath="fable\" />


Using Fable.Package.SDK allows to remove these lines and will asked you to set the PackageTags information so your NuGet package can be listed in https://fable.io/packages/

This did not work for me out of the box, will open an Issue in the given project.

https://github.com/fslaborg/FsSpreadsheet/blob/e59da935ebced63c3bcd7ed9e9dd3e276715fe54/src/FsSpreadsheet/FsSpreadsheet.fsproj#L6

Here are the lines in question. I thought this would be enough to trigger the inclusion of the src files in a Fable folders when running dotnet pack

It should be enough yes,

Use the following to include the dependency, you didn't have it included by default because it is only done automatically since 1.1.0. This will make your package not include Fable.Package.SDK in its dependencies.

<PackageReference Include="Fable.Package.SDK"> <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets> <PrivateAssets>all</PrivateAssets> </PackageReference>

You should also remove:

<Content Include="*.fsproj; **\*.fs; **\*.fsi" PackagePath="fable\" />

If this is still not working I can have a look at it if you want

Hey, sry forgot to write here. The Inclusion of the Source Files works now! (I saw you released the 1.1.0 version)

Just got another small issue: fable-compiler/Fable.Package.SDK#6

It does produce a proper nuget file. So ignoring the error kinda works, but would be nice to find the reason behind this.

Its strange in theory if there is an error it should fails.

But perhaps MSBuild create the package before and then the CLI exist with an error code. I will check the issue you reported.

The issue is caused by this line:

<PackageTags>ARC F# FSharp dotnet .Net bioinformatics biology fable-library datascience dataplant nfdi metadata</PackageTags>

Judging by the content of the tag, I think you wanted to use <Description>

Its strange in theory if there is an error it should fails.

But perhaps MSBuild create the package before and then the CLI exist with an error code. I will check the issue you reported.

Yeah sry with "ignoring the error" I meant actually catching and ignoring the error :D

The issue is caused by this line:

<PackageTags>ARC F# FSharp dotnet .Net bioinformatics biology fable-library datascience dataplant nfdi metadata</PackageTags>

Judging by the content of the tag, I think you wanted to use <Description>

These are actually tags used by nuget to increase findability of the package.

Kinda hotfixed it by merging the two lists (See issue on Fable.Packages.SDK)

…avascript packages

HLWeil · 2024-10-02T22:02:14Z

As far as I can tell everything works. I just pushed version 2.1.0-alpha1 to Nuget, npm and pypi.

HLWeil · 2024-10-02T22:02:36Z

So.. It's ready to review @Freymaurer @kMutagene

Thanks a lot for your input, @MangelMaxime!

Freymaurer · 2024-10-07T10:31:03Z

build/BasicTasks.fs

@@ -163,6 +163,7 @@ let build = BuildTask.create "Build" [clean] {
        let msBuildParams =
            {p.MSBuildParams with 
                DisableInternalBinLog = true
+                NodeReuse = false


Why was this added?

Nevermind, removed it

Freymaurer · 2024-10-07T10:32:03Z

build/PackageTasks.fs

@@ -104,7 +104,7 @@ module BundlePy =
        run python "-m poetry build" ProjectInfo.pyPkgDir //Remove "-o ." because not compatible with publish 


-let packPy = BuildTask.create "PackPy" [clean; build; runTests] {
+let packPy = BuildTask.create "PackPy" [clean; build; (*runTests*)] {


💀 commented out tests(!)

Whoops, fixed

package.json

Freymaurer · 2024-10-07T10:42:18Z

src/ARCtrl/JsonIO/ROCrateObject.fs

i am not really a fun of reflection in f# code. I fully trust you in this, that we do not have to rework it in 2 years

Yeah it's always a bit dangerous, but here I think we should be fine, as the Option part can be ignored in js and py.

Freymaurer · 2024-10-07T10:57:13Z

src/Package.Metadata.props

HLWeil added 4 commits September 30, 2024 16:54

start working on ro-crate-json parsing

2e47979

first buildable version after fable restructure

f6afa53

remove javascript and pyton packages from main solution

c429686

various test fixes for Fable logic transition

43d65db

HLWeil mentioned this pull request Oct 2, 2024

[Feature Request] Add additional compiler directives thoth-org/Thoth.Json#206

Closed

remove restorelockedmode flag

3586dee

MangelMaxime reviewed Oct 2, 2024

View reviewed changes

HLWeil added 5 commits October 2, 2024 16:20

move duplicate project references into props files

755879d

Make use of Fable.Package.SDK

93030e9

fix fable ready packaging and/by update package tags

8552f9e

rename json IO implementations folder to reduce ambiguity in py and j…

99b2659

…avascript packages

bump to 2.1.0-alpha1

7d873b4

remove leftover catching of erros in dotnet packaging

12eb2b9

Freymaurer reviewed Oct 7, 2024

View reviewed changes

small changes to build-chain according to PR review

b8640a7

Freymaurer approved these changes Oct 7, 2024

View reviewed changes

HLWeil merged commit 9e43e81 into main Oct 7, 2024
2 checks passed

This was referenced Oct 23, 2024

[BUG] Unable to use ARCtrl.Json in fable JavaScript environment #373

Closed

[Feature Request] Include Fable.Packages.SDK and central version management fslaborg/FsSpreadsheet#102

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Split ARCtrl project into language-specific project files #446

Split ARCtrl project into language-specific project files #446

HLWeil commented Oct 2, 2024 •

edited

Loading

MangelMaxime Oct 2, 2024

HLWeil Oct 2, 2024

MangelMaxime Oct 2, 2024

HLWeil Oct 2, 2024

HLWeil Oct 2, 2024

MangelMaxime Oct 2, 2024

HLWeil Oct 2, 2024 •

edited

Loading

MangelMaxime Oct 2, 2024

MangelMaxime Oct 2, 2024

HLWeil Oct 2, 2024

HLWeil Oct 2, 2024

HLWeil Oct 2, 2024 •

edited

Loading

HLWeil commented Oct 2, 2024

HLWeil commented Oct 2, 2024 •

edited

Loading

Freymaurer Oct 7, 2024

HLWeil Oct 7, 2024

Freymaurer Oct 7, 2024

HLWeil Oct 7, 2024

Freymaurer Oct 7, 2024

HLWeil Oct 7, 2024

Freymaurer Oct 7, 2024

Split ARCtrl project into language-specific project files #446

Split ARCtrl project into language-specific project files #446

Conversation

HLWeil commented Oct 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HLWeil Oct 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HLWeil Oct 2, 2024 • edited Loading

Choose a reason for hiding this comment

HLWeil commented Oct 2, 2024

HLWeil commented Oct 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HLWeil commented Oct 2, 2024 •

edited

Loading

HLWeil Oct 2, 2024 •

edited

Loading

HLWeil Oct 2, 2024 •

edited

Loading

HLWeil commented Oct 2, 2024 •

edited

Loading